Skip to main content

run_introspection

Function run_introspection 

Source
pub fn run_introspection(
    credentials: &Credentials,
    dialect: Dialect,
    out_dir: &Path,
    init_metadata: bool,
    breakpoints: bool,
    introspect_casing: Option<IntrospectCasing>,
    filters: &SnapshotFilters,
    migrations_table: &str,
    migrations_schema: &str,
) -> Result<IntrospectResult, CliError>
Expand description

Introspect a database and write schema/snapshot files.

This is the main entry point for CLI introspection.

ยงErrors

Returns CliError if connecting to the database fails, if querying the catalogs fails, if applying the configured snapshot filters fails, or if writing the generated schema and snapshot files to disk fails.