Python API: sam v8_1_5 sam.dbQuery()
|  |
This is the python interface to the command 'sam db query'.
Command Description:
Execute an arbitrary SQL query against the SAM database,
without requiring installation of ORACLE_CLIENT, etc.
Uses the DbDerivedClient package (from SamUtility) to
pass the query along to the dbserver, where it will be
invoked.
Example:
$ sam db query "select distinct station_name from stations where station_id > 10"
Python Usage:
from Sam import sam
result = sam.dbQuery(...)
Return value: SamStruct.SamListOfRows.SamListOfRows
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
------------------------------------------------------------------------------------------------------------------------------------
(*) args SamBoolean SQL query to be invoked (enclose within quotation marks)
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
format (restricted value) return format, either a python dictionary or a list (default = list)
noQuerySmart SamBoolean turn off the query-smart flag
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)
v SamBoolean verbose mode
====================================================================================================================================
Restricted values:
format: must be in (dict, list)
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: