SESSION_CONTEXT (Transact-SQL)

THIS TOPIC APPLIES TO: yesSQL Server (starting with 2016)yesAzure SQL DatabasenoAzure SQL Data Warehouse noParallel Data Warehouse

Returns the value of the specified key in the current session context. The value is set by using the sp_set_session_context (Transact-SQL) procedure.

Topic link icon Transact-SQL Syntax Conventions

Syntax

SESSION_CONTEXT(N'key')  

Arguments

'key'
The key (type sysname) of the value being retrieved.

Return Type

sql_variant

Return Value

The value associated with the specified key in the session context, or NULL if no value has been set for that key.

Permissions

Any user can read the session context for their session.

Remarks

SESSION_CONTEXT’s MARS behavior is similar to that of CONTEXT_INFO. If a MARS batch sets a key-value pair, the new value will not be returned in other MARS batches on the same connection unless they started after the batch that set the new value completed. If multiple MARS batches are active on a connection, values cannot be set as “read_only.” This prevents race conditions and non-determinism about which value “wins.”

Examples

The following simple example sets the session context value for key user_id to 4, and then uses the SESSION_CONTEXT function to retrieve the value.

EXEC sp_set_session_context 'user_id', 4;  
SELECT SESSION_CONTEXT(N'user_id');  

See Also

sp_set_session_context (Transact-SQL)
CURRENT_TRANSACTION_ID (Transact-SQL)
Row-Level Security
CONTEXT_INFO (Transact-SQL)
SET CONTEXT_INFO (Transact-SQL)