Skip to main content

Driver

Enum Driver 

Source
pub enum Driver {
    Rusqlite,
    Libsql,
    Turso,
    PostgresSync,
    TokioPostgres,
    D1Http,
    DurableSqlite,
    AwsDataApi,
}
Expand description

Database driver for Rust database connections

Variants§

§

Rusqlite

rusqlite - synchronous SQLite driver

§

Libsql

libsql - LibSQL driver (local embedded)

§

Turso

turso - Turso cloud driver (remote)

§

PostgresSync

postgres-sync - synchronous PostgreSQL driver

§

TokioPostgres

tokio-postgres - async PostgreSQL driver

§

D1Http

d1-http - Cloudflare D1 over the HTTP API

Targets a remote D1 database via the Cloudflare REST API. Requires accountId, databaseId, and token in dbCredentials. For deploying to a Worker binding at runtime use the d1 driver feature on the drizzle crate itself — this CLI driver is for schema ops (generate / push / pull / migrate) against a live D1 instance from your dev box.

§

DurableSqlite

durable-sqlite - Cloudflare Durable Objects SQLite storage

DOs run SQLite embedded inside the Worker runtime. There’s no remote endpoint to push to from the CLI, so this driver is schema-only: generate produces SQL migrations and a bundled migrations.js index (like drizzle-kit’s bundle: true) that the Worker imports at build time to apply migrations inside DurableObject::new().

§

AwsDataApi

aws-data-api - AWS RDS Data API (Aurora Serverless PostgreSQL)

Runs SQL through the AWS RDS Data API instead of a direct TCP connection. Requires database, secretArn (AWS Secrets Manager ARN holding the DB password), and resourceArn (Aurora cluster ARN) in dbCredentials. The AWS region comes from the standard SDK chain (env vars, ~/.aws/config, EC2/ECS metadata) — drizzle-kit takes no region field and we match that.

At the Rust layer this would route through the aws-sdk-rdsdata crate, which isn’t yet wired into drizzle-rs — this driver is currently recognized by the CLI for config parity, but operations return a pointed UnsupportedForDriver error.

Implementations§

Source§

impl Driver

Source

pub const ALL: &'static [&'static str]

Source

pub const fn as_str(self) -> &'static str

Source

pub const fn valid_for(dialect: Dialect) -> &'static [Self]

Source

pub const fn is_valid_for(self, dialect: Dialect) -> bool

Source

pub const fn is_codegen_only(self) -> bool

True for drivers that only make sense as schema/codegen targets — i.e. drivers where the CLI has no way to connect to a live DB from the dev machine (e.g. Durable Objects SQLite runs inside the Workers runtime).

Trait Implementations§

Source§

impl Clone for Driver

Source§

fn clone(&self) -> Driver

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 Driver

Source§

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

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

impl<'de> Deserialize<'de> for Driver

Source§

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

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Display for Driver

Source§

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

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

impl FromStr for Driver

Source§

type Err = String

The associated error which can be returned from parsing.
Source§

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type. Read more
Source§

impl Hash for Driver

Source§

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Source§

impl JsonSchema for Driver

Source§

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema. Read more
Source§

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type. Read more
Source§

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type. Read more
Source§

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword. Read more
Source§

impl PartialEq for Driver

Source§

fn eq(&self, other: &Driver) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Copy for Driver

Source§

impl Eq for Driver

Source§

impl StructuralPartialEq for Driver

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<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> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> 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> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. 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<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,