Trait pliantdb_core::schema::Schema

pub trait Schema: Send + Sync + Debug + 'static {
    fn schema_name() -> Result<SchemaName, InvalidNameError>;
    fn define_collections(schema: &mut Schematic) -> Result<(), Error>;

    fn schematic() -> Result<Schematic, Error> { ... }
}

Defines a group of collections that are stored into a single database.

Required methods

fn schema_name() -> Result<SchemaName, InvalidNameError>

Returns the unique SchemaName for this schema.

fn define_collections(schema: &mut Schematic) -> Result<(), Error>

Defines the Collections into schema.

Provided methods

fn schematic() -> Result<Schematic, Error>

Retrieves the Schematic for this schema.

Implementations on Foreign Types

impl Schema for ()

This trait is only useful for tools like pliantdb local-backup. There is no real-world use case of connecting to a Database with no schema.

fn schema_name() -> Result<SchemaName, InvalidNameError>

fn define_collections(_schema: &mut Schematic) -> Result<(), Error>

Implementors

impl Schema for BasicSchema

impl<T> Schema for T where
    T: Collection + 'static,