store_dir - store a directory of files to SUMS
[DRMS Utilities]

Store arbitrary directory of files to SUMS. More...

Collaboration diagram for store_dir - store a directory of files to SUMS:
Synopsis:
store_dir [-cvGEN_FLAGS] series=<series_name> dirname=<prefix>/<subdir> sel=<sel_text> [note=<note_text>] 

Files stored with store_dir - store a directory of files to SUMS can be easily retrieved by the retrieve_dir - retrieve a directory from SUMS utility.

If the series series_name does not exist, store_dir - store a directory of files to SUMS will first create that series, provided that the user supplies the -c flag. store_dir - store a directory of files to SUMS 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 - store a directory of files to SUMS 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 - retrieve a directory from SUMS 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 - store a directory of files to SUMS with the same value for prefix/subdir. series_name must contain prime keywords dirname and sel, and it should contain the keyword note.

If a keyword named DATE is present, the current date will be stored as a standard DRMS time. The template for automatic series generation includes DATE as a time keyword. NOTE that DATE is not included as a prime key so the records must still be distinguised by sel and dirname

Flags:
-c: Silently create the series series_name if it does not exist.
-v: Run in verbose mode.
GEN_FLAGS
Ubiquitous flags present in every module. DRMS common main program
Parameters:
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.
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"

Generated on Sat Mar 25 07:00:34 2017 for JSOC_Documentation by  doxygen 1.5.7.1