sessionProp

getSessOpt

Description

Displays the value of a session option. This action is part of the Session Properties Action Set and is used to retrieve the current setting of various session-specific options.

sessionProp.getSessOpt <result=results> <status=rc> \/ name="APPTAG" | "AZURETENANTID" | "BIGINTPROCESSING" | "CASLIB" | "CMPLIB" | "CMPOPT" | "COLLATE" | "DATASTEPFMTERR" | "DATASTEPMERGENOBY" | "DATASTEPMSGSUMLEVEL" | "DATASTEPREPLACETABLE" | "DATASTEPVARLENCHK" | "DATESTYLE" | "DEBUGOPT" | "DEFAULTMEMORYFORMAT" | "DEFAULTTABLEREPLICATION" | "DQLOCALE" | "DQQKBREPOLOC" | "DQSETUPLOC" | "EVENTDS" | "HISTORYLINELENGTH" | "INTERVALDS" | "LOCALE" | "LOGFLUSHTIME" | "MAXTABLEMEM" | "MAXCORESPERWORKER" | "MESSAGELEVEL" | "METRICS" | "NWORKERS" | "NLDECSEPARATOR" | "S2FORMATSEARCH" | "SUBSETSESSIONCOPIES" | "TIMEZONE" | "TIMEOUT" | "TRANSFERSESSION" | "USEGPU" | "YEARCUTOFF";
Settings
ParameterDescription
nameSpecifies the name of a session option to display. This is a required parameter. The possible values are listed below, each with its specific description.
APPTAGDisplays the string that is included in the JSON log line of some CAS log messages on the CAS server.
AZURETENANTIDDisplays the tenant ID for Azure storage.
BIGINTPROCESSINGDisplays the status of integer processing in the session as 1 (enabled) or 0 (disabled). Alias: BIGINT
CASLIBDisplays the name of the active caslib.
CMPLIBDisplays the cmplib setting.
CMPOPTDisplays the code generation optimizations.
COLLATEDisplays the collating sequence for sorting.
DATASTEPFMTERRDisplays whether a DATA step generates an error when a variable format cannot be found. Alias: FMTERR
DATASTEPMERGENOBYDisplays whether no warning, a warning, or an error message is generated when a DATA step merge is run with no BY statement.
DATASTEPMSGSUMLEVELDisplays the DATA step message summary level. When the DATA step runs on multiple threads, the same message can be generated on each thread. This parameter controls the summary level of duplicate messages.
DATASTEPREPLACETABLEDisplays whether a DATA step can replace an existing table.
DATASTEPVARLENCHKDisplays whether no warning, a warning, or an error message is generated when using APPEND and the source has longer strings than the destination.
DATESTYLEDisplays the date style setting.
DEBUGOPTDisplays the debugger options.
DEFAULTMEMORYFORMATDisplays the default memory format for session tables.
DEFAULTTABLEREPLICATIONDisplays the default new table replication factor. Alias: DEFAULTREP
DQLOCALEDisplays the default locale to use for data quality operations.
DQQKBREPOLOCDisplays the name of the caslib where QKBs are stored.
DQSETUPLOCDisplays the name of the default QKB to use for data quality operations.
EVENTDSDisplays event objects that define custom date events.
HISTORYLINELENGTHDisplays the maximum history line length.
INTERVALDSDisplays interval object pairs.
LOCALEDisplays the locale used for sorting and formatting.
LOGFLUSHTIMEDisplays the log flush time.
MAXTABLEMEMDisplays the maximum table memory setting.
MAXCORESPERWORKERDisplays the maximum cores per worker.
MESSAGELEVELDisplays the log message level.
METRICSDisplays the action metric setting.
NWORKERSDisplays the number of worker nodes associated with this session.
NLDECSEPARATORDisplays the nldecseparator setting.
S2FORMATSEARCHDisplays the search path for user-defined format libraries that have been published to SingleStore for use by the EP.
SUBSETSESSIONCOPIESDisplays the number of backup copies of blocks for in-memory tables to create in subset sessions.
TIMEZONEDisplays the user local time zone. Refer to 'Time Zone Information and Time Zone Names' in the SAS System Options: Reference for more information about time zones.
TIMEOUTDisplays the session time-out.
TRANSFERSESSIONDisplays whether this session is included when transferring state to a new server.
USEGPUDisplays whether work is offloaded to GPU.
YEARCUTOFFDisplays the year cutoff.

Examples

This example shows how to retrieve the value of a session option. The specific example code is available in the linked documentation.

SAS® / CAS Code Code awaiting community validation
Copied!
1// Code not provided in the HTML snippet.
Result :
The value of the specified session option.

FAQ

What is the getSessOpt action?
What does the APPTAG parameter display?
What does the AZURETENANTID parameter display?
What does the BIGINTPROCESSING parameter display?
What does the CASLIB parameter display?
What does the CMPLIB parameter display?
What does the CMPOPT parameter display?
What does the COLLATE parameter display?
What does the DATASTEPFMTERR parameter display?
What does the DATASTEPMERGENOBY parameter display?
What does the DATASTEPMSGSUMLEVEL parameter display?
What does the DATASTEPREPLACETABLE parameter display?
What does the DATASTEPVARLENCHK parameter display?
What does the DATESTYLE parameter display?
What does the DEBUGOPT parameter display?
What does the DEFAULTMEMORYFORMAT parameter display?
What does the DEFAULTTABLEREPLICATION parameter display?
What does the DQLOCALE parameter display?
What does the DQQKBREPOLOC parameter display?
What does the DQSETUPLOC parameter display?
What does the EVENTDS parameter display?
What does the FMTERR parameter display?
What does the HISTORYLINELENGTH parameter display?
What does the INTERVALDS parameter display?
What does the LOCALE parameter display?
What does the LOGFLUSHTIME parameter display?
What does the MAXTABLEMEM parameter display?
What does the MAXCORESPERWORKER parameter display?
What does the MESSAGELEVEL parameter display?
What does the METRICS parameter display?
What does the NWORKERS parameter display?
What does the NLDECSEPARATOR parameter display?
What does the S2FORMATSEARCH parameter display?
What does the SUBSETSESSIONCOPIES parameter display?
What does the TIMEZONE parameter display?
What does the TIMEOUT parameter display?
What does the TRANSFERSESSION parameter display?
What does the USEGPU parameter display?
What does the YEARCUTOFF parameter display?