Struct PgClient 

pub struct PgClient {
    pub pools: Arc<HashMap<String, PgPool>>,
}

PostgreSQL client Cog that manages a map of connection pools keyed by schema name.

Created automatically from PgConfig during Gearbox::crank(). Inject it into other Cogs or route handlers to access the database:

#[cog]
pub struct UserRepo {
    #[inject]
    pg: Arc<PgClient>,
}

Fields

pools: Arc<HashMap<String, PgPool>>

Implementations

impl PgClient

pub fn get_pool(&self, schema: &str) -> Result<&PgPool, PgError>

Returns the connection pool for the given schema name.

Returns PgError::SchemaNotFound if no pool is configured for that schema.

pub fn pool(&self) -> Result<&PgPool, PgError>

Convenience method for single-schema setups.

If exactly one pool exists, returns it. Otherwise looks up the "default" pool. Returns PgError::SchemaNotFound if no suitable pool is found.

Trait Implementations

impl Cog for PgClient

fn new<'async_trait>( hub: Arc<Hub>, ) -> Pin<Box<dyn Future<Output = Result<Self, Error>> + Send + 'async_trait>>

where Self: 'async_trait,

Construct this Cog, resolving dependencies and configuration from the Hub.

fn on_start<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>

where 'life0: 'async_trait, Self: 'async_trait,

Called after all cogs have been initialized. Override to perform post-initialization work (start background tasks, warm caches, etc.).

fn on_shutdown<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>

where 'life0: 'async_trait, Self: 'async_trait,

Called during graceful shutdown. Override to perform cleanup (flush buffers, close connections, etc.).