Set parameters

Within your application, you can define parameters that can be used to store and retrieve data from SurrealDB. Parameters are used to store data in a structured format, and can be used to store data in a key-value pair format.

Important

Parameters allow you to define global (database-wide) parameters that are available to every client.

.let()

Assigns a value as a parameter for this connection.

Method Syntax
async db.let(key, val)

Arguments

Example Usage

// Assign the variable on the connection
await db.let('name', {
	first: 'Tobie',
	last: 'Morgan Hitchcock',
});

// Use the variable in a subsequent query
await db.query('CREATE person SET name = $name');

// Use the variable in a subsequent query
await db.query('SELECT * FROM person WHERE name.first = $name.first');

.unset()

Removes a parameter for this connection.

Method Syntax
async db.unset(key)

Arguments

Example usage

// Remove the variable from the connection
await db.unset('name');