Skip to main content

Module prelude

Module prelude 

Source
Expand description

Common database primitive re-exports.

Structs§

AffectedRows
A count of affected rows.
BackendName
ColumnMetadata
Column metadata.
ColumnName
A strongly typed database identifier wrapper: ColumnName.
ColumnRef
A column reference with optional table qualification.
ColumnTypeLabel
ConstraintMetadata
Constraint metadata.
ConstraintRef
Constraint reference metadata.
DatabaseDsn
DatabaseEngine
DatabaseName
A strongly typed database identifier wrapper: DatabaseName.
DatabaseUrl
DriverName
A strongly typed database identifier wrapper: DriverName.
DriverVersion
ForeignKey
Foreign key metadata.
HasMore
Whether more results are available.
IndexColumn
An indexed column.
IndexMetadata
Index metadata.
IndexRef
Index reference metadata.
KeyColumn
A key column reference.
MigrationId
MigrationPlan
A migration plan descriptor. This does not execute migrations.
MigrationStep
A migration step descriptor.
PageRequest
Page request metadata.
PrimaryKey
Primary key metadata.
RecordId
RecordKey
RecordRef
A generic record reference.
RelationEndpoint
A relation endpoint label with optionality metadata.
Relationship
Relationship metadata.
ResultPage
Generic result page.
ResultSet
Generic result set container.
RowCount
A row count.
RowId
A row identifier label.
SchemaMetadata
Schema metadata.
SchemaName
A strongly typed database identifier wrapper: SchemaName.
SchemaRef
A database schema reference.
SortKey
TableMetadata
Table metadata.
TableName
A strongly typed database identifier wrapper: TableName.
TableRef
A table reference with optional schema qualification.
TableStats
Basic table statistics.
TotalCount
Total result count metadata.
TransactionId
Transaction identifier label.
UniqueKey
Unique key metadata.

Enums§

BackendKind
Backend kind metadata.
Cardinality
Common cardinality labels.
ConstraintKind
Broad constraint kind.
DatabaseKind
Common database storage families.
DatabaseObjectKind
Common database object kinds.
Deferrability
Deferrability metadata.
DriverCapability
Driver capability metadata.
IndexKind
Broad index kind.
IndexOrder
Index column sort order.
MigrationDirection
Migration direction metadata.
Nullability
Column nullability metadata.
QueryKind
Broad query kind.
QueryMode
Query mode metadata.
RecordStatus
Broad record status.
RowStatus
Broad row status.
SortDirection
Sort direction metadata.
TransactionIsolation
Common transaction isolation levels.
TransactionMode
Transaction mode metadata.