Get session settings

Forms the session settings structure for executing the request

Parameters

Function GetSessionSettings(Val SessionID = Undefined, Val CheckSession = Undefined, Val Timeout = 60) Export

Parameter	CLI option	Type	Required	Description
SessionID	--id	String	✖	Session ID. A new unique identifier if not specified (a new session will be created)
CheckSession	--check	Boolean	✖	Check for session existence. True when ID is specified and false when not, unless otherwise specified
Timeout	--timeout	Number	✖	Session lifetime in seconds

Returns

Structure Of KeyAndValue - Session settings structure

Advanced call ?

Parameter	Description
dontwait	Creates a background job and returns its data (for 1C and OneScript only)

1C:Enterprise/OneScript code example

    SessionID = String(New UUID);
    Check     = True;
    Timeout   = 120;

    Result = OPI_ClickHouse.GetSessionSettings(SessionID, Check, Timeout);

Bash

    oint clickhouse GetSessionSettings \
      --id "86064a8b-b646-4f2e-aa31-3b662dd68c43" \
      --check true \
      --timeout 120

CMD/Bat

    oint clickhouse GetSessionSettings ^
      --id "86064a8b-b646-4f2e-aa31-3b662dd68c43" ^
      --check true ^
      --timeout 120

Result

{
 "id": "a1770294-a574-4088-8b1d-b3f9f6f649c3",
 "check": true,
 "timeout": 120
}