show_keys - Examine a dataseries structure or contents

Deprecated -- Prints keyword information and/or file path for given recordset.

Use show_info - Examine a dataseries structure or contents instead of show_keys. Show_keys is no longer maintained. The functionality of show_keys is now a subset of show_info.

Show_keys can list the keyword names and values, and the segment names and file names (full paths) for each record in a record set. It can also list the full path to the record direcory in SUMS, which contains the segment files. Exactly what information gets printed is controlled by command-line flags (see below). The -k flag controls the format of the output. If it is set, then the output is in table format, with a header row showing the keyword names. Otherwise, keyword name=value pairs are listed one per line. If the -a flag is set, show_keys - Examine a dataseries structure or contents lists the names of all series keywords, prime keywords, and segments, and exits. Otherwise, it prints keyword and segment information as specified by the other flags and arguments. If the -p flag is set and seglist is specified, then the full paths for the segment files will be displayed. If the -p flag is set, but seglist is not specified, then only the full path to the record's storage unit will be displayed.

The number of records for which information will be printed must be specified, either by supplying a record_set string that selects a subset of records from a series, or by supplying the n=nrecords argument, which indicates the number of records.

Synopsis:
show_keys [-aklpqrDRIVER_FLAGS] ds=<record_set> [n=<nrecords>] [key=<keylist>] [seg=<seglist>]

Example: To show the storage-unit paths for a maximum of 10 records:

  show_keys -p ds=su_arta.TestStoreFile n=10

Example: To show information, in non-table format, for all keywords, plus the segment named file_seg, for a maximum of 10 records:

  show_keys ds=su_arta.TestStoreFile -akr n=10 seg=file_seg

Flags:
-a: Show all keyword names and values for each record specified by record_set or nrecords. -a takes precedence over keylist.
-k: List keyword name=value pairs, one per line. Otherwise print all keyword values on a single line and print a header line containing the keyword names (table format).
-l: List the names of all series keywords, prime keywords, and segments, and exit. Otherwise, print keyword and segment information as specified by the other flags and arguments.
-p: Include in the output the full storage-unit path for each record
-q: Quiet - omit the header line listing keyword names if the -k flag is set
-r: Include in the output the record number keyword
Driver flags:
DRMS common main program
Parameters:
record_set A series name followed by an optional record-set specification (i.e., seriesname[RecordSet_filter]). Causes selection of a subset of records in the series. This argument is required, and if no record-set filter is specified, then n=nrecords must be present.
nrecords nrecords specifies the maximum number of records for which information is printed. If nrecords < 0, show_keys - Examine a dataseries structure or contents displays information for the last nrecords records in the record set. If nrecords > 0, show_keys - Examine a dataseries structure or contents displays information for the first nrecords records in the record set. If record_set contains a record set filter, then nrecords can reduce the total number of records for which information is displayed.
keylist Comma-separated list of keyword names. For each keyword listed, information will be displayed. keylist is ignored in the case that the -a flag is set.
seglist Comma-separated list of segment names. For each segment listed, the full path to the segment's file is displayed (if the -p flag is set) or the file name of the segment's file name is displayed (if the -p flag is unset).
Bug:
Deprecated in favor of show_info
See also:
retrieve_file - retrieve a file from SUMS drms_query - for each record specified, print the psql 'recnum' value, and optionally the record-directory path describe_series - print summary information about a series

Generated on Wed Sep 20 07:00:34 2017 for JSOC_Documentation by  doxygen 1.5.7.1