Command Usage: sam v8_1_5 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
Usage:
sam update dataset definition [--options] [-flags]
sam update definition [--options] [-flags]
Where:
--options:
--addKeywords=<value> # comma-separated list of keywords to be added to existing keywords for this definition
--corbaCallTimeout=<value> # time in seconds for CORBA method calls to return before timing out (default: 0; zero implies no timeout)
--definitionId=<value> # DB-assigned ID number of an existing definition to be modified
--definitionName=<value> # name of an existing definition to be modified
--description=<value> # new description to be associated with this definition
--dimensions=<value> # new dimensions to be assigned to this definition
--group=<value> # new work group to be assigned to this definition
--keywords=<value> # comma-separated list of keywords to be associated with this definition
--newDefinitionName=<value> # new name to be assigned to this definition
--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)
--userName=<value> # new user to be assigned to this definition
-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
Synonymous Options:
--defId=<value> # synonym for --definitionId=<value>
--defName=<value> # synonym for --definitionName=<value>
--defdesc=<value> # synonym for --description=<value>
--desc=<value> # synonym for --description=<value>
--dim=<value> # synonym for --dimensions=<value>
--dimension=<value> # synonym for --dimensions=<value>
--dims=<value> # synonym for --dimensions=<value>
--newDefName=<value> # synonym for --newDefinitionName=<value>
--newName=<value> # synonym for --newDefinitionName=<value>
Must specify at least one of:
--definitionName=<value> OR --definitionId=<value>
Mutually Exclusive Options:
--definitionName=<value> OR --definitionId=<value>
Required Data Types:
addKeywords : SamStringList
corbaCallTimeout : int
definitionId : long
definitionName : string
description : string
dimensions : string
group : string
keywords : SamStringList
newDefinitionName : string
retryInterval : int
retryJitter : int
retryMaxCount : int
userName : 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: