Struct Database 

pub struct Database { /* private fields */ }

Represents a pool of database connections.

This struct provides a thread-safe wrapper around a connection pool, allowing multiple parts of the application to share database connections efficiently. Supports runtime backend selection between PostgreSQL and SQLite.

Thread Safety

The Database struct is Clone and can be safely shared between threads. Each clone references the same underlying connection pool.

Implementations

impl Database

pub fn new(connection_string: &str, database_name: &str, max_size: u32) -> Self

Creates a new database connection pool with automatic backend detection.

The backend is detected from the connection string:

• postgres:// or postgresql:// -> PostgreSQL
• sqlite://, file paths, or :memory: -> SQLite

Arguments

• connection_string - The database connection URL or path
• database_name - The database name (used for PostgreSQL, ignored for SQLite)
• max_size - Maximum number of connections in the pool

Panics

Panics if the connection pool cannot be created.

pub fn new_with_schema( connection_string: &str, database_name: &str, max_size: u32, schema: Option<&str>, ) -> Self

Creates a new database connection pool with optional schema support.

The backend is detected from the connection string. Schema support is only effective for PostgreSQL; the schema parameter is stored but ignored for SQLite.

Arguments

• connection_string - The database connection URL or path
• database_name - The database name (used for PostgreSQL, ignored for SQLite)
• max_size - Maximum number of connections in the pool
• schema - Optional schema name for PostgreSQL multi-tenant isolation

Panics

Panics if connection pool creation fails or if the schema name is invalid. Use try_new_with_schema for fallible construction.

pub fn try_new_with_schema( connection_string: &str, _database_name: &str, max_size: u32, schema: Option<&str>, ) -> Result<Self, DatabaseError>

Creates a new database connection pool with optional schema support.

This is the fallible version of new_with_schema.

Arguments

• connection_string - The database connection URL or path
• database_name - The database name (used for PostgreSQL, ignored for SQLite)
• max_size - Maximum number of connections in the pool
• schema - Optional schema name for PostgreSQL multi-tenant isolation

Errors

Returns an error if:

• The schema name is invalid (SQL injection prevention)
• The connection pool cannot be created

pub fn backend(&self) -> BackendType

Returns the detected backend type.

pub fn schema(&self) -> Option<&str>

Returns the schema name if set.

pub fn pool(&self) -> AnyPool

Returns a clone of the connection pool.

pub fn get_connection(&self) -> AnyPool

Alias for pool() for backward compatibility.

pub fn close(&self)

Closes the connection pool, releasing all database connections.

After calling this method, all current and future attempts to get connections from the pool will fail immediately. This should be called when shutting down to ensure connections are properly released back to the database server.

Example

let db = Database::new("postgres://localhost/mydb", "mydb", 10)?;
// ... use database ...
db.close(); // Release all connections

pub async fn run_migrations(&self) -> Result<(), String>

Runs pending database migrations for the appropriate backend.

This method detects the backend type and runs the corresponding migrations.

pub async fn setup_schema(&self, schema: &str) -> Result<(), String>

Sets up the PostgreSQL schema for multi-tenant isolation.

Creates the schema if it doesn’t exist and runs migrations within it. Returns an error if called on a SQLite backend or if the schema name is invalid (to prevent SQL injection).

Security

Schema names are validated to prevent SQL injection attacks. Only alphanumeric characters and underscores are allowed.

pub async fn get_connection_with_schema( &self, ) -> Result<Object<PgManager>, PoolError<Error>>

Gets a PostgreSQL connection with the schema search path set.

For PostgreSQL, this sets the search path to the configured schema. For SQLite, this is a no-op and returns an error.

Security

Schema names are validated before use in SQL to prevent injection attacks.

pub async fn get_postgres_connection( &self, ) -> Result<Object<PgManager>, PoolError<Error>>

Gets a PostgreSQL connection.

Returns an error if this is a SQLite backend.

pub async fn get_sqlite_connection( &self, ) -> Result<Object<SqliteManager>, PoolError<Error>>

Gets a SQLite connection.

Returns an error if this is a PostgreSQL backend.

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 Debug for Database

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

Formats the value using the given formatter.