Crate surrealdb_core

Surrealdb Core

This crate is the internal core library of SurrealDB. It contains most of the database functionality on top of which the surreal binary is implemented.

Unstable!

This crate is SurrealDB internal API. It does not adhere to semver and it's API is free to change and break code even between patch versions. If you are looking for a stable interface to the Surrealdb library please have a look at the rust SDK

Modules

channel

Channels for receiving a SurrealQL database export

cnf

ctx

This module defines and handles the context for the SurrealDB database.

dbs

Datastore module which is the core of the database node. In this module we essentially manage the entire lifecycle of a database request acting as the glue between the API and the response. In this module we use channels as a transport layer and executors to process the operations. This module also gives a context to the transaction.

env

err

fflags

Feature flags for SurrealDB This is a public scope module that is not for external use It is public for API access

iam

idg

idx

key

How the keys are structured in the key value store

kvs

The module defining the key value store. Everything related the transaction for the key value store is defined in the tx.rs file. This module enables the following operations on the key value store:

mem

options

rpc

sql

The full type definitions for the SurrealQL query language

syn

Module containing the implementation of the surrealql tokens, lexer, and parser.

sys

vs

vs is a module to handle Versionstamps. This module is supplemental to the kvs::tx module and is not intended to be used directly by applications. This module might be migrated into the kvs or kvs::tx module in the future.

Macros

lazy_env_parse

A macro that allows lazily parsing a value from the environment variable, with a fallback default value if the variable is not set or parsing fails.

lazy_env_parse_or_else

Lazily parses an environment variable into a specified type. If the environment variable is not set or the parsing fails, it returns a default value.