Python API: sam v8_1_5 sam.updateDatasetDefinition()
|  |
This is the python interface to the command 'sam update dataset definition'.
Command Description:
Modify an existing dataset definition.
If the definition has been used to take snapshots, then
the only thing that may be modified is to add new keywords
to the definition:
sam update dataset definition --addKeywords=newKeyword1,newKeyword2
If the definition has not yet been used to take any snapshots, then
any field can be modified:
# change the dimensions of an existing definition:
sam update dataset definition --defName=myOldDef \
--dims="new dimension string here"
# change the group and keywords of an existing definition:
sam update dataset definition --defName=myOldDef \
--group=newGroup \
--keywords=key1,key2,key3
Python Usage:
from Sam import sam
result = sam.updateDatasetDefinition(...)
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
------------------------------------------------------------------------------------------------------------------------------------
addKeywords SamStringList comma-separated list of keywords to be added to existing keywords for this definition
c SamBoolean automatically close all servants after each method call
corbaCallTimeout int time in seconds for CORBA method calls to return before timing out (default: 0; zero implies no timeout)
d SamBoolean debug mode
definitionId long DB-assigned ID number of an existing definition to be modified
definitionName string name of an existing definition to be modified
description string new description to be associated with this definition
dimensions string new dimensions to be assigned to this definition
group string new work group to be assigned to this definition
keywords SamStringList comma-separated list of keywords to be associated with this definition
newDefinitionName string new name to be assigned to this definition
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)
userName string new user to be assigned to this definition
v SamBoolean verbose mode
====================================================================================================================================
Must have at least one of:
(definitionName, definitionId)
Mutually exclusive keywords:
(definitionName || definitionId)
Environment Defaults:
c = os.environ['SAM_PYAPI_AUTO_CLOSE_SERVANTS']
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: