galchemy - v3.1.0

galchemy/schema/introspection/postgres

Types

ColumnRow

</> 
pub type ColumnRow {
  ColumnRow(
    schema_name: String,
    table_name: String,
    column_name: String,
    ordinal_position: Int,
    is_nullable: Bool,
    data_type: String,
    udt_name: String,
    character_maximum_length: option.Option(Int),
    numeric_precision: option.Option(Int),
    numeric_scale: option.Option(Int),
    datetime_precision: option.Option(Int),
    column_default: option.Option(String),
  )
}

Constructors 

  • ColumnRow(
  schema_name: String,
  table_name: String,
  column_name: String,
  ordinal_position: Int,
  is_nullable: Bool,
  data_type: String,
  udt_name: String,
  character_maximum_length: option.Option(Int),
  numeric_precision: option.Option(Int),
  numeric_scale: option.Option(Int),
  datetime_precision: option.Option(Int),
  column_default: option.Option(String),
)

ConstraintKind

</> 
pub type ConstraintKind {
  PrimaryKeyConstraint
  UniqueConstraint
  ForeignKeyConstraint
}

Constructors 

  • PrimaryKeyConstraint
  • UniqueConstraint
  • ForeignKeyConstraint

ConstraintRow

</> 
pub type ConstraintRow {
  ConstraintRow(
    schema_name: String,
    table_name: String,
    constraint_name: String,
    kind: ConstraintKind,
    column_name: String,
    ordinal_position: Int,
    referenced_schema: option.Option(String),
    referenced_table: option.Option(String),
    referenced_column: option.Option(String),
  )
}

Constructors 

  • ConstraintRow(
  schema_name: String,
  table_name: String,
  constraint_name: String,
  kind: ConstraintKind,
  column_name: String,
  ordinal_position: Int,
  referenced_schema: option.Option(String),
  referenced_table: option.Option(String),
  referenced_column: option.Option(String),
)

IndexRow

</> 
pub type IndexRow {
  IndexRow(
    schema_name: String,
    table_name: String,
    index_name: String,
    is_unique: Bool,
    definition: String,
  )
}

Constructors 

  • IndexRow(
  schema_name: String,
  table_name: String,
  index_name: String,
  is_unique: Bool,
  definition: String,
)

IntrospectionError

</> 
pub type IntrospectionError {
  ColumnsQueryError(pog.QueryError)
  ConstraintsQueryError(pog.QueryError)
  IndexesQueryError(pog.QueryError)
}

Constructors

IntrospectionOptions

</> 
pub type IntrospectionOptions {
  IntrospectionOptions(
    schemas: List(String),
    include_system_schemas: Bool,
  )
}

Constructors 

  • IntrospectionOptions(
  schemas: List(String),
  include_system_schemas: Bool,
)

Values

column_row_decoder

</> 
pub fn column_row_decoder() -> decode.Decoder(ColumnRow)

compile_columns_query

</> 
pub fn compile_columns_query(
  options: IntrospectionOptions,
) -> compiler.CompiledQuery

compile_constraints_query

</> 
pub fn compile_constraints_query(
  options: IntrospectionOptions,
) -> compiler.CompiledQuery

compile_indexes_query

</> 
pub fn compile_indexes_query(
  options: IntrospectionOptions,
) -> compiler.CompiledQuery

compile_query

</> 
pub fn compile_query(
  options: IntrospectionOptions,
) -> compiler.CompiledQuery

constraint_row_decoder

</> 
pub fn constraint_row_decoder() -> decode.Decoder(ConstraintRow)

default_options

</> 
pub fn default_options() -> IntrospectionOptions

include_system_schemas

</> 
pub fn include_system_schemas(
  options: IntrospectionOptions,
) -> IntrospectionOptions

index_row_decoder

</> 
pub fn index_row_decoder() -> decode.Decoder(IndexRow)

introspect

</> 
pub fn introspect(
  connection: pog.Connection,
  options: IntrospectionOptions,
) -> Result(model.SchemaSnapshot, IntrospectionError)

only_schemas

</> 
pub fn only_schemas(
  options: IntrospectionOptions,
  schemas: List(String),
) -> IntrospectionOptions

rows_to_snapshot

</> 
pub fn rows_to_snapshot(
  columns: List(ColumnRow),
  constraints: List(ConstraintRow),
  indexes: List(IndexRow),
) -> model.SchemaSnapshot

to_columns_query

</> 
pub fn to_columns_query(
  options: IntrospectionOptions,
) -> pog.Query(ColumnRow)

to_constraints_query

</> 
pub fn to_constraints_query(
  options: IntrospectionOptions,
) -> pog.Query(ConstraintRow)

to_indexes_query

</> 
pub fn to_indexes_query(
  options: IntrospectionOptions,
) -> pog.Query(IndexRow)

to_query

</> 
pub fn to_query(
  options: IntrospectionOptions,
) -> pog.Query(ColumnRow)
✨ Search Document