Skip to main content

Module db

Module db 

Source
Expand description

Database contracts, model metadata, and SQL naming defaults.

Modules§

sql
Shared SQL planning helpers for SQL-speaking database adapters.

Structs§

Account
Linked credential, OAuth, or social provider account.
AdapterCapabilities
Database adapter capability metadata.
AuthSchemaOptions
Options used to build OpenAuth’s core database schema metadata.
ColumnToAdd
A column missing from an existing table and planned for additive creation.
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.
IndexToCreate
A standalone index missing from the database and planned for creation.
JoinAdapter
Adapter wrapper that resolves OpenAuth 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.
MigrationStatement
A SQL statement emitted by a migration plan.
RateLimit
Database-backed rate limit bucket.
SchemaAdapter
Adapter wrapper that maps OpenAuth logical schema names to database names.
SchemaCreation
Schema file content produced by an adapter or migration generator.
SchemaMigrationPlan
Additive schema changes planned for a live database.
Session
Persisted user session.
Sort
Sort clause.
SqlAdapterRunner
Shared CRUD runner for SQL adapters that can execute raw SQL.
SqlColumnSnapshot
Introspected column metadata used by the pure migration planner.
SqlDeleteOnePlan
Shared single-row delete statement.
SqlFragment
A SQL fragment plus its ordered parameters.
SqlJoinReadStatement
A native join read statement and borrowed metadata needed for row grouping.
SqlParam
A database value paired with the field type needed to bind NULLs correctly.
SqlRateLimitNames
Physical database names used by SQL-backed rate limit stores.
SqlRateLimitPlan
SQL statements used by database-backed rate limit stores.
SqlReadStatement
A read statement and the metadata needed to decode its result rows.
SqlSchemaSnapshot
Introspected database schema used by the pure migration planner.
SqlSelectedField
Field selected by a SQL read statement.
SqlStatement
A complete SQL statement plus its ordered parameters.
TableOptions
Per-table schema overrides.
TableToCreate
A table missing from the database and planned for creation.
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.
DeleteOneStrategy
Dialect strategy used to delete only one matching row.
IdGeneration
ID generation strategy for core database models.
IdValue
Normalized ID value.
JoinRelation
Resolved relation kind for joined output.
MigrationStatementKind
The additive operation represented by a migration statement.
OnDelete
Foreign key delete behavior.
RateLimitStorage
Storage backend selected for rate limit counters.
SchemaMigrationWarning
Non-executable findings discovered while planning migrations.
SortDirection
Sort direction.
SqlDialect
SQL dialect supported by OpenAuth’s shared SQL planner.
SqlUpdateOnePlan
Shared single-row update strategy.
WhereMode
Case sensitivity for string predicates.
WhereOperator
Predicate operator.

Traits§

DbAdapter
Async database adapter contract used by core authentication behavior.
SqlExecutor
Minimal async execution boundary required by the shared SQL runner.
SqlRowReader
Driver row decoding boundary for converting raw driver rows into OpenAuth values.

Functions§

auth_schema
Build OpenAuth’s core database schema metadata.
consume_sql_rate_limit_record
Applies OpenAuth rate-limit semantics to a locked database record.
count_statement
create_statement
delete_many_statement
delete_one_statement
execute_schema_migration_plan
Executes a pure migration plan through any SQL executor.
filter_output_fields
Return a copy of a DB record with non-returnable fields removed.
find_many_statement
find_many_with_joins_statement
find_one_statement
plan_schema_migration
Compares a target OpenAuth schema with a SQL schema snapshot and emits an additive plan.
rate_limit_consume_statements
Builds the dialect-specific statement trio used by SQL-backed rate-limit stores.
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
update_many_statement
update_one_plan

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.