Struct Databases 

pub struct Databases { /* private fields */ }

Named databases ("default", "analytics", …) plus an optional DatabaseRouter.

A queryset holds one Db and never spans aliases: pick the database with get, using or the router-aware for_read / for_write / objects. Combining querysets bound to different databases (union and friends) is an error.

Implementations

impl Databases

pub const DEFAULT: &'static str = "default"

Alias used by default_db.

pub fn new() -> Self

Empty registry.

pub fn with(self, alias: impl Into<String>, db: Db) -> Self

Register db under alias (replacing an existing entry).

pub fn with_router(self, router: impl DatabaseRouter) -> Self

Route reads and writes through router (replacing a previous one).

pub fn get(&self, alias: &str) -> Option<&Db>

Handle registered under alias.

pub fn default_db(&self) -> Option<&Db>

Handle registered as "default".

pub fn aliases(&self) -> impl Iterator<Item = &str>

Registered aliases, sorted.

pub fn for_read<M: Model>(&self) -> Result<&Db, OrmError>

The database M is read from: the router’s choice, else "default".

Errors

OrmError::UnknownDatabase if the chosen alias is not registered.

pub fn for_write<M: Model>(&self) -> Result<&Db, OrmError>

The database M is written to: the router’s choice, else "default".

Errors

OrmError::UnknownDatabase if the chosen alias is not registered.

pub fn objects<M: Model>(&self) -> Result<QuerySet<M>, OrmError>

Queryset over M on its read database (Django Model.objects under a router).

Errors

As for_read.

pub fn using<M: Model>(&self, alias: &str) -> Result<QuerySet<M>, OrmError>

Queryset over M on the database registered as alias (Django Model.objects.using(alias)), bypassing the router.

Errors

OrmError::UnknownDatabase if alias is not registered.

pub fn allow_migrate(&self, alias: &str, model: &ModelMeta) -> bool

Whether migrations may create model on alias (true without a router).

Trait Implementations

impl Clone for Databases

fn clone(&self) -> Databases

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Databases

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

Formats the value using the given formatter.

impl Default for Databases

fn default() -> Databases

Returns the “default value” for a type.