Skip to main content

Module db

Module db 

Source
Expand description

Database contracts, model metadata, and SQL naming defaults.

Re-exports§

pub use crate::options::validate_rate_limit_rule;
pub use oauth_provider::oauth_provider_schema;
pub use oauth_provider::OAUTH_ACCESS_TOKEN_MODEL;
pub use oauth_provider::OAUTH_CLIENT_MODEL;
pub use oauth_provider::OAUTH_REFRESH_TOKEN_MODEL;
pub use sql::consume_sql_rate_limit_record;
pub use sql::count_statement;
pub use sql::create_statement;
pub use sql::delete_many_statement;
pub use sql::delete_one_statement;
pub use sql::ensure_executable_migration_plan;
pub use sql::execute_schema_migration_plan;
pub use sql::find_many_statement;
pub use sql::find_many_with_joins_statement;
pub use sql::find_one_statement;
pub use sql::plan_schema_migration;
pub use sql::rate_limit_consume_statements;
pub use sql::rate_limit_count_from_i64;
pub use sql::rate_limit_count_to_i64;
pub use sql::update_many_statement;
pub use sql::update_one_plan;
pub use sql::ColumnToAdd;
pub use sql::DeleteOneStrategy;
pub use sql::IndexToCreate;
pub use sql::MigrationStatement;
pub use sql::MigrationStatementKind;
pub use sql::SchemaMigrationPlan;
pub use sql::SchemaMigrationWarning;
pub use sql::SqlAdapterRunner;
pub use sql::SqlColumnSnapshot;
pub use sql::SqlDeleteOnePlan;
pub use sql::SqlDialect;
pub use sql::SqlExecutor;
pub use sql::SqlFragment;
pub use sql::SqlJoinReadStatement;
pub use sql::SqlParam;
pub use sql::SqlRateLimitNames;
pub use sql::SqlRateLimitPlan;
pub use sql::SqlReadStatement;
pub use sql::SqlRowReader;
pub use sql::SqlSchemaSnapshot;
pub use sql::SqlSelectedField;
pub use sql::SqlStatement;
pub use sql::SqlUpdateOnePlan;
pub use sql::TableToCreate;

Modules§

oauth_provider
Shared OAuth 2.1 provider database schema used by rustauth-oauth-provider and MCP.
sql
Shared SQL planning helpers for SQL-speaking database adapters.

Structs§

Account
Linked credential, OAuth, or social provider account.
AdapterCapabilities
Database adapter capability metadata.
AuthSchema
Schema view for validated table and field names.
AuthSchemaOptions
Options used to build RustAuth’s core database schema metadata.
Count
Count query contract for adapters.
Create
Create query contract for adapters.
DbField
Field metadata used by adapters and migrations.
DbSchema
Schema metadata keyed by logical table name.
DbTable
Table metadata keyed by logical field name.
Delete
Single-row delete query contract for adapters.
DeleteMany
Multi-row delete query contract for adapters.
FindMany
Find-many query contract for adapters.
FindOne
Find-one query contract for adapters.
ForeignKey
Foreign key metadata for adapter and migration implementations.
HookedAdapter
Adapter wrapper that runs plugin database hooks for mutating operations.
IdPolicy
ID field and transform policy.
JoinAdapter
Adapter wrapper that resolves RustAuth join options at runtime.
JoinConfig
Adapter-facing join configuration after relation metadata is resolved.
JoinOn
Resolved join column pair.
JoinOption
User-facing join request before schema relation metadata has been resolved.
JoinResolution
Resolved join metadata plus any base select fields required to execute it.
MemoryAdapter
Async-safe in-memory adapter backed by shared state.
RateLimit
Database-backed rate limit bucket.
SchemaAdapter
Adapter wrapper that maps RustAuth logical schema names to database names.
SchemaCreation
Schema file content produced by an adapter or migration generator.
SchemaTable
Validated logical table bound to the merged auth schema.
Session
Persisted user session.
Sort
Sort clause.
TableOptions
Per-table schema overrides.
Update
Single-row update query contract for adapters.
UpdateMany
Multi-row update query contract for adapters.
User
Core user record.
Verification
Verification token or value used by flows such as email verification.
Where
Adapter query predicate.

Enums§

Connector
Connector between predicates.
DbFieldType
Supported database field kinds for core schema metadata.
DbValue
Primitive value accepted by adapter query predicates.
IdGeneration
ID generation strategy for core database models.
IdValue
Normalized ID value.
JoinRelation
Resolved relation kind for joined output.
OnDelete
Foreign key delete behavior.
RateLimitStorage
Storage backend selected for rate limit counters.
SortDirection
Sort direction.
WhereMode
Case sensitivity for string predicates.
WhereOperator
Predicate operator.

Traits§

DbAdapter
Async database adapter contract used by core authentication behavior.

Functions§

auth_schema
Build RustAuth’s core database schema metadata.
filter_output_fields
Return a copy of a DB record with non-returnable fields removed.
resolve_join_options
run_transaction_without_native_support
Execute a transaction callback directly when native transactions are unavailable.
transform_count_query
transform_count_query_with_capabilities
transform_create_query
transform_create_query_with_capabilities
transform_delete_many_query
transform_delete_many_query_with_capabilities
transform_delete_query
transform_delete_query_with_capabilities
transform_find_many_query
transform_find_many_query_with_capabilities
transform_find_one_query
transform_find_one_query_with_capabilities
transform_update_many_query
transform_update_many_query_with_capabilities
transform_update_query
transform_update_query_with_capabilities

Type Aliases§

AdapterFuture
Boxed async result returned by database adapter methods.
AdapterResult
DbRecord
Dynamic record payload exchanged between core auth logic and adapters.
TransactionAdapter
Adapter handle passed to transaction callbacks.
TransactionCallback
Callback executed inside an adapter transaction.