envs

SurrealDB — CLI and connections

surrealdb/server · version 1

envs add surrealdb/server

This declares the keys below in your catalog and sets none of them. A template is a schema for keys; it never carries a value.

Key Needed Kind Notes
SURREAL_USER optional secret Half of the login. SurrealDB publishes a full table of these names, which is rarer than it should be.. where to get it
SURREAL_PASS optional secret The other half.. where to get it
SURREAL_TOKEN optional secret A JWT used instead of the pair. SurrealDB says to treat it as a credential because it grants whatever the authenticating user does, and to keep it out of shell history and committed scripts.. where to get it
SURREAL_NAMESPACE optional config Which namespace to select. A name.. where to get it
SURREAL_DATABASE optional config Which database within it. A name.. where to get it
SURREAL_AUTH_LEVEL optional config Root, namespace or database. SurrealDB keeps control-plane credentials under a separate SURREALCTL_ prefix, so a database token cannot be sent to the cloud API by accident.. where to get it

The JSON the CLI reads