Struct Config 

pub struct Config {

    pub dialect: Dialect,
    pub url: Option<String>,
    pub out: Option<String>,
    pub schema: String,
    pub no_back_referencing: bool,
    pub only: Vec<String>,
    pub except: Vec<String>,
    pub output: Output,
    pub hooks: Hooks,
    pub inflections: BTreeMap<String, String>,
    pub tables: BTreeMap<String, TableConfig>,
    pub aliases: BTreeMap<String, TableAliases>,
    pub relationships: Vec<ManualRelationship>,
    pub types: Types,
    pub queries: Option<QueriesConfig>,
}

The whole configuration file.

Fields

dialect: Dialect

The dialect to introspect and emit for.

url: Option<String>

The connection string (sqlite://path or a plain path; postgres://…). Schema provenance is the user’s migration flow’s business — the generator reads whatever the connection sees.

out: Option<String>

The directory the generated files land in.

schema: String

PostgreSQL: the namespace to introspect (bob’s shared_schema).

no_back_referencing: bool

Emit no has-many back-references anywhere.

only: Vec<String>

When non-empty, only these tables are generated.

except: Vec<String>

These tables are skipped.

output: Output

Output options.

hooks: Hooks

Where the application’s hand-written hook functions live.

inflections: BTreeMap<String, String>

Irregular plural → singular (people = "person").

tables: BTreeMap<String, TableConfig>

Per-table options, keyed by table name.

aliases: BTreeMap<String, TableAliases>

Renames, keyed by table name.

relationships: Vec<ManualRelationship>

Manual relationships for keys the schema does not declare.

types: Types

The user-overridable type map.

queries: Option<QueriesConfig>

Hand-written SQL → typed code (Layer 4). Absent means no query files are generated from; see crate::queries.

Implementations

impl Config

pub fn from_toml(text: &str) -> Result<Config>

Parse a configuration from TOML text.

pub fn load(path: impl AsRef<Path>) -> Result<Config>

Read and parse a configuration file.

pub fn includes_table(&self, table: &str) -> bool

Whether table survives the only/except filters.

pub fn includes_column(&self, table: &str, column: &str) -> bool

Whether table.column survives the per-table column filters.

Trait Implementations

impl Clone for Config

fn clone(&self) -> Config

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Config

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Config

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.