Skip to main content

SqlBindingConfig

Struct SqlBindingConfig 

Source
pub struct SqlBindingConfig {
    pub dir: Option<PathBuf>,
    pub url: Option<String>,
    pub admin_url: Option<String>,
    pub replica_url: Option<String>,
    pub token_env: Option<String>,
    pub admin_token_env: Option<String>,
    pub preview_mode: Option<String>,
    pub preview_init: Option<PathBuf>,
    pub databases: BTreeMap<String, ExternalDatabaseConfig>,
}
Expand description

libsql settings for the handler sql binding — the single SQL backend. Each site gets a real database boundary (an embedded file per site, or a sqld namespace per site), never schema separation (which arbitrary guest SQL escapes). Setting url switches from single-node to a shared sqld cluster; everything else stays identical.

Fields§

§dir: Option<PathBuf>

Single-node: root directory for the per-site embedded database files (default <data-dir>/handlers-sql). Ignored when url is set.

§url: Option<String>

Cluster: base sqld data URL (e.g. http://sqld:8080). When set, each site is a sqld namespace addressed as a subdomain of this URL; admin_url is then required.

§admin_url: Option<String>

Cluster: sqld admin API base URL (e.g. http://sqld:9090) for creating per-site namespaces. Required when url is set.

§replica_url: Option<String>

Cluster: optional sqld read-replica data URL. When set, handlers’ read-only sql transactions (open-read-only) route to this endpoint while writes stay on url (reads → replicas, writes → primary). Reads may lag (eventually consistent). Ignored in single-node mode (no url).

§token_env: Option<String>

Name of the env var holding the sqld data auth token (optional; never the token itself in-file).

§admin_token_env: Option<String>

Name of the env var holding the sqld admin API auth key (optional).

§preview_mode: Option<String>

How preview deployments get their SQL database: empty (default — a fresh isolated db), branch (a consistent copy of the site’s live db; single-node only), or shared (the site’s live db). See boatramp_core::sql::PreviewSqlMode.

§preview_init: Option<PathBuf>

Path to an idempotent SQL script run when an empty preview database is first opened (e.g. schema/seed). Ignored in branch/shared modes.

§databases: BTreeMap<String, ExternalDatabaseConfig>

handlers.bindings.sql.databases — external bring-your-own databases, each opened by name via sql.open("<name>"). An operator-configured Postgres/MySQL whose isolation is the operator’s (it’s their database), so these bypass the per-site libsql boundary and are reachable by any handler/function granted the sql binding. Needs the sql-postgres / sql-mysql build feature for the engine. A name here shadows the same name on the managed libsql default.

Trait Implementations§

Source§

impl Clone for SqlBindingConfig

Source§

fn clone(&self) -> SqlBindingConfig

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for SqlBindingConfig

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for SqlBindingConfig

Source§

fn default() -> SqlBindingConfig

Returns the “default value” for a type. Read more
Source§

impl<'de> Deserialize<'de> for SqlBindingConfig

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> FromRef<T> for T
where T: Clone,

Source§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
Source§

impl<A, B, T> HttpServerConnExec<A, B> for T
where B: Body,

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more