Differences
This shows you the differences between two versions of the page.
Both sides previous revision Previous revision Next revision | Previous revision | ||
metamod:user_database_revised [2010-09-24 12:41:22] egils |
metamod:user_database_revised [2022-05-31 09:29:32] (current) |
||
---|---|---|---|
Line 7: | Line 7: | ||
**2010-09-24: | **2010-09-24: | ||
+ | |||
+ | **2010-09-28: | ||
+ | |||
+ | 2010-11-11: Removed WMS_URL and WMS_XML entries from the InfoDS table | ||
===== Overview ===== | ===== Overview ===== | ||
Line 86: | Line 90: | ||
^LOCATION |Location. Single entity. Absolute path to the directory under which all files belonging to the dataset are found. The files may be found directly in the location directory, or in any subdirectory of the location directory at any level. | | ^LOCATION |Location. Single entity. Absolute path to the directory under which all files belonging to the dataset are found. The files may be found directly in the location directory, or in any subdirectory of the location directory at any level. | | ||
^CATALOG |Partial URL to a THREDDS dataset. Single entity. Combined with the file name, this URL can be used to access the content of a file through a TDS server. It can also provide the URL that points to the THREDDS catalog containing the METAMOD dataset. | | ^CATALOG |Partial URL to a THREDDS dataset. Single entity. Combined with the file name, this URL can be used to access the content of a file through a TDS server. It can also provide the URL that points to the THREDDS catalog containing the METAMOD dataset. | | ||
- | ^WMS_URL |URL to the WMS service that can display data from the dataset. Single entity. | | ||
- | ^WMS_XML |XML document that describes available alternatives for displaying the dataset in WMS. For example, the parameters that can be displayed. Each parameter may have a palette (for example " | ||
|Additional information types may be added later, for example to implement projection information: | |Additional information types may be added later, for example to implement projection information: | ||
^PROJECTION_XML |XML document used to represent reprojection information. The document contains, among other things, each projection the user has asked for (" | ^PROJECTION_XML |XML document used to represent reprojection information. The document contains, among other things, each projection the user has asked for (" | ||
Line 142: | Line 144: | ||
^Method ^Purpose ^Parameters ^ | ^Method ^Purpose ^Parameters ^ | ||
|user_find |Search for an existing user in the database and make him/her the current user. |IN: User E-mail address, application id (A_id). | | |user_find |Search for an existing user in the database and make him/her the current user. |IN: User E-mail address, application id (A_id). | | ||
- | |**user_lfind** |**Search for an existing user in the database and make him/her the current user.** |**IN: User login name, application id (A_id).** | | + | |user_lfind |Search for an existing user in the database and make him/her the current user. |IN: User login name, application id (A_id). | |
- | |user_create |Create a new user and make it the current user. |IN: User E-mail address, application id (A_id). | + | |user_create |Create a new user and make it the current user. |IN: User E-mail address, application id (A_id). Initially, the value of the mandatory U_loginname field will be set to the E-mail address, but this can be changed using the user_set method. | |
- | |< | + | |user_put |Set user properties for the current user |IN: Property name (one of ' |
- | |user_get |Get user properties for the current user. |IN: Property name (one of ' | + | |user_get |Get user properties for the current user. |IN: Property name (one of ' |
|user_first |Make the first user in the database the current user. |OUT: TRUE if found, FALSE if no users exist. | | |user_first |Make the first user in the database the current user. |OUT: TRUE if found, FALSE if no users exist. | | ||
|user_next |Make the next user in the database the current one. |OUT: TRUE if found, FALSE if already last user. | | |user_next |Make the next user in the database the current one. |OUT: TRUE if found, FALSE if already last user. | | ||
Line 160: | Line 162: | ||
|dset_next |Make the next dataset (owned by the current user) the current dataset. |OUT: true if found, false if already last dataset. | | |dset_next |Make the next dataset (owned by the current user) the current dataset. |OUT: true if found, false if already last dataset. | | ||
|dset_isync |Make the dataset corresponding to the current infoUDS-row (see below) the current dataset. |OUT: TRUE if found, FALSE on error. | | |dset_isync |Make the dataset corresponding to the current infoUDS-row (see below) the current dataset. |OUT: TRUE if found, FALSE on error. | | ||
- | |**dset_get** < | + | |dset_get |Get information from the current dataset. |IN: Information type (I_type) or one of ' |
- | |**dset_put** < | + | |dset_put |Add or replace content fields in the current dataset. |IN: Information type (I_type), value of I_content field (single entity or XML). | |
==== Functions for manipulating the InfoUDS table==== | ==== Functions for manipulating the InfoUDS table==== | ||
Line 177: | Line 179: | ||
^Method ^Purpose ^Parameters ^ | ^Method ^Purpose ^Parameters ^ | ||
- | |file_find |Search for an existing file (owned by the curent | + | |file_find |Search for an existing file (**owned by the curent |
- | |file_create |Create a new file (for the current | + | |file_create |Create a new file (**for the current |
- | |< | + | |file_put |Set file properties for the current file |IN: Property name (one of ' |
|file_get |Get file properties for the current file. |IN: Property name (one of F_name', | |file_get |Get file properties for the current file. |IN: Property name (one of F_name', | ||
- | |file_first |Make the first file (in the current | + | |file_first |Make the first file (**owned by the current |
|file_next |Make the next file in the database the current one. |OUT: true if found, false if already last file. | | |file_next |Make the next file in the database the current one. |OUT: true if found, false if already last file. | | ||
+ | |**file_delete** |**Delete the current file entry from the database.** |**OUT: true if the entry was deleted, false on error.** | | ||
==== Example usecase ==== | ==== Example usecase ==== |