Struct DB 

pub struct DB;

Database facade - main entry point for database operations

Provides static methods for initializing and accessing the database connection. The connection is stored in the application container as a singleton.

Example

use kit::{DB, DatabaseConfig, Config};

// Initialize (usually in bootstrap.rs)
Config::register(DatabaseConfig::from_env());
DB::init().await?;

// Use anywhere in your app
let conn = DB::connection()?;

Implementations

impl DB

pub async fn init() -> Result<(), FrameworkError>

Initialize the database connection

Reads configuration from DatabaseConfig (must be registered via Config system) and establishes a connection pool. The connection is stored in the App container.

Errors

Returns an error if:

• DatabaseConfig is not registered
• Connection to the database fails

Example

// In bootstrap.rs
pub async fn register() {
    DB::init().await.expect("Failed to connect to database");
}

pub async fn init_with(config: DatabaseConfig) -> Result<(), FrameworkError>

Initialize with a custom config

Useful for testing or when you need to connect to a different database.

Example

let config = DatabaseConfig::builder()
    .url("sqlite::memory:")
    .build();
DB::init_with(config).await?;

pub fn connection() -> Result<DbConnection, FrameworkError>

Get the database connection

Returns the connection from the App container. The connection is wrapped in a DbConnection which provides convenient access to the underlying SeaORM DatabaseConnection.

Errors

Returns an error if DB::init() was not called.

Example

let conn = DB::connection()?;

// Use with SeaORM queries
let users = User::find()
    .all(conn.inner())
    .await?;

pub fn is_connected() -> bool

Check if the database connection is initialized

Example

if DB::is_connected() {
    let conn = DB::connection()?;
    // ...
}

pub fn get() -> Result<DbConnection, FrameworkError>

Get the database connection for use with SeaORM

This is a convenience alias for DB::connection(). The returned DbConnection implements Deref<Target=DatabaseConnection>, so you can use it directly with SeaORM methods.

Example

use kit::database::DB;
use sea_orm::{Set, ActiveModelTrait};

let new_todo = todos::ActiveModel {
    title: Set("My Todo".to_string()),
    ..Default::default()
};

// Use &* to dereference to &DatabaseConnection
let inserted = new_todo.insert(&*DB::get()?).await?;

// Or use .inner() method
let inserted = new_todo.insert(DB::get()?.inner()).await?;