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.
.let()
Assigns a value as a parameter for this connection.
Method Syntaxasync db.let(key, val)
Arguments
| Arguments | Description | ||
|---|---|---|---|
key | Specifies the name of the variable. | ||
val | Assigns the value to the variable name. |
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 Syntaxasync db.unset(key)
Arguments
| Arguments | Description | ||
|---|---|---|---|
key | Specifies the name of the variable. |
Example usage
// Remove the variable from the connection
await db.unset('name');