Non-Sync Variables

Non-sync variables are set to take effect on individual nodes. They have one the following four states:

  • Settable to take effect when a node starts

  • Settable to take effect while a node is running

  • Settable to take effect both when a node starts and while the node is running

  • Read-only (not settable)

Most non-sync variables are settable to take effect both when a node starts and while the node is running. Exceptions are indicated in the Exceptions to When Variable can be Set column in the list of non-sync variables.

Non-Sync Variable Scopes

Every non-sync variable has one of the following scopes.

  • Global. When you set a global variable, its value is effective for your current connection to the node and any other existing or subsequent connections, initiated by any user.

  • Session that can also be set globally. When set for the session, the variable’s value is effective for your current connection to the node. When set globally, this variable’s value is NOT effective for your current connection to the node but is effective for any other existing or subsequent connections to the node, initiated by any user.

Important

SingleStore recommends using a global setting for session variables whose values must be propagated to leaf nodes from the aggregator nodes on which the variable is set.

For session variables that are only referenced by the aggregator nodes, the SET SESSION statement can be used instead.

Most non-sync variables have global scope. Those that instead have the scope session that can also be set globally are indicated in the Description column in the list of non-sync variables.

Note: Use the @@ selector to read the value of a variable. See Reading Variables for more information.

Setting Non-Sync Variables

Non-sync variables with global or session scope can be set globally in the following ways.

  • SET GLOBAL sets a non-sync variable globally and the variable’s value will not persist if the node is restarted.

Caution

When you add new nodes to a workspace, non-sync variables that you set previously are not automatically applied to the new nodes.

Last modified: March 21, 2024

Was this article helpful?