If the series series_name does not exist, store_dir will first create that series, provided that the user supplies the -c flag. If perm=1, then the series will be globally accessible, otherwise, only the user calling store_dir will have access. store_dir then creates a record in the series series_name and creates a subdirectory, subdir, in the record's SUMS directory (for each record there is a single SUMS directory). store_dir copies all files from prefix/subdir to subdir in the record's SUMS directory. It also stores prefix/subdir in the record's dirname keyword value so that retrieve_dir can locate the subdirectory within the SUMS directory that contains the files.
sel=sel_text and note=note_text allow the user to link additional information to the record to facilitate the subsequent search for files in the series. They set the record's sel and note keywords to have the values sel_text and note_text, respectively. In particular, sel can be used to differentiate between multiple calls to store_dir with the same value for prefix/subdir. series_name must contain prime keywords dirname and sel, and it must contain the keyword note.
store_dir [-cvDRIVER_FLAGS] series=<series_name> dirname=<prefix>/<subdir>
sel=<sel_text> [note=<note_text>] [perm=0|1]
Example: To store a directory of files,
store_dir series=su_arta.TestStoreDir dirname=/auto/home2/arta/savedFilesJanuary sel=January note="All my January work"
-c: Silently create the series series_name if it does not exist. -v: Run in verbose mode.| series_name | Specifies the series, series_name, to which the file-referring record will be added. Should a record-set specifier be provided, it will be ignored. | |
| prefix/subdir | The local full path that contains the files to be stored in SUMS. The record created will contain a prime keyword named dirname whose value will be prefix/subdir. | |
| sel_text | Contains a string that will be the keyword value for the sel prime keyword of the record created. This extra prime keyword facilitates selection between multiple records containing equivalent values for the dirname (it may be desirable to save files in the same directly repeatedly, or save the same file over time). | |
| note_text | An optional string that will be the keyword value for the note keyword of the record created. | |
| perm=0|1 | Relevant only when the -c flag is used and a series is created. A perm of 0 will make the created series accessible only by the current user. A perm of 1 will make the series globally accessible. |
Defines | |
| #define | NOTSPECIFIED "***NOTSPECIFIED***" |
Variables | |
| ModuleArgs_t | module_args [] |
| Global DRMS-module structure representing the default command-line arguments for a DRMS module. | |
| char * | module_name = "store_dir" |
| Global DRMS-module string providing the name of the module. | |
| int | verbose = 0 |
Initial value:
{
{ARG_STRING, "series", "", "Series name to store the dir into"},
{ARG_STRING, "dirname", "", "Dir to store. prime key"},
{ARG_STRING, "sel", "", "selection name. prime key"},
{ARG_STRING, "note", "N/A", "comment field"},
{ARG_INT, "perm", "1", ""},
{ARG_FLAG, "c", "0", "create new series if needed"},
{ARG_FLAG, "v", "0", "verbose flag"},
{ARG_END}
}
module_args, a global array of ModuleArgs_t structures, provides a standard mechanism for declaring the parameters expected to be used by a module along with their types and default values, if any. module_args must be declared in every module. The elements of the module_args array are parsed and compared with arguments supplied to the module from the command line or other invocation to produce a CmdParams_t structure (cmdparams) through which their values are available through the params_get suite of functions.
The module_args declarator requires at least one element, which must be of type ARG_END (which is 0, so an empty initializer as shown in the synopsis is acceptable). Any array elements following the ARG_END element are ignored.
Although the default value (and range, if applicable) is supplied as a character string, it will be interpreted according to the declared type of the argument. Each element of cmdparams, except those of type ARG_VOID, must have a name field. Arguments of type ARG_INT, ARG_FLOAT, ARG_DOUBLE, and ARG_STRING should be self-explanatory. Arguemts of type ARG_FLAG are expected to have single-character names and to be associated with logical binaries, with a default value of FALSE (0); they can be set on the command line via the -X construct (where X is the name of the element to be set to TRUE). ARG_TIME is a special case of ARG_DOUBLE, whose default or assigned values are interpreted by sscan_time (q.v.). ARG_VOID is reserved for use with undeclared arguments supplied on the command line; it should not be used for declared arguments in the module_args list.
The types ARG_INTS, ARG_FLOATS, and ARG_DOUBLES are used for parameters that can be arrays of arbitrary length. The values must be supplied as comma separated sets enclosed within matched delimiting pairs of either brackets [], braces {} or parentheses () (unless there is only one value in the array, in which case the delimiters are optional). The total number of elements in the array is returned as the added parameter name_nvals, and the value for the nth element (counting from 0) as name_n_value. For example, a @ module_args element declared as:
{ARG_FLOATS, "lat", "[0.0, 5.0, 10.0]", "", ""},
would return 3 for params_get_int (params, "lat_nvals") and the value 5.0 for params_get_float (params, "lat_1_value"). The number of array values supplied at run time need not match the number in the default; indeed there is no necessity of setting any default value at all, just as with other types of arguments.
ARG_NUME is a special type of argument representing an enumeration class. It makes use of the module_args->range field, which must be a comma-separated list of strings. The value returned is an integer coresponding to the order number of the range element matching the supplied value. For example, a module_args element declared as:
{ARG_NUME, "color", "green", "", "red, yellow, green, blue"},
would return 2 for params_get_int (params, "color"). A failure occurs if the value supplied does not match anything in the range; the type is designed especially for use with driver programs that can provide menus of options, such as CGI forms.
ARG_DATASET and ARG_DATASERIES are special cases of ARG_STRING reserved for names of DRMS dataset specifications or series names in an environment where the database can be queried for possible values; they are not currently treated differently from any other type of string argument.
ARG_NEWDATA does not appear to be implemented; ARG_NUMARGS is reserved for internal use by the Fortran interface and should not be used.
To summarize, ModuleArgs_t->type must have one of the following values:
| ARG_INT | parameter is to be interpreted as type int |
| ARG_FLOAT | parameter is to be interpreted as type double |
| ARG_DOUBLE | parameter is to be interpreted as type double |
| ARG_TIME | parameter is to be interpreted as type double, with a conversion from standard date-time string formats to a standard reference epoch |
| ARG_STRING | parameter is to be interpreted as type char* |
| ARG_FLAG | the parameter is (ordinarily) a single-character named one which can take the value of 0 or 1. The default value, if present, should be 0; as the command-line flag specifier can only set its parameter values to 1; however, it is better to leave the default value empty, so that the cmdparams_exists function can be used in the code. |
| ARG_NUME | the parameter value is string-compared with the members of the module_args->range list, and replaced with the string representation of the number corresponding to the order number of the (first) matching token in the list; its value is subsequently to be interpreted as type int. Basically equivalent to type enum |
| ARG_INTS | (not yet implemented) |
| ARG_FLOATS | (not yet implemented) |
| ARG_DOUBLE | synonymous with ARG_FLOATS |
| ARG_VOID | (not yet implemented) |
| ARG_END | signals the end of the parsed argument list. Elements may follow in the declaration, but will be ignored. Since ARG_END is defined as 0, an empty (null) member serves the same purpose. |
The module_args->description is intended to be used only by the front-end handler for documentation, such as when the command is invoked with a -H help flag, or in CGI web forms.
Definition at line 121 of file store_dir.c.
1.5.4