SQL environment properties#

SQL environment properties allow you to globally configure parameters relevant to all SQL queries and the context they are processed in.

All properties described in this page are defined as follows, depending on the deployment type:

  • Kubernetes: In the additionalProperties section of the the top-level coordinator and worker nodes in the values.yaml file.

  • Starburst Admin:: In the files/coordinator/config.properties.j2 and files/worker/config.properties.j2 files.

sql.forced-session-time-zone#

Force the time zone for any query processing to the configured value, and therefore override the time zone of the client. The time zone must be specified as a string such as UTC or other valid values.

sql.default-catalog#

Set the default catalog for all clients. Any default catalog configuration provided by a client overrides this default.

sql.default-schema#

Set the default schema for all clients. Must be set to a schema name that is valid for the default catalog. Any default schema configuration provided by a client overrides this default.

sql.default-function-catalog#

Set the default catalog for SQL routine storage for all clients. The connector used in the catalog must support Routine management. Any usage of a fully qualified name for a routine overrides this default.

The default catalog and schema for SQL routine storage must be configured together, and the resulting entry must be set as part of the path. For example, the following example section for Config properties uses the functions schema in the brain catalog for routine storage, and adds it as the only entry on the path:

sql.default-function-catalog=brain
sql.default-function-schema=default
sql.path=brain.default

sql.default-function-schema#

Set the default schema for SQL routine storage for all clients. Must be set to a schema name that is valid for the default function catalog. Any usage of a fully qualified name for a routine overrides this default.

sql.path#

Define the default collection of paths to functions or table functions in specific catalogs and schemas. Paths are specified as catalog_name.schema_name. Multiple paths must be separated by commas. Find more details about the path in SET PATH.