Struct ExternalDatabaseConfig 

pub struct ExternalDatabaseConfig {
    pub kind: String,
    pub url_env: String,
    pub read_url_env: Option<String>,
    pub compute: Option<String>,
    pub database: Option<String>,
    pub user: Option<String>,
    pub password_env: Option<String>,
    pub pool_max: Option<u32>,
    pub read_only: bool,
    pub allow_preview: bool,
    pub connect_timeout_secs: Option<u64>,
}

One external SQL database for the handler sql binding. Its source is one of two mutually-exclusive forms:

• url_env — a bring-your-own database: the connection URL is a secret, named indirectly by an env var (never written in the config file).
• compute — a database boatramp runs as a compute workload: boatramp derives the connection from the workload’s live endpoint (host:port) plus the database/user/password_env here, so there is no URL to hand-map and it follows the workload across restarts (PLAN-managed-compute-sql).

Fields

kind: String

Engine: postgres (aliases postgresql/pg) or mysql (alias mariadb).

url_env: String

Name of the env var holding the connection URL (e.g. postgres://user:pw@host/db). Required unless compute is set.

read_url_env: Option<String>

Optional env var holding a read-replica connection URL. When set, open-read-only transactions route there; writes stay on url_env.

compute: Option<String>

The name of a compute workload (a Postgres/MySQL server boatramp runs) to source this database from, instead of url_env. boatramp resolves the workload’s live endpoint and builds the connection. Mutually exclusive with url_env.

database: Option<String>

The database name inside the compute-backed server (non-secret).

user: Option<String>

The connecting user for the compute-backed server (non-secret).

password_env: Option<String>

Env var holding the password for user on the compute-backed server. Omit to let boatramp fully manage the credential (PLAN-managed-compute-sql Phase 2): it generates a strong password once, seals it with the [secrets] envelope, injects it into the DB workload’s server-init env at launch, and connects the handler with it — the operator sets no DB secret at all. Set it only to bring your own password for the compute-backed server.

pool_max: Option<u32>

Maximum pooled connections (default 8).

read_only: bool

Open every transaction READ ONLY (the engine rejects writes) — for a database functions should only read.

allow_preview: bool

Permit preview deployments to reach this database. Default false: a preview is refused, so it can never touch the operator’s live external DB.

connect_timeout_secs: Option<u64>

Connection/acquire timeout in seconds (default 10).

Implementations

impl ExternalDatabaseConfig

pub fn validate(&self, name: &str) -> Result<(), String>

Validate the source is well-formed: exactly one of url_env / compute, and a compute-backed database has the connection details boatramp can’t infer (database + user). password_env is optional — omit it to let boatramp manage the credential (Phase 2). name is the binding name, for the error message.

pub fn is_managed_credential(&self) -> bool

Whether this compute-backed database uses a boatramp-managed credential (Phase 2): compute is set and no password_env was supplied.

Trait Implementations

impl Clone for ExternalDatabaseConfig

fn clone(&self) -> ExternalDatabaseConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ExternalDatabaseConfig

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

Formats the value using the given formatter.

impl Default for ExternalDatabaseConfig

fn default() -> ExternalDatabaseConfig

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ExternalDatabaseConfig

where ExternalDatabaseConfig: Default,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.