Expand description
This module contains types related to database tables.
Structs§
- Candid
Foreign KeyDef - Serializable foreign key definition for API boundaries.
- Column
Def - Defines a column in a database table.
- Column
Snapshot - Snapshot of a single column definition.
- Custom
Data Type Snapshot - User-defined custom-type metadata carried inside
DataTypeSnapshot::Custom. Boxed in the parent enum so the discriminant stays compact (the migration error variants embed twoDataTypeSnapshots each, and an inlineString+WireSizewould bloatcrate::error::DbmsErrorpast clippy’sresult_large_errthreshold). - Foreign
KeyDef - Defines a foreign key relationship for a column.
- Foreign
KeySnapshot - Snapshot of a foreign key reference attached to a column.
- Index
Def - Defines an index on one or more columns of a table.
- Index
Snapshot - Snapshot of a secondary index defined on a table.
- Join
Column Def - Serializable column definition for API boundaries.
- Table
Schema Snapshot - Frozen, comparable view of a
TableSchemaused for migration detection.
Enums§
- Candid
Data Type Kind - Serializable data type kind for API boundaries.
- Data
Type Snapshot - Stable, tag-keyed encoding of a column data type.
- OnDelete
Snapshot - Stable, tag-keyed encoding of the
ON DELETEreferential action. - Table
Error - Table related errors
- Values
Source - Indicates the source of the column values.
- Wire
Size - On-disk wire layout descriptor for a custom-typed column.
Traits§
- Insert
Record - This trait represents a record for inserting into a table.
- Table
Record - This trait represents a record returned by a
crate::dbms::query::Queryfor a table. - Table
Schema - Table schema representation.
- Update
Record - This trait represents a record for updating a table.
Functions§
- fingerprint_
for_ name - Computes the
TableFingerprintfor an arbitrary table name. - flatten_
table_ columns - Flattens
TableColumnsrows into flat column-value pairs.
Type Aliases§
- Table
Columns - Table
Fingerprint - A type representing a unique fingerprint for a table schema.