retrieve_dir [-lGEN_FLAGS] series=<record_set> to=<dest> [dirkey=<dirname_keyword>]
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 - store a directory of files to SUMS. retrieve_dir - retrieve a directory from SUMS 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 - retrieve a directory from SUMS 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 - retrieve a directory from SUMS 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.
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 - store a directory of files to SUMS. |