@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
|
@@ -55,4 +55,4 @@ const enabled = configService.get(FEATURE_X_ENABLED); // typed as boolean
|
|
|
55
55
|
|
|
56
56
|
At runtime the returned object is minimal (just `{ key: string }`) so there is
|
|
57
57
|
virtually no overhead. The generic `TType` is only used by TypeScript for stronger
|
|
58
|
-
compile-time checking
|
|
58
|
+
compile-time checking - enabling you to avoid magic strings and untyped fetches.
|
|
@@ -5,7 +5,7 @@ editUrl: false
|
|
|
5
5
|
---
|
|
6
6
|
# Class: HttpLoggerMiddleware
|
|
7
7
|
|
|
8
|
-
Defined in: [middlewares/HttpLoggerMiddleware.ts:
|
|
8
|
+
Defined in: [middlewares/HttpLoggerMiddleware.ts:12](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/middlewares/HttpLoggerMiddleware.ts#L12)
|
|
9
9
|
|
|
10
10
|
## Implements
|
|
11
11
|
|
|
@@ -19,7 +19,7 @@ Defined in: [middlewares/HttpLoggerMiddleware.ts:50](https://github.com/RueDeRen
|
|
|
19
19
|
new HttpLoggerMiddleware(): HttpLoggerMiddleware;
|
|
20
20
|
```
|
|
21
21
|
|
|
22
|
-
Defined in: [middlewares/HttpLoggerMiddleware.ts:
|
|
22
|
+
Defined in: [middlewares/HttpLoggerMiddleware.ts:26](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/middlewares/HttpLoggerMiddleware.ts#L26)
|
|
23
23
|
|
|
24
24
|
Constructs a new instance of the `HttpLoggerMiddleware` class.
|
|
25
25
|
|
|
@@ -38,7 +38,7 @@ use(
|
|
|
38
38
|
next): void;
|
|
39
39
|
```
|
|
40
40
|
|
|
41
|
-
Defined in: [middlewares/HttpLoggerMiddleware.ts:
|
|
41
|
+
Defined in: [middlewares/HttpLoggerMiddleware.ts:32](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/middlewares/HttpLoggerMiddleware.ts#L32)
|
|
42
42
|
|
|
43
43
|
#### Parameters
|
|
44
44
|
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: 'Function: maskSensitive()'
|
|
3
|
+
generated: true
|
|
4
|
+
editUrl: false
|
|
5
|
+
---
|
|
6
|
+
# Function: maskSensitive()
|
|
7
|
+
|
|
8
|
+
```ts
|
|
9
|
+
function maskSensitive(value): string;
|
|
10
|
+
```
|
|
11
|
+
|
|
12
|
+
Defined in: [utils/MaskSensitiveUtils.ts:67](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/utils/MaskSensitiveUtils.ts#L67)
|
|
13
|
+
|
|
14
|
+
Serializes a value to a JSON string with sensitive keys masked.
|
|
15
|
+
|
|
16
|
+
## Parameters
|
|
17
|
+
|
|
18
|
+
| Parameter | Type | Description |
|
|
19
|
+
| ------ | ------ | ------ |
|
|
20
|
+
| `value` | `unknown` | Arbitrary value to sanitize and serialize. |
|
|
21
|
+
|
|
22
|
+
## Returns
|
|
23
|
+
|
|
24
|
+
`string`
|
|
25
|
+
|
|
26
|
+
A JSON string safe for logging.
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: 'Function: maskSensitiveFields()'
|
|
3
|
+
generated: true
|
|
4
|
+
editUrl: false
|
|
5
|
+
---
|
|
6
|
+
# Function: maskSensitiveFields()
|
|
7
|
+
|
|
8
|
+
```ts
|
|
9
|
+
function maskSensitiveFields(value): unknown;
|
|
10
|
+
```
|
|
11
|
+
|
|
12
|
+
Defined in: [utils/MaskSensitiveUtils.ts:35](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-core/src/utils/MaskSensitiveUtils.ts#L35)
|
|
13
|
+
|
|
14
|
+
Recursively masks values of sensitive keys in a plain object for safe logging.
|
|
15
|
+
|
|
16
|
+
## Parameters
|
|
17
|
+
|
|
18
|
+
| Parameter | Type | Description |
|
|
19
|
+
| ------ | ------ | ------ |
|
|
20
|
+
| `value` | `unknown` | Arbitrary value to sanitize (objects, arrays, primitives). |
|
|
21
|
+
|
|
22
|
+
## Returns
|
|
23
|
+
|
|
24
|
+
`unknown`
|
|
25
|
+
|
|
26
|
+
A new value with sensitive fields replaced by `'***'`.
|
|
@@ -97,4 +97,6 @@ editUrl: false
|
|
|
97
97
|
| [createEventKey](Function.createEventKey) | Creates a branded event key for the [EventHub](Class.EventHub). |
|
|
98
98
|
| [env](Function.env) | Marker function for environment strings. |
|
|
99
99
|
| [getMimeTypeByFileNameOrExtension](Function.getMimeTypeByFileNameOrExtension) | Get MIME type by file name or extension. |
|
|
100
|
+
| [maskSensitive](Function.maskSensitive) | Serializes a value to a JSON string with sensitive keys masked. |
|
|
101
|
+
| [maskSensitiveFields](Function.maskSensitiveFields) | Recursively masks values of sensitive keys in a plain object for safe logging. |
|
|
100
102
|
| [Public](Function.Public) | The `Public` decorator. |
|
|
@@ -466,6 +466,14 @@ export class OrderService {
|
|
|
466
466
|
| `UserAvatarGeneratorService` | Generate deterministic avatars from user identifiers |
|
|
467
467
|
| `UsernameGeneratorService` | Generate random usernames from word lists |
|
|
468
468
|
| `SseHub` | Server-Sent Events hub — bounded to 10,000 event subjects |
|
|
469
|
+
| `maskSensitiveFields()` | Recursively masks sensitive keys (password, token, apikey, etc.) in objects for safe logging |
|
|
470
|
+
| `maskSensitive()` | Serializes a value to JSON with sensitive keys masked |
|
|
471
|
+
|
|
472
|
+
---
|
|
473
|
+
|
|
474
|
+
## HTTP Logger Middleware
|
|
475
|
+
|
|
476
|
+
The `HttpLoggerMiddleware` logs incoming requests with automatic masking of sensitive data in query parameters, route params, and request bodies. Sensitive fields (passwords, tokens, API keys, emails, etc.) are replaced with `'***'` before logging.
|
|
469
477
|
|
|
470
478
|
---
|
|
471
479
|
|
|
@@ -489,3 +497,6 @@ export class OrderService {
|
|
|
489
497
|
| `ContentTemplateEngine` | Service | Template compilation |
|
|
490
498
|
| `MemoryLayeredCache` | Class | In-memory LRU cache |
|
|
491
499
|
| `RedisLayeredCache` | Class | Redis-backed cache |
|
|
500
|
+
| `maskSensitiveFields()` | Utility | Recursively masks sensitive keys in objects for safe logging |
|
|
501
|
+
| `maskSensitive()` | Utility | JSON-serializes values with sensitive keys masked |
|
|
502
|
+
| `HttpLoggerMiddleware` | Middleware | Request logging with automatic sensitive data masking |
|
|
@@ -5,7 +5,7 @@ editUrl: false
|
|
|
5
5
|
---
|
|
6
6
|
# Class: DatabaseHealthIndicator
|
|
7
7
|
|
|
8
|
-
Defined in: [
|
|
8
|
+
Defined in: [health/DatabaseHealthIndicator.ts:16](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-database/src/health/DatabaseHealthIndicator.ts#L16)
|
|
9
9
|
|
|
10
10
|
Health indicator for database connectivity.
|
|
11
11
|
|
|
@@ -21,7 +21,7 @@ Health indicator for database connectivity.
|
|
|
21
21
|
new DatabaseHealthIndicator(prismaHealthIndicator, databaseService): DatabaseHealthIndicator;
|
|
22
22
|
```
|
|
23
23
|
|
|
24
|
-
Defined in: [
|
|
24
|
+
Defined in: [health/DatabaseHealthIndicator.ts:26](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-database/src/health/DatabaseHealthIndicator.ts#L26)
|
|
25
25
|
|
|
26
26
|
#### Parameters
|
|
27
27
|
|
|
@@ -39,10 +39,10 @@ Defined in: [terminus/DatabaseHealthIndicator.ts:26](https://github.com/RueDeRen
|
|
|
39
39
|
### key
|
|
40
40
|
|
|
41
41
|
```ts
|
|
42
|
-
readonly key:
|
|
42
|
+
readonly key: string = 'database';
|
|
43
43
|
```
|
|
44
44
|
|
|
45
|
-
Defined in: [
|
|
45
|
+
Defined in: [health/DatabaseHealthIndicator.ts:35](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-database/src/health/DatabaseHealthIndicator.ts#L35)
|
|
46
46
|
|
|
47
47
|
Unique key identifying the indicator
|
|
48
48
|
|
|
@@ -60,14 +60,16 @@ IHealthIndicator.key
|
|
|
60
60
|
check(): Promise<HealthIndicatorResult<"database">>;
|
|
61
61
|
```
|
|
62
62
|
|
|
63
|
-
Defined in: [
|
|
63
|
+
Defined in: [health/DatabaseHealthIndicator.ts:47](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-database/src/health/DatabaseHealthIndicator.ts#L47)
|
|
64
64
|
|
|
65
|
-
|
|
65
|
+
Checks database connectivity via a Prisma ping.
|
|
66
66
|
|
|
67
67
|
#### Returns
|
|
68
68
|
|
|
69
69
|
`Promise`\<`HealthIndicatorResult`\<`"database"`\>\>
|
|
70
70
|
|
|
71
|
+
The health indicator result.
|
|
72
|
+
|
|
71
73
|
#### Implementation of
|
|
72
74
|
|
|
73
75
|
```ts
|
|
@@ -5,7 +5,7 @@ editUrl: false
|
|
|
5
5
|
---
|
|
6
6
|
# Class: DatabaseModule
|
|
7
7
|
|
|
8
|
-
Defined in: [DatabaseModule.ts:
|
|
8
|
+
Defined in: [DatabaseModule.ts:53](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-database/src/DatabaseModule.ts#L53)
|
|
9
9
|
|
|
10
10
|
## Constructors
|
|
11
11
|
|
|
@@ -27,7 +27,7 @@ new DatabaseModule(): DatabaseModule;
|
|
|
27
27
|
static forRoot(config?): DynamicModule;
|
|
28
28
|
```
|
|
29
29
|
|
|
30
|
-
Defined in: [DatabaseModule.ts:
|
|
30
|
+
Defined in: [DatabaseModule.ts:62](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-database/src/DatabaseModule.ts#L62)
|
|
31
31
|
|
|
32
32
|
Registers the `DatabaseModule` with global middlewares.
|
|
33
33
|
|
|
@@ -51,7 +51,7 @@ A `DynamicModule` that can be imported globally
|
|
|
51
51
|
static register(config?): DynamicModule;
|
|
52
52
|
```
|
|
53
53
|
|
|
54
|
-
Defined in: [DatabaseModule.ts:
|
|
54
|
+
Defined in: [DatabaseModule.ts:82](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-database/src/DatabaseModule.ts#L82)
|
|
55
55
|
|
|
56
56
|
Registers the `DatabaseModule` with dynamic middlewares.
|
|
57
57
|
|
|
@@ -1,25 +1,21 @@
|
|
|
1
1
|
---
|
|
2
|
-
title: '
|
|
2
|
+
title: 'Abstract Class: RepositoryBase\<TDelegate, TArgs, TReturn, TEntity\>'
|
|
3
3
|
generated: true
|
|
4
4
|
editUrl: false
|
|
5
5
|
---
|
|
6
|
-
#
|
|
6
|
+
# Abstract Class: RepositoryBase\<TDelegate, TArgs, TReturn, TEntity\>
|
|
7
7
|
|
|
8
|
-
Defined in: [repositories/abstracts/RepositoryBase.ts:
|
|
8
|
+
Defined in: [repositories/abstracts/RepositoryBase.ts:74](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-database/src/repositories/abstracts/RepositoryBase.ts#L74)
|
|
9
9
|
|
|
10
10
|
The base class for all repositories.
|
|
11
11
|
|
|
12
|
-
## Deprecated
|
|
13
|
-
|
|
14
|
-
Use `RepositoryBase2` instead. This class will be removed in a future major version.
|
|
15
|
-
|
|
16
12
|
## Type Parameters
|
|
17
13
|
|
|
18
14
|
| Type Parameter | Default type |
|
|
19
15
|
| ------ | ------ |
|
|
20
|
-
| `TDelegate` *extends* `Record
|
|
21
|
-
| `TArgs` *extends* `Record
|
|
22
|
-
| `TReturn` *extends* `Record
|
|
16
|
+
| `TDelegate` *extends* `Record`\<[`RepositoryOperationsBase`](TypeAlias.RepositoryOperationsBase), (`args`) => `Promise`\<`any`\>\> | - |
|
|
17
|
+
| `TArgs` *extends* `Record`\<[`RepositoryOperationsBase`](TypeAlias.RepositoryOperationsBase), `unknown`\> | - |
|
|
18
|
+
| `TReturn` *extends* `Record`\<[`RepositoryOperationsBase`](TypeAlias.RepositoryOperationsBase), `unknown`\> | - |
|
|
23
19
|
| `TEntity` | `unknown` |
|
|
24
20
|
|
|
25
21
|
## Constructors
|
|
@@ -30,7 +26,7 @@ Use `RepositoryBase2` instead. This class will be removed in a future major vers
|
|
|
30
26
|
new RepositoryBase<TDelegate, TArgs, TReturn, TEntity>(db, model): RepositoryBase<TDelegate, TArgs, TReturn, TEntity>;
|
|
31
27
|
```
|
|
32
28
|
|
|
33
|
-
Defined in: [repositories/abstracts/RepositoryBase.ts:
|
|
29
|
+
Defined in: [repositories/abstracts/RepositoryBase.ts:91](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-database/src/repositories/abstracts/RepositoryBase.ts#L91)
|
|
34
30
|
|
|
35
31
|
#### Parameters
|
|
36
32
|
|
|
@@ -45,7 +41,7 @@ Defined in: [repositories/abstracts/RepositoryBase.ts:61](https://github.com/Rue
|
|
|
45
41
|
|
|
46
42
|
## Accessors
|
|
47
43
|
|
|
48
|
-
###
|
|
44
|
+
### database
|
|
49
45
|
|
|
50
46
|
#### Get Signature
|
|
51
47
|
|
|
@@ -53,7 +49,7 @@ Defined in: [repositories/abstracts/RepositoryBase.ts:61](https://github.com/Rue
|
|
|
53
49
|
get protected database(): DatabaseService;
|
|
54
50
|
```
|
|
55
51
|
|
|
56
|
-
Defined in: [repositories/abstracts/RepositoryBase.ts:
|
|
52
|
+
Defined in: [repositories/abstracts/RepositoryBase.ts:114](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-database/src/repositories/abstracts/RepositoryBase.ts#L114)
|
|
57
53
|
|
|
58
54
|
Provides access to the underlying DatabaseService for derived repositories.
|
|
59
55
|
Only to be used for transactional orchestration that spans multiple models.
|
|
@@ -64,7 +60,7 @@ Only to be used for transactional orchestration that spans multiple models.
|
|
|
64
60
|
|
|
65
61
|
***
|
|
66
62
|
|
|
67
|
-
###
|
|
63
|
+
### model
|
|
68
64
|
|
|
69
65
|
#### Get Signature
|
|
70
66
|
|
|
@@ -72,7 +68,7 @@ Only to be used for transactional orchestration that spans multiple models.
|
|
|
72
68
|
get protected model(): TDelegate;
|
|
73
69
|
```
|
|
74
70
|
|
|
75
|
-
Defined in: [repositories/abstracts/RepositoryBase.ts:
|
|
71
|
+
Defined in: [repositories/abstracts/RepositoryBase.ts:104](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-database/src/repositories/abstracts/RepositoryBase.ts#L104)
|
|
76
72
|
|
|
77
73
|
##### Returns
|
|
78
74
|
|
|
@@ -80,13 +76,13 @@ Defined in: [repositories/abstracts/RepositoryBase.ts:74](https://github.com/Rue
|
|
|
80
76
|
|
|
81
77
|
## Methods
|
|
82
78
|
|
|
83
|
-
###
|
|
79
|
+
### aggregate()
|
|
84
80
|
|
|
85
81
|
```ts
|
|
86
82
|
protected aggregate<TResult>(args): Promise<TResult>;
|
|
87
83
|
```
|
|
88
84
|
|
|
89
|
-
Defined in: [repositories/abstracts/RepositoryBase.ts:
|
|
85
|
+
Defined in: [repositories/abstracts/RepositoryBase.ts:312](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-database/src/repositories/abstracts/RepositoryBase.ts#L312)
|
|
90
86
|
|
|
91
87
|
Performs aggregation operations on the records.
|
|
92
88
|
|
|
@@ -110,13 +106,13 @@ The aggregation result.
|
|
|
110
106
|
|
|
111
107
|
***
|
|
112
108
|
|
|
113
|
-
###
|
|
109
|
+
### count()
|
|
114
110
|
|
|
115
111
|
```ts
|
|
116
112
|
protected count<TResult>(args): Promise<TResult>;
|
|
117
113
|
```
|
|
118
114
|
|
|
119
|
-
Defined in: [repositories/abstracts/RepositoryBase.ts:
|
|
115
|
+
Defined in: [repositories/abstracts/RepositoryBase.ts:324](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-database/src/repositories/abstracts/RepositoryBase.ts#L324)
|
|
120
116
|
|
|
121
117
|
Counts the number of records that match the criteria.
|
|
122
118
|
|
|
@@ -140,13 +136,13 @@ The count of matching records.
|
|
|
140
136
|
|
|
141
137
|
***
|
|
142
138
|
|
|
143
|
-
###
|
|
139
|
+
### create()
|
|
144
140
|
|
|
145
141
|
```ts
|
|
146
142
|
protected create<TResult>(args): Promise<TResult>;
|
|
147
143
|
```
|
|
148
144
|
|
|
149
|
-
Defined in: [repositories/abstracts/RepositoryBase.ts:
|
|
145
|
+
Defined in: [repositories/abstracts/RepositoryBase.ts:228](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-database/src/repositories/abstracts/RepositoryBase.ts#L228)
|
|
150
146
|
|
|
151
147
|
Creates a new record.
|
|
152
148
|
|
|
@@ -170,13 +166,13 @@ The created record.
|
|
|
170
166
|
|
|
171
167
|
***
|
|
172
168
|
|
|
173
|
-
###
|
|
169
|
+
### createMany()
|
|
174
170
|
|
|
175
171
|
```ts
|
|
176
172
|
protected createMany<TResult>(args): Promise<TResult>;
|
|
177
173
|
```
|
|
178
174
|
|
|
179
|
-
Defined in: [repositories/abstracts/RepositoryBase.ts:
|
|
175
|
+
Defined in: [repositories/abstracts/RepositoryBase.ts:240](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-database/src/repositories/abstracts/RepositoryBase.ts#L240)
|
|
180
176
|
|
|
181
177
|
Creates multiple records.
|
|
182
178
|
|
|
@@ -200,13 +196,13 @@ The created records.
|
|
|
200
196
|
|
|
201
197
|
***
|
|
202
198
|
|
|
203
|
-
###
|
|
199
|
+
### delete()
|
|
204
200
|
|
|
205
201
|
```ts
|
|
206
202
|
protected delete<TResult>(args): Promise<TResult>;
|
|
207
203
|
```
|
|
208
204
|
|
|
209
|
-
Defined in: [repositories/abstracts/RepositoryBase.ts:
|
|
205
|
+
Defined in: [repositories/abstracts/RepositoryBase.ts:288](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-database/src/repositories/abstracts/RepositoryBase.ts#L288)
|
|
210
206
|
|
|
211
207
|
Deletes a record by its identifier.
|
|
212
208
|
|
|
@@ -230,13 +226,13 @@ The deleted record.
|
|
|
230
226
|
|
|
231
227
|
***
|
|
232
228
|
|
|
233
|
-
###
|
|
229
|
+
### deleteMany()
|
|
234
230
|
|
|
235
231
|
```ts
|
|
236
232
|
protected deleteMany<TResult>(args): Promise<TResult>;
|
|
237
233
|
```
|
|
238
234
|
|
|
239
|
-
Defined in: [repositories/abstracts/RepositoryBase.ts:
|
|
235
|
+
Defined in: [repositories/abstracts/RepositoryBase.ts:300](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-database/src/repositories/abstracts/RepositoryBase.ts#L300)
|
|
240
236
|
|
|
241
237
|
Deletes multiple records by their identifiers.
|
|
242
238
|
|
|
@@ -260,13 +256,13 @@ The deleted records.
|
|
|
260
256
|
|
|
261
257
|
***
|
|
262
258
|
|
|
263
|
-
###
|
|
259
|
+
### execute()
|
|
264
260
|
|
|
265
261
|
```ts
|
|
266
262
|
execute<TResult>(query): Promise<TResult>;
|
|
267
263
|
```
|
|
268
264
|
|
|
269
|
-
Defined in: [repositories/abstracts/RepositoryBase.ts:
|
|
265
|
+
Defined in: [repositories/abstracts/RepositoryBase.ts:129](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-database/src/repositories/abstracts/RepositoryBase.ts#L129)
|
|
270
266
|
|
|
271
267
|
Executes a predefined query against the underlying model.
|
|
272
268
|
|
|
@@ -290,13 +286,13 @@ The query result.
|
|
|
290
286
|
|
|
291
287
|
***
|
|
292
288
|
|
|
293
|
-
###
|
|
289
|
+
### executeTransactional()
|
|
294
290
|
|
|
295
291
|
```ts
|
|
296
292
|
executeTransactional<TResult>(query): Promise<TResult>;
|
|
297
293
|
```
|
|
298
294
|
|
|
299
|
-
Defined in: [repositories/abstracts/RepositoryBase.ts:
|
|
295
|
+
Defined in: [repositories/abstracts/RepositoryBase.ts:141](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-database/src/repositories/abstracts/RepositoryBase.ts#L141)
|
|
300
296
|
|
|
301
297
|
Executes a transactional query providing a Prisma TransactionClient for multi-model work.
|
|
302
298
|
|
|
@@ -320,13 +316,13 @@ The query result.
|
|
|
320
316
|
|
|
321
317
|
***
|
|
322
318
|
|
|
323
|
-
###
|
|
319
|
+
### findFirst()
|
|
324
320
|
|
|
325
321
|
```ts
|
|
326
322
|
protected findFirst<TResult>(args): Promise<TResult>;
|
|
327
323
|
```
|
|
328
324
|
|
|
329
|
-
Defined in: [repositories/abstracts/RepositoryBase.ts:
|
|
325
|
+
Defined in: [repositories/abstracts/RepositoryBase.ts:203](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-database/src/repositories/abstracts/RepositoryBase.ts#L203)
|
|
330
326
|
|
|
331
327
|
Finds the first record that matches the criteria.
|
|
332
328
|
|
|
@@ -350,13 +346,47 @@ The found record or null if not found.
|
|
|
350
346
|
|
|
351
347
|
***
|
|
352
348
|
|
|
353
|
-
###
|
|
349
|
+
### findFirstOrThrow()
|
|
350
|
+
|
|
351
|
+
```ts
|
|
352
|
+
protected findFirstOrThrow<TResult>(args): Promise<TResult>;
|
|
353
|
+
```
|
|
354
|
+
|
|
355
|
+
Defined in: [repositories/abstracts/RepositoryBase.ts:216](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-database/src/repositories/abstracts/RepositoryBase.ts#L216)
|
|
356
|
+
|
|
357
|
+
Finds the first record that matches the criteria or throws if not found.
|
|
358
|
+
|
|
359
|
+
#### Type Parameters
|
|
360
|
+
|
|
361
|
+
| Type Parameter | Default type |
|
|
362
|
+
| ------ | ------ |
|
|
363
|
+
| `TResult` | `TReturn`\[`"findFirstOrThrow"`\] |
|
|
364
|
+
|
|
365
|
+
#### Parameters
|
|
366
|
+
|
|
367
|
+
| Parameter | Type | Description |
|
|
368
|
+
| ------ | ------ | ------ |
|
|
369
|
+
| `args` | `TArgs`\[`"findFirstOrThrow"`\] | The arguments to find the first record. |
|
|
370
|
+
|
|
371
|
+
#### Returns
|
|
372
|
+
|
|
373
|
+
`Promise`\<`TResult`\>
|
|
374
|
+
|
|
375
|
+
The found record.
|
|
376
|
+
|
|
377
|
+
#### Throws
|
|
378
|
+
|
|
379
|
+
PrismaClientKnownRequestError with code P2025 if no record matches.
|
|
380
|
+
|
|
381
|
+
***
|
|
382
|
+
|
|
383
|
+
### findMany()
|
|
354
384
|
|
|
355
385
|
```ts
|
|
356
386
|
findMany<TResult>(args?, page?): Promise<TResult>;
|
|
357
387
|
```
|
|
358
388
|
|
|
359
|
-
Defined in: [repositories/abstracts/RepositoryBase.ts:
|
|
389
|
+
Defined in: [repositories/abstracts/RepositoryBase.ts:181](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-database/src/repositories/abstracts/RepositoryBase.ts#L181)
|
|
360
390
|
|
|
361
391
|
Finds multiple records with optional pagination.
|
|
362
392
|
|
|
@@ -381,13 +411,13 @@ The found records.
|
|
|
381
411
|
|
|
382
412
|
***
|
|
383
413
|
|
|
384
|
-
###
|
|
414
|
+
### findUnique()
|
|
385
415
|
|
|
386
416
|
```ts
|
|
387
417
|
protected findUnique<TResult>(args): Promise<TResult>;
|
|
388
418
|
```
|
|
389
419
|
|
|
390
|
-
Defined in: [repositories/abstracts/RepositoryBase.ts:
|
|
420
|
+
Defined in: [repositories/abstracts/RepositoryBase.ts:153](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-database/src/repositories/abstracts/RepositoryBase.ts#L153)
|
|
391
421
|
|
|
392
422
|
Finds a unique record by its identifier.
|
|
393
423
|
|
|
@@ -411,13 +441,47 @@ The found record or null if not found.
|
|
|
411
441
|
|
|
412
442
|
***
|
|
413
443
|
|
|
414
|
-
###
|
|
444
|
+
### findUniqueOrThrow()
|
|
445
|
+
|
|
446
|
+
```ts
|
|
447
|
+
protected findUniqueOrThrow<TResult>(args): Promise<TResult>;
|
|
448
|
+
```
|
|
449
|
+
|
|
450
|
+
Defined in: [repositories/abstracts/RepositoryBase.ts:166](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-database/src/repositories/abstracts/RepositoryBase.ts#L166)
|
|
451
|
+
|
|
452
|
+
Finds a unique record by its identifier or throws if not found.
|
|
453
|
+
|
|
454
|
+
#### Type Parameters
|
|
455
|
+
|
|
456
|
+
| Type Parameter | Default type |
|
|
457
|
+
| ------ | ------ |
|
|
458
|
+
| `TResult` | `TReturn`\[`"findUniqueOrThrow"`\] |
|
|
459
|
+
|
|
460
|
+
#### Parameters
|
|
461
|
+
|
|
462
|
+
| Parameter | Type | Description |
|
|
463
|
+
| ------ | ------ | ------ |
|
|
464
|
+
| `args` | `TArgs`\[`"findUniqueOrThrow"`\] | The arguments to find the unique record. |
|
|
465
|
+
|
|
466
|
+
#### Returns
|
|
467
|
+
|
|
468
|
+
`Promise`\<`TResult`\>
|
|
469
|
+
|
|
470
|
+
The found record.
|
|
471
|
+
|
|
472
|
+
#### Throws
|
|
473
|
+
|
|
474
|
+
PrismaClientKnownRequestError with code P2025 if the record does not exist.
|
|
475
|
+
|
|
476
|
+
***
|
|
477
|
+
|
|
478
|
+
### groupBy()
|
|
415
479
|
|
|
416
480
|
```ts
|
|
417
481
|
protected groupBy<TResult>(args): Promise<TResult>;
|
|
418
482
|
```
|
|
419
483
|
|
|
420
|
-
Defined in: [repositories/abstracts/RepositoryBase.ts:
|
|
484
|
+
Defined in: [repositories/abstracts/RepositoryBase.ts:336](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-database/src/repositories/abstracts/RepositoryBase.ts#L336)
|
|
421
485
|
|
|
422
486
|
Groups records by specified fields and performs aggregations.
|
|
423
487
|
|
|
@@ -441,13 +505,13 @@ The grouped records with aggregations.
|
|
|
441
505
|
|
|
442
506
|
***
|
|
443
507
|
|
|
444
|
-
###
|
|
508
|
+
### merge()
|
|
445
509
|
|
|
446
510
|
```ts
|
|
447
511
|
protected merge<TResult>(entity): Promise<TResult>;
|
|
448
512
|
```
|
|
449
513
|
|
|
450
|
-
Defined in: [repositories/abstracts/RepositoryBase.ts:
|
|
514
|
+
Defined in: [repositories/abstracts/RepositoryBase.ts:348](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-database/src/repositories/abstracts/RepositoryBase.ts#L348)
|
|
451
515
|
|
|
452
516
|
Merges the given `data` with the user identified by the `id`.
|
|
453
517
|
|
|
@@ -471,13 +535,13 @@ The merged data.
|
|
|
471
535
|
|
|
472
536
|
***
|
|
473
537
|
|
|
474
|
-
###
|
|
538
|
+
### tryCatch()
|
|
475
539
|
|
|
476
540
|
```ts
|
|
477
541
|
protected tryCatch<T>(promise): Promise<T>;
|
|
478
542
|
```
|
|
479
543
|
|
|
480
|
-
Defined in: [repositories/abstracts/RepositoryBase.ts:
|
|
544
|
+
Defined in: [repositories/abstracts/RepositoryBase.ts:382](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-database/src/repositories/abstracts/RepositoryBase.ts#L382)
|
|
481
545
|
|
|
482
546
|
Wraps a promise in a try-catch block to handle errors uniformly.
|
|
483
547
|
|
|
@@ -501,13 +565,13 @@ The result of the promise or throws an error.
|
|
|
501
565
|
|
|
502
566
|
***
|
|
503
567
|
|
|
504
|
-
###
|
|
568
|
+
### update()
|
|
505
569
|
|
|
506
570
|
```ts
|
|
507
571
|
protected update<TResult>(args): Promise<TResult>;
|
|
508
572
|
```
|
|
509
573
|
|
|
510
|
-
Defined in: [repositories/abstracts/RepositoryBase.ts:
|
|
574
|
+
Defined in: [repositories/abstracts/RepositoryBase.ts:252](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-database/src/repositories/abstracts/RepositoryBase.ts#L252)
|
|
511
575
|
|
|
512
576
|
Updates an existing record.
|
|
513
577
|
|
|
@@ -531,13 +595,13 @@ The updated record.
|
|
|
531
595
|
|
|
532
596
|
***
|
|
533
597
|
|
|
534
|
-
###
|
|
598
|
+
### updateMany()
|
|
535
599
|
|
|
536
600
|
```ts
|
|
537
601
|
protected updateMany<TResult>(args): Promise<TResult>;
|
|
538
602
|
```
|
|
539
603
|
|
|
540
|
-
Defined in: [repositories/abstracts/RepositoryBase.ts:
|
|
604
|
+
Defined in: [repositories/abstracts/RepositoryBase.ts:264](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-database/src/repositories/abstracts/RepositoryBase.ts#L264)
|
|
541
605
|
|
|
542
606
|
Updates multiple existing records.
|
|
543
607
|
|
|
@@ -561,13 +625,13 @@ The updated records.
|
|
|
561
625
|
|
|
562
626
|
***
|
|
563
627
|
|
|
564
|
-
###
|
|
628
|
+
### upsert()
|
|
565
629
|
|
|
566
630
|
```ts
|
|
567
631
|
protected upsert<TResult>(args): Promise<TResult>;
|
|
568
632
|
```
|
|
569
633
|
|
|
570
|
-
Defined in: [repositories/abstracts/RepositoryBase.ts:
|
|
634
|
+
Defined in: [repositories/abstracts/RepositoryBase.ts:276](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-database/src/repositories/abstracts/RepositoryBase.ts#L276)
|
|
571
635
|
|
|
572
636
|
Creates or updates a record based on its existence.
|
|
573
637
|
|