Skip to content
@archipel/platform-database Auto-generated

@breadstone/archipel-platform-database

Classes

ClassDescription
DatabaseHealthIndicatorHealth indicator for database connectivity.
DatabaseModule-
DatabaseServiceRepresents the database service.
PrismaServiceRepresents the prisma service.
RepositoryBaseThe base class for all repositories.
RepositoryBase2Minimal repository base that exposes the underlying Prisma delegate and provides a typed pipe helper for functional operators.
RepositoryExceptionFilterRepresents the Prisma client exception filter.

Interfaces

InterfaceDescription
ICursorPaginatedResultRepresents the result of a cursor-paginated query.
ICursorPaginateOptionsOptions for cursor-based pagination.
IDatabaseModuleConfigRepresents the database module configuration.
IPaginatedResult-
IPaginateOptions-
IPrismaServiceOptionsRepresents the options for the PrismaService.
IRepositoryQueryRepresents a reusable query definition for repositories.
IRepositoryQuery2Represents a reusable query definition for repositories.
ITransactionalRepositoryQueryRepresents a repository query that requires a Prisma TransactionClient to access multiple delegates.

Type Aliases

Type AliasDescription
CursorPaginateFunctionThe type of a cursor paginate function.
DelegateArgs-
DelegateOperationsExtracts the subset of known Prisma operations that a concrete delegate actually implements. Useful for type-level checks without requiring the consumer to state the provider explicitly.
DelegateReturnTypes-
PaginateFunction-
QueryResultTypeExtracts the result type from a repository query. Useful for type-safe mapping without duplicating query result types.
RepositoryOperationsAllSuperset of all known Prisma model delegate operations across every supported database provider.
RepositoryOperationsBaseThe baseline set of operations available on every Prisma provider (PostgreSQL, CockroachDB, SQLite, MySQL, MariaDB, SQL Server, MongoDB).
TransactionalQueryResultTypeExtracts the result type from a transactional repository query.

Variables

VariableDescription
DATABASE_MODULE_CONFIGRepresents the database module.
DB_AUTO_CONNECTIONWhether to skip the automatic database connection on module init.
PLATFORM_DATABASE_CONFIG_ENTRIESCore configuration entries required by platform-database.

Functions

FunctionDescription
aggregateExecutes an aggregate query via the delegate aggregate method.
aggregateRawExecutes a raw aggregate query via the delegate aggregateRaw method.
countCounts records via the delegate count method.
createCreates a record using the underlying delegate create method.
createManyCreates multiple records via the delegate createMany method.
createManyAndReturnCreates multiple records and returns them via the delegate createManyAndReturn method.
cursorPaginatorCreates a cursor-based pagination function with the given default options.
findFirstCreates an operator that executes a findFirst query with the provided arguments.
findFirstOrThrowFinds the first record matching the criteria via the delegate findFirstOrThrow method. Throws a PrismaClientKnownRequestError with code P2025 if no record is found.
findManyFinds many records via the delegate findMany method.
findManyPagedFinds many records with pagination using the delegate findMany method.
findRawExecutes a raw find query via the delegate findRaw method.
findUniqueFinds a unique record via the delegate findUnique method.
findUniqueOrThrowFinds a unique record via the delegate findUniqueOrThrow method. Throws a PrismaClientKnownRequestError with code P2025 if no record is found.
groupByPerforms a group-by query via the delegate groupBy method.
pageable-
paginator-
pipeExecutes a single operator against the provided delegate.
pipeAllSequentially executes multiple operators. The last result is returned. Useful for multi-step dependent operations.
queryCreates a new repository query.
query2Creates a new repository query.
removeDeletes a single record via the delegate delete method.
removeManyDeletes multiple records via the delegate deleteMany method.
skipUtility function that returns the provided value or undefined if the value is undefined. In Prisma 6+, passing undefined for a field in a query signals Prisma to skip that field.
transactionalQueryFactory to create a transactional repository query.
updateUpdates a single record via the delegate update method.
updateManyUpdates multiple records via the delegate updateMany method.
updateManyAndReturnUpdates multiple records and returns them via the delegate updateManyAndReturn method.
upsertCreates or updates a record via the delegate upsert method.

Released under the MIT License.