Struct Db 

pub struct Db { /* private fields */ }

A connection pool plus the dynamic CRUD executor.

Implementations

impl Db

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

Open a pool against the given Postgres URL, creating the database first if it does not exist yet.

A fresh checkout pointed at a running Postgres would otherwise fail with database "…" does not exist before migrations ever get a chance to run, so on that specific error we connect to the postgres maintenance database on the same server, CREATE DATABASE, and retry once. Any other failure (bad credentials, no server) is returned untouched.

pub fn connection(&self) -> &DatabaseConnection

Access the underlying connection (used by [migrate]).

pub async fn list( &self, r: &Resource, filters: &[Filter], sort: &[Sort], limit: i64, offset: i64, ) -> Result<Value, Error>

GET /<resource> — a JSON array of rows, newest first unless sort says otherwise.

pub async fn get( &self, r: &Resource, id: Uuid, filters: &[Filter], ) -> Result<Option<Value>, Error>

GET /<resource>/<id> — one row or None.

pub async fn create( &self, r: &Resource, data: &Map<String, Value>, ) -> Result<Value, Error>

POST /<resource> — insert and return the created row.

pub async fn update( &self, r: &Resource, id: Uuid, data: &Map<String, Value>, filters: &[Filter], ) -> Result<Option<Value>, Error>

PATCH /<resource>/<id> — update present fields, return the new row.

pub async fn delete( &self, r: &Resource, id: Uuid, filters: &[Filter], ) -> Result<bool, Error>

DELETE /<resource>/<id> — returns whether a row was removed.

pub async fn fetch_by_ids( &self, r: &Resource, ids: &[Uuid], filters: &[Filter], ) -> Result<Value, Error>

Fetch multiple rows of a resource by id (used for relation expansion). filters carry the caller’s authorization scope, so an expansion can never reach a row a direct read would have refused. Returns a JSON array with hidden fields stripped; order is unspecified.

pub async fn raw_json( &self, sql: &str, params: &[Value], ) -> Result<Value, Error>

Raw query bridge used by function .sos. SELECT/WITH statements come back as a JSON array of rows; anything else returns {"rows_affected":n}.

Trait Implementations

impl Clone for Db

fn clone(&self) -> Db

Returns a duplicate of the value.

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

Performs copy-assignment from source.