Struct TableMetadata 

pub struct TableMetadata {
    pub schema: Table,
    pub record_pk_column: Option<usize>,
    pub user_id_columns: Vec<usize>,
    pub json_metadata: JsonMetadata,
    /* private fields */
}

A data class describing a sqlite Table and additional meta data useful for TrailBase.

An example of TrailBase idiosyncrasies are UUIDv7 columns, which are a bespoke concept.

Fields

schema: Table

record_pk_column: Option<usize>

If and which column on this table qualifies as a record PK column, i.e. integer or UUIDv7.

user_id_columns: Vec<usize>

If and which columns on this table reference _user(id).

json_metadata: JsonMetadata

Metadata for CHECK(json_schema()) columns.

Implementations

impl TableMetadata

pub fn new(table: Table, tables: &[Table], user_table_name: &str) -> Self

Build a new TableMetadata instance containing TrailBase/RecordApi specific information.

NOTE: The list of all tables is needed only to extract interger/UUIDv7 pk columns for foreign key relationships.

pub fn name(&self) -> &QualifiedName

pub fn column_index_by_name(&self, key: &str) -> Option<usize>

pub fn column_by_name(&self, key: &str) -> Option<(usize, &Column)>

Trait Implementations

impl Borrow<QualifiedName> for TableMetadata

fn borrow(&self) -> &QualifiedName

Immutably borrows from an owned value.

impl Clone for TableMetadata

fn clone(&self) -> TableMetadata

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TableMetadata

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

Formats the value using the given formatter.

impl Eq for TableMetadata

impl Hash for TableMetadata

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for TableMetadata

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl TableOrViewMetadata for TableMetadata

fn qualified_name(&self) -> &QualifiedName

fn columns(&self) -> Option<&[Column]>

fn json_metadata(&self) -> Option<&JsonMetadata>

fn record_pk_column(&self) -> Option<(usize, &Column)>