Command Usage: samadmin v8_1_5 samadmin add data type
|  |
Command Description:
Register a new DataType in the SAM db.
At the command line, the only format for entering dataTypes is
by entering a string defining the MODULE and CLASS of a python
data structure that can be imported by the SAM DbServer,
in the format 'MODULE.CLASS'
Command line example:
$ samadmin add data type --dataType='SamStruct.SamSize.SamSize'
where the module is 'SamStruct.SamSize' and the class is 'SamSize'.
The module and class must have a python implementation that is
available (i.e., in the $PYTHONPATH) of the SAM dbserver.
When using the API, there are additional means of specifying
the dataType:
a) a python class object:
from SamStruct.SamTime import SamTime
samAdmin.addDataType(dataType=SamTime)
c) an instance of a python class:
from SamStruct.SamTime import SamTime
t1 = SamTime("NOW")
samAdmin.addDataType(dataType=t1)
a) an object defined in the SAM IDL:
import SAM
samAdmin.addDataType(dataType=SAM.SamTimeStruct)
In this case, the higher-level python wrapper class object
will be added to the database.
Usage:
samadmin add data type <--requiredOptions> [--options] [-flags]
Where:
--requiredOptions:
--dataType=<value> # the new data type to be registered
--options:
--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)
-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
Required Data Types:
connect : string
corbaCallTimeout : int
dataType : DataType
retryInterval : int
retryJitter : int
retryMaxCount : int
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: