Python API: samAdmin v8_1_5
samAdmin.addDimension()

Just having some fun...
This is the python interface to the command '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"


Python Usage:
	from SamAdmin import samAdmin
	result = samAdmin.addDimension(...)

Return value: 

Arguments are passed as keyword-value pairs, as in:
	 myfunc(arg1='myarg', arg2='anotherarg', d=1)

Argument Keyword Description:
	(*) indicates that this keyword is required
	>>> indicates that either the API object or the CLI equivalent (<<<) is required
====================================================================================================================================
    KEYWORD                    DATA TYPE            DESCRIPTION
------------------------------------------------------------------------------------------------------------------------------------
    alias                      string               alternate table name to use, in case this table is used more than once in the query. DEFAULT is table name
    c                          SamBoolean           automatically close all servants after each method call
    column                     string               non-parameter dimensions: column name for this dimension
    connect                    string               oracle username/password for connecting to this database
    corbaCallTimeout           int                  time in seconds for CORBA method calls to return before timing out (default: 0; zero implies no timeout)
    d                          SamBoolean           debug mode
(*) desc                       string               description used in dataset query help
(*) name                       string               dimension name for use in dataset queries
    retryInterval              int                  retry interval base in seconds; will multiply this base times retryCount (default: 5)
    retryJitter                int                  retry jitter, random jitter added to base retry interval times retryCount (default: 5)
    retryMaxCount              int                  number of times to retry CORBA calls for retriable exceptions (default: 25; zero implies no retries)
    s                          SamBoolean           retrySilently mode (do not issue messages to stderr on proxy retries)
    t                          SamBoolean           time-it mode (print additional info on timings)
    table                      string               non-parameter dimensions: table which contains the column for this dimension
    type                       (restricted value)   non-parameter dimensions: datatype of this column
    v                          SamBoolean           verbose mode
====================================================================================================================================

Restricted values:
	type: must be in (date, set, number, string, datetime)

Environment Defaults:
	c = os.environ['SAM_PYAPI_AUTO_CLOSE_SERVANTS']
	connect = os.environ['SAM_ORACLE_CONNECT']
	corbaCallTimeout = os.environ['SAM_PYAPI_CORBA_CALL_TIMEOUT']
	retryInterval = os.environ['SAM_PYAPI_RETRY_INTERVAL']
	retryJitter = os.environ['SAM_PYAPI_RETRY_JITTER']
	retryMaxCount = os.environ['SAM_PYAPI_RETRY_MAX_COUNT']
	s = os.environ['SAM_PYAPI_RETRY_SILENTLY']



See Also: