Struct StartOptions 

pub struct StartOptions {
    pub datastore: Option<String>,
    pub datastore_uri: Option<String>,
    pub spanner_credentials_file: Option<String>,
    pub spanner_emulator_host: Option<String>,
    pub mysql_table_prefix: Option<String>,
    pub metrics_enabled: Option<bool>,
    pub datastore_metrics_enabled: Option<bool>,
    pub cache_metrics_enabled: Option<bool>,
    pub otlp_endpoint: Option<String>,
    pub metrics_port: Option<u16>,
    pub metrics_host: Option<String>,
}

Options for starting an embedded SpiceDB instance.

Fields

datastore: Option<String>

Datastore: “memory” (default), “postgres”, “cockroachdb”, “spanner”, “mysql”

datastore_uri: Option<String>

Connection string for remote datastores. Required for postgres, cockroachdb, spanner, mysql.

spanner_credentials_file: Option<String>

Path to Spanner service account JSON (Spanner only)

spanner_emulator_host: Option<String>

Spanner emulator host, e.g. “localhost:9010” (Spanner only)

mysql_table_prefix: Option<String>

Prefix for all tables (MySQL only)

metrics_enabled: Option<bool>

Primary switch for all metrics and tracing (default: false). When false, all other observability options are ignored.

datastore_metrics_enabled: Option<bool>

Enable datastore Prometheus metrics (default: true when metrics_enabled=true). Only takes effect when metrics_enabled=true.

cache_metrics_enabled: Option<bool>

Enable cache Prometheus metrics for dispatch/namespace/cluster caches (default: true when metrics_enabled=true). Only takes effect when metrics_enabled=true.

otlp_endpoint: Option<String>

OTLP gRPC endpoint for OpenTelemetry traces, e.g. "localhost:4317" (insecure). Only used when metrics_enabled=true.

metrics_port: Option<u16>

If set, starts a Prometheus HTTP server on this port at /metrics. Only used when metrics_enabled=true.

metrics_host: Option<String>

Host/IP the Prometheus HTTP server binds to (default: "0.0.0.0"). Only used when metrics_enabled=true and metrics_port is set.

Trait Implementations

impl Clone for StartOptions

fn clone(&self) -> StartOptions

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for StartOptions

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for StartOptions

fn default() -> StartOptions

Returns the “default value” for a type.

impl Serialize for StartOptions

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.