Click here to sign up to SurrealDB Cloud
Back to top
Documentation SurrealQL Functions Session functions

Session functions

These functions can be used when working with and manipulating text and string values.
Function Description
session::db() Returns the currently selected database
session::id() Returns the current user's session ID
session::ip() Returns the current user's session IP address
session::ns() Returns the currently selected namespace
session::origin() Returns the current user's HTTP origin
session::sc() Returns the current user's authentication scope

session::db

The session::db function returns the currently selected database.

session::db() -> string

The following example shows this function, and its output, when used in a RETURN statement:

RETURN session::db();
"my_db"

session::id

The session::id function returns the current user's session ID.

session::id() -> string

The following example shows this function, and its output, when used in a RETURN statement:

RETURN session::id();
"I895rKuixHwCNIduyBIYH2M0Pga7oUmWnng5exEE4a7EB942GVElGrnRhE5scF5d"

session::ip

The session::ip function returns the current user's session IP address.

session::ip() -> string

The following example shows this function, and its output, when used in a RETURN statement:

RETURN session::ip();
"2001:db8:3333:4444:CCCC:DDDD:EEEE:FFFF"

session::ns

The session::ns function returns the currently selected namespace.

session::ns() -> string

The following example shows this function, and its output, when used in a RETURN statement:

RETURN session::ns();
"my_ns"

session::origin

The session::origin function returns the current user's HTTP origin.

session::origin() -> string

The following example shows this function, and its output, when used in a RETURN statement:

RETURN session::origin();
"http://localhost:3000"

session::sc

The session::sc function returns the current user's authentication scope.

session::sc() -> string

The following example shows this function, and its output, when used in a RETURN statement:

RETURN session::sc();
"user"