comon_orm library
Classes
- AggregateQuery
- Backend-neutral aggregate query.
- AggregateQueryResult
- Aggregate output returned by AggregateQuery and GroupByQuery.
- BoolFilter
- Boolean field predicates used in generated and manual query inputs.
- ComonOrmClient
- Entry point for ad-hoc access to models through a DatabaseAdapter.
- CountQuery
- Query object for counting records.
- CreateManyQuery
- Query object for inserting multiple records in a single operation.
- CreateQuery
- Query object for creating a single record.
- CreateRelationWrite
- Nested create payload for a single relation.
-
CursorPage<
T, TCursor> - One cursor-based page of results together with the cursor for the next page.
- DatabaseAdapter
- Backend contract used by generated clients and low-level query delegates.
- DatabaseExecutionMiddleware
- Optional execution wrapper for middleware that must scope the query run.
- DatabaseMiddleware
- Hook surface for observing or mutating adapter operations.
- DatabaseMiddlewareContext
- Mutable middleware context passed to DatabaseMiddleware.beforeQuery.
- DatabaseMiddlewareResult
- Result passed to DatabaseMiddleware.afterQuery.
- DeleteManyQuery
- Query object for bulk deletes.
- DeleteQuery
- Query object for deleting a single record.
- DirectoryMigrationReader
- Filesystem-backed runtime migration reader.
- DoubleFilter
- Numeric predicates used by aggregate filters and numeric comparisons.
- FindFirstQuery
- Query object for fetching the first matching record.
- FindManyQuery
- Query object for fetching multiple records.
- FindUniqueQuery
- Query object for fetching a unique record.
- GeneratedDatasourceMetadata
- Generated datasource metadata for runtime bootstrap.
- GeneratedDatasourceUrl
- Generated datasource URL description for runtime bootstrap.
- GeneratedEnumMetadata
- Generated enum metadata for runtime lookup and normalization.
- GeneratedFieldDefaultMetadata
- Generated default metadata for a field.
- GeneratedFieldMetadata
- Generated field metadata used by runtime bridge and adapters.
- GeneratedModelMetadata
- Generated model metadata for runtime lookup and relation resolution.
- GeneratedRelationMetadata
- Generated relation metadata attached to a relation field.
- GeneratedRuntimeSchema
- Root generated runtime schema emitted by generated clients.
- GroupByOrderBy
- Ordering entry used by group-by queries.
- GroupByQuery
- Backend-neutral group-by query.
- GroupByQueryResultRow
- Single grouped row returned by GroupByQuery.
- InMemoryDatabaseAdapter
- In-memory adapter intended for tests, examples, and local experimentation.
- IntFilter
- Integer field predicates used in generated and manual query inputs.
- MiddlewareDatabaseAdapter
- Decorator that applies DatabaseMiddleware to a DatabaseAdapter.
- MigrationArtifact
- Runtime migration artifact consumed by MigrationExecutor.
- MigrationCapableDatabaseAdapter
-
Adapter capability required by
ComonOrm.migrate(...). - MigrationExecutor
- Runtime migration executor created by provider adapters.
- MigrationReader
- Source of runtime migration artifacts.
- ModelDelegate
- Binds model-scoped query objects to a concrete model name.
- NumericAggregatesFilter
-
Numeric aggregate filters used in generated
havinginputs. - QueryAggregatePredicate
-
Aggregate predicate used by
havingand aggregate-aware ordering. - QueryCountAggregateResult
- Count values returned by an aggregate query.
- QueryCountSelection
- Count selection for aggregate and group-by queries.
- QueryCursor
- Unique cursor selector used for cursor-based pagination.
- QueryInclude
- Include tree for eager-loading relations.
- QueryIncludeEntry
- Single entry inside an include tree.
- QueryLogEntry
- Captures one executed SQL statement together with its runtime metadata.
- QueryLoggingMiddleware
- Built-in middleware that logs executed SQL statements.
- QueryLogicalGroup
- Logical OR group represented as branches of predicates.
- QueryOrderBy
- Single field ordering entry.
- QueryPredicate
- Backend-neutral predicate used by adapters.
- QueryRelation
- Relation metadata used for includes, filters, and nested writes.
- QueryRelationFilter
- Relation-scoped predicates used by nested filters.
- QuerySelect
- Scalar field projection.
- ResolvedRuntimeDatasourceConfig
- Datasource settings resolved from runtime metadata.
- RuntimeDatasourceResolver
- Resolves datasource configuration from runtime metadata bridges.
- RuntimeDatasourceUrlView
- Runtime view of a datasource URL.
- RuntimeDatasourceView
- Runtime datasource bridge.
- RuntimeEnumView
- Runtime enum bridge.
- RuntimeFieldDefaultView
- Runtime view of a field default.
- RuntimeFieldView
- Runtime field bridge.
- RuntimeImplicitManyToManyStorage
- Bridge-level implicit many-to-many storage description.
- RuntimeModelView
- Runtime model bridge.
- RuntimeRelationView
- Runtime relation view resolved from AST or generated metadata.
- RuntimeSchemaView
- Runtime schema bridge used by adapters and bootstrap helpers.
- StringFilter
- String field predicates used in generated and manual query inputs.
- UpdateManyQuery
- Query object for bulk updates.
- UpdateQuery
- Query object for updating a single record.
- UpsertManyEntry
- Single entry payload for a bulk upsert operation.
- UpsertManyQuery
- Query object for bulk upserts.
- UpsertQuery
- Query object for atomically creating or updating a single record.
Enums
- DatabaseMiddlewareOperation
- Operation kinds that can be intercepted by DatabaseMiddleware.
- GeneratedDatasourceUrlKind
- Parser-independent URL source kinds for generated datasource metadata.
- GeneratedRuntimeDefaultKind
- Runtime default-value strategies relevant to adapters.
- GeneratedRuntimeFieldKind
- Runtime field categories used by generated metadata.
- GeneratedRuntimeRelationCardinality
- Cardinality of a generated relation from the source field point of view.
- GeneratedRuntimeRelationStorageKind
- Physical storage strategy for a generated relation.
- IncludeStrategy
- Strategy an adapter should use to resolve include relations.
- QueryAggregateFunction
- Aggregate function names supported by the query engine.
- QueryRelationCardinality
- Cardinality of a relation from the source model point of view.
- QueryRelationStorageKind
- Physical storage strategy used by a relation.
- QueryStringMode
- Case-sensitivity mode for string filter predicates.
- RuntimeDatasourceUrlKind
- Bridge-level datasource URL kinds used by runtime metadata consumers.
- RuntimeDefaultKind
- Bridge-level default strategies relevant to runtime behavior.
- RuntimeFieldKind
- Bridge-level field categories used by runtime consumers.
- RuntimeRelationCardinality
- Bridge-level relation cardinality.
- RuntimeRelationStorageKind
- Bridge-level relation storage kind.
- SortOrder
-
Sort direction used in
orderByclauses.
Functions
-
applyDistinctRecords(
Iterable< Map< records, Iterable<String, Object?> >String> fields) → List<Map< String, Object?> > -
Returns
recordswith duplicate rows removed according tofields. -
collectRuntimeImplicitManyToManyStorages(
RuntimeSchemaView schema) → List< RuntimeImplicitManyToManyStorage> - Collects all implicit many-to-many storages from a runtime schema view.
-
computeAggregateQueryResult(
Iterable< Map< records, AggregateQuery query) → AggregateQueryResultString, Object?> > -
Computes aggregate values for
recordsaccording toquery. -
computeGroupByQueryResultRows(
Iterable< Map< records, GroupByQuery query) → List<String, Object?> >GroupByQueryResultRow> -
Computes grouped rows for
recordsaccording toquery. -
formatQueryLogEntry(
QueryLogEntry entry) → String - Formats a query log entry into a readable single-line summary.
-
printQueryLogEntry(
QueryLogEntry entry) → void - Writes query log entries to print.
-
resolveRuntimeImplicitManyToManyStorage(
{required RuntimeSchemaView schema, required String sourceModelName, required String relationFieldName}) → RuntimeImplicitManyToManyStorage? - Resolves the storage mapping for a runtime implicit many-to-many relation.
-
runLoggedQuery<
T> ({required String sql, List< Object?> parameters = const <Object?>[], required FutureOr<T> action(), Object? result}) → Future<T> - Runs one SQL statement under the active QueryLoggingMiddleware, if any.
-
runLoggedQuerySync<
T> ({required String sql, List< Object?> parameters = const <Object?>[], required T action(), Object? result}) → T - Runs one synchronous SQL statement under the active QueryLoggingMiddleware, if any.
-
runtimeSchemaViewFromGeneratedSchema(
GeneratedRuntimeSchema schema) → RuntimeSchemaView -
Creates a runtime schema bridge over
schema. -
runtimeSchemaViewFromSchemaDocument(
SchemaDocument schema) → RuntimeSchemaView -
Creates a runtime schema bridge over
schema.
Typedefs
- QueryLogWriter = void Function(QueryLogEntry entry)
- Callback used by QueryLoggingMiddleware to emit query log entries.
- RuntimeDatasourceUrlResolver = String Function(String schemaPath, String rawUrl, String provider)
- Provider-specific runtime datasource URL normalization hook.
Exceptions / Errors
- RuntimeValidationError
- Error thrown when a generated/delegate query fails runtime validation.