rorm-declaration 0.4.2

The base defintion layer all rorm crates rely on.
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
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61

//! This modules holds the definition of the configuration used by [rorm-cli]

use serde::{Deserialize, Serialize};

/**
The representation of all supported DB drivers
 */
#[derive(Serialize, Deserialize, Debug, Clone)]
#[serde(tag = "Driver")]
pub enum DatabaseDriver {
    /// Representation of the SQLite driver
    #[cfg(feature = "sqlite")]
    #[serde(rename_all = "PascalCase")]
    SQLite {
        /// The filename of the sqlite database
        filename: String,
    },
    /// Representation of the Postgres driver
    #[cfg(feature = "postgres")]
    #[serde(rename_all = "PascalCase")]
    Postgres {
        /// Name of the database
        name: String,
        /// Host of the database
        host: String,
        /// Port of the database
        port: u16,
        /// User to connect to the database
        user: String,
        /// Password to connect to the database
        password: String,
    },
    /// Representation of the MySQL / MariaDB driver
    #[cfg(feature = "mysql")]
    #[serde(rename_all = "PascalCase")]
    MySQL {
        /// Name of the database
        name: String,
        /// Host of the database
        host: String,
        /// Port of the database
        port: u16,
        /// User to connect to the database
        user: String,
        /// Password to connect to the database
        password: String,
    },
}

/**
The configuration struct for database related settings
 */
#[derive(Serialize, Deserialize, Debug, Clone)]
#[serde(rename_all = "PascalCase")]
pub struct DatabaseConfig {
    /// The representation of the SQL driver. Will be flattened
    #[serde(flatten)]
    pub driver: DatabaseDriver,
    /// The name of the migration table. Only used be [rorm-cli].
    pub last_migration_table_name: Option<String>,
}