...
options:
--recurse Recurse sub-folders
--search-folders Search for datasets inside folder(s)
--search-groups Search in groups. This option is superseded by the -G (--group) option if they are both supplied.
--group <group name> Dataset Group under which to search for datasets.
--site <site name> Name of Site to search. May be used multiple times to specify a list of sites in which case order is taken as preference. Defaults to the Master-location if not provided.
--filter <filter expression> Criteria by which to filter datasets. ie: 'DatasetDataType=="MERIT" && nMetStart>=257731220 && nMetStop <=257731580'
--display <meta name> Name of meta-data field to display in output. Default is to display only the file location. May be used multiple times to specify an ordered list of fields to display.
--sort <meta name> Name of meta-data field to sort on. May be used multiple times to specify a list of fields to sort on. Order determines precedence.
- -show-unscanned-locations If no "OK" (ie: verified by file crawler) location exists, display first location (if any) which has not yet been scanned. If this option and '--show-non-ok-locations' are both specified, an unscanned location will be returned before a non-ok location regardless of their sequence in the ordered site list.
--show-non-ok-locations If no "OK" (ie: verified by file crawler) location exists, display first location (if any) which exists in the list of sites.
...
Argument | Explanation |
---|---|
<logical folder> | This parameter is required and comes after all options are specified. Replace it with the Data Catalog folder path where you want to begin your search. |
--recurse | If you specify this option, the find command will traverse the entire folder tree under <logical folder> searching for datasets that meet your criteria. |
--search-folders | Tells find to look inside the folder (or folders if --recurse specified) and consider datasets that live there. In general, datasets live in groups, and this option is not used. |
--search-groups | Tells find to look inside all dataset groups in the specified folder (or folder tree if using --recurse) for your files. May be combined with --search-folders and --recurse. |
--group <group name> | Tells find to look inside groups only if they have the name specified by <group name>. May be used with --recurse to search in groups of the given name in a folder tree. |
--site <site name> | Specifies a specific site you want to get datasets from. May be used multiple times to specify a list of sites to search where order indicates preference. |
--filter <filter expression> | Also known as "search criteria" is an expression using logical operators, meta-data fields and constant values on which to filter the output results. See below for details. |
--display <meta name> | Causes the meta-data value associated with 'meta name' to be displayed in the output. May be used multiple times. Columns are tab-separated. |
--sort <meta name> | Specifies the name of the specific meta-data field on which to sort the output results. May be used multiple times to specify a list of fields to sort on where order indicates preference. |
...
. | |
--show-unscanned-locations | If a verified disk location can not be found in the specified site-list, the first location (site-preference order) which has not been scanned yet will be returned. |
--show-non-ok-locations | Similar to --show-unscanned-locations, but will return the first location in the ordered site list that has a disk location regardless of the file scan-status. The file may be missing, 'bad', or otherwise. caveat (Caveat emptor.) If you specify this option in addition to the --show-unscanned-locations option. An unscanned location will be returned before a non-ok location if both exist. |
*Important note: At least one of --search-folders, --search-groups, --group <group name> must be specified.
...