crash_orm 0.7.2

A simple, typed ORM for Postgres
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
39
40
41
42
43
44
45

use async_trait::async_trait;

use crate::connection::DatabaseConnection;

/// Trait implementing functions to modify the table itself in the database.
///
/// This trait can be derived, usually together with [Entity](crate::prelude::Entity).
///
/// ```
/// use crash_orm::derive::{Entity, Schema};
///
/// #[derive(Entity, Debug, Schema)]
/// struct TestItem {
///     id: u32,
///     name: String,
/// }
/// ```
#[async_trait]
pub trait Schema {
    /// Create the table based on the provided struct.
    ///
    /// This will fail, if the table already exists.
    /// Use [create_table_if_not_exists](Self::create_table_if_not_exists) if you want to ignore that.
    async fn create_table(connection: &impl DatabaseConnection) -> crate::Result<()>;

    /// Drop the table if it exists
    async fn drop_table(connection: &impl DatabaseConnection) -> crate::Result<()>;

    /// Empty the table
    async fn truncate_table(connection: &impl DatabaseConnection) -> crate::Result<()>;

    /// Check whether the table exists or not
    async fn table_exists(connection: &impl DatabaseConnection) -> crate::Result<bool>;

    /// Creates a table if it doesn't exist.
    ///
    /// This will not fail compared to [create_table](Self::create_table) if the table is already present.
    async fn create_table_if_not_exists(connection: &impl DatabaseConnection) -> crate::Result<()> {
        if !Self::table_exists(connection).await? {
            Self::create_table(connection).await?;
        }

        Ok(())
    }
}