Command Usage: samadmin v8_1_5 samadmin add dimension
|  |
Command Description:
Add a new dimension to the SAM db.
A dimension name of the form X.Y is assumed to be a PARAMETER-type
dimension, where X corresponds to the paramCategory and Y corresponds
to the paramType. In this case, you do not need to specify any
table names or column names; the code knows "what to do". For
example, to add a dimension that would allow you to query based
on the paramCategory/paramType combination of 'global' and 'requestId',
you would enter
sam add dimension --name=global.requestId \
--desc="Request ID associated with the job that produced this file"
(Note, however, that as of sam_admin_pyapi v6_7_0_1, the
associated dimension is automatically added to the db whenever a new
paramCategory/paramType is added, so you probably do not ever need
manually enter any param-type dimensions).
For dimensions that correspond to a join with a particular table
and column, you must specify the table name and column name. For
example, to add a dimension that would allow you to query based on
the CRC value of a file, you would enter
sam add dimension --name=crc_value \
--table=data_files --column=crc_value \
--type=string \
--desc="CRC value of the file"
Usage:
samadmin add dimension <--requiredOptions> [--options] [-flags]
Where:
--requiredOptions:
--desc=<value> # description used in dataset query help
--name=<value> # dimension name for use in dataset queries
--options:
--alias=<value> # alternate table name to use, in case this table is used more than once in the query. DEFAULT is table name
--column=<value> # non-parameter dimensions: column name for this dimension
--connect=<value> # oracle username/password for connecting to this database
--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)
--table=<value> # non-parameter dimensions: table which contains the column for this dimension
--type=<value> # non-parameter dimensions: datatype of this column
-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
Restricted Values:
type: must be date OR set OR number OR string OR datetime
Required Data Types:
alias : string
column : string
connect : string
corbaCallTimeout : int
desc : string
name : string
retryInterval : int
retryJitter : int
retryMaxCount : int
table : string
You may omit "-c" if the $SAM_PYAPI_AUTO_CLOSE_SERVANTS environmental variable is set.
You may omit "--connect=<value>" if the $SAM_ORACLE_CONNECT 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: