Xqlite.Schema.ForeignKeyInfo (Xqlite v0.7.0)

View Source

Information about a foreign key constraint originating from a table, corresponding to PRAGMA foreign_key_list.

Summary

Types

t()

Struct definition.

Types

t()

@type t() :: %Xqlite.Schema.ForeignKeyInfo{
  column_sequence: integer(),
  from_column: String.t(),
  id: integer(),
  match_clause: Xqlite.Schema.Types.fk_match(),
  on_delete: Xqlite.Schema.Types.fk_action(),
  on_update: Xqlite.Schema.Types.fk_action(),
  target_table: String.t(),
  to_column: String.t() | nil
}

Struct definition.

  • :id - ID of the foreign key constraint (0-based index for the table).
  • :column_sequence - 0-based index of the column within the foreign key constraint (for compound FKs).
  • :target_table - Name of the table referenced by the foreign key.
  • :from_column - Name of the column in the current table that is part of the foreign key.
  • :to_column - Name of the column in the target table that is referenced. Can be nil if the FK targets a UNIQUE constraint rather than a primary key.
  • :on_update - Action taken on update (see t:Types.fk_action/0).
  • :on_delete - Action taken on delete (see t:Types.fk_action/0).
  • :match_clause - The MATCH clause specified (see t:Types.fk_match/0).