Struct ConnectOptions 

pub struct ConnectOptions { /* private fields */ }

The options for opening a Turso database.

use std::time::Duration;
use turso_orm_driver::ConnectOptions;

let opts = ConnectOptions::new("app.db")
    .max_connections(4)
    .busy_timeout(Duration::from_secs(5))
    .foreign_keys(true);
assert_eq!(opts.max_connections_value(), 4);

Implementations

impl ConnectOptions

pub fn new(path: impl AsRef<Path>) -> ConnectOptions

Opens, or creates, the database file at path; ":memory:" opens an in-memory database.

pub fn in_memory() -> ConnectOptions

Opens a private in-memory database.

pub fn sync( path: impl AsRef<Path>, remote_url: impl Into<String>, ) -> ConnectOptions

Available on crate feature sync only.

Opens a local replica of a Turso Cloud database.

pub fn remote(url: impl Into<String>) -> ConnectOptions

Available on crate feature serverless only.

Opens a Turso Cloud database over HTTP, without a local file.

Every statement is an HTTP request, so the busy timeout and the MVCC setting do not apply; the pool, the pragmas and the transactions do, since each connection is a server-side session.

pub fn auth_token(self, token: impl Into<String>) -> ConnectOptions

Available on crate features serverless or sync only.

Sets the bearer token of a remote database or of an embedded replica’s remote; ignored for local sources.

pub fn remote_encryption_key(self, key: impl Into<String>) -> ConnectOptions

Available on crate feature serverless only.

Sets the base64 key of a remote database encrypted with a customer-managed key; ignored for other sources.

pub fn read_only(self, read_only: bool) -> ConnectOptions

Opens the database in read-only mode.

pub fn encryption( self, cipher: impl Into<String>, hexkey: impl Into<String>, ) -> ConnectOptions

Enables encryption at rest — experimental in Turso.

pub fn experimental(self, experimental: Experimental) -> ConnectOptions

Enables experimental engine features.

pub fn max_connections(self, max: usize) -> ConnectOptions

Sets the maximum number of pooled connections (minimum 1, default 8).

pub fn acquire_timeout(self, timeout: Duration) -> ConnectOptions

Sets how long to wait for a free pooled connection (default 30 s).

pub fn busy_timeout( self, timeout: impl Into<Option<Duration>>, ) -> ConnectOptions

Sets how long a connection waits on a lock before failing with a busy error (default 5 s); None fails immediately.

pub fn foreign_keys(self, enabled: bool) -> ConnectOptions

Enforces foreign keys (PRAGMA foreign_keys = ON, default on).

pub fn mvcc(self, enabled: bool) -> ConnectOptions

Switches the database to MVCC (PRAGMA journal_mode = 'mvcc'), which enables BEGIN CONCURRENT and multiple concurrent writers.

Experimental in Turso; conflicts surface at commit as busy errors.

pub fn pragma( self, name: impl Into<String>, value: impl Into<String>, ) -> ConnectOptions

Runs PRAGMA name = value on every new connection.

pub fn source(&self) -> &Source

The configured source.

pub fn max_connections_value(&self) -> usize

The configured pool size.

pub fn busy_timeout_value(&self) -> Option<Duration>

The configured busy timeout.

pub fn is_in_memory(&self) -> bool

Whether this points at the in-memory database.

Trait Implementations

impl Clone for ConnectOptions

fn clone(&self) -> ConnectOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ConnectOptions

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

Formats the value using the given formatter.

impl Eq for ConnectOptions

impl From<&Path> for ConnectOptions

fn from(path: &Path) -> ConnectOptions

Converts to this type from the input type.

impl From<&str> for ConnectOptions

fn from(path: &str) -> ConnectOptions

Converts to this type from the input type.

impl From<PathBuf> for ConnectOptions

fn from(path: PathBuf) -> ConnectOptions

Converts to this type from the input type.

impl From<String> for ConnectOptions

fn from(path: String) -> ConnectOptions

Converts to this type from the input type.

impl PartialEq for ConnectOptions

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for ConnectOptions