@breadstone/archipel-platform-database
Classes
| Class | Description |
|---|---|
| DatabaseHealthIndicator | Health indicator for database connectivity. |
| DatabaseModule | - |
| DatabaseService | Represents the database service. |
| PrismaService | Represents the prisma service. |
| RepositoryBase | The base class for all repositories. |
| RepositoryBase2 | Minimal repository base that exposes the underlying Prisma delegate and provides a typed pipe helper for functional operators. |
| RepositoryExceptionFilter | Represents the Prisma client exception filter. |
Interfaces
| Interface | Description |
|---|---|
| ICursorPaginatedResult | Represents the result of a cursor-paginated query. |
| ICursorPaginateOptions | Options for cursor-based pagination. |
| IDatabaseModuleConfig | Represents the database module configuration. |
| IPaginatedResult | - |
| IPaginateOptions | - |
| IPrismaServiceOptions | Represents the options for the PrismaService. |
| IRepositoryQuery | Represents a reusable query definition for repositories. |
| IRepositoryQuery2 | Represents a reusable query definition for repositories. |
| ITransactionalRepositoryQuery | Represents a repository query that requires a Prisma TransactionClient to access multiple delegates. |
Type Aliases
| Type Alias | Description |
|---|---|
| CursorPaginateFunction | The type of a cursor paginate function. |
| DelegateArgs | - |
| DelegateOperations | Extracts 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 | - |
| QueryResultType | Extracts the result type from a repository query. Useful for type-safe mapping without duplicating query result types. |
| RepositoryOperationsAll | Superset of all known Prisma model delegate operations across every supported database provider. |
| RepositoryOperationsBase | The baseline set of operations available on every Prisma provider (PostgreSQL, CockroachDB, SQLite, MySQL, MariaDB, SQL Server, MongoDB). |
| TransactionalQueryResultType | Extracts the result type from a transactional repository query. |
Variables
| Variable | Description |
|---|---|
| DATABASE_MODULE_CONFIG | Represents the database module. |
| DB_AUTO_CONNECTION | Whether to skip the automatic database connection on module init. |
| PLATFORM_DATABASE_CONFIG_ENTRIES | Core configuration entries required by platform-database. |
Functions
| Function | Description |
|---|---|
| aggregate | Executes an aggregate query via the delegate aggregate method. |
| aggregateRaw | Executes a raw aggregate query via the delegate aggregateRaw method. |
| count | Counts records via the delegate count method. |
| create | Creates a record using the underlying delegate create method. |
| createMany | Creates multiple records via the delegate createMany method. |
| createManyAndReturn | Creates multiple records and returns them via the delegate createManyAndReturn method. |
| cursorPaginator | Creates a cursor-based pagination function with the given default options. |
| findFirst | Creates an operator that executes a findFirst query with the provided arguments. |
| findFirstOrThrow | Finds the first record matching the criteria via the delegate findFirstOrThrow method. Throws a PrismaClientKnownRequestError with code P2025 if no record is found. |
| findMany | Finds many records via the delegate findMany method. |
| findManyPaged | Finds many records with pagination using the delegate findMany method. |
| findRaw | Executes a raw find query via the delegate findRaw method. |
| findUnique | Finds a unique record via the delegate findUnique method. |
| findUniqueOrThrow | Finds a unique record via the delegate findUniqueOrThrow method. Throws a PrismaClientKnownRequestError with code P2025 if no record is found. |
| groupBy | Performs a group-by query via the delegate groupBy method. |
| pageable | - |
| paginator | - |
| pipe | Executes a single operator against the provided delegate. |
| pipeAll | Sequentially executes multiple operators. The last result is returned. Useful for multi-step dependent operations. |
| query | Creates a new repository query. |
| query2 | Creates a new repository query. |
| remove | Deletes a single record via the delegate delete method. |
| removeMany | Deletes multiple records via the delegate deleteMany method. |
| skip | Utility 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. |
| transactionalQuery | Factory to create a transactional repository query. |
| update | Updates a single record via the delegate update method. |
| updateMany | Updates multiple records via the delegate updateMany method. |
| updateManyAndReturn | Updates multiple records and returns them via the delegate updateManyAndReturn method. |
| upsert | Creates or updates a record via the delegate upsert method. |