@appwrite.io/console 15.6.0 → 15.8.0
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/README.md +1 -1
- package/dist/cjs/sdk.js +237 -33
- package/dist/cjs/sdk.js.map +1 -1
- package/dist/esm/sdk.js +237 -33
- package/dist/esm/sdk.js.map +1 -1
- package/dist/iife/sdk.js +237 -33
- package/package.json +2 -2
- package/types/enums/build-runtime.d.ts +1 -0
- package/types/enums/runtime.d.ts +1 -0
- package/types/models.d.ts +152 -15
- package/types/services/backups.d.ts +6 -6
- package/types/services/documents-db.d.ts +13 -4
- package/types/services/mongo.d.ts +3 -6
- package/types/services/mysql.d.ts +5 -8
- package/types/services/postgresql.d.ts +5 -8
- package/types/services/project.d.ts +10 -10
- package/types/services/storage.d.ts +4 -1
- package/types/services/tables-db.d.ts +13 -4
- package/types/services/vectors-db.d.ts +13 -4
- package/types/services/waf.d.ts +126 -18
package/types/models.d.ts
CHANGED
|
@@ -880,7 +880,7 @@ export declare namespace Models {
|
|
|
880
880
|
*/
|
|
881
881
|
status?: DatabaseStatus;
|
|
882
882
|
/**
|
|
883
|
-
* Underlying engine of the dedicated backing: postgresql, mysql,
|
|
883
|
+
* Underlying engine of the dedicated backing: postgresql, mysql, or mongodb. A managed product (tablesdb, documentsdb, vectorsdb) reports the engine it runs on, so its type and engine can differ. Null when the database has no dedicated backing.
|
|
884
884
|
*/
|
|
885
885
|
engine?: string;
|
|
886
886
|
/**
|
|
@@ -8743,6 +8743,14 @@ export declare namespace Models {
|
|
|
8743
8743
|
* Backup type. Possible values: full (complete database snapshot), incremental (changes since last backup), wal (write-ahead log continuous archival).
|
|
8744
8744
|
*/
|
|
8745
8745
|
type: string;
|
|
8746
|
+
/**
|
|
8747
|
+
* Backup type that was requested. Differs from `type` when the backend could not run the requested type and took a different one instead, in which case `fallbackReason` explains why. Empty for backups taken before the requested type was recorded.
|
|
8748
|
+
*/
|
|
8749
|
+
requestedType: string;
|
|
8750
|
+
/**
|
|
8751
|
+
* Why the backend ran a different backup type than the one requested. Empty when the backup ran as requested.
|
|
8752
|
+
*/
|
|
8753
|
+
fallbackReason: string;
|
|
8746
8754
|
/**
|
|
8747
8755
|
* Backup status. Possible values: pending (queued for processing), running (currently in progress), completed (successfully finished), failed (encountered an error), verified (integrity check passed).
|
|
8748
8756
|
*/
|
|
@@ -9417,7 +9425,7 @@ export declare namespace Models {
|
|
|
9417
9425
|
*/
|
|
9418
9426
|
host: string;
|
|
9419
9427
|
/**
|
|
9420
|
-
* Branch port.
|
|
9428
|
+
* Branch port. Null until the backing reports one.
|
|
9421
9429
|
*/
|
|
9422
9430
|
port: number;
|
|
9423
9431
|
/**
|
|
@@ -9437,7 +9445,7 @@ export declare namespace Models {
|
|
|
9437
9445
|
*/
|
|
9438
9446
|
ssl: boolean;
|
|
9439
9447
|
/**
|
|
9440
|
-
* Database engine. Possible values: postgresql, mysql,
|
|
9448
|
+
* Database engine. Possible values: postgresql, mysql, mongodb.
|
|
9441
9449
|
*/
|
|
9442
9450
|
engine: string;
|
|
9443
9451
|
/**
|
|
@@ -9651,6 +9659,14 @@ export declare namespace Models {
|
|
|
9651
9659
|
* Migration phase. Possible values: pending, provisioned, capturing, backfilling, catching_up, verifying, ready_to_cutover, cutover, soaking, done, failed, rolled_back.
|
|
9652
9660
|
*/
|
|
9653
9661
|
phase: string;
|
|
9662
|
+
/**
|
|
9663
|
+
* Number of times a migration step has failed and been recorded.
|
|
9664
|
+
*/
|
|
9665
|
+
attempt: number;
|
|
9666
|
+
/**
|
|
9667
|
+
* Reason the most recent migration step failed, empty while none has.
|
|
9668
|
+
*/
|
|
9669
|
+
lastError: string;
|
|
9654
9670
|
/**
|
|
9655
9671
|
* Number of documents still pending replication to the target.
|
|
9656
9672
|
*/
|
|
@@ -9705,7 +9721,7 @@ export declare namespace Models {
|
|
|
9705
9721
|
*/
|
|
9706
9722
|
api: string;
|
|
9707
9723
|
/**
|
|
9708
|
-
* Database engine: postgresql, mysql,
|
|
9724
|
+
* Database engine: postgresql, mysql, or mongodb.
|
|
9709
9725
|
*/
|
|
9710
9726
|
engine: string;
|
|
9711
9727
|
/**
|
|
@@ -9725,7 +9741,7 @@ export declare namespace Models {
|
|
|
9725
9741
|
*/
|
|
9726
9742
|
hostname: string;
|
|
9727
9743
|
/**
|
|
9728
|
-
* Database port for connections.
|
|
9744
|
+
* Database port for connections. Derived from the engine when the backing has not reported one yet.
|
|
9729
9745
|
*/
|
|
9730
9746
|
connectionPort: number;
|
|
9731
9747
|
/**
|
|
@@ -9805,7 +9821,7 @@ export declare namespace Models {
|
|
|
9805
9821
|
*/
|
|
9806
9822
|
crossRegionReplicas: number;
|
|
9807
9823
|
/**
|
|
9808
|
-
* Maximum concurrent connections.
|
|
9824
|
+
* Maximum concurrent client connections. This is the limit a client pool may reach; the engine's own max_connections reported by the status endpoint is a smaller backend limit the pooler multiplexes onto and does not constrain a client pool.
|
|
9809
9825
|
*/
|
|
9810
9826
|
networkMaxConnections: number;
|
|
9811
9827
|
/**
|
|
@@ -9981,7 +9997,7 @@ export declare namespace Models {
|
|
|
9981
9997
|
*/
|
|
9982
9998
|
ready: boolean;
|
|
9983
9999
|
/**
|
|
9984
|
-
* Database engine: postgresql, mysql,
|
|
10000
|
+
* Database engine: postgresql, mysql, or mongodb.
|
|
9985
10001
|
*/
|
|
9986
10002
|
engine: string;
|
|
9987
10003
|
/**
|
|
@@ -9997,7 +10013,31 @@ export declare namespace Models {
|
|
|
9997
10013
|
*/
|
|
9998
10014
|
connections: DatabaseStatusConnections;
|
|
9999
10015
|
/**
|
|
10000
|
-
*
|
|
10016
|
+
* Requested replication sync mode. Possible values: async, sync, quorum. Compare with effectiveSyncMode for what the primary is enforcing.
|
|
10017
|
+
*/
|
|
10018
|
+
syncMode: string;
|
|
10019
|
+
/**
|
|
10020
|
+
* Replication sync mode the primary is actually enforcing. Null when high availability is disabled or the state could not be read.
|
|
10021
|
+
*/
|
|
10022
|
+
effectiveSyncMode?: string;
|
|
10023
|
+
/**
|
|
10024
|
+
* Whether the enforced replication is weaker than the requested syncMode.
|
|
10025
|
+
*/
|
|
10026
|
+
syncDegraded: boolean;
|
|
10027
|
+
/**
|
|
10028
|
+
* Number of standby acknowledgements the primary waits for before a write is committed.
|
|
10029
|
+
*/
|
|
10030
|
+
syncAcknowledgements: number;
|
|
10031
|
+
/**
|
|
10032
|
+
* Number of standbys registered with the primary for synchronous replication.
|
|
10033
|
+
*/
|
|
10034
|
+
syncStandbyCount: number;
|
|
10035
|
+
/**
|
|
10036
|
+
* Whether the reported sync state was read from the engine. When false the state could not be confirmed and the other sync fields carry no reading.
|
|
10037
|
+
*/
|
|
10038
|
+
syncStateConfirmed: boolean;
|
|
10039
|
+
/**
|
|
10040
|
+
* List of database replicas and their status. Every configured member appears, including one the backend has not brought up, which is reported as not healthy.
|
|
10001
10041
|
*/
|
|
10002
10042
|
replicas: DatabaseStatusReplica[];
|
|
10003
10043
|
/**
|
|
@@ -10432,11 +10472,11 @@ export declare namespace Models {
|
|
|
10432
10472
|
*/
|
|
10433
10473
|
$id: string;
|
|
10434
10474
|
/**
|
|
10435
|
-
* Member role. Possible values: primary (accepts reads and writes), replica (read-only follower).
|
|
10475
|
+
* Member role. Possible values: primary (accepts reads and writes), replica (read-only follower), unknown (placement not established; reported while a transition is moving or restarting the topology and this member has not been probed, so no member can be named the write target).
|
|
10436
10476
|
*/
|
|
10437
10477
|
role: string;
|
|
10438
10478
|
/**
|
|
10439
|
-
* Member pod status. Possible values: provisioning (pod missing or Pending), starting (Running but not Ready), active (Running and Ready), failed (Failed phase or CrashLoopBackOff container), or the lowercased pod phase reported by the cluster.
|
|
10479
|
+
* Member pod status. Possible values: pending (configured but absent from the backend topology, so nothing is bringing it up), provisioning (pod missing or Pending), starting (Running but not Ready), active (Running and Ready), failed (Failed phase or CrashLoopBackOff container), or the lowercased pod phase reported by the cluster.
|
|
10440
10480
|
*/
|
|
10441
10481
|
status: string;
|
|
10442
10482
|
/**
|
|
@@ -10515,9 +10555,29 @@ export declare namespace Models {
|
|
|
10515
10555
|
*/
|
|
10516
10556
|
replicas: number;
|
|
10517
10557
|
/**
|
|
10518
|
-
*
|
|
10558
|
+
* Requested replication sync mode. Possible values: async (asynchronous, fastest), sync (synchronous, strong consistency), quorum (quorum-based, majority of replicas must confirm). This is what was asked for; compare it with effectiveSyncMode for what the primary is enforcing.
|
|
10519
10559
|
*/
|
|
10520
10560
|
syncMode: string;
|
|
10561
|
+
/**
|
|
10562
|
+
* Replication sync mode the primary is actually enforcing. Null when high availability is disabled or the state could not be read. A value below the requested syncMode means writes are being acknowledged with weaker durability than configured.
|
|
10563
|
+
*/
|
|
10564
|
+
effectiveSyncMode?: string;
|
|
10565
|
+
/**
|
|
10566
|
+
* Whether the enforced replication is weaker than the requested syncMode.
|
|
10567
|
+
*/
|
|
10568
|
+
syncDegraded: boolean;
|
|
10569
|
+
/**
|
|
10570
|
+
* Number of standby acknowledgements the primary waits for before a write is committed. Zero means writes are acknowledged locally.
|
|
10571
|
+
*/
|
|
10572
|
+
syncAcknowledgements: number;
|
|
10573
|
+
/**
|
|
10574
|
+
* Number of standbys registered with the primary for synchronous replication.
|
|
10575
|
+
*/
|
|
10576
|
+
syncStandbyCount: number;
|
|
10577
|
+
/**
|
|
10578
|
+
* Whether the reported sync state was read from the engine. When false the state could not be confirmed and the other sync fields carry no reading.
|
|
10579
|
+
*/
|
|
10580
|
+
syncStateConfirmed: boolean;
|
|
10521
10581
|
/**
|
|
10522
10582
|
* Per-pod statuses for the primary and every replica.
|
|
10523
10583
|
*/
|
|
@@ -11130,7 +11190,7 @@ export declare namespace Models {
|
|
|
11130
11190
|
*/
|
|
11131
11191
|
mode: string;
|
|
11132
11192
|
/**
|
|
11133
|
-
*
|
|
11193
|
+
* Client-connection ceiling the pooler accepts. Enforced on MySQL and MariaDB; on PostgreSQL the pooler has no client cap, so this reports the database's advertised networkMaxConnections and cannot be set here.
|
|
11134
11194
|
*/
|
|
11135
11195
|
maxConnections: number;
|
|
11136
11196
|
/**
|
|
@@ -11441,7 +11501,7 @@ export declare namespace Models {
|
|
|
11441
11501
|
*/
|
|
11442
11502
|
current: number;
|
|
11443
11503
|
/**
|
|
11444
|
-
*
|
|
11504
|
+
* The engine's own max_connections. On a pooled database this is the backend limit the pooler multiplexes onto, not the ceiling a client pool may reach — that is networkMaxConnections on the database resource.
|
|
11445
11505
|
*/
|
|
11446
11506
|
max: number;
|
|
11447
11507
|
};
|
|
@@ -11450,11 +11510,11 @@ export declare namespace Models {
|
|
|
11450
11510
|
*/
|
|
11451
11511
|
export type DatabaseStatusReplica = {
|
|
11452
11512
|
/**
|
|
11453
|
-
*
|
|
11513
|
+
* Member index within the database. Read `role` for which member accepts writes: a failover moves the primary without renumbering the indexes.
|
|
11454
11514
|
*/
|
|
11455
11515
|
index: number;
|
|
11456
11516
|
/**
|
|
11457
|
-
*
|
|
11517
|
+
* Member role. Possible values: primary (accepts reads and writes), replica (read-only follower), unknown (placement not established; reported while a transition is moving or restarting the topology, so no member can be named the write target).
|
|
11458
11518
|
*/
|
|
11459
11519
|
role: string;
|
|
11460
11520
|
/**
|
|
@@ -12681,6 +12741,79 @@ export declare namespace Models {
|
|
|
12681
12741
|
*/
|
|
12682
12742
|
config: object;
|
|
12683
12743
|
};
|
|
12744
|
+
/**
|
|
12745
|
+
* WafRuleChallenge
|
|
12746
|
+
*/
|
|
12747
|
+
export type WafRuleChallenge = {
|
|
12748
|
+
/**
|
|
12749
|
+
* Rule ID.
|
|
12750
|
+
*/
|
|
12751
|
+
$id: string;
|
|
12752
|
+
/**
|
|
12753
|
+
* WAF rule creation time in ISO 8601 format.
|
|
12754
|
+
*/
|
|
12755
|
+
$createdAt: string;
|
|
12756
|
+
/**
|
|
12757
|
+
* WAF rule last update time in ISO 8601 format.
|
|
12758
|
+
*/
|
|
12759
|
+
$updatedAt: string;
|
|
12760
|
+
/**
|
|
12761
|
+
* Human friendly rule name.
|
|
12762
|
+
*/
|
|
12763
|
+
name: string;
|
|
12764
|
+
/**
|
|
12765
|
+
* Optional description for the rule.
|
|
12766
|
+
*/
|
|
12767
|
+
description: string;
|
|
12768
|
+
/**
|
|
12769
|
+
* Team ID.
|
|
12770
|
+
*/
|
|
12771
|
+
teamId: string;
|
|
12772
|
+
/**
|
|
12773
|
+
* Project ID.
|
|
12774
|
+
*/
|
|
12775
|
+
projectId: string;
|
|
12776
|
+
/**
|
|
12777
|
+
* Resource type the rule is scoped to.
|
|
12778
|
+
*/
|
|
12779
|
+
resourceType: string;
|
|
12780
|
+
/**
|
|
12781
|
+
* Resource identifier. Empty for API-wide rules.
|
|
12782
|
+
*/
|
|
12783
|
+
resourceId: string;
|
|
12784
|
+
/**
|
|
12785
|
+
* Action performed when the rule matches.
|
|
12786
|
+
*/
|
|
12787
|
+
action: WafRuleAction;
|
|
12788
|
+
/**
|
|
12789
|
+
* Evaluation priority. Lower values execute earlier.
|
|
12790
|
+
*/
|
|
12791
|
+
priority: number;
|
|
12792
|
+
/**
|
|
12793
|
+
* Whether the rule is active.
|
|
12794
|
+
*/
|
|
12795
|
+
enabled: boolean;
|
|
12796
|
+
/**
|
|
12797
|
+
* List of conditions evaluated for this rule.
|
|
12798
|
+
*/
|
|
12799
|
+
conditions: object;
|
|
12800
|
+
/**
|
|
12801
|
+
* Action specific configuration.
|
|
12802
|
+
*/
|
|
12803
|
+
config: object;
|
|
12804
|
+
/**
|
|
12805
|
+
* Challenge type enforced when the rule matches.
|
|
12806
|
+
*/
|
|
12807
|
+
challengeType: string;
|
|
12808
|
+
/**
|
|
12809
|
+
* Challenge difficulty from 1 (easiest) to 5 (hardest) enforced when the rule matches.
|
|
12810
|
+
*/
|
|
12811
|
+
difficulty: number;
|
|
12812
|
+
/**
|
|
12813
|
+
* Seconds a visitor stays cleared after passing the challenge before being challenged again.
|
|
12814
|
+
*/
|
|
12815
|
+
ttl: number;
|
|
12816
|
+
};
|
|
12684
12817
|
/**
|
|
12685
12818
|
* WafRuleRateLimit
|
|
12686
12819
|
*/
|
|
@@ -12749,6 +12882,10 @@ export declare namespace Models {
|
|
|
12749
12882
|
* Interval in seconds for the rate limit window.
|
|
12750
12883
|
*/
|
|
12751
12884
|
interval: number;
|
|
12885
|
+
/**
|
|
12886
|
+
* Rate limit key: `ip` limits per client IP, `userId` limits per authenticated user.
|
|
12887
|
+
*/
|
|
12888
|
+
key: string;
|
|
12752
12889
|
};
|
|
12753
12890
|
/**
|
|
12754
12891
|
* WafRuleRedirect
|
|
@@ -211,18 +211,18 @@ export declare class Backups {
|
|
|
211
211
|
/**
|
|
212
212
|
* Create and trigger a new restoration for a backup on a project.
|
|
213
213
|
*
|
|
214
|
-
* For a backup of one database, the restoration resolves its destination before it is queued.
|
|
214
|
+
* For a backup of one database, the restoration resolves its destination before it is queued. When `newResourceId` is omitted, the archived database is restored in place and its own ID is returned in `options`. Pass a different `newResourceId` to restore alongside it as a new database instead.
|
|
215
215
|
*
|
|
216
216
|
* The restoration migration records the archived database in `resourceId` and `resourceType`, and the resolved database in `destinationResourceId` and `destinationResourceType`. Database types are stored canonically as `database`, `documentsdb`, or `vectorsdb`. Project-wide restorations leave these fields empty because they do not have a single source or destination database.
|
|
217
217
|
*
|
|
218
218
|
* To list every migration related to one database, use its canonical type in a nested `OR(AND(...), AND(...), AND(...))` across the root, parent, and destination relation pairs: `(resourceType, resourceId)`, `(parentResourceType, parentResourceId)`, and `(destinationResourceType, destinationResourceId)`. Legacy and TablesDB databases use `database`; the operational `resourceType` of a table migration is not rewritten to `tablesdb`.
|
|
219
219
|
*
|
|
220
|
-
* When restoring a DocumentsDB or VectorsDB database
|
|
220
|
+
* When restoring a DocumentsDB or VectorsDB database from a dedicated source, the restore provisions a fresh dedicated backing database at the source database's own specification and lands the data there. An in-place restore swaps the database onto that backing only once the restore has succeeded, and retires the backing it displaced only once that swap is confirmed, so the source keeps serving its own data until the restored data is in place and any failure leaves it untouched. A serverless source has no dedicated backing to clone and restores onto the archived database instead.
|
|
221
221
|
*
|
|
222
222
|
*
|
|
223
223
|
* @param {string} params.archiveId - Backup archive ID to restore
|
|
224
224
|
* @param {BackupServices[]} params.services - Array of services to restore
|
|
225
|
-
* @param {string} params.newResourceId - Destination resource ID. Omit to
|
|
225
|
+
* @param {string} params.newResourceId - Destination resource ID. Omit to restore the archived resource in place, or pass a different ID to restore alongside it as a new resource. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.
|
|
226
226
|
* @param {string} params.newResourceName - Database name. Max length: 128 chars.
|
|
227
227
|
* @throws {AppwriteException}
|
|
228
228
|
* @returns {Promise<Models.BackupRestoration>}
|
|
@@ -236,18 +236,18 @@ export declare class Backups {
|
|
|
236
236
|
/**
|
|
237
237
|
* Create and trigger a new restoration for a backup on a project.
|
|
238
238
|
*
|
|
239
|
-
* For a backup of one database, the restoration resolves its destination before it is queued.
|
|
239
|
+
* For a backup of one database, the restoration resolves its destination before it is queued. When `newResourceId` is omitted, the archived database is restored in place and its own ID is returned in `options`. Pass a different `newResourceId` to restore alongside it as a new database instead.
|
|
240
240
|
*
|
|
241
241
|
* The restoration migration records the archived database in `resourceId` and `resourceType`, and the resolved database in `destinationResourceId` and `destinationResourceType`. Database types are stored canonically as `database`, `documentsdb`, or `vectorsdb`. Project-wide restorations leave these fields empty because they do not have a single source or destination database.
|
|
242
242
|
*
|
|
243
243
|
* To list every migration related to one database, use its canonical type in a nested `OR(AND(...), AND(...), AND(...))` across the root, parent, and destination relation pairs: `(resourceType, resourceId)`, `(parentResourceType, parentResourceId)`, and `(destinationResourceType, destinationResourceId)`. Legacy and TablesDB databases use `database`; the operational `resourceType` of a table migration is not rewritten to `tablesdb`.
|
|
244
244
|
*
|
|
245
|
-
* When restoring a DocumentsDB or VectorsDB database
|
|
245
|
+
* When restoring a DocumentsDB or VectorsDB database from a dedicated source, the restore provisions a fresh dedicated backing database at the source database's own specification and lands the data there. An in-place restore swaps the database onto that backing only once the restore has succeeded, and retires the backing it displaced only once that swap is confirmed, so the source keeps serving its own data until the restored data is in place and any failure leaves it untouched. A serverless source has no dedicated backing to clone and restores onto the archived database instead.
|
|
246
246
|
*
|
|
247
247
|
*
|
|
248
248
|
* @param {string} archiveId - Backup archive ID to restore
|
|
249
249
|
* @param {BackupServices[]} services - Array of services to restore
|
|
250
|
-
* @param {string} newResourceId - Destination resource ID. Omit to
|
|
250
|
+
* @param {string} newResourceId - Destination resource ID. Omit to restore the archived resource in place, or pass a different ID to restore alongside it as a new resource. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.
|
|
251
251
|
* @param {string} newResourceName - Database name. Max length: 128 chars.
|
|
252
252
|
* @throws {AppwriteException}
|
|
253
253
|
* @returns {Promise<Models.BackupRestoration>}
|
|
@@ -36,6 +36,7 @@ export declare class DocumentsDB {
|
|
|
36
36
|
* @param {boolean} params.enabled - Is the database enabled? When set to 'disabled', users cannot access the database but Server SDKs with an API key can still read and write to the database. No data is lost when this is toggled.
|
|
37
37
|
* @param {string} params.specification - Database specification. Defaults to `serverless`, which creates the database on the shared pool. Any other value provisions a dedicated database on that specification.
|
|
38
38
|
* @param {number} params.replicas - Number of high availability replicas (0-5) for the dedicated database backing this database. Requires a dedicated `specification`; must be 0 for a serverless database. High availability is enabled when greater than 0.
|
|
39
|
+
* @param {string} params.syncMode - Replication sync mode for the dedicated database backing this database. Requires a dedicated `specification`; the mode is only in force once there is at least one replica. Allowed values: async, sync, quorum.
|
|
39
40
|
* @throws {AppwriteException}
|
|
40
41
|
* @returns {Promise<Models.Database>}
|
|
41
42
|
*/
|
|
@@ -45,6 +46,7 @@ export declare class DocumentsDB {
|
|
|
45
46
|
enabled?: boolean;
|
|
46
47
|
specification?: string;
|
|
47
48
|
replicas?: number;
|
|
49
|
+
syncMode?: string;
|
|
48
50
|
}): Promise<Models.Database>;
|
|
49
51
|
/**
|
|
50
52
|
* Create a new Database.
|
|
@@ -55,11 +57,12 @@ export declare class DocumentsDB {
|
|
|
55
57
|
* @param {boolean} enabled - Is the database enabled? When set to 'disabled', users cannot access the database but Server SDKs with an API key can still read and write to the database. No data is lost when this is toggled.
|
|
56
58
|
* @param {string} specification - Database specification. Defaults to `serverless`, which creates the database on the shared pool. Any other value provisions a dedicated database on that specification.
|
|
57
59
|
* @param {number} replicas - Number of high availability replicas (0-5) for the dedicated database backing this database. Requires a dedicated `specification`; must be 0 for a serverless database. High availability is enabled when greater than 0.
|
|
60
|
+
* @param {string} syncMode - Replication sync mode for the dedicated database backing this database. Requires a dedicated `specification`; the mode is only in force once there is at least one replica. Allowed values: async, sync, quorum.
|
|
58
61
|
* @throws {AppwriteException}
|
|
59
62
|
* @returns {Promise<Models.Database>}
|
|
60
63
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
61
64
|
*/
|
|
62
|
-
create(databaseId: string, name: string, enabled?: boolean, specification?: string, replicas?: number): Promise<Models.Database>;
|
|
65
|
+
create(databaseId: string, name: string, enabled?: boolean, specification?: string, replicas?: number, syncMode?: string): Promise<Models.Database>;
|
|
63
66
|
/**
|
|
64
67
|
* List the dedicated database specifications available on the current plan. Each specification reports its resource limits, pricing, and whether it is enabled for the organization.
|
|
65
68
|
*
|
|
@@ -193,7 +196,9 @@ export declare class DocumentsDB {
|
|
|
193
196
|
* @param {string} params.databaseId - Database ID.
|
|
194
197
|
* @param {string} params.name - Database name. Max length: 128 chars.
|
|
195
198
|
* @param {boolean} params.enabled - Is database enabled? When set to 'disabled', users cannot access the database but Server SDKs with an API key can still read and write to the database. No data is lost when this is toggled.
|
|
199
|
+
* @param {string} params.specification - Database specification. Resizing between dedicated specifications changes cpu, memory, storage and the connection ceiling via a rolling cutover with zero downtime. Moving a `serverless` database onto a dedicated specification is a data migration, not a resize.
|
|
196
200
|
* @param {number} params.replicas - Number of high availability replicas (0-5) for the dedicated database backing this database. Only valid when the database is backed by a dedicated specification. High availability is enabled when greater than 0.
|
|
201
|
+
* @param {string} params.syncMode - Replication sync mode for the dedicated database backing this database. Only valid when the database is backed by a dedicated specification; the mode is only in force once there is at least one replica. Allowed values: async, sync, quorum.
|
|
197
202
|
* @throws {AppwriteException}
|
|
198
203
|
* @returns {Promise<Models.Database>}
|
|
199
204
|
*/
|
|
@@ -201,7 +206,9 @@ export declare class DocumentsDB {
|
|
|
201
206
|
databaseId: string;
|
|
202
207
|
name: string;
|
|
203
208
|
enabled?: boolean;
|
|
209
|
+
specification?: string;
|
|
204
210
|
replicas?: number;
|
|
211
|
+
syncMode?: string;
|
|
205
212
|
}): Promise<Models.Database>;
|
|
206
213
|
/**
|
|
207
214
|
* Update a database by its unique ID.
|
|
@@ -209,12 +216,14 @@ export declare class DocumentsDB {
|
|
|
209
216
|
* @param {string} databaseId - Database ID.
|
|
210
217
|
* @param {string} name - Database name. Max length: 128 chars.
|
|
211
218
|
* @param {boolean} enabled - Is database enabled? When set to 'disabled', users cannot access the database but Server SDKs with an API key can still read and write to the database. No data is lost when this is toggled.
|
|
219
|
+
* @param {string} specification - Database specification. Resizing between dedicated specifications changes cpu, memory, storage and the connection ceiling via a rolling cutover with zero downtime. Moving a `serverless` database onto a dedicated specification is a data migration, not a resize.
|
|
212
220
|
* @param {number} replicas - Number of high availability replicas (0-5) for the dedicated database backing this database. Only valid when the database is backed by a dedicated specification. High availability is enabled when greater than 0.
|
|
221
|
+
* @param {string} syncMode - Replication sync mode for the dedicated database backing this database. Only valid when the database is backed by a dedicated specification; the mode is only in force once there is at least one replica. Allowed values: async, sync, quorum.
|
|
213
222
|
* @throws {AppwriteException}
|
|
214
223
|
* @returns {Promise<Models.Database>}
|
|
215
224
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
216
225
|
*/
|
|
217
|
-
update(databaseId: string, name: string, enabled?: boolean, replicas?: number): Promise<Models.Database>;
|
|
226
|
+
update(databaseId: string, name: string, enabled?: boolean, specification?: string, replicas?: number, syncMode?: string): Promise<Models.Database>;
|
|
218
227
|
/**
|
|
219
228
|
* Delete a database by its unique ID. Only API keys with with databases.write scope can delete a database.
|
|
220
229
|
*
|
|
@@ -881,7 +890,7 @@ export declare class DocumentsDB {
|
|
|
881
890
|
*/
|
|
882
891
|
deleteIndex(databaseId: string, collectionId: string, key: string): Promise<{}>;
|
|
883
892
|
/**
|
|
884
|
-
* Trigger a manual failover for a dedicated database with high availability enabled. Promotes a replica to primary. The failover runs asynchronously; poll the database document for status updates.
|
|
893
|
+
* Trigger a manual failover for a dedicated database with high availability enabled. Promotes a replica to primary. The failover runs asynchronously; poll the database document for status updates. A database left mid-operation by a failover that did not finish also accepts this call as a repair, provided `targetReplicaId` names the member to promote.
|
|
885
894
|
*
|
|
886
895
|
* @param {string} params.databaseId - Database ID.
|
|
887
896
|
* @param {string} params.targetReplicaId - Target replica ID to promote. If not specified, the healthiest replica is selected.
|
|
@@ -893,7 +902,7 @@ export declare class DocumentsDB {
|
|
|
893
902
|
targetReplicaId?: string;
|
|
894
903
|
}): Promise<Models.DedicatedDatabase>;
|
|
895
904
|
/**
|
|
896
|
-
* Trigger a manual failover for a dedicated database with high availability enabled. Promotes a replica to primary. The failover runs asynchronously; poll the database document for status updates.
|
|
905
|
+
* Trigger a manual failover for a dedicated database with high availability enabled. Promotes a replica to primary. The failover runs asynchronously; poll the database document for status updates. A database left mid-operation by a failover that did not finish also accepts this call as a repair, provided `targetReplicaId` names the member to promote.
|
|
897
906
|
*
|
|
898
907
|
* @param {string} databaseId - Database ID.
|
|
899
908
|
* @param {string} targetReplicaId - Target replica ID to promote. If not specified, the healthiest replica is selected.
|
|
@@ -40,7 +40,6 @@ export declare class Mongo {
|
|
|
40
40
|
* @param {boolean} params.storageAutoscaling - Enable automatic storage expansion when usage exceeds threshold.
|
|
41
41
|
* @param {number} params.storageAutoscalingThresholdPercent - Storage usage percentage (50-95) that triggers automatic expansion.
|
|
42
42
|
* @param {number} params.storageAutoscalingMaxGb - Maximum storage size in GB for autoscaling. 0 means no limit.
|
|
43
|
-
* @param {string} params.api - Product API that owns this database: tablesdb, documentsdb, or vectorsdb. Omit for a raw database reached directly; its api is its engine. tablesdb/documentsdb/vectorsdb databases are reached only through their product APIs.
|
|
44
43
|
* @throws {AppwriteException}
|
|
45
44
|
* @returns {Promise<Models.DedicatedDatabase>}
|
|
46
45
|
*/
|
|
@@ -60,7 +59,6 @@ export declare class Mongo {
|
|
|
60
59
|
storageAutoscaling?: boolean;
|
|
61
60
|
storageAutoscalingThresholdPercent?: number;
|
|
62
61
|
storageAutoscalingMaxGb?: number;
|
|
63
|
-
api?: string;
|
|
64
62
|
}): Promise<Models.DedicatedDatabase>;
|
|
65
63
|
/**
|
|
66
64
|
* Create a new dedicated database with the chosen engine and configuration. Status will be 'provisioning' until the database is ready.
|
|
@@ -80,12 +78,11 @@ export declare class Mongo {
|
|
|
80
78
|
* @param {boolean} storageAutoscaling - Enable automatic storage expansion when usage exceeds threshold.
|
|
81
79
|
* @param {number} storageAutoscalingThresholdPercent - Storage usage percentage (50-95) that triggers automatic expansion.
|
|
82
80
|
* @param {number} storageAutoscalingMaxGb - Maximum storage size in GB for autoscaling. 0 means no limit.
|
|
83
|
-
* @param {string} api - Product API that owns this database: tablesdb, documentsdb, or vectorsdb. Omit for a raw database reached directly; its api is its engine. tablesdb/documentsdb/vectorsdb databases are reached only through their product APIs.
|
|
84
81
|
* @throws {AppwriteException}
|
|
85
82
|
* @returns {Promise<Models.DedicatedDatabase>}
|
|
86
83
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
87
84
|
*/
|
|
88
|
-
create(databaseId: string, name: string, version?: string, specification?: string, replicas?: number, syncMode?: string, standbyRegion?: string, networkIdleTimeoutSeconds?: number, networkIPAllowlist?: string[], idleTimeoutMinutes?: number, pitr?: boolean, pitrRetentionDays?: number, storageAutoscaling?: boolean, storageAutoscalingThresholdPercent?: number, storageAutoscalingMaxGb?: number
|
|
85
|
+
create(databaseId: string, name: string, version?: string, specification?: string, replicas?: number, syncMode?: string, standbyRegion?: string, networkIdleTimeoutSeconds?: number, networkIPAllowlist?: string[], idleTimeoutMinutes?: number, pitr?: boolean, pitrRetentionDays?: number, storageAutoscaling?: boolean, storageAutoscalingThresholdPercent?: number, storageAutoscalingMaxGb?: number): Promise<Models.DedicatedDatabase>;
|
|
89
86
|
/**
|
|
90
87
|
* List the dedicated database specifications available on the current plan. Each specification reports its resource limits, pricing, and whether it is enabled for the organization.
|
|
91
88
|
*
|
|
@@ -567,7 +564,7 @@ export declare class Mongo {
|
|
|
567
564
|
*/
|
|
568
565
|
updateCredentials(databaseId: string): Promise<Models.DedicatedDatabase>;
|
|
569
566
|
/**
|
|
570
|
-
* Trigger a manual failover for a dedicated database with high availability enabled. Promotes a replica to primary. The failover runs asynchronously; poll the database document for status updates.
|
|
567
|
+
* Trigger a manual failover for a dedicated database with high availability enabled. Promotes a replica to primary. The failover runs asynchronously; poll the database document for status updates. A database left mid-operation by a failover that did not finish also accepts this call as a repair, provided `targetReplicaId` names the member to promote.
|
|
571
568
|
*
|
|
572
569
|
* @param {string} params.databaseId - Database ID.
|
|
573
570
|
* @param {string} params.targetReplicaId - Target replica ID to promote. If not specified, the healthiest replica is selected.
|
|
@@ -579,7 +576,7 @@ export declare class Mongo {
|
|
|
579
576
|
targetReplicaId?: string;
|
|
580
577
|
}): Promise<Models.DedicatedDatabase>;
|
|
581
578
|
/**
|
|
582
|
-
* Trigger a manual failover for a dedicated database with high availability enabled. Promotes a replica to primary. The failover runs asynchronously; poll the database document for status updates.
|
|
579
|
+
* Trigger a manual failover for a dedicated database with high availability enabled. Promotes a replica to primary. The failover runs asynchronously; poll the database document for status updates. A database left mid-operation by a failover that did not finish also accepts this call as a repair, provided `targetReplicaId` names the member to promote.
|
|
583
580
|
*
|
|
584
581
|
* @param {string} databaseId - Database ID.
|
|
585
582
|
* @param {string} targetReplicaId - Target replica ID to promote. If not specified, the healthiest replica is selected.
|
|
@@ -40,7 +40,6 @@ export declare class Mysql {
|
|
|
40
40
|
* @param {boolean} params.storageAutoscaling - Enable automatic storage expansion when usage exceeds threshold.
|
|
41
41
|
* @param {number} params.storageAutoscalingThresholdPercent - Storage usage percentage (50-95) that triggers automatic expansion.
|
|
42
42
|
* @param {number} params.storageAutoscalingMaxGb - Maximum storage size in GB for autoscaling. 0 means no limit.
|
|
43
|
-
* @param {string} params.api - Product API that owns this database: tablesdb, documentsdb, or vectorsdb. Omit for a raw database reached directly; its api is its engine. tablesdb/documentsdb/vectorsdb databases are reached only through their product APIs.
|
|
44
43
|
* @throws {AppwriteException}
|
|
45
44
|
* @returns {Promise<Models.DedicatedDatabase>}
|
|
46
45
|
*/
|
|
@@ -60,7 +59,6 @@ export declare class Mysql {
|
|
|
60
59
|
storageAutoscaling?: boolean;
|
|
61
60
|
storageAutoscalingThresholdPercent?: number;
|
|
62
61
|
storageAutoscalingMaxGb?: number;
|
|
63
|
-
api?: string;
|
|
64
62
|
}): Promise<Models.DedicatedDatabase>;
|
|
65
63
|
/**
|
|
66
64
|
* Create a new dedicated database with the chosen engine and configuration. Status will be 'provisioning' until the database is ready.
|
|
@@ -80,12 +78,11 @@ export declare class Mysql {
|
|
|
80
78
|
* @param {boolean} storageAutoscaling - Enable automatic storage expansion when usage exceeds threshold.
|
|
81
79
|
* @param {number} storageAutoscalingThresholdPercent - Storage usage percentage (50-95) that triggers automatic expansion.
|
|
82
80
|
* @param {number} storageAutoscalingMaxGb - Maximum storage size in GB for autoscaling. 0 means no limit.
|
|
83
|
-
* @param {string} api - Product API that owns this database: tablesdb, documentsdb, or vectorsdb. Omit for a raw database reached directly; its api is its engine. tablesdb/documentsdb/vectorsdb databases are reached only through their product APIs.
|
|
84
81
|
* @throws {AppwriteException}
|
|
85
82
|
* @returns {Promise<Models.DedicatedDatabase>}
|
|
86
83
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
87
84
|
*/
|
|
88
|
-
create(databaseId: string, name: string, version?: string, specification?: string, replicas?: number, syncMode?: string, standbyRegion?: string, networkIdleTimeoutSeconds?: number, networkIPAllowlist?: string[], idleTimeoutMinutes?: number, pitr?: boolean, pitrRetentionDays?: number, storageAutoscaling?: boolean, storageAutoscalingThresholdPercent?: number, storageAutoscalingMaxGb?: number
|
|
85
|
+
create(databaseId: string, name: string, version?: string, specification?: string, replicas?: number, syncMode?: string, standbyRegion?: string, networkIdleTimeoutSeconds?: number, networkIPAllowlist?: string[], idleTimeoutMinutes?: number, pitr?: boolean, pitrRetentionDays?: number, storageAutoscaling?: boolean, storageAutoscalingThresholdPercent?: number, storageAutoscalingMaxGb?: number): Promise<Models.DedicatedDatabase>;
|
|
89
86
|
/**
|
|
90
87
|
* List the dedicated database specifications available on the current plan. Each specification reports its resource limits, pricing, and whether it is enabled for the organization.
|
|
91
88
|
*
|
|
@@ -595,7 +592,7 @@ export declare class Mysql {
|
|
|
595
592
|
*/
|
|
596
593
|
createExecution(databaseId: string, sql: string, bindings?: object, timeoutSeconds?: number): Promise<Models.DedicatedDatabaseExecution>;
|
|
597
594
|
/**
|
|
598
|
-
* Trigger a manual failover for a dedicated database with high availability enabled. Promotes a replica to primary. The failover runs asynchronously; poll the database document for status updates.
|
|
595
|
+
* Trigger a manual failover for a dedicated database with high availability enabled. Promotes a replica to primary. The failover runs asynchronously; poll the database document for status updates. A database left mid-operation by a failover that did not finish also accepts this call as a repair, provided `targetReplicaId` names the member to promote.
|
|
599
596
|
*
|
|
600
597
|
* @param {string} params.databaseId - Database ID.
|
|
601
598
|
* @param {string} params.targetReplicaId - Target replica ID to promote. If not specified, the healthiest replica is selected.
|
|
@@ -607,7 +604,7 @@ export declare class Mysql {
|
|
|
607
604
|
targetReplicaId?: string;
|
|
608
605
|
}): Promise<Models.DedicatedDatabase>;
|
|
609
606
|
/**
|
|
610
|
-
* Trigger a manual failover for a dedicated database with high availability enabled. Promotes a replica to primary. The failover runs asynchronously; poll the database document for status updates.
|
|
607
|
+
* Trigger a manual failover for a dedicated database with high availability enabled. Promotes a replica to primary. The failover runs asynchronously; poll the database document for status updates. A database left mid-operation by a failover that did not finish also accepts this call as a repair, provided `targetReplicaId` names the member to promote.
|
|
611
608
|
*
|
|
612
609
|
* @param {string} databaseId - Database ID.
|
|
613
610
|
* @param {string} targetReplicaId - Target replica ID to promote. If not specified, the healthiest replica is selected.
|
|
@@ -737,7 +734,7 @@ export declare class Mysql {
|
|
|
737
734
|
*
|
|
738
735
|
* @param {string} params.databaseId - Database ID.
|
|
739
736
|
* @param {string} params.mode - Connection pool mode. Allowed values: transaction, session. Transaction mode returns connections to the pool after each transaction; session mode holds connections for the entire session lifetime.
|
|
740
|
-
* @param {number} params.maxConnections -
|
|
737
|
+
* @param {number} params.maxConnections - Client-connection ceiling the pooler accepts. Supported on MySQL and MariaDB only; the PostgreSQL pooler has no client cap, so set networkMaxConnections on the database instead.
|
|
741
738
|
* @param {number} params.defaultPoolSize - Default pool size per user.
|
|
742
739
|
* @param {boolean} params.readWriteSplitting - Route SELECTs to HA replicas, writes and locked reads to the primary. Defaults to true when HA is enabled.
|
|
743
740
|
* @param {string} params.poolerCpuRequest - Pooler sidecar CPU request override (Kubernetes quantity, e.g. "250m" or "1"). Leave null for the proportional default (5% of DB CPU, floor 100m).
|
|
@@ -763,7 +760,7 @@ export declare class Mysql {
|
|
|
763
760
|
*
|
|
764
761
|
* @param {string} databaseId - Database ID.
|
|
765
762
|
* @param {string} mode - Connection pool mode. Allowed values: transaction, session. Transaction mode returns connections to the pool after each transaction; session mode holds connections for the entire session lifetime.
|
|
766
|
-
* @param {number} maxConnections -
|
|
763
|
+
* @param {number} maxConnections - Client-connection ceiling the pooler accepts. Supported on MySQL and MariaDB only; the PostgreSQL pooler has no client cap, so set networkMaxConnections on the database instead.
|
|
767
764
|
* @param {number} defaultPoolSize - Default pool size per user.
|
|
768
765
|
* @param {boolean} readWriteSplitting - Route SELECTs to HA replicas, writes and locked reads to the primary. Defaults to true when HA is enabled.
|
|
769
766
|
* @param {string} poolerCpuRequest - Pooler sidecar CPU request override (Kubernetes quantity, e.g. "250m" or "1"). Leave null for the proportional default (5% of DB CPU, floor 100m).
|
|
@@ -40,7 +40,6 @@ export declare class Postgresql {
|
|
|
40
40
|
* @param {boolean} params.storageAutoscaling - Enable automatic storage expansion when usage exceeds threshold.
|
|
41
41
|
* @param {number} params.storageAutoscalingThresholdPercent - Storage usage percentage (50-95) that triggers automatic expansion.
|
|
42
42
|
* @param {number} params.storageAutoscalingMaxGb - Maximum storage size in GB for autoscaling. 0 means no limit.
|
|
43
|
-
* @param {string} params.api - Product API that owns this database: tablesdb, documentsdb, or vectorsdb. Omit for a raw database reached directly; its api is its engine. tablesdb/documentsdb/vectorsdb databases are reached only through their product APIs.
|
|
44
43
|
* @throws {AppwriteException}
|
|
45
44
|
* @returns {Promise<Models.DedicatedDatabase>}
|
|
46
45
|
*/
|
|
@@ -60,7 +59,6 @@ export declare class Postgresql {
|
|
|
60
59
|
storageAutoscaling?: boolean;
|
|
61
60
|
storageAutoscalingThresholdPercent?: number;
|
|
62
61
|
storageAutoscalingMaxGb?: number;
|
|
63
|
-
api?: string;
|
|
64
62
|
}): Promise<Models.DedicatedDatabase>;
|
|
65
63
|
/**
|
|
66
64
|
* Create a new dedicated database with the chosen engine and configuration. Status will be 'provisioning' until the database is ready.
|
|
@@ -80,12 +78,11 @@ export declare class Postgresql {
|
|
|
80
78
|
* @param {boolean} storageAutoscaling - Enable automatic storage expansion when usage exceeds threshold.
|
|
81
79
|
* @param {number} storageAutoscalingThresholdPercent - Storage usage percentage (50-95) that triggers automatic expansion.
|
|
82
80
|
* @param {number} storageAutoscalingMaxGb - Maximum storage size in GB for autoscaling. 0 means no limit.
|
|
83
|
-
* @param {string} api - Product API that owns this database: tablesdb, documentsdb, or vectorsdb. Omit for a raw database reached directly; its api is its engine. tablesdb/documentsdb/vectorsdb databases are reached only through their product APIs.
|
|
84
81
|
* @throws {AppwriteException}
|
|
85
82
|
* @returns {Promise<Models.DedicatedDatabase>}
|
|
86
83
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
87
84
|
*/
|
|
88
|
-
create(databaseId: string, name: string, version?: string, specification?: string, replicas?: number, syncMode?: string, standbyRegion?: string, networkIdleTimeoutSeconds?: number, networkIPAllowlist?: string[], idleTimeoutMinutes?: number, pitr?: boolean, pitrRetentionDays?: number, storageAutoscaling?: boolean, storageAutoscalingThresholdPercent?: number, storageAutoscalingMaxGb?: number
|
|
85
|
+
create(databaseId: string, name: string, version?: string, specification?: string, replicas?: number, syncMode?: string, standbyRegion?: string, networkIdleTimeoutSeconds?: number, networkIPAllowlist?: string[], idleTimeoutMinutes?: number, pitr?: boolean, pitrRetentionDays?: number, storageAutoscaling?: boolean, storageAutoscalingThresholdPercent?: number, storageAutoscalingMaxGb?: number): Promise<Models.DedicatedDatabase>;
|
|
89
86
|
/**
|
|
90
87
|
* List the dedicated database specifications available on the current plan. Each specification reports its resource limits, pricing, and whether it is enabled for the organization.
|
|
91
88
|
*
|
|
@@ -658,7 +655,7 @@ export declare class Postgresql {
|
|
|
658
655
|
*/
|
|
659
656
|
deleteExtension(databaseId: string, extensionName: string): Promise<Models.DedicatedDatabase>;
|
|
660
657
|
/**
|
|
661
|
-
* Trigger a manual failover for a dedicated database with high availability enabled. Promotes a replica to primary. The failover runs asynchronously; poll the database document for status updates.
|
|
658
|
+
* Trigger a manual failover for a dedicated database with high availability enabled. Promotes a replica to primary. The failover runs asynchronously; poll the database document for status updates. A database left mid-operation by a failover that did not finish also accepts this call as a repair, provided `targetReplicaId` names the member to promote.
|
|
662
659
|
*
|
|
663
660
|
* @param {string} params.databaseId - Database ID.
|
|
664
661
|
* @param {string} params.targetReplicaId - Target replica ID to promote. If not specified, the healthiest replica is selected.
|
|
@@ -670,7 +667,7 @@ export declare class Postgresql {
|
|
|
670
667
|
targetReplicaId?: string;
|
|
671
668
|
}): Promise<Models.DedicatedDatabase>;
|
|
672
669
|
/**
|
|
673
|
-
* Trigger a manual failover for a dedicated database with high availability enabled. Promotes a replica to primary. The failover runs asynchronously; poll the database document for status updates.
|
|
670
|
+
* Trigger a manual failover for a dedicated database with high availability enabled. Promotes a replica to primary. The failover runs asynchronously; poll the database document for status updates. A database left mid-operation by a failover that did not finish also accepts this call as a repair, provided `targetReplicaId` names the member to promote.
|
|
674
671
|
*
|
|
675
672
|
* @param {string} databaseId - Database ID.
|
|
676
673
|
* @param {string} targetReplicaId - Target replica ID to promote. If not specified, the healthiest replica is selected.
|
|
@@ -800,7 +797,7 @@ export declare class Postgresql {
|
|
|
800
797
|
*
|
|
801
798
|
* @param {string} params.databaseId - Database ID.
|
|
802
799
|
* @param {string} params.mode - Connection pool mode. Allowed values: transaction, session. Transaction mode returns connections to the pool after each transaction; session mode holds connections for the entire session lifetime.
|
|
803
|
-
* @param {number} params.maxConnections -
|
|
800
|
+
* @param {number} params.maxConnections - Client-connection ceiling the pooler accepts. Supported on MySQL and MariaDB only; the PostgreSQL pooler has no client cap, so set networkMaxConnections on the database instead.
|
|
804
801
|
* @param {number} params.defaultPoolSize - Default pool size per user.
|
|
805
802
|
* @param {boolean} params.readWriteSplitting - Route SELECTs to HA replicas, writes and locked reads to the primary. Defaults to true when HA is enabled.
|
|
806
803
|
* @param {string} params.poolerCpuRequest - Pooler sidecar CPU request override (Kubernetes quantity, e.g. "250m" or "1"). Leave null for the proportional default (5% of DB CPU, floor 100m).
|
|
@@ -826,7 +823,7 @@ export declare class Postgresql {
|
|
|
826
823
|
*
|
|
827
824
|
* @param {string} databaseId - Database ID.
|
|
828
825
|
* @param {string} mode - Connection pool mode. Allowed values: transaction, session. Transaction mode returns connections to the pool after each transaction; session mode holds connections for the entire session lifetime.
|
|
829
|
-
* @param {number} maxConnections -
|
|
826
|
+
* @param {number} maxConnections - Client-connection ceiling the pooler accepts. Supported on MySQL and MariaDB only; the PostgreSQL pooler has no client cap, so set networkMaxConnections on the database instead.
|
|
830
827
|
* @param {number} defaultPoolSize - Default pool size per user.
|
|
831
828
|
* @param {boolean} readWriteSplitting - Route SELECTs to HA replicas, writes and locked reads to the primary. Defaults to true when HA is enabled.
|
|
832
829
|
* @param {string} poolerCpuRequest - Pooler sidecar CPU request override (Kubernetes quantity, e.g. "250m" or "1"). Leave null for the proportional default (5% of DB CPU, floor 100m).
|