Command Usage: sam v8_1_5 sam declare file
|  |
Command Description:
This command "declares" the metadata for a file to SAM,
but the file itself is not stored (only the metadata is stored).
You provide the metadata, and SAM uses the metadata to declare a "virtual"
file (i.e., a file with no physical locations).
The --source option is provided for backwards compatibility,
but does NOT need to be used; you may specify the full path to the
metadata description file as part of the argument. In other words, the following
two commands are equivalent:
sam declare /full/path/to/myMetadata.py
sam declare --sourceDir=/full/path/to myMetadata.py
The metadata description file must contain one SamDataFile object which
describes the metadata to be entered into the database:
# myMetadata.py:
from SamFile.SamDataFile import SamDataFile
myMetadata = SamDataFile(fileName='raw_physics_file_name_here',
fileType='importedCollider',
...)
For additional information about file metadata, see the output
from the commands:
sam get registered filetypes
sam describe metadata requirements --filetype=<fileTypeHere>
sam describe metadata attributes
Usage:
sam declare file [--options] [-flags] <arg1>
sam declare metadata [--options] [-flags] <arg1>
Where:
--options:
--corbaCallTimeout=<value> # time in seconds for CORBA method calls to return before timing out (default: 0; zero implies no timeout)
--retryInterval=<value> # retry interval base in seconds; will multiply this base times retryCount (default: 5)
--retryJitter=<value> # retry jitter, random jitter added to base retry interval times retryCount (default: 5)
--retryMaxCount=<value> # number of times to retry CORBA calls for retriable exceptions (default: 25; zero implies no retries)
--sourceDir=<value> # directory containing the metadata description file
-flags:
-c # automatically close all servants after each method call
-d # debug mode
-s # retrySilently mode (do not issue messages to stderr on proxy retries)
-t # time-it mode (print additional info on timings)
-v # verbose mode
Args:
<arg1> # name of the python file containing the metadata for the file to be declared
Synonymous Options:
--source=<value> # synonym for --sourceDir=<value>
Required Data Types:
corbaCallTimeout : int
retryInterval : int
retryJitter : int
retryMaxCount : int
sourceDir : string
You may omit "-c" if the $SAM_PYAPI_AUTO_CLOSE_SERVANTS environmental variable is set.
You may omit "--corbaCallTimeout=<value>" if the $SAM_PYAPI_CORBA_CALL_TIMEOUT environmental variable is set.
You may omit "--retryInterval=<value>" if the $SAM_PYAPI_RETRY_INTERVAL environmental variable is set.
You may omit "--retryJitter=<value>" if the $SAM_PYAPI_RETRY_JITTER environmental variable is set.
You may omit "--retryMaxCount=<value>" if the $SAM_PYAPI_RETRY_MAX_COUNT environmental variable is set.
You may omit "-s" if the $SAM_PYAPI_RETRY_SILENTLY environmental variable is set.
UNIX ExitStatus:
Success : 0
Unhandled exceptions : 127
See Also: