Command Usage: sam v8_1_5 sam update file parameters
|  |
Command Description:
Update the datafile Parameters associated with this file by
adding any new parameters, or replacing existing values with new
values.
Example:
# a file named MyParamFile.py:
from SamStruct.Params import Params
newParams = Params({'Global' : {'newKeyword':'newValue',
'existingKeyword':'newValue'},
'Reco' : {'newRecoWord':'newValue'}})
# python interface:
from Sam import sam
sam.updateFileParameters(params=newParams, fileName='here_is_my_file')
# or, define a 'params' object to be used by commandline:
params = newParams
Command line usage with the above example:
$ setup sam
$ sam update file parameters --paramFile=MyParamFile.py --fileName='here_is_my_file'
Usage:
sam update file parameters <--requiredOptions> [--options] [-flags]
sam update file params <--requiredOptions> [--options] [-flags]
sam update params <--requiredOptions> [--options] [-flags]
Where:
--requiredOptions:
--fileName=<value> # name of an existing file to be updated
--options:
--corbaCallTimeout=<value> # time in seconds for CORBA method calls to return before timing out (default: 0; zero implies no timeout)
--paramFile=<value> # name of a file defining a "params" object
--params=<value> # python dictionary of parameters to be updated
--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
Synonymous Options:
--file=<value> # synonym for --fileName=<value>
--name=<value> # synonym for --fileName=<value>
Must specify at least one of:
--params=<value> OR --paramFile=<value>
Mutually Exclusive Options:
--params=<value> OR --paramFile=<value>
Required Data Types:
corbaCallTimeout : int
fileName : string
paramFile : string
params : Params
retryInterval : int
retryJitter : int
retryMaxCount : int
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: