Crate use_database 

use-database

Thin facade crate for primitive RustUse database vocabulary.

This crate is part of the use-database facade workspace. It provides small, engine-neutral vocabulary types and metadata containers. It does not connect to databases, execute queries, run migrations, parse SQL, or model engine-specific behavior.

Example

use use_database::{DatabaseName, PageRequest, TableName};

let database = DatabaseName::new("app").expect("valid database name");
let table = TableName::new("users").expect("valid table name");
let page = PageRequest::new(1, 50);

assert_eq!(database.as_str(), "app");
assert_eq!(table.as_str(), "users");
assert_eq!(page.per_page(), 50);

Thin facade for primitive database vocabulary crates.

Re-exports

pub use use_db_column as column;

pub use use_db_constraint as constraint;

pub use use_db_core as core;

pub use use_db_driver as driver;

pub use use_db_index as index;

pub use use_db_key as key;

pub use use_db_migration as migration;

pub use use_db_name as name;

pub use use_db_query as query;

pub use use_db_record as record;

pub use use_db_relation as relation;

pub use use_db_result as result;

pub use use_db_row as row;

pub use use_db_schema as schema;

pub use use_db_table as table;

pub use use_db_transaction as transaction;

pub use use_db_url as url;

Modules

prelude

Common database primitive re-exports.

Structs

AffectedRows

A count of affected rows.

BackendFeature

BackendName

CheckExpressionLabel

A check expression label, not an executable expression.

CollectionName

A strongly typed database identifier wrapper: CollectionName.

ColumnDefault

ColumnMetadata

Column metadata.

ColumnName

A strongly typed database identifier wrapper: ColumnName.

ColumnOrdinal

A one-based column ordinal.

ColumnRef

A column reference with optional table qualification.

ColumnTypeLabel

ConnectionName

A strongly typed database identifier wrapper: ConnectionName.

ConstraintMetadata

Constraint metadata.

ConstraintName

A strongly typed database identifier wrapper: ConstraintName.

ConstraintRef

Constraint reference metadata.

Cursor

CursorPosition

A cursor position label.

DatabaseCapability

DatabaseDialect

DatabaseDsn

DatabaseEngine

DatabaseFeature

DatabaseHost

DatabaseName

A strongly typed database identifier wrapper: DatabaseName.

DatabasePath

A database URL path component.

DatabasePort

A database network port.

DatabaseScheme

A database URL scheme such as postgresql or sqlite.

DatabaseUrl

DatabaseUrlParts

Lightweight parts extracted from a database URL.

DatabaseVersion

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.

IndexName

A strongly typed database identifier wrapper: IndexName.

IndexRef

Index reference metadata.

KeyColumn

A key column reference.

Limit

Limit count metadata.

MigrationAppliedAt

MigrationChecksum

MigrationId

MigrationName

A strongly typed database identifier wrapper: MigrationName.

MigrationPlan

A migration plan descriptor. This does not execute migrations.

MigrationStep

A migration step descriptor.

MigrationVersion

Offset

Offset count metadata.

PageInfo

Page metadata.

PageRequest

Page request metadata.

PoolName

A strongly typed database identifier wrapper: PoolName.

PrimaryKey

Primary key metadata.

Projection

Projection metadata.

QueryLabel

QueryTimeout

Query timeout in milliseconds.

RecordId

RecordKey

RecordRef

A generic record reference.

RecordVersion

A monotonically meaningful record version value.

RelationEndpoint

A relation endpoint label with optionality metadata.

RelationName

A strongly typed database identifier wrapper: RelationName.

RelationRef

Relation reference metadata.

Relationship

Relationship metadata.

ResultPage

Generic result page.

ResultSet

Generic result set container.

ResultSetMetadata

Result set metadata.

RowCount

A row count.

RowId

A row identifier label.

RowNumber

A one-based row number.

SchemaMetadata

Schema metadata.

SchemaName

A strongly typed database identifier wrapper: SchemaName.

SchemaNamespace

A schema namespace search list.

SchemaRef

A database schema reference.

SchemaVersion

A schema version label.

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.

ConstraintStatus

Constraint status metadata.

DatabaseError

Error returned by primitive database vocabulary constructors.

DatabaseKind

Common database storage families.

DatabaseNameError

Error returned when a database identifier wrapper rejects input.

DatabaseObjectKind

Common database object kinds.

Deferrability

Deferrability metadata.

DriverCapability

Driver capability metadata.

FilterOperator

Filter operator vocabulary.

IndexKind

Broad index kind.

IndexOrder

Index column sort order.

IndexUniqueness

Index uniqueness metadata.

KeyKind

Broad database key kind.

MigrationDirection

Migration direction metadata.

MigrationStatus

Migration status metadata.

Nullability

Column nullability metadata.

QueryKind

Broad query kind.

QueryMode

Query mode metadata.

RecordStatus

Broad record status.

RelationKind

Broad relation kind.

RowStatus

Broad row status.

SchemaObject

Objects that may be described as members of a schema-like namespace.

SortDirection

Sort direction metadata.

TableKind

Broad table families.

TableStatus

Broad table lifecycle status.

TransactionBoundary

Transaction boundary metadata.

TransactionIsolation

Common transaction isolation levels.

TransactionMode

Transaction mode metadata.

TransactionOutcome

Transaction outcome metadata.

TransactionState

Transaction state metadata.

Type Aliases

CandidateKey

Candidate key metadata.

CompositeKey

Composite key metadata.

DatabaseResult

Result alias for primitive database vocabulary operations.