Struct Database 

pub struct Database { /* private fields */ }

The main entry point for Bottle ORM database operations.

Database manages a connection pool and provides methods for starting transactions, creating tables, and building queries for models.

It is designed to be thread-safe and easily shared across an application (internally uses an Arc for the connection pool).

Implementations

impl Database

pub fn builder() -> DatabaseBuilder

Creates a new DatabaseBuilder for configuring the connection.

pub async fn connect(url: &str) -> Result<Self, Error>

Connects to a database using the provided connection string.

This is a convenience method that uses default builder settings.

Arguments

• url - A database connection URL (e.g., “postgres://user:pass@localhost/db”)

pub fn migrator(&self) -> Migrator<'_>

Returns a new Migrator instance for managing schema changes.

pub fn model<T: Model + Send + Sync + Unpin + AnyImpl>( &self, ) -> QueryBuilder<T, Self>

Starts building a query for the specified model.

Type Parameters

• T - The Model type to query.

pub fn raw<'a>(&self, sql: &'a str) -> RawQuery<'a, Self>

Creates a raw SQL query builder.

pub async fn begin(&self) -> Result<Transaction<'_>, Error>

Starts a new database transaction.

pub async fn table_exists(&self, table_name: &str) -> Result<bool, Error>

Checks if a table exists in the database.

pub async fn create_table<T: Model>(&self) -> Result<(), Error>

Creates a table based on the provided Model metadata.

pub async fn sync_table<T: Model>(&self) -> Result<(), Error>

Synchronizes a table schema by adding missing columns or indexes.

pub async fn get_table_columns( &self, table_name: &str, ) -> Result<Vec<String>, Error>

Returns the current columns of a table.

pub async fn get_table_indexes( &self, table_name: &str, ) -> Result<Vec<String>, Error>

Returns the current indexes of a table.

pub async fn assign_foreign_keys<T: Model>(&self) -> Result<(), Error>

Assigns foreign keys to a table.

Trait Implementations

impl Clone for Database

fn clone(&self) -> Database

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Connection for Database

fn execute<'a, 'q: 'a>( &'a self, sql: &'q str, args: AnyArguments<'q>, ) -> BoxFuture<'a, Result<AnyQueryResult, Error>>

fn fetch_all<'a, 'q: 'a>( &'a self, sql: &'q str, args: AnyArguments<'q>, ) -> BoxFuture<'a, Result<Vec<AnyRow>, Error>>

fn fetch_one<'a, 'q: 'a>( &'a self, sql: &'q str, args: AnyArguments<'q>, ) -> BoxFuture<'a, Result<AnyRow, Error>>

fn fetch_optional<'a, 'q: 'a>( &'a self, sql: &'q str, args: AnyArguments<'q>, ) -> BoxFuture<'a, Result<Option<AnyRow>, Error>>

impl Debug for Database

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

Formats the value using the given formatter.