@breadstone/archipel-mcp 0.0.23 → 0.0.26
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/data/guides/caching.md +33 -0
- package/data/guides/email-delivery.md +27 -1
- package/data/guides/esigning-integration.md +11 -5
- package/data/guides/health-indicators.md +220 -0
- package/data/guides/index.md +2 -0
- package/data/guides/queue-infrastructure.md +329 -0
- package/data/guides/telemetry-and-observability.md +20 -0
- package/data/packages/platform-analytics/api/Class.AnalyticsClientPort.md +20 -0
- package/data/packages/platform-analytics/api/Class.AnalyticsHealthIndicator.md +78 -0
- package/data/packages/platform-analytics/api/Class.AppInsightsAnalyticsClient.md +24 -0
- package/data/packages/platform-analytics/api/Class.DatadogAnalyticsClient.md +24 -0
- package/data/packages/platform-analytics/api/Class.NoopAnalyticsClient.md +24 -0
- package/data/packages/platform-analytics/api/Class.SentryAnalyticsClient.md +24 -0
- package/data/packages/platform-analytics/api/index.md +1 -0
- package/data/packages/platform-analytics/index.md +25 -1
- package/data/packages/platform-authentication/api/Class.AuthenticationHealthIndicator.md +68 -0
- package/data/packages/platform-authentication/api/index.md +1 -0
- package/data/packages/platform-authentication/index.md +25 -1
- package/data/packages/platform-blob-storage/api/Class.BlobHealthIndicator.md +7 -7
- package/data/packages/platform-blob-storage/api/Class.BlobModule.md +2 -2
- package/data/packages/platform-blob-storage/api/Interface.IAwsS3BlobProviderRegistration.md +3 -3
- package/data/packages/platform-blob-storage/api/Interface.IAzureBlobProviderRegistration.md +3 -3
- package/data/packages/platform-blob-storage/api/Interface.IBlobModuleOptions.md +5 -5
- package/data/packages/platform-blob-storage/api/Interface.ICustomBlobProviderRegistration.md +3 -3
- package/data/packages/platform-blob-storage/api/Interface.IVercelBlobProviderRegistration.md +3 -3
- package/data/packages/platform-blob-storage/api/TypeAlias.IBlobProviderRegistration.md +1 -1
- package/data/packages/platform-blob-storage/api/index.md +1 -1
- package/data/packages/platform-blob-storage/index.md +19 -14
- package/data/packages/platform-caching/api/Class.MemoryLayeredCache.md +10 -10
- package/data/packages/platform-caching/api/Class.NoopCacheMetricsRecorder.md +6 -6
- package/data/packages/platform-caching/api/Class.RedisLayeredCache.md +10 -10
- package/data/packages/platform-caching/api/Interface.ILayeredCache.md +9 -9
- package/data/packages/platform-caching/api/Interface.ILayeredCacheOptions.md +6 -6
- package/data/packages/platform-caching/api/Variable.CACHE_DEFAULT_TTL_MS.md +14 -0
- package/data/packages/platform-caching/api/Variable.CACHE_MAX_ENTRIES.md +14 -0
- package/data/packages/platform-caching/api/Variable.CACHE_STALE_WHILE_REVALIDATE.md +14 -0
- package/data/packages/platform-caching/api/Variable.PLATFORM_CACHING_CONFIG_ENTRIES.md +14 -0
- package/data/packages/platform-caching/api/Variable.REDIS_CONFIG_ENTRIES.md +14 -0
- package/data/packages/platform-caching/api/Variable.REDIS_KEY_PREFIX.md +14 -0
- package/data/packages/platform-caching/api/Variable.REDIS_TTL_SECONDS.md +14 -0
- package/data/packages/platform-caching/api/Variable.REDIS_URL.md +14 -0
- package/data/packages/platform-caching/api/index.md +13 -0
- package/data/packages/platform-caching/index.md +47 -1
- package/data/packages/platform-configuration/api/Function.createConfigKey.md +1 -1
- package/data/packages/platform-core/api/Class.HttpLoggerMiddleware.md +3 -3
- package/data/packages/platform-core/api/Function.maskSensitive.md +26 -0
- package/data/packages/platform-core/api/Function.maskSensitiveFields.md +26 -0
- package/data/packages/platform-core/api/index.md +2 -0
- package/data/packages/platform-core/index.md +11 -0
- package/data/packages/platform-database/api/Class.DatabaseHealthIndicator.md +8 -6
- package/data/packages/platform-database/api/Class.DatabaseModule.md +3 -3
- package/data/packages/platform-database/api/Class.RepositoryBase.md +113 -49
- package/data/packages/platform-database/api/Class.RepositoryBase2.md +171 -0
- package/data/packages/platform-database/api/Function.aggregate.md +33 -0
- package/data/packages/platform-database/api/Function.aggregateRaw.md +34 -0
- package/data/packages/platform-database/api/Function.count.md +33 -0
- package/data/packages/platform-database/api/Function.create.md +33 -0
- package/data/packages/platform-database/api/Function.createMany.md +33 -0
- package/data/packages/platform-database/api/Function.createManyAndReturn.md +35 -0
- package/data/packages/platform-database/api/Function.findFirst.md +35 -0
- package/data/packages/platform-database/api/Function.findFirstOrThrow.md +34 -0
- package/data/packages/platform-database/api/Function.findMany.md +32 -0
- package/data/packages/platform-database/api/Function.findManyPaged.md +34 -0
- package/data/packages/platform-database/api/Function.findRaw.md +34 -0
- package/data/packages/platform-database/api/Function.findUnique.md +32 -0
- package/data/packages/platform-database/api/Function.findUniqueOrThrow.md +34 -0
- package/data/packages/platform-database/api/Function.groupBy.md +33 -0
- package/data/packages/platform-database/api/Function.paginator.md +1 -1
- package/data/packages/platform-database/api/Function.pipe.md +34 -0
- package/data/packages/platform-database/api/Function.pipeAll.md +35 -0
- package/data/packages/platform-database/api/Function.query2.md +35 -0
- package/data/packages/platform-database/api/Function.remove.md +33 -0
- package/data/packages/platform-database/api/Function.removeMany.md +33 -0
- package/data/packages/platform-database/api/Function.update.md +33 -0
- package/data/packages/platform-database/api/Function.updateMany.md +33 -0
- package/data/packages/platform-database/api/Function.updateManyAndReturn.md +35 -0
- package/data/packages/platform-database/api/Function.upsert.md +33 -0
- package/data/packages/platform-database/api/Interface.IDatabaseModuleConfig.md +3 -3
- package/data/packages/platform-database/api/Interface.IRepositoryQuery2.md +45 -0
- package/data/packages/platform-database/api/TypeAlias.DelegateArgs.md +1 -1
- package/data/packages/platform-database/api/TypeAlias.DelegateOperations.md +29 -0
- package/data/packages/platform-database/api/TypeAlias.DelegateReturnTypes.md +1 -1
- package/data/packages/platform-database/api/TypeAlias.PaginateFunction.md +1 -1
- package/data/packages/platform-database/api/TypeAlias.RepositoryOperationsAll.md +19 -0
- package/data/packages/platform-database/api/TypeAlias.RepositoryOperationsBase.md +34 -0
- package/data/packages/platform-database/api/Variable.DATABASE_MODULE_CONFIG.md +1 -1
- package/data/packages/platform-database/api/index.md +29 -1
- package/data/packages/platform-database/index.md +17 -5
- package/data/packages/platform-documents/api/Class.DocumentEngine.md +9 -5
- package/data/packages/platform-documents/index.md +1 -1
- package/data/packages/platform-esigning/api/Class.AdobeSignEsigningProvider.md +24 -0
- package/data/packages/platform-esigning/api/Class.DocuSignEsigningProvider.md +24 -0
- package/data/packages/platform-esigning/api/Class.DropboxSignEsigningProvider.md +24 -0
- package/data/packages/platform-esigning/api/Class.EsigningClientPort.md +20 -0
- package/data/packages/platform-esigning/api/Class.EsigningHealthIndicator.md +78 -0
- package/data/packages/platform-esigning/api/Class.InternalEsigningProvider.md +24 -0
- package/data/packages/platform-esigning/api/index.md +1 -0
- package/data/packages/platform-esigning/index.md +26 -2
- package/data/packages/platform-health/api/Class.HealthModule.md +42 -0
- package/data/packages/platform-health/api/Class.HealthOrchestrator.md +64 -0
- package/data/packages/platform-health/api/Interface.IHealthCheckResult.md +46 -0
- package/data/packages/platform-health/api/Interface.IHealthIndicator.md +41 -0
- package/data/packages/platform-health/api/Variable.HEALTH_INDICATORS_TOKEN.md +14 -0
- package/data/packages/platform-health/api/index.md +26 -0
- package/data/packages/platform-health/index.md +18 -7
- package/data/packages/platform-intelligence/api/Class.IntelligenceHealthIndicator.md +78 -0
- package/data/packages/platform-intelligence/api/index.md +1 -0
- package/data/packages/platform-intelligence/index.md +24 -1
- package/data/packages/platform-logging/api/Class.ContextLogger.md +152 -0
- package/data/packages/platform-logging/api/Class.LoggerModule.md +8 -2
- package/data/packages/platform-logging/api/Class.RequestContextStore.md +90 -0
- package/data/packages/platform-logging/api/Class.RequestIdMiddleware.md +68 -0
- package/data/packages/platform-logging/api/Interface.IRequestContext.md +34 -0
- package/data/packages/platform-logging/api/Variable.REQUEST_ID_HEADER.md +14 -0
- package/data/packages/platform-logging/api/index.md +11 -1
- package/data/packages/platform-logging/index.md +89 -7
- package/data/packages/platform-mailing/api/Class.MailHealthIndicator.md +5 -5
- package/data/packages/platform-mailing/api/Class.MailModule.md +28 -1
- package/data/packages/platform-mailing/api/Class.MailVerificationService.md +49 -16
- package/data/packages/platform-mailing/api/Class.SmtpConnectionVerifier.md +84 -0
- package/data/packages/platform-mailing/api/Interface.IMailModuleOptions.md +36 -0
- package/data/packages/platform-mailing/api/index.md +3 -1
- package/data/packages/platform-mailing/index.md +64 -8
- package/data/packages/platform-mapping/api/Class.MappingBuilder.md +110 -0
- package/data/packages/platform-mapping/api/Class.MappingError.md +56 -0
- package/data/packages/platform-mapping/api/Class.MappingModule.md +46 -0
- package/data/packages/platform-mapping/api/Class.MappingNotRegisteredError.md +52 -0
- package/data/packages/platform-mapping/api/Class.MappingProfileBase.md +52 -0
- package/data/packages/platform-mapping/api/Class.MappingService.md +284 -0
- package/data/packages/platform-mapping/api/Class.TypeMappingNotRegisteredError.md +53 -0
- package/data/packages/platform-mapping/api/Function.createMappingKey.md +39 -0
- package/data/packages/platform-mapping/api/Interface.IMappingBuilder.md +76 -0
- package/data/packages/platform-mapping/api/Interface.IMappingKey.md +58 -0
- package/data/packages/platform-mapping/api/Interface.IMappingProfile.md +32 -0
- package/data/packages/platform-mapping/api/TypeAlias.Constructor.md +28 -0
- package/data/packages/platform-mapping/api/index.md +38 -0
- package/data/packages/platform-mcp/api/Class.McpHealthIndicator.md +78 -0
- package/data/packages/platform-mcp/api/index.md +1 -0
- package/data/packages/platform-mcp/index.md +24 -1
- package/data/packages/platform-openapi/api/Function.SwaggerFeature.md +2 -2
- package/data/packages/platform-openapi/api/Function.getSwaggerFeatureMetadata.md +2 -2
- package/data/packages/platform-payments/api/Class.LemonSqueezyClient.md +24 -0
- package/data/packages/platform-payments/api/Class.MollieClient.md +24 -0
- package/data/packages/platform-payments/api/Class.PaddleClient.md +24 -0
- package/data/packages/platform-payments/api/Class.PaymentClientPort.md +20 -0
- package/data/packages/platform-payments/api/Class.PaymentHealthIndicator.md +78 -0
- package/data/packages/platform-payments/api/Class.StripeClient.md +28 -4
- package/data/packages/platform-payments/api/index.md +1 -0
- package/data/packages/platform-payments/index.md +26 -2
- package/data/packages/platform-queue/api/Class.AzureQueue.md +221 -0
- package/data/packages/platform-queue/api/Class.BullMqQueue.md +220 -0
- package/data/packages/platform-queue/api/Class.MemoryQueue.md +194 -0
- package/data/packages/platform-queue/api/Class.QueueError.md +51 -0
- package/data/packages/platform-queue/api/Class.QueueHealthIndicator.md +68 -0
- package/data/packages/platform-queue/api/Class.QueueJobNotFoundError.md +43 -0
- package/data/packages/platform-queue/api/Class.QueueJobStateError.md +48 -0
- package/data/packages/platform-queue/api/Class.QueueValidationError.md +43 -0
- package/data/packages/platform-queue/api/Interface.IAzureQueueOptions.md +48 -0
- package/data/packages/platform-queue/api/Interface.IBullMqQueueOptions.md +45 -0
- package/data/packages/platform-queue/api/Interface.IMemoryQueueOptions.md +32 -0
- package/data/packages/platform-queue/api/Interface.IQueue.md +173 -0
- package/data/packages/platform-queue/api/Interface.IQueueJob.md +139 -0
- package/data/packages/platform-queue/api/TypeAlias.QueueJobStatus.md +14 -0
- package/data/packages/platform-queue/api/Variable.AZURE_CONFIG_ENTRIES.md +17 -0
- package/data/packages/platform-queue/api/Variable.AZURE_CONNECTION_STRING.md +14 -0
- package/data/packages/platform-queue/api/Variable.AZURE_RECEIVE_WAIT_MS.md +21 -0
- package/data/packages/platform-queue/api/Variable.BULLMQ_CONFIG_ENTRIES.md +17 -0
- package/data/packages/platform-queue/api/Variable.BULLMQ_PREFIX.md +18 -0
- package/data/packages/platform-queue/api/Variable.BULLMQ_REDIS_URL.md +21 -0
- package/data/packages/platform-queue/api/Variable.PLATFORM_QUEUE_CONFIG_ENTRIES.md +17 -0
- package/data/packages/platform-queue/api/Variable.QUEUE_JOB_STATUS.md +30 -0
- package/data/packages/platform-queue/api/Variable.QUEUE_MAX_JOBS.md +21 -0
- package/data/packages/platform-queue/api/index.md +49 -0
- package/data/packages/platform-queue/index.md +168 -0
- package/data/packages/platform-resources/api/Class.BlobResourceStrategy.md +195 -0
- package/data/packages/platform-resources/api/Class.EmbeddedResourceStrategy.md +215 -0
- package/data/packages/platform-resources/api/Class.FileResourceStrategy.md +190 -0
- package/data/packages/platform-resources/api/Class.ResourceManager.md +477 -0
- package/data/packages/platform-resources/api/Class.ResourceModule.md +46 -0
- package/data/packages/platform-resources/api/Class.ResourceNotFoundError.md +60 -0
- package/data/packages/platform-resources/api/Interface.IBlobResourceStrategyConfig.md +28 -0
- package/data/packages/platform-resources/api/Interface.IBlobServiceAdapter.md +40 -0
- package/data/packages/platform-resources/api/Interface.IFileResourceStrategyConfig.md +72 -0
- package/data/packages/platform-resources/api/Interface.IResourceManagerConfig.md +89 -0
- package/data/packages/platform-resources/api/Interface.IResourceMetadata.md +94 -0
- package/data/packages/platform-resources/api/Interface.IResourceResult.md +34 -0
- package/data/packages/platform-resources/api/Interface.IResourceStrategy.md +134 -0
- package/data/packages/platform-resources/api/index.md +29 -0
- package/data/packages/platform-telemetry/api/Class.OtelSdkHolder.md +20 -2
- package/data/packages/platform-telemetry/api/Class.TelemetryHealthIndicator.md +78 -0
- package/data/packages/platform-telemetry/api/index.md +1 -0
- package/data/packages/platform-telemetry/index.md +25 -1
- package/data/patterns/config-pattern.md +3 -1
- package/package.json +1 -1
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: 'Function: pipe()'
|
|
3
|
+
generated: true
|
|
4
|
+
editUrl: false
|
|
5
|
+
---
|
|
6
|
+
# Function: pipe()
|
|
7
|
+
|
|
8
|
+
```ts
|
|
9
|
+
function pipe<D, R>(delegate, op): R;
|
|
10
|
+
```
|
|
11
|
+
|
|
12
|
+
Defined in: [repositories2/operators/pipe.ts:10](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-database/src/repositories2/operators/pipe.ts#L10)
|
|
13
|
+
|
|
14
|
+
**`Beta`**
|
|
15
|
+
|
|
16
|
+
Executes a single operator against the provided delegate.
|
|
17
|
+
|
|
18
|
+
## Type Parameters
|
|
19
|
+
|
|
20
|
+
| Type Parameter | Description |
|
|
21
|
+
| ------ | ------ |
|
|
22
|
+
| `D` | Concrete delegate type (e.g. Prisma.UserDelegate) |
|
|
23
|
+
| `R` | Result type produced by the operator |
|
|
24
|
+
|
|
25
|
+
## Parameters
|
|
26
|
+
|
|
27
|
+
| Parameter | Type |
|
|
28
|
+
| ------ | ------ |
|
|
29
|
+
| `delegate` | `D` |
|
|
30
|
+
| `op` | `QueryOperator`\<`D`, `R`\> |
|
|
31
|
+
|
|
32
|
+
## Returns
|
|
33
|
+
|
|
34
|
+
`R`
|
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: 'Function: pipeAll()'
|
|
3
|
+
generated: true
|
|
4
|
+
editUrl: false
|
|
5
|
+
---
|
|
6
|
+
# Function: pipeAll()
|
|
7
|
+
|
|
8
|
+
```ts
|
|
9
|
+
function pipeAll<D, R>(delegate, ...ops): Promise<R>;
|
|
10
|
+
```
|
|
11
|
+
|
|
12
|
+
Defined in: [repositories2/operators/pipe.ts:22](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-database/src/repositories2/operators/pipe.ts#L22)
|
|
13
|
+
|
|
14
|
+
**`Beta`**
|
|
15
|
+
|
|
16
|
+
Sequentially executes multiple operators. The last result is returned.
|
|
17
|
+
Useful for multi-step dependent operations.
|
|
18
|
+
|
|
19
|
+
## Type Parameters
|
|
20
|
+
|
|
21
|
+
| Type Parameter | Description |
|
|
22
|
+
| ------ | ------ |
|
|
23
|
+
| `D` | Concrete delegate type (e.g. Prisma.UserDelegate) |
|
|
24
|
+
| `R` | Result type produced by the operator |
|
|
25
|
+
|
|
26
|
+
## Parameters
|
|
27
|
+
|
|
28
|
+
| Parameter | Type |
|
|
29
|
+
| ------ | ------ |
|
|
30
|
+
| `delegate` | `D` |
|
|
31
|
+
| ...`ops` | `QueryOperator`\<`D`, `unknown`\>[] |
|
|
32
|
+
|
|
33
|
+
## Returns
|
|
34
|
+
|
|
35
|
+
`Promise`\<`R`\>
|
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: 'Function: query2()'
|
|
3
|
+
generated: true
|
|
4
|
+
editUrl: false
|
|
5
|
+
---
|
|
6
|
+
# Function: query2()
|
|
7
|
+
|
|
8
|
+
```ts
|
|
9
|
+
function query2<TDelegate, TRun, TResult>(name, run): IRepositoryQuery2<TDelegate, TRun>;
|
|
10
|
+
```
|
|
11
|
+
|
|
12
|
+
Defined in: [repositories2/queries/query2.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-database/src/repositories2/queries/query2.ts#L15)
|
|
13
|
+
|
|
14
|
+
Creates a new repository query.
|
|
15
|
+
|
|
16
|
+
## Type Parameters
|
|
17
|
+
|
|
18
|
+
| Type Parameter |
|
|
19
|
+
| ------ |
|
|
20
|
+
| `TDelegate` |
|
|
21
|
+
| `TRun` *extends* (`delegate`) => `TResult` |
|
|
22
|
+
| `TResult` |
|
|
23
|
+
|
|
24
|
+
## Parameters
|
|
25
|
+
|
|
26
|
+
| Parameter | Type | Description |
|
|
27
|
+
| ------ | ------ | ------ |
|
|
28
|
+
| `name` | `string` | The name of the query. |
|
|
29
|
+
| `run` | `TRun` | The function that runs the query. |
|
|
30
|
+
|
|
31
|
+
## Returns
|
|
32
|
+
|
|
33
|
+
[`IRepositoryQuery2`](Interface.IRepositoryQuery2)\<`TDelegate`, `TRun`\>
|
|
34
|
+
|
|
35
|
+
The repository query.
|
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: 'Function: remove()'
|
|
3
|
+
generated: true
|
|
4
|
+
editUrl: false
|
|
5
|
+
---
|
|
6
|
+
# Function: remove()
|
|
7
|
+
|
|
8
|
+
```ts
|
|
9
|
+
function remove<D, A>(args): QueryOperator<D, ReturnType<D["delete"]>>;
|
|
10
|
+
```
|
|
11
|
+
|
|
12
|
+
Defined in: [repositories2/operators/delete.ts:13](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-database/src/repositories2/operators/delete.ts#L13)
|
|
13
|
+
|
|
14
|
+
**`Beta`**
|
|
15
|
+
|
|
16
|
+
Deletes a single record via the delegate `delete` method.
|
|
17
|
+
|
|
18
|
+
## Type Parameters
|
|
19
|
+
|
|
20
|
+
| Type Parameter |
|
|
21
|
+
| ------ |
|
|
22
|
+
| `D` *extends* `IDeleteDelegate` |
|
|
23
|
+
| `A` *extends* `unknown` |
|
|
24
|
+
|
|
25
|
+
## Parameters
|
|
26
|
+
|
|
27
|
+
| Parameter | Type | Description |
|
|
28
|
+
| ------ | ------ | ------ |
|
|
29
|
+
| `args` | `A` | Prisma delete arguments |
|
|
30
|
+
|
|
31
|
+
## Returns
|
|
32
|
+
|
|
33
|
+
`QueryOperator`\<`D`, `ReturnType`\<`D`\[`"delete"`\]\>\>
|
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: 'Function: removeMany()'
|
|
3
|
+
generated: true
|
|
4
|
+
editUrl: false
|
|
5
|
+
---
|
|
6
|
+
# Function: removeMany()
|
|
7
|
+
|
|
8
|
+
```ts
|
|
9
|
+
function removeMany<D, A>(args): QueryOperator<D, ReturnType<D["deleteMany"]>>;
|
|
10
|
+
```
|
|
11
|
+
|
|
12
|
+
Defined in: [repositories2/operators/deleteMany.ts:13](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-database/src/repositories2/operators/deleteMany.ts#L13)
|
|
13
|
+
|
|
14
|
+
**`Beta`**
|
|
15
|
+
|
|
16
|
+
Deletes multiple records via the delegate `deleteMany` method.
|
|
17
|
+
|
|
18
|
+
## Type Parameters
|
|
19
|
+
|
|
20
|
+
| Type Parameter |
|
|
21
|
+
| ------ |
|
|
22
|
+
| `D` *extends* `IDeleteManyDelegate` |
|
|
23
|
+
| `A` *extends* `unknown` |
|
|
24
|
+
|
|
25
|
+
## Parameters
|
|
26
|
+
|
|
27
|
+
| Parameter | Type | Description |
|
|
28
|
+
| ------ | ------ | ------ |
|
|
29
|
+
| `args` | `A` | Prisma deleteMany arguments |
|
|
30
|
+
|
|
31
|
+
## Returns
|
|
32
|
+
|
|
33
|
+
`QueryOperator`\<`D`, `ReturnType`\<`D`\[`"deleteMany"`\]\>\>
|
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: 'Function: update()'
|
|
3
|
+
generated: true
|
|
4
|
+
editUrl: false
|
|
5
|
+
---
|
|
6
|
+
# Function: update()
|
|
7
|
+
|
|
8
|
+
```ts
|
|
9
|
+
function update<D, A>(args): QueryOperator<D, ReturnType<D["update"]>>;
|
|
10
|
+
```
|
|
11
|
+
|
|
12
|
+
Defined in: [repositories2/operators/update.ts:13](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-database/src/repositories2/operators/update.ts#L13)
|
|
13
|
+
|
|
14
|
+
**`Beta`**
|
|
15
|
+
|
|
16
|
+
Updates a single record via the delegate `update` method.
|
|
17
|
+
|
|
18
|
+
## Type Parameters
|
|
19
|
+
|
|
20
|
+
| Type Parameter |
|
|
21
|
+
| ------ |
|
|
22
|
+
| `D` *extends* `IUpdateDelegate` |
|
|
23
|
+
| `A` *extends* `unknown` |
|
|
24
|
+
|
|
25
|
+
## Parameters
|
|
26
|
+
|
|
27
|
+
| Parameter | Type | Description |
|
|
28
|
+
| ------ | ------ | ------ |
|
|
29
|
+
| `args` | `A` | Prisma update arguments |
|
|
30
|
+
|
|
31
|
+
## Returns
|
|
32
|
+
|
|
33
|
+
`QueryOperator`\<`D`, `ReturnType`\<`D`\[`"update"`\]\>\>
|
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: 'Function: updateMany()'
|
|
3
|
+
generated: true
|
|
4
|
+
editUrl: false
|
|
5
|
+
---
|
|
6
|
+
# Function: updateMany()
|
|
7
|
+
|
|
8
|
+
```ts
|
|
9
|
+
function updateMany<D, A>(args): QueryOperator<D, ReturnType<D["updateMany"]>>;
|
|
10
|
+
```
|
|
11
|
+
|
|
12
|
+
Defined in: [repositories2/operators/updateMany.ts:13](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-database/src/repositories2/operators/updateMany.ts#L13)
|
|
13
|
+
|
|
14
|
+
**`Beta`**
|
|
15
|
+
|
|
16
|
+
Updates multiple records via the delegate `updateMany` method.
|
|
17
|
+
|
|
18
|
+
## Type Parameters
|
|
19
|
+
|
|
20
|
+
| Type Parameter |
|
|
21
|
+
| ------ |
|
|
22
|
+
| `D` *extends* `IUpdateManyDelegate` |
|
|
23
|
+
| `A` *extends* `unknown` |
|
|
24
|
+
|
|
25
|
+
## Parameters
|
|
26
|
+
|
|
27
|
+
| Parameter | Type | Description |
|
|
28
|
+
| ------ | ------ | ------ |
|
|
29
|
+
| `args` | `A` | Prisma updateMany arguments |
|
|
30
|
+
|
|
31
|
+
## Returns
|
|
32
|
+
|
|
33
|
+
`QueryOperator`\<`D`, `ReturnType`\<`D`\[`"updateMany"`\]\>\>
|
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: 'Function: updateManyAndReturn()'
|
|
3
|
+
generated: true
|
|
4
|
+
editUrl: false
|
|
5
|
+
---
|
|
6
|
+
# Function: updateManyAndReturn()
|
|
7
|
+
|
|
8
|
+
```ts
|
|
9
|
+
function updateManyAndReturn<D, A>(args): QueryOperator<D, ReturnType<D["updateManyAndReturn"]>>;
|
|
10
|
+
```
|
|
11
|
+
|
|
12
|
+
Defined in: [repositories2/operators/updateManyAndReturn.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-database/src/repositories2/operators/updateManyAndReturn.ts#L15)
|
|
13
|
+
|
|
14
|
+
**`Beta`**
|
|
15
|
+
|
|
16
|
+
Updates multiple records and returns them via the delegate `updateManyAndReturn` method.
|
|
17
|
+
|
|
18
|
+
**Provider support:** PostgreSQL, CockroachDB, SQLite only.
|
|
19
|
+
|
|
20
|
+
## Type Parameters
|
|
21
|
+
|
|
22
|
+
| Type Parameter |
|
|
23
|
+
| ------ |
|
|
24
|
+
| `D` *extends* `IUpdateManyAndReturnDelegate` |
|
|
25
|
+
| `A` *extends* `unknown` |
|
|
26
|
+
|
|
27
|
+
## Parameters
|
|
28
|
+
|
|
29
|
+
| Parameter | Type | Description |
|
|
30
|
+
| ------ | ------ | ------ |
|
|
31
|
+
| `args` | `A` | Prisma updateManyAndReturn arguments |
|
|
32
|
+
|
|
33
|
+
## Returns
|
|
34
|
+
|
|
35
|
+
`QueryOperator`\<`D`, `ReturnType`\<`D`\[`"updateManyAndReturn"`\]\>\>
|
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: 'Function: upsert()'
|
|
3
|
+
generated: true
|
|
4
|
+
editUrl: false
|
|
5
|
+
---
|
|
6
|
+
# Function: upsert()
|
|
7
|
+
|
|
8
|
+
```ts
|
|
9
|
+
function upsert<D, A>(args): QueryOperator<D, ReturnType<D["upsert"]>>;
|
|
10
|
+
```
|
|
11
|
+
|
|
12
|
+
Defined in: [repositories2/operators/upsert.ts:13](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-database/src/repositories2/operators/upsert.ts#L13)
|
|
13
|
+
|
|
14
|
+
**`Beta`**
|
|
15
|
+
|
|
16
|
+
Creates or updates a record via the delegate `upsert` method.
|
|
17
|
+
|
|
18
|
+
## Type Parameters
|
|
19
|
+
|
|
20
|
+
| Type Parameter |
|
|
21
|
+
| ------ |
|
|
22
|
+
| `D` *extends* `IUpsertDelegate` |
|
|
23
|
+
| `A` *extends* `unknown` |
|
|
24
|
+
|
|
25
|
+
## Parameters
|
|
26
|
+
|
|
27
|
+
| Parameter | Type | Description |
|
|
28
|
+
| ------ | ------ | ------ |
|
|
29
|
+
| `args` | `A` | Prisma upsert arguments |
|
|
30
|
+
|
|
31
|
+
## Returns
|
|
32
|
+
|
|
33
|
+
`QueryOperator`\<`D`, `ReturnType`\<`D`\[`"upsert"`\]\>\>
|
|
@@ -5,7 +5,7 @@ editUrl: false
|
|
|
5
5
|
---
|
|
6
6
|
# Interface: IDatabaseModuleConfig
|
|
7
7
|
|
|
8
|
-
Defined in: [DatabaseModule.ts:
|
|
8
|
+
Defined in: [DatabaseModule.ts:15](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-database/src/DatabaseModule.ts#L15)
|
|
9
9
|
|
|
10
10
|
Represents the database module configuration.
|
|
11
11
|
|
|
@@ -17,7 +17,7 @@ Represents the database module configuration.
|
|
|
17
17
|
optional adapter?: unknown;
|
|
18
18
|
```
|
|
19
19
|
|
|
20
|
-
Defined in: [DatabaseModule.ts:
|
|
20
|
+
Defined in: [DatabaseModule.ts:20](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-database/src/DatabaseModule.ts#L20)
|
|
21
21
|
|
|
22
22
|
A Prisma driver adapter instance (e.g. `PrismaPg`, `PrismaLibSQL`).
|
|
23
23
|
Required for Prisma 7+ with the new `prisma-client` generator.
|
|
@@ -30,6 +30,6 @@ Required for Prisma 7+ with the new `prisma-client` generator.
|
|
|
30
30
|
optional middlewares?: unknown[];
|
|
31
31
|
```
|
|
32
32
|
|
|
33
|
-
Defined in: [DatabaseModule.ts:
|
|
33
|
+
Defined in: [DatabaseModule.ts:22](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-database/src/DatabaseModule.ts#L22)
|
|
34
34
|
|
|
35
35
|
Future extension point for Prisma middlewares
|
|
@@ -0,0 +1,45 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: 'Interface: IRepositoryQuery2\<TDelegate, TRun\>'
|
|
3
|
+
generated: true
|
|
4
|
+
editUrl: false
|
|
5
|
+
---
|
|
6
|
+
# Interface: IRepositoryQuery2\<TDelegate, TRun\>
|
|
7
|
+
|
|
8
|
+
Defined in: [repositories2/queries/IRepositoryQuery2.ts:8](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-database/src/repositories2/queries/IRepositoryQuery2.ts#L8)
|
|
9
|
+
|
|
10
|
+
Represents a reusable query definition for repositories.
|
|
11
|
+
|
|
12
|
+
## Template
|
|
13
|
+
|
|
14
|
+
The query result type.
|
|
15
|
+
|
|
16
|
+
## Type Parameters
|
|
17
|
+
|
|
18
|
+
| Type Parameter | Default type | Description |
|
|
19
|
+
| ------ | ------ | ------ |
|
|
20
|
+
| `TDelegate` | - | The Prisma delegate type. |
|
|
21
|
+
| `TRun` *extends* (`delegate`) => `any` | (`delegate`) => `any` | - |
|
|
22
|
+
|
|
23
|
+
## Properties
|
|
24
|
+
|
|
25
|
+
### name
|
|
26
|
+
|
|
27
|
+
```ts
|
|
28
|
+
readonly name: string;
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
Defined in: [repositories2/queries/IRepositoryQuery2.ts:17](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-database/src/repositories2/queries/IRepositoryQuery2.ts#L17)
|
|
32
|
+
|
|
33
|
+
The identifier used for logging.
|
|
34
|
+
|
|
35
|
+
***
|
|
36
|
+
|
|
37
|
+
### run
|
|
38
|
+
|
|
39
|
+
```ts
|
|
40
|
+
run: TRun;
|
|
41
|
+
```
|
|
42
|
+
|
|
43
|
+
Defined in: [repositories2/queries/IRepositoryQuery2.ts:26](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-database/src/repositories2/queries/IRepositoryQuery2.ts#L26)
|
|
44
|
+
|
|
45
|
+
Executes the query against the provided model.
|
|
@@ -9,7 +9,7 @@ editUrl: false
|
|
|
9
9
|
type DelegateArgs<T> = { [K in keyof T]: T[K] extends (args: infer A) => Promise<unknown> ? A : never };
|
|
10
10
|
```
|
|
11
11
|
|
|
12
|
-
Defined in: [repositories/abstracts/RepositoryBase.ts:
|
|
12
|
+
Defined in: [repositories/abstracts/RepositoryBase.ts:412](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-database/src/repositories/abstracts/RepositoryBase.ts#L412)
|
|
13
13
|
|
|
14
14
|
## Type Parameters
|
|
15
15
|
|
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: 'Type Alias: DelegateOperations\<TDelegate\>'
|
|
3
|
+
generated: true
|
|
4
|
+
editUrl: false
|
|
5
|
+
---
|
|
6
|
+
# Type Alias: DelegateOperations\<TDelegate\>
|
|
7
|
+
|
|
8
|
+
```ts
|
|
9
|
+
type DelegateOperations<TDelegate> = Extract<RepositoryOperationsAll, keyof TDelegate>;
|
|
10
|
+
```
|
|
11
|
+
|
|
12
|
+
Defined in: [repositories/abstracts/RepositoryBase.ts:66](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-database/src/repositories/abstracts/RepositoryBase.ts#L66)
|
|
13
|
+
|
|
14
|
+
Extracts the subset of known Prisma operations that a concrete delegate actually implements.
|
|
15
|
+
Useful for type-level checks without requiring the consumer to state the provider explicitly.
|
|
16
|
+
|
|
17
|
+
## Type Parameters
|
|
18
|
+
|
|
19
|
+
| Type Parameter |
|
|
20
|
+
| ------ |
|
|
21
|
+
| `TDelegate` |
|
|
22
|
+
|
|
23
|
+
## Example
|
|
24
|
+
|
|
25
|
+
```typescript
|
|
26
|
+
// On PostgreSQL: 'findUnique' | ... | 'createManyAndReturn' | 'updateManyAndReturn'
|
|
27
|
+
// On SQL Server: 'findUnique' | ... (15 base ops only)
|
|
28
|
+
type Ops = DelegateOperations<Prisma.TaskDelegate>;
|
|
29
|
+
```
|
|
@@ -9,7 +9,7 @@ editUrl: false
|
|
|
9
9
|
type DelegateReturnTypes<T> = { [K in keyof T]: T[K] extends (args: infer A) => Promise<infer R> ? R : never };
|
|
10
10
|
```
|
|
11
11
|
|
|
12
|
-
Defined in: [repositories/abstracts/RepositoryBase.ts:
|
|
12
|
+
Defined in: [repositories/abstracts/RepositoryBase.ts:419](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-database/src/repositories/abstracts/RepositoryBase.ts#L419)
|
|
13
13
|
|
|
14
14
|
## Type Parameters
|
|
15
15
|
|
|
@@ -9,7 +9,7 @@ editUrl: false
|
|
|
9
9
|
type PaginateFunction = <T, K>(model, args?, options?) => Promise<IPaginatedResult<T>>;
|
|
10
10
|
```
|
|
11
11
|
|
|
12
|
-
Defined in: [features/Pagination.ts:
|
|
12
|
+
Defined in: [features/Pagination.ts:18](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-database/src/features/Pagination.ts#L18)
|
|
13
13
|
|
|
14
14
|
## Type Parameters
|
|
15
15
|
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: 'Type Alias: RepositoryOperationsAll'
|
|
3
|
+
generated: true
|
|
4
|
+
editUrl: false
|
|
5
|
+
---
|
|
6
|
+
# Type Alias: RepositoryOperationsAll
|
|
7
|
+
|
|
8
|
+
```ts
|
|
9
|
+
type RepositoryOperationsAll =
|
|
10
|
+
| RepositoryOperationsBase
|
|
11
|
+
| "createManyAndReturn"
|
|
12
|
+
| "updateManyAndReturn"
|
|
13
|
+
| "findRaw"
|
|
14
|
+
| "aggregateRaw";
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
Defined in: [repositories/abstracts/RepositoryBase.ts:20](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-database/src/repositories/abstracts/RepositoryBase.ts#L20)
|
|
18
|
+
|
|
19
|
+
Superset of all known Prisma model delegate operations across every supported database provider.
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: 'Type Alias: RepositoryOperationsBase'
|
|
3
|
+
generated: true
|
|
4
|
+
editUrl: false
|
|
5
|
+
---
|
|
6
|
+
# Type Alias: RepositoryOperationsBase
|
|
7
|
+
|
|
8
|
+
```ts
|
|
9
|
+
type RepositoryOperationsBase =
|
|
10
|
+
| "aggregate"
|
|
11
|
+
| "count"
|
|
12
|
+
| "create"
|
|
13
|
+
| "createMany"
|
|
14
|
+
| "delete"
|
|
15
|
+
| "deleteMany"
|
|
16
|
+
| "findFirst"
|
|
17
|
+
| "findFirstOrThrow"
|
|
18
|
+
| "findMany"
|
|
19
|
+
| "findUnique"
|
|
20
|
+
| "findUniqueOrThrow"
|
|
21
|
+
| "groupBy"
|
|
22
|
+
| "update"
|
|
23
|
+
| "updateMany"
|
|
24
|
+
| "upsert";
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
Defined in: [repositories/abstracts/RepositoryBase.ts:37](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-database/src/repositories/abstracts/RepositoryBase.ts#L37)
|
|
28
|
+
|
|
29
|
+
The baseline set of operations available on **every** Prisma provider
|
|
30
|
+
(PostgreSQL, CockroachDB, SQLite, MySQL, MariaDB, SQL Server, MongoDB).
|
|
31
|
+
|
|
32
|
+
Provider-specific extras (e.g. `createManyAndReturn` on PostgreSQL) are
|
|
33
|
+
deliberately excluded so that consumers targeting any provider satisfy
|
|
34
|
+
the constraint automatically.
|
|
@@ -9,6 +9,6 @@ editUrl: false
|
|
|
9
9
|
const DATABASE_MODULE_CONFIG: "DATABASE_MODULE_CONFIG" = 'DATABASE_MODULE_CONFIG';
|
|
10
10
|
```
|
|
11
11
|
|
|
12
|
-
Defined in: [DatabaseModule.ts:
|
|
12
|
+
Defined in: [DatabaseModule.ts:30](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-database/src/DatabaseModule.ts#L30)
|
|
13
13
|
|
|
14
14
|
Represents the database module.
|
|
@@ -13,7 +13,8 @@ editUrl: false
|
|
|
13
13
|
| [DatabaseModule](Class.DatabaseModule) | - |
|
|
14
14
|
| [DatabaseService](Class.DatabaseService) | Represents the database service. |
|
|
15
15
|
| [PrismaService](Class.PrismaService) | Represents the prisma service. |
|
|
16
|
-
| [
|
|
16
|
+
| [RepositoryBase](Class.RepositoryBase) | The base class for all repositories. |
|
|
17
|
+
| [RepositoryBase2](Class.RepositoryBase2) | Minimal repository base that exposes the underlying Prisma delegate and provides a typed pipe helper for functional operators. |
|
|
17
18
|
| [RepositoryExceptionFilter](Class.RepositoryExceptionFilter) | Represents the Prisma client exception filter. |
|
|
18
19
|
|
|
19
20
|
## Interfaces
|
|
@@ -27,6 +28,7 @@ editUrl: false
|
|
|
27
28
|
| [IPaginateOptions](Interface.IPaginateOptions) | - |
|
|
28
29
|
| [IPrismaServiceOptions](Interface.IPrismaServiceOptions) | Represents the options for the PrismaService. |
|
|
29
30
|
| [IRepositoryQuery](Interface.IRepositoryQuery) | Represents a reusable query definition for repositories. |
|
|
31
|
+
| [IRepositoryQuery2](Interface.IRepositoryQuery2) | Represents a reusable query definition for repositories. |
|
|
30
32
|
| [ITransactionalRepositoryQuery](Interface.ITransactionalRepositoryQuery) | Represents a repository query that requires a Prisma TransactionClient to access multiple delegates. |
|
|
31
33
|
|
|
32
34
|
## Type Aliases
|
|
@@ -35,9 +37,12 @@ editUrl: false
|
|
|
35
37
|
| ------ | ------ |
|
|
36
38
|
| [CursorPaginateFunction](TypeAlias.CursorPaginateFunction) | The type of a cursor paginate function. |
|
|
37
39
|
| [DelegateArgs](TypeAlias.DelegateArgs) | - |
|
|
40
|
+
| [DelegateOperations](TypeAlias.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. |
|
|
38
41
|
| [DelegateReturnTypes](TypeAlias.DelegateReturnTypes) | - |
|
|
39
42
|
| [PaginateFunction](TypeAlias.PaginateFunction) | - |
|
|
40
43
|
| [QueryResultType](TypeAlias.QueryResultType) | Extracts the result type from a repository query. Useful for type-safe mapping without duplicating query result types. |
|
|
44
|
+
| [RepositoryOperationsAll](TypeAlias.RepositoryOperationsAll) | Superset of all known Prisma model delegate operations across every supported database provider. |
|
|
45
|
+
| [RepositoryOperationsBase](TypeAlias.RepositoryOperationsBase) | The baseline set of operations available on **every** Prisma provider (PostgreSQL, CockroachDB, SQLite, MySQL, MariaDB, SQL Server, MongoDB). |
|
|
41
46
|
| [TransactionalQueryResultType](TypeAlias.TransactionalQueryResultType) | Extracts the result type from a transactional repository query. |
|
|
42
47
|
|
|
43
48
|
## Variables
|
|
@@ -52,9 +57,32 @@ editUrl: false
|
|
|
52
57
|
|
|
53
58
|
| Function | Description |
|
|
54
59
|
| ------ | ------ |
|
|
60
|
+
| [aggregate](Function.aggregate) | Executes an aggregate query via the delegate `aggregate` method. |
|
|
61
|
+
| [aggregateRaw](Function.aggregateRaw) | Executes a raw aggregate query via the delegate `aggregateRaw` method. |
|
|
62
|
+
| [count](Function.count) | Counts records via the delegate `count` method. |
|
|
63
|
+
| [create](Function.create) | Creates a record using the underlying delegate `create` method. |
|
|
64
|
+
| [createMany](Function.createMany) | Creates multiple records via the delegate `createMany` method. |
|
|
65
|
+
| [createManyAndReturn](Function.createManyAndReturn) | Creates multiple records and returns them via the delegate `createManyAndReturn` method. |
|
|
55
66
|
| [cursorPaginator](Function.cursorPaginator) | Creates a cursor-based pagination function with the given default options. |
|
|
67
|
+
| [findFirst](Function.findFirst) | Creates an operator that executes a `findFirst` query with the provided arguments. |
|
|
68
|
+
| [findFirstOrThrow](Function.findFirstOrThrow) | Finds the first record matching the criteria via the delegate `findFirstOrThrow` method. Throws a `PrismaClientKnownRequestError` with code `P2025` if no record is found. |
|
|
69
|
+
| [findMany](Function.findMany) | Finds many records via the delegate `findMany` method. |
|
|
70
|
+
| [findManyPaged](Function.findManyPaged) | Finds many records with pagination using the delegate `findMany` method. |
|
|
71
|
+
| [findRaw](Function.findRaw) | Executes a raw find query via the delegate `findRaw` method. |
|
|
72
|
+
| [findUnique](Function.findUnique) | Finds a unique record via the delegate `findUnique` method. |
|
|
73
|
+
| [findUniqueOrThrow](Function.findUniqueOrThrow) | Finds a unique record via the delegate `findUniqueOrThrow` method. Throws a `PrismaClientKnownRequestError` with code `P2025` if no record is found. |
|
|
74
|
+
| [groupBy](Function.groupBy) | Performs a group-by query via the delegate `groupBy` method. |
|
|
56
75
|
| [pageable](Function.pageable) | - |
|
|
57
76
|
| [paginator](Function.paginator) | - |
|
|
77
|
+
| [pipe](Function.pipe) | Executes a single operator against the provided delegate. |
|
|
78
|
+
| [pipeAll](Function.pipeAll) | Sequentially executes multiple operators. The last result is returned. Useful for multi-step dependent operations. |
|
|
58
79
|
| [query](Function.query) | Creates a new repository query. |
|
|
80
|
+
| [query2](Function.query2) | Creates a new repository query. |
|
|
81
|
+
| [remove](Function.remove) | Deletes a single record via the delegate `delete` method. |
|
|
82
|
+
| [removeMany](Function.removeMany) | Deletes multiple records via the delegate `deleteMany` method. |
|
|
59
83
|
| [skip](Function.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. |
|
|
60
84
|
| [transactionalQuery](Function.transactionalQuery) | Factory to create a transactional repository query. |
|
|
85
|
+
| [update](Function.update) | Updates a single record via the delegate `update` method. |
|
|
86
|
+
| [updateMany](Function.updateMany) | Updates multiple records via the delegate `updateMany` method. |
|
|
87
|
+
| [updateManyAndReturn](Function.updateManyAndReturn) | Updates multiple records and returns them via the delegate `updateManyAndReturn` method. |
|
|
88
|
+
| [upsert](Function.upsert) | Creates or updates a record via the delegate `upsert` method. |
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
title: platform-database
|
|
3
3
|
description: Prisma ORM integration with PostgreSQL, repository pattern, query abstraction, and pagination.
|
|
4
4
|
order: 5
|
|
5
|
-
tags: [database, prisma, postgresql, repository, queries, pagination]
|
|
5
|
+
tags: [database, prisma, postgresql, repository, queries, pagination, health]
|
|
6
6
|
package: '@breadstone/archipel-platform-database'
|
|
7
7
|
---
|
|
8
8
|
|
|
@@ -294,13 +294,25 @@ interface IOrderEntity {
|
|
|
294
294
|
|
|
295
295
|
## Health Check
|
|
296
296
|
|
|
297
|
+
The `DatabaseHealthIndicator` verifies database connectivity via a Prisma ping (`SELECT 1`). Import it from the `/health` subpath:
|
|
298
|
+
|
|
297
299
|
```typescript
|
|
298
|
-
import { DatabaseHealthIndicator } from '@breadstone/archipel-platform-database';
|
|
300
|
+
import { DatabaseHealthIndicator } from '@breadstone/archipel-platform-database/health';
|
|
301
|
+
import { HealthModule } from '@breadstone/archipel-platform-health';
|
|
299
302
|
|
|
300
|
-
|
|
301
|
-
|
|
303
|
+
@Module({
|
|
304
|
+
imports: [
|
|
305
|
+
DatabaseModule,
|
|
306
|
+
HealthModule.withIndicators([DatabaseHealthIndicator]),
|
|
307
|
+
],
|
|
308
|
+
})
|
|
309
|
+
export class AppModule {}
|
|
302
310
|
```
|
|
303
311
|
|
|
312
|
+
| Key | Check | Dependencies |
|
|
313
|
+
| --- | ----- | ------------ |
|
|
314
|
+
| `database` | Prisma `SELECT 1` ping | `PrismaHealthIndicator`, `DatabaseService` |
|
|
315
|
+
|
|
304
316
|
---
|
|
305
317
|
|
|
306
318
|
## Exports Summary
|
|
@@ -314,7 +326,7 @@ import { DatabaseHealthIndicator } from '@breadstone/archipel-platform-database'
|
|
|
314
326
|
| `query()` | Factory | Create typed query objects |
|
|
315
327
|
| `transactionalQuery()` | Factory | Create transactional query objects |
|
|
316
328
|
| `paginator()` | Factory | Create pagination helper |
|
|
317
|
-
| `DatabaseHealthIndicator` | Health | PostgreSQL health check
|
|
329
|
+
| `DatabaseHealthIndicator` | Health | PostgreSQL health check (`/health` subpath) |
|
|
318
330
|
| `PLATFORM_DATABASE_CONFIG_ENTRIES` | Constant | Config entries for `ConfigModule` |
|
|
319
331
|
| `DB_ACCELERATE_URL` | Config Key | Prisma Accelerate URL |
|
|
320
332
|
| `DB_AUTO_CONNECTION` | Config Key | Auto-connect toggle |
|