docbox-database 0.11.1

Docbox database structures, logic, and migrations
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38

#![forbid(unsafe_code)]
#![recursion_limit = "256"]

// Pool re-exports
pub use pool::{
    DatabasePoolCache, DatabasePoolCacheConfig, DatabasePoolCacheConfigError, DbConnectErr,
    DbSecrets,
};

/// SQLx re-exports for other projects
pub use sqlx::{
    self, PgExecutor as DbExecutor, PgPool, Postgres, Transaction,
    postgres::{PgConnectOptions, PgPoolOptions},
};

pub mod create;
pub mod migrations;
pub mod models;
pub mod pool;
pub mod utils;

/// Type of the database connection pool
pub type DbPool = PgPool;

/// Short type alias for a database error
pub type DbErr = sqlx::Error;

/// Type alias for a result where the error is a [DbErr]
pub type DbResult<T> = Result<T, DbErr>;

/// Type of a database transaction
pub type DbTransaction<'c> = Transaction<'c, Postgres>;

/// Name of the root database
pub const ROOT_DATABASE_NAME: &str = "docbox";

/// Name of the root database role
pub const ROOT_DATABASE_ROLE_NAME: &str = "docbox_config_api";