record_set is a database query that allows the user to select a subset of records of a series. In particular, the user can supply values for the sel and note keywords in record_set to search for files saved with store_dir. retrieve_dir retrieves the set of records specified, and for each record uses the value contained within the dirname_keyword keyword (defaults to "dirname") to identify the subdirectory within the record's SUMS directory (i.e., it is all of the string after the last '/' in this value) that contains the record's files. It then copies (or links, if the -l flag is present) all files from this subdirectory to a identically named subdirectory of the directory specified by dest. retrieve_dir will overwrite any files existing in the destination subdirectory whose name matches the name of a file to be copied from a SUMS subdirectory.
If the link flag, -l, is specified, then retrieve_dir will create a link to the SUMS subdirectory instead of copying from the SUMS subdirectory to the destination subdirectory. Over time this link may become broken as SUMS may remove a stored file if it is present in SUMS longer than its specified retention time.
retrieve_dir [-lDRIVER_FLAGS] series=<record_set> to=<dest> [dirkey=<dirname_keyword>]
Example: to retrieve a directory of files:
retrieve_dir series=su_arta.TestStoreDir to=/home/arta/restoredFilesJanuary/ dirkey=dirname
-l: Create a symbolic link to the SUMS directory containing the file(s) of interest.| record_set | A series name followed by an optional record set filter (i.e., name[filter]). Causes selection of a subset of records in the series. Each record retrieved with this record_set query will refer to one directory that will be copied to dest. | |
| dest | The destination directory to which the SUMS subdirectory should be copied/linked. Do not append a final '/' to the path (i.e., /home/arta/dir1 is acceptable, but /home/arta/dir1/ is not) | |
| dirname_keyword | Name of the keyword containing the path of the directory originally stored with store_dir. |
Variables | |
| ModuleArgs_t | module_args [] |
| Global DRMS-module structure representing the default command-line arguments for a DRMS module. | |
| char * | module_name = "retrieve_dir" |
| Global DRMS-module string providing the name of the module. | |
| int | verbose = 0 |
Initial value:
{
{ARG_STRING, "series", "", "Series name to retrieve from"},
{ARG_STRING, "to", "", "Target dir to cp to"},
{ARG_STRING, "dirkey", "dirname", "Keyword containing the dir name"},
{ARG_FLAG, "l", "0", "Link instead to the retrieved dir in the SUMS storage"},
{ARG_END, NULL, NULL}
}
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 100 of file retrieve_dir.c.
1.5.4