@appwrite.io/console 13.2.0 → 14.0.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.
@@ -30,8 +30,6 @@ export declare class Compute {
30
30
  * @param {string} params.database - Physical database/catalog name. Defaults to databaseId.
31
31
  * @param {string} params.engine - Database engine: postgres, mysql, mariadb, or mongodb.
32
32
  * @param {string} params.version - Database engine version. Defaults to latest for selected engine.
33
- * @param {string} params.region - Region identifier. Use one of the enabled region codes (e.g., fra, nyc, syd).
34
- * @param {string} params.type - Database type: shared (serverless) or dedicated (always-on).
35
33
  * @param {string} params.specification - Specification identifier.
36
34
  * @param {string} params.backend - Database backend provider: prisma, or edge.
37
35
  * @param {number} params.cpu - CPU in millicores (125-16000).
@@ -39,8 +37,7 @@ export declare class Compute {
39
37
  * @param {number} params.storage - Storage in GB to allocate (1-16384).
40
38
  * @param {string} params.storageClass - Storage class: ssd, nvme, or hdd.
41
39
  * @param {number} params.storageMaxGb - Maximum storage limit in GB. 0 uses system default.
42
- * @param {boolean} params.highAvailability - Enable high availability.
43
- * @param {number} params.highAvailabilityReplicaCount - Number of high availability replicas (0-5).
40
+ * @param {number} params.replicas - Number of high availability replicas (0-5). High availability is enabled when greater than 0.
44
41
  * @param {string} params.highAvailabilitySyncMode - Replication sync mode preference. Allowed values: async, sync, quorum.
45
42
  * @param {number} params.networkMaxConnections - Maximum concurrent connections.
46
43
  * @param {number} params.networkIdleTimeoutSeconds - Connection idle timeout in seconds.
@@ -56,6 +53,7 @@ export declare class Compute {
56
53
  * @param {number} params.storageAutoscalingMaxGb - Maximum storage size in GB for autoscaling. 0 means no limit.
57
54
  * @param {boolean} params.metricsEnabled - Enable metrics collection.
58
55
  * @param {boolean} params.poolerEnabled - Enable connection pooler on provision.
56
+ * @param {string} params.api - Product API that owns this database: compute (raw, direct-access), tablesdb, documentsdb, or vectorsdb. tablesdb/documentsdb/vectorsdb computes are reached only through their product APIs.
59
57
  * @throws {AppwriteException}
60
58
  * @returns {Promise<Models.DedicatedDatabase>}
61
59
  */
@@ -65,8 +63,6 @@ export declare class Compute {
65
63
  database?: string;
66
64
  engine?: string;
67
65
  version?: string;
68
- region?: string;
69
- type?: string;
70
66
  specification?: string;
71
67
  backend?: string;
72
68
  cpu?: number;
@@ -74,8 +70,7 @@ export declare class Compute {
74
70
  storage?: number;
75
71
  storageClass?: string;
76
72
  storageMaxGb?: number;
77
- highAvailability?: boolean;
78
- highAvailabilityReplicaCount?: number;
73
+ replicas?: number;
79
74
  highAvailabilitySyncMode?: string;
80
75
  networkMaxConnections?: number;
81
76
  networkIdleTimeoutSeconds?: number;
@@ -91,6 +86,7 @@ export declare class Compute {
91
86
  storageAutoscalingMaxGb?: number;
92
87
  metricsEnabled?: boolean;
93
88
  poolerEnabled?: boolean;
89
+ api?: string;
94
90
  }): Promise<Models.DedicatedDatabase>;
95
91
  /**
96
92
  * Create a new dedicated database with the chosen engine and configuration. Status will be 'provisioning' until the database is ready.
@@ -100,8 +96,6 @@ export declare class Compute {
100
96
  * @param {string} database - Physical database/catalog name. Defaults to databaseId.
101
97
  * @param {string} engine - Database engine: postgres, mysql, mariadb, or mongodb.
102
98
  * @param {string} version - Database engine version. Defaults to latest for selected engine.
103
- * @param {string} region - Region identifier. Use one of the enabled region codes (e.g., fra, nyc, syd).
104
- * @param {string} type - Database type: shared (serverless) or dedicated (always-on).
105
99
  * @param {string} specification - Specification identifier.
106
100
  * @param {string} backend - Database backend provider: prisma, or edge.
107
101
  * @param {number} cpu - CPU in millicores (125-16000).
@@ -109,8 +103,7 @@ export declare class Compute {
109
103
  * @param {number} storage - Storage in GB to allocate (1-16384).
110
104
  * @param {string} storageClass - Storage class: ssd, nvme, or hdd.
111
105
  * @param {number} storageMaxGb - Maximum storage limit in GB. 0 uses system default.
112
- * @param {boolean} highAvailability - Enable high availability.
113
- * @param {number} highAvailabilityReplicaCount - Number of high availability replicas (0-5).
106
+ * @param {number} replicas - Number of high availability replicas (0-5). High availability is enabled when greater than 0.
114
107
  * @param {string} highAvailabilitySyncMode - Replication sync mode preference. Allowed values: async, sync, quorum.
115
108
  * @param {number} networkMaxConnections - Maximum concurrent connections.
116
109
  * @param {number} networkIdleTimeoutSeconds - Connection idle timeout in seconds.
@@ -126,11 +119,12 @@ export declare class Compute {
126
119
  * @param {number} storageAutoscalingMaxGb - Maximum storage size in GB for autoscaling. 0 means no limit.
127
120
  * @param {boolean} metricsEnabled - Enable metrics collection.
128
121
  * @param {boolean} poolerEnabled - Enable connection pooler on provision.
122
+ * @param {string} api - Product API that owns this database: compute (raw, direct-access), tablesdb, documentsdb, or vectorsdb. tablesdb/documentsdb/vectorsdb computes are reached only through their product APIs.
129
123
  * @throws {AppwriteException}
130
124
  * @returns {Promise<Models.DedicatedDatabase>}
131
125
  * @deprecated Use the object parameter style method for a better developer experience.
132
126
  */
133
- createDatabase(databaseId: string, name: string, database?: string, engine?: string, version?: string, region?: string, type?: string, specification?: string, backend?: string, cpu?: number, memory?: number, storage?: number, storageClass?: string, storageMaxGb?: number, highAvailability?: boolean, highAvailabilityReplicaCount?: number, highAvailabilitySyncMode?: string, networkMaxConnections?: number, networkIdleTimeoutSeconds?: number, networkIPAllowlist?: string[], idleTimeoutMinutes?: number, backupEnabled?: boolean, backupPitr?: boolean, backupCron?: string, backupRetentionDays?: number, pitrRetentionDays?: number, storageAutoscaling?: boolean, storageAutoscalingThresholdPercent?: number, storageAutoscalingMaxGb?: number, metricsEnabled?: boolean, poolerEnabled?: boolean): Promise<Models.DedicatedDatabase>;
127
+ createDatabase(databaseId: string, name: string, database?: string, engine?: string, version?: string, specification?: string, backend?: string, cpu?: number, memory?: number, storage?: number, storageClass?: string, storageMaxGb?: number, replicas?: number, highAvailabilitySyncMode?: string, networkMaxConnections?: number, networkIdleTimeoutSeconds?: number, networkIPAllowlist?: string[], idleTimeoutMinutes?: number, backupEnabled?: boolean, backupPitr?: boolean, backupCron?: string, backupRetentionDays?: number, pitrRetentionDays?: number, storageAutoscaling?: boolean, storageAutoscalingThresholdPercent?: number, storageAutoscalingMaxGb?: number, metricsEnabled?: boolean, poolerEnabled?: boolean, api?: string): Promise<Models.DedicatedDatabase>;
134
128
  /**
135
129
  * 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.
136
130
  *
@@ -162,14 +156,13 @@ export declare class Compute {
162
156
  *
163
157
  * @param {string} params.databaseId - Database ID.
164
158
  * @param {string} params.name - Database display name.
165
- * @param {string} params.status - Database status. Allowed values: ready, paused, inactive. Set to "paused" to pause, "ready" to resume, or "inactive" to spin down a shared database.
166
- * @param {string} params.specification - Specification. Changes cpu, memory, and type based on specification config.
159
+ * @param {string} params.status - Database status. Allowed values: ready, paused, inactive. Set to "paused" to pause, "ready" to resume, or "inactive" to spin down a shared-pool database.
160
+ * @param {string} params.specification - Specification. Changes cpu, memory, and node pool based on specification config.
167
161
  * @param {number} params.cpu - CPU cores to allocate (125-16000).
168
162
  * @param {number} params.memory - Memory in MB to allocate (128-65536).
169
163
  * @param {number} params.storage - Storage in GB to allocate (1-16384).
170
164
  * @param {string} params.storageClass - Storage class. Allowed values: ssd, nvme, hdd.
171
- * @param {boolean} params.highAvailability - Enable high availability.
172
- * @param {number} params.highAvailabilityReplicaCount - Number of high availability replicas (0-5).
165
+ * @param {number} params.replicas - Number of high availability replicas (0-5). High availability is enabled when greater than 0.
173
166
  * @param {string} params.highAvailabilitySyncMode - Replication sync mode preference. Allowed values: async, sync, quorum.
174
167
  * @param {number} params.networkMaxConnections - Maximum concurrent connections.
175
168
  * @param {number} params.networkIdleTimeoutSeconds - Connection idle timeout in seconds (60-86400).
@@ -188,7 +181,7 @@ export declare class Compute {
188
181
  * @param {number} params.metricsTraceSampleRate - Fraction of queries to trace (0.0–1.0). Forwarded to the sidecar.
189
182
  * @param {number} params.metricsSlowQueryLogThresholdMs - Threshold in ms above which queries are logged as slow. Forwarded to the sidecar.
190
183
  * @param {boolean} params.sqlApiEnabled - Enable the SQL API sidecar for this database.
191
- * @param {string[]} params.sqlApiAllowedStatements - Statement types the SQL API accepts. Allowed values: SELECT, INSERT, UPDATE, DELETE.
184
+ * @param {string[]} params.sqlApiAllowedStatements - Statement types the SQL API accepts. Allowed values: SELECT, INSERT, UPDATE, DELETE, CREATE, ALTER, DROP, TRUNCATE, GRANT, REVOKE.
192
185
  * @param {number} params.sqlApiMaxRows - Maximum rows returned per SQL API execution (1-1000000).
193
186
  * @param {number} params.sqlApiMaxBytes - Maximum serialised SQL API result payload in bytes (1024-104857600).
194
187
  * @param {number} params.sqlApiTimeoutSeconds - Per-call SQL API execution timeout in seconds (1-300).
@@ -204,8 +197,7 @@ export declare class Compute {
204
197
  memory?: number;
205
198
  storage?: number;
206
199
  storageClass?: string;
207
- highAvailability?: boolean;
208
- highAvailabilityReplicaCount?: number;
200
+ replicas?: number;
209
201
  highAvailabilitySyncMode?: string;
210
202
  networkMaxConnections?: number;
211
203
  networkIdleTimeoutSeconds?: number;
@@ -234,14 +226,13 @@ export declare class Compute {
234
226
  *
235
227
  * @param {string} databaseId - Database ID.
236
228
  * @param {string} name - Database display name.
237
- * @param {string} status - Database status. Allowed values: ready, paused, inactive. Set to "paused" to pause, "ready" to resume, or "inactive" to spin down a shared database.
238
- * @param {string} specification - Specification. Changes cpu, memory, and type based on specification config.
229
+ * @param {string} status - Database status. Allowed values: ready, paused, inactive. Set to "paused" to pause, "ready" to resume, or "inactive" to spin down a shared-pool database.
230
+ * @param {string} specification - Specification. Changes cpu, memory, and node pool based on specification config.
239
231
  * @param {number} cpu - CPU cores to allocate (125-16000).
240
232
  * @param {number} memory - Memory in MB to allocate (128-65536).
241
233
  * @param {number} storage - Storage in GB to allocate (1-16384).
242
234
  * @param {string} storageClass - Storage class. Allowed values: ssd, nvme, hdd.
243
- * @param {boolean} highAvailability - Enable high availability.
244
- * @param {number} highAvailabilityReplicaCount - Number of high availability replicas (0-5).
235
+ * @param {number} replicas - Number of high availability replicas (0-5). High availability is enabled when greater than 0.
245
236
  * @param {string} highAvailabilitySyncMode - Replication sync mode preference. Allowed values: async, sync, quorum.
246
237
  * @param {number} networkMaxConnections - Maximum concurrent connections.
247
238
  * @param {number} networkIdleTimeoutSeconds - Connection idle timeout in seconds (60-86400).
@@ -260,7 +251,7 @@ export declare class Compute {
260
251
  * @param {number} metricsTraceSampleRate - Fraction of queries to trace (0.0–1.0). Forwarded to the sidecar.
261
252
  * @param {number} metricsSlowQueryLogThresholdMs - Threshold in ms above which queries are logged as slow. Forwarded to the sidecar.
262
253
  * @param {boolean} sqlApiEnabled - Enable the SQL API sidecar for this database.
263
- * @param {string[]} sqlApiAllowedStatements - Statement types the SQL API accepts. Allowed values: SELECT, INSERT, UPDATE, DELETE.
254
+ * @param {string[]} sqlApiAllowedStatements - Statement types the SQL API accepts. Allowed values: SELECT, INSERT, UPDATE, DELETE, CREATE, ALTER, DROP, TRUNCATE, GRANT, REVOKE.
264
255
  * @param {number} sqlApiMaxRows - Maximum rows returned per SQL API execution (1-1000000).
265
256
  * @param {number} sqlApiMaxBytes - Maximum serialised SQL API result payload in bytes (1024-104857600).
266
257
  * @param {number} sqlApiTimeoutSeconds - Per-call SQL API execution timeout in seconds (1-300).
@@ -268,9 +259,9 @@ export declare class Compute {
268
259
  * @returns {Promise<Models.DedicatedDatabase>}
269
260
  * @deprecated Use the object parameter style method for a better developer experience.
270
261
  */
271
- updateDatabase(databaseId: string, name?: string, status?: string, specification?: string, cpu?: number, memory?: number, storage?: number, storageClass?: string, highAvailability?: boolean, highAvailabilityReplicaCount?: number, highAvailabilitySyncMode?: string, networkMaxConnections?: number, networkIdleTimeoutSeconds?: number, networkIPAllowlist?: string[], idleTimeoutMinutes?: number, backupEnabled?: boolean, backupPitr?: boolean, backupCron?: string, backupRetentionDays?: number, pitrRetentionDays?: number, storageAutoscaling?: boolean, storageAutoscalingThresholdPercent?: number, storageAutoscalingMaxGb?: number, poolerEnabled?: boolean, metricsEnabled?: boolean, metricsTraceSampleRate?: number, metricsSlowQueryLogThresholdMs?: number, sqlApiEnabled?: boolean, sqlApiAllowedStatements?: string[], sqlApiMaxRows?: number, sqlApiMaxBytes?: number, sqlApiTimeoutSeconds?: number): Promise<Models.DedicatedDatabase>;
262
+ updateDatabase(databaseId: string, name?: string, status?: string, specification?: string, cpu?: number, memory?: number, storage?: number, storageClass?: string, replicas?: number, highAvailabilitySyncMode?: string, networkMaxConnections?: number, networkIdleTimeoutSeconds?: number, networkIPAllowlist?: string[], idleTimeoutMinutes?: number, backupEnabled?: boolean, backupPitr?: boolean, backupCron?: string, backupRetentionDays?: number, pitrRetentionDays?: number, storageAutoscaling?: boolean, storageAutoscalingThresholdPercent?: number, storageAutoscalingMaxGb?: number, poolerEnabled?: boolean, metricsEnabled?: boolean, metricsTraceSampleRate?: number, metricsSlowQueryLogThresholdMs?: number, sqlApiEnabled?: boolean, sqlApiAllowedStatements?: string[], sqlApiMaxRows?: number, sqlApiMaxBytes?: number, sqlApiTimeoutSeconds?: number): Promise<Models.DedicatedDatabase>;
272
263
  /**
273
- * Delete a dedicated database. This action is irreversible. The database status will be set to 'deleting' and all resources will be cleaned up.
264
+ * Delete a dedicated database. This action is irreversible. The database status will be set to 'deleting' and all resources will be cleaned up. Deletion is allowed from any state, and repeating the call re-dispatches the cleanup.
274
265
  *
275
266
  * @param {string} params.databaseId - Database ID.
276
267
  * @throws {AppwriteException}
@@ -280,7 +271,7 @@ export declare class Compute {
280
271
  databaseId: string;
281
272
  }): Promise<{}>;
282
273
  /**
283
- * Delete a dedicated database. This action is irreversible. The database status will be set to 'deleting' and all resources will be cleaned up.
274
+ * Delete a dedicated database. This action is irreversible. The database status will be set to 'deleting' and all resources will be cleaned up. Deletion is allowed from any state, and repeating the call re-dispatches the cleanup.
284
275
  *
285
276
  * @param {string} databaseId - Database ID.
286
277
  * @throws {AppwriteException}
@@ -333,7 +324,7 @@ export declare class Compute {
333
324
  */
334
325
  createDatabaseBackup(databaseId: string, type?: string): Promise<Models.DedicatedDatabaseBackup>;
335
326
  /**
336
- * List scheduled backup policies for a dedicated database.
327
+ * List scheduled backup policies for a dedicated database.
337
328
  *
338
329
  * @param {string} params.databaseId - Database ID.
339
330
  * @param {string[]} params.queries - Array of query strings generated using the Query class provided by the SDK.
@@ -345,7 +336,7 @@ export declare class Compute {
345
336
  queries?: string[];
346
337
  }): Promise<Models.BackupPolicyList>;
347
338
  /**
348
- * List scheduled backup policies for a dedicated database.
339
+ * List scheduled backup policies for a dedicated database.
349
340
  *
350
341
  * @param {string} databaseId - Database ID.
351
342
  * @param {string[]} queries - Array of query strings generated using the Query class provided by the SDK.
@@ -355,7 +346,7 @@ export declare class Compute {
355
346
  */
356
347
  listDatabaseBackupPolicies(databaseId: string, queries?: string[]): Promise<Models.BackupPolicyList>;
357
348
  /**
358
- * Create a scheduled backup policy for a dedicated database.
349
+ * Create a scheduled backup policy for a dedicated database.
359
350
  *
360
351
  * @param {string} params.databaseId - Database ID.
361
352
  * @param {string} params.policyId - Policy ID. Choose a custom ID or generate a random ID with `ID.unique()`. 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.
@@ -377,7 +368,7 @@ export declare class Compute {
377
368
  enabled?: boolean;
378
369
  }): Promise<Models.BackupPolicy>;
379
370
  /**
380
- * Create a scheduled backup policy for a dedicated database.
371
+ * Create a scheduled backup policy for a dedicated database.
381
372
  *
382
373
  * @param {string} databaseId - Database ID.
383
374
  * @param {string} policyId - Policy ID. Choose a custom ID or generate a random ID with `ID.unique()`. 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.
@@ -802,31 +793,6 @@ export declare class Compute {
802
793
  * @deprecated Use the object parameter style method for a better developer experience.
803
794
  */
804
795
  createDatabaseFailover(databaseId: string, targetReplicaId?: string): Promise<Models.DedicatedDatabase>;
805
- /**
806
- * Get query-level performance insights for a dedicated database. Returns top queries by execution time, wait events, and aggregate query statistics.
807
- *
808
- * @param {string} params.databaseId - Database ID.
809
- * @param {string} params.period - Analysis period for performance insights. Allowed values: 1h (last hour), 24h (last 24 hours), 7d (last 7 days).
810
- * @param {number} params.limit - Maximum number of queries to return.
811
- * @throws {AppwriteException}
812
- * @returns {Promise<Models.DedicatedDatabasePerformanceInsights>}
813
- */
814
- getDatabaseInsights(params: {
815
- databaseId: string;
816
- period?: string;
817
- limit?: number;
818
- }): Promise<Models.DedicatedDatabasePerformanceInsights>;
819
- /**
820
- * Get query-level performance insights for a dedicated database. Returns top queries by execution time, wait events, and aggregate query statistics.
821
- *
822
- * @param {string} databaseId - Database ID.
823
- * @param {string} period - Analysis period for performance insights. Allowed values: 1h (last hour), 24h (last 24 hours), 7d (last 7 days).
824
- * @param {number} limit - Maximum number of queries to return.
825
- * @throws {AppwriteException}
826
- * @returns {Promise<Models.DedicatedDatabasePerformanceInsights>}
827
- * @deprecated Use the object parameter style method for a better developer experience.
828
- */
829
- getDatabaseInsights(databaseId: string, period?: string, limit?: number): Promise<Models.DedicatedDatabasePerformanceInsights>;
830
796
  /**
831
797
  * Update the maintenance window for a dedicated database. Maintenance operations like minor version upgrades will be performed during this window.
832
798
  *
@@ -852,28 +818,6 @@ export declare class Compute {
852
818
  * @deprecated Use the object parameter style method for a better developer experience.
853
819
  */
854
820
  updateDatabaseMaintenanceWindow(databaseId: string, day: string, hourUtc: number): Promise<Models.DedicatedDatabase>;
855
- /**
856
- * Get detailed performance metrics for a dedicated database. Returns CPU, memory, storage, IOPS, QPS, and connection metrics.
857
- *
858
- * @param {string} params.databaseId - Database ID.
859
- * @param {string} params.period - Metrics aggregation period. Allowed values: 1h (last hour), 24h (last 24 hours), 7d (last 7 days), 30d (last 30 days).
860
- * @throws {AppwriteException}
861
- * @returns {Promise<Models.DedicatedDatabaseMetrics>}
862
- */
863
- getDatabaseMetrics(params: {
864
- databaseId: string;
865
- period?: string;
866
- }): Promise<Models.DedicatedDatabaseMetrics>;
867
- /**
868
- * Get detailed performance metrics for a dedicated database. Returns CPU, memory, storage, IOPS, QPS, and connection metrics.
869
- *
870
- * @param {string} databaseId - Database ID.
871
- * @param {string} period - Metrics aggregation period. Allowed values: 1h (last hour), 24h (last 24 hours), 7d (last 7 days), 30d (last 30 days).
872
- * @throws {AppwriteException}
873
- * @returns {Promise<Models.DedicatedDatabaseMetrics>}
874
- * @deprecated Use the object parameter style method for a better developer experience.
875
- */
876
- getDatabaseMetrics(databaseId: string, period?: string): Promise<Models.DedicatedDatabaseMetrics>;
877
821
  /**
878
822
  * Migrate a database between shared and dedicated types. Shared to dedicated provisions an always-on dedicated instance; dedicated to shared converts to a serverless instance that scales to zero when idle. Data is copied to the target with a brief read-only window during cutover.
879
823
  *
@@ -1061,47 +1005,6 @@ export declare class Compute {
1061
1005
  * @deprecated Use the object parameter style method for a better developer experience.
1062
1006
  */
1063
1007
  getDatabaseRestoration(databaseId: string, restorationId: string): Promise<Models.DedicatedDatabaseRestoration>;
1064
- /**
1065
- * Get the current schema for a dedicated database. Returns collections, fields, data types, constraints, and indexes.
1066
- *
1067
- * @param {string} params.databaseId - Database ID.
1068
- * @throws {AppwriteException}
1069
- * @returns {Promise<Models.DedicatedDatabaseSchema>}
1070
- */
1071
- getDatabaseSchema(params: {
1072
- databaseId: string;
1073
- }): Promise<Models.DedicatedDatabaseSchema>;
1074
- /**
1075
- * Get the current schema for a dedicated database. Returns collections, fields, data types, constraints, and indexes.
1076
- *
1077
- * @param {string} databaseId - Database ID.
1078
- * @throws {AppwriteException}
1079
- * @returns {Promise<Models.DedicatedDatabaseSchema>}
1080
- * @deprecated Use the object parameter style method for a better developer experience.
1081
- */
1082
- getDatabaseSchema(databaseId: string): Promise<Models.DedicatedDatabaseSchema>;
1083
- /**
1084
- * Preview a schema change against a dedicated database. Returns the expected impact including affected collections, records, and a dry-run diff of the schema before and after the change.
1085
- *
1086
- * @param {string} params.databaseId - Database ID.
1087
- * @param {string} params.sql - Schema statement to preview.
1088
- * @throws {AppwriteException}
1089
- * @returns {Promise<Models.DedicatedDatabaseSchemaPreview>}
1090
- */
1091
- createDatabaseSchemaPreview(params: {
1092
- databaseId: string;
1093
- sql: string;
1094
- }): Promise<Models.DedicatedDatabaseSchemaPreview>;
1095
- /**
1096
- * Preview a schema change against a dedicated database. Returns the expected impact including affected collections, records, and a dry-run diff of the schema before and after the change.
1097
- *
1098
- * @param {string} databaseId - Database ID.
1099
- * @param {string} sql - Schema statement to preview.
1100
- * @throws {AppwriteException}
1101
- * @returns {Promise<Models.DedicatedDatabaseSchemaPreview>}
1102
- * @deprecated Use the object parameter style method for a better developer experience.
1103
- */
1104
- createDatabaseSchemaPreview(databaseId: string, sql: string): Promise<Models.DedicatedDatabaseSchemaPreview>;
1105
1008
  /**
1106
1009
  * List slow queries for a dedicated database. Returns queries that exceeded the specified threshold.
1107
1010
  *
@@ -1089,7 +1089,7 @@ export declare class Databases {
1089
1089
  * @param {string} params.collectionId - Collection ID. You can create a new collection using the Database service [server integration](https://appwrite.io/docs/server/databases#databasesCreateCollection).
1090
1090
  * @param {string} params.key - Attribute Key.
1091
1091
  * @param {boolean} params.required - Is attribute required?
1092
- * @param {any[]} params.xdefault - Default value for attribute when not provided, two-dimensional array of coordinate pairs, [[longitude, latitude], [longitude, latitude], …], listing the vertices of the line in order. Cannot be set when attribute is required.
1092
+ * @param {any[][]} params.xdefault - Default value for attribute when not provided, two-dimensional array of coordinate pairs, [[longitude, latitude], [longitude, latitude], …], listing the vertices of the line in order. Cannot be set when attribute is required.
1093
1093
  * @throws {AppwriteException}
1094
1094
  * @returns {Promise<Models.AttributeLine>}
1095
1095
  * @deprecated This API has been deprecated since 1.8.0. Please use `TablesDB.createLineColumn` instead.
@@ -1099,7 +1099,7 @@ export declare class Databases {
1099
1099
  collectionId: string;
1100
1100
  key: string;
1101
1101
  required: boolean;
1102
- xdefault?: any[];
1102
+ xdefault?: any[][];
1103
1103
  }): Promise<Models.AttributeLine>;
1104
1104
  /**
1105
1105
  * Create a geometric line attribute.
@@ -1108,12 +1108,12 @@ export declare class Databases {
1108
1108
  * @param {string} collectionId - Collection ID. You can create a new collection using the Database service [server integration](https://appwrite.io/docs/server/databases#databasesCreateCollection).
1109
1109
  * @param {string} key - Attribute Key.
1110
1110
  * @param {boolean} required - Is attribute required?
1111
- * @param {any[]} xdefault - Default value for attribute when not provided, two-dimensional array of coordinate pairs, [[longitude, latitude], [longitude, latitude], …], listing the vertices of the line in order. Cannot be set when attribute is required.
1111
+ * @param {any[][]} xdefault - Default value for attribute when not provided, two-dimensional array of coordinate pairs, [[longitude, latitude], [longitude, latitude], …], listing the vertices of the line in order. Cannot be set when attribute is required.
1112
1112
  * @throws {AppwriteException}
1113
1113
  * @returns {Promise<Models.AttributeLine>}
1114
1114
  * @deprecated Use the object parameter style method for a better developer experience.
1115
1115
  */
1116
- createLineAttribute(databaseId: string, collectionId: string, key: string, required: boolean, xdefault?: any[]): Promise<Models.AttributeLine>;
1116
+ createLineAttribute(databaseId: string, collectionId: string, key: string, required: boolean, xdefault?: any[][]): Promise<Models.AttributeLine>;
1117
1117
  /**
1118
1118
  * Update a line attribute. Changing the `default` value will not update already existing documents.
1119
1119
  *
@@ -1121,7 +1121,7 @@ export declare class Databases {
1121
1121
  * @param {string} params.collectionId - Collection ID. You can create a new collection using the Database service [server integration](https://appwrite.io/docs/server/databases#createCollection).
1122
1122
  * @param {string} params.key - Attribute Key.
1123
1123
  * @param {boolean} params.required - Is attribute required?
1124
- * @param {any[]} params.xdefault - Default value for attribute when not provided, two-dimensional array of coordinate pairs, [[longitude, latitude], [longitude, latitude], …], listing the vertices of the line in order. Cannot be set when attribute is required.
1124
+ * @param {any[][]} params.xdefault - Default value for attribute when not provided, two-dimensional array of coordinate pairs, [[longitude, latitude], [longitude, latitude], …], listing the vertices of the line in order. Cannot be set when attribute is required.
1125
1125
  * @param {string} params.newKey - New attribute key.
1126
1126
  * @throws {AppwriteException}
1127
1127
  * @returns {Promise<Models.AttributeLine>}
@@ -1132,7 +1132,7 @@ export declare class Databases {
1132
1132
  collectionId: string;
1133
1133
  key: string;
1134
1134
  required: boolean;
1135
- xdefault?: any[];
1135
+ xdefault?: any[][];
1136
1136
  newKey?: string;
1137
1137
  }): Promise<Models.AttributeLine>;
1138
1138
  /**
@@ -1142,13 +1142,13 @@ export declare class Databases {
1142
1142
  * @param {string} collectionId - Collection ID. You can create a new collection using the Database service [server integration](https://appwrite.io/docs/server/databases#createCollection).
1143
1143
  * @param {string} key - Attribute Key.
1144
1144
  * @param {boolean} required - Is attribute required?
1145
- * @param {any[]} xdefault - Default value for attribute when not provided, two-dimensional array of coordinate pairs, [[longitude, latitude], [longitude, latitude], …], listing the vertices of the line in order. Cannot be set when attribute is required.
1145
+ * @param {any[][]} xdefault - Default value for attribute when not provided, two-dimensional array of coordinate pairs, [[longitude, latitude], [longitude, latitude], …], listing the vertices of the line in order. Cannot be set when attribute is required.
1146
1146
  * @param {string} newKey - New attribute key.
1147
1147
  * @throws {AppwriteException}
1148
1148
  * @returns {Promise<Models.AttributeLine>}
1149
1149
  * @deprecated Use the object parameter style method for a better developer experience.
1150
1150
  */
1151
- updateLineAttribute(databaseId: string, collectionId: string, key: string, required: boolean, xdefault?: any[], newKey?: string): Promise<Models.AttributeLine>;
1151
+ updateLineAttribute(databaseId: string, collectionId: string, key: string, required: boolean, xdefault?: any[][], newKey?: string): Promise<Models.AttributeLine>;
1152
1152
  /**
1153
1153
  * Create a longtext attribute.
1154
1154
  *
@@ -1306,7 +1306,7 @@ export declare class Databases {
1306
1306
  * @param {string} params.collectionId - Collection ID. You can create a new collection using the Database service [server integration](https://appwrite.io/docs/server/databases#databasesCreateCollection).
1307
1307
  * @param {string} params.key - Attribute Key.
1308
1308
  * @param {boolean} params.required - Is attribute required?
1309
- * @param {any[]} params.xdefault - Default value for attribute when not provided, array of two numbers [longitude, latitude], representing a single coordinate. Cannot be set when attribute is required.
1309
+ * @param {number[]} params.xdefault - Default value for attribute when not provided, array of two numbers [longitude, latitude], representing a single coordinate. Cannot be set when attribute is required.
1310
1310
  * @throws {AppwriteException}
1311
1311
  * @returns {Promise<Models.AttributePoint>}
1312
1312
  * @deprecated This API has been deprecated since 1.8.0. Please use `TablesDB.createPointColumn` instead.
@@ -1316,7 +1316,7 @@ export declare class Databases {
1316
1316
  collectionId: string;
1317
1317
  key: string;
1318
1318
  required: boolean;
1319
- xdefault?: any[];
1319
+ xdefault?: number[];
1320
1320
  }): Promise<Models.AttributePoint>;
1321
1321
  /**
1322
1322
  * Create a geometric point attribute.
@@ -1325,12 +1325,12 @@ export declare class Databases {
1325
1325
  * @param {string} collectionId - Collection ID. You can create a new collection using the Database service [server integration](https://appwrite.io/docs/server/databases#databasesCreateCollection).
1326
1326
  * @param {string} key - Attribute Key.
1327
1327
  * @param {boolean} required - Is attribute required?
1328
- * @param {any[]} xdefault - Default value for attribute when not provided, array of two numbers [longitude, latitude], representing a single coordinate. Cannot be set when attribute is required.
1328
+ * @param {number[]} xdefault - Default value for attribute when not provided, array of two numbers [longitude, latitude], representing a single coordinate. Cannot be set when attribute is required.
1329
1329
  * @throws {AppwriteException}
1330
1330
  * @returns {Promise<Models.AttributePoint>}
1331
1331
  * @deprecated Use the object parameter style method for a better developer experience.
1332
1332
  */
1333
- createPointAttribute(databaseId: string, collectionId: string, key: string, required: boolean, xdefault?: any[]): Promise<Models.AttributePoint>;
1333
+ createPointAttribute(databaseId: string, collectionId: string, key: string, required: boolean, xdefault?: number[]): Promise<Models.AttributePoint>;
1334
1334
  /**
1335
1335
  * Update a point attribute. Changing the `default` value will not update already existing documents.
1336
1336
  *
@@ -1338,7 +1338,7 @@ export declare class Databases {
1338
1338
  * @param {string} params.collectionId - Collection ID. You can create a new collection using the Database service [server integration](https://appwrite.io/docs/server/databases#createCollection).
1339
1339
  * @param {string} params.key - Attribute Key.
1340
1340
  * @param {boolean} params.required - Is attribute required?
1341
- * @param {any[]} params.xdefault - Default value for attribute when not provided, array of two numbers [longitude, latitude], representing a single coordinate. Cannot be set when attribute is required.
1341
+ * @param {number[]} params.xdefault - Default value for attribute when not provided, array of two numbers [longitude, latitude], representing a single coordinate. Cannot be set when attribute is required.
1342
1342
  * @param {string} params.newKey - New attribute key.
1343
1343
  * @throws {AppwriteException}
1344
1344
  * @returns {Promise<Models.AttributePoint>}
@@ -1349,7 +1349,7 @@ export declare class Databases {
1349
1349
  collectionId: string;
1350
1350
  key: string;
1351
1351
  required: boolean;
1352
- xdefault?: any[];
1352
+ xdefault?: number[];
1353
1353
  newKey?: string;
1354
1354
  }): Promise<Models.AttributePoint>;
1355
1355
  /**
@@ -1359,13 +1359,13 @@ export declare class Databases {
1359
1359
  * @param {string} collectionId - Collection ID. You can create a new collection using the Database service [server integration](https://appwrite.io/docs/server/databases#createCollection).
1360
1360
  * @param {string} key - Attribute Key.
1361
1361
  * @param {boolean} required - Is attribute required?
1362
- * @param {any[]} xdefault - Default value for attribute when not provided, array of two numbers [longitude, latitude], representing a single coordinate. Cannot be set when attribute is required.
1362
+ * @param {number[]} xdefault - Default value for attribute when not provided, array of two numbers [longitude, latitude], representing a single coordinate. Cannot be set when attribute is required.
1363
1363
  * @param {string} newKey - New attribute key.
1364
1364
  * @throws {AppwriteException}
1365
1365
  * @returns {Promise<Models.AttributePoint>}
1366
1366
  * @deprecated Use the object parameter style method for a better developer experience.
1367
1367
  */
1368
- updatePointAttribute(databaseId: string, collectionId: string, key: string, required: boolean, xdefault?: any[], newKey?: string): Promise<Models.AttributePoint>;
1368
+ updatePointAttribute(databaseId: string, collectionId: string, key: string, required: boolean, xdefault?: number[], newKey?: string): Promise<Models.AttributePoint>;
1369
1369
  /**
1370
1370
  * Create a geometric polygon attribute.
1371
1371
  *
@@ -1373,7 +1373,7 @@ export declare class Databases {
1373
1373
  * @param {string} params.collectionId - Collection ID. You can create a new collection using the Database service [server integration](https://appwrite.io/docs/server/databases#databasesCreateCollection).
1374
1374
  * @param {string} params.key - Attribute Key.
1375
1375
  * @param {boolean} params.required - Is attribute required?
1376
- * @param {any[]} params.xdefault - Default value for attribute when not provided, three-dimensional array where the outer array holds one or more linear rings, [[[longitude, latitude], …], …], the first ring is the exterior boundary, any additional rings are interior holes, and each ring must start and end with the same coordinate pair. Cannot be set when attribute is required.
1376
+ * @param {any[][]} params.xdefault - Default value for attribute when not provided, three-dimensional array where the outer array holds one or more linear rings, [[[longitude, latitude], …], …], the first ring is the exterior boundary, any additional rings are interior holes, and each ring must start and end with the same coordinate pair. Cannot be set when attribute is required.
1377
1377
  * @throws {AppwriteException}
1378
1378
  * @returns {Promise<Models.AttributePolygon>}
1379
1379
  * @deprecated This API has been deprecated since 1.8.0. Please use `TablesDB.createPolygonColumn` instead.
@@ -1383,7 +1383,7 @@ export declare class Databases {
1383
1383
  collectionId: string;
1384
1384
  key: string;
1385
1385
  required: boolean;
1386
- xdefault?: any[];
1386
+ xdefault?: any[][];
1387
1387
  }): Promise<Models.AttributePolygon>;
1388
1388
  /**
1389
1389
  * Create a geometric polygon attribute.
@@ -1392,12 +1392,12 @@ export declare class Databases {
1392
1392
  * @param {string} collectionId - Collection ID. You can create a new collection using the Database service [server integration](https://appwrite.io/docs/server/databases#databasesCreateCollection).
1393
1393
  * @param {string} key - Attribute Key.
1394
1394
  * @param {boolean} required - Is attribute required?
1395
- * @param {any[]} xdefault - Default value for attribute when not provided, three-dimensional array where the outer array holds one or more linear rings, [[[longitude, latitude], …], …], the first ring is the exterior boundary, any additional rings are interior holes, and each ring must start and end with the same coordinate pair. Cannot be set when attribute is required.
1395
+ * @param {any[][]} xdefault - Default value for attribute when not provided, three-dimensional array where the outer array holds one or more linear rings, [[[longitude, latitude], …], …], the first ring is the exterior boundary, any additional rings are interior holes, and each ring must start and end with the same coordinate pair. Cannot be set when attribute is required.
1396
1396
  * @throws {AppwriteException}
1397
1397
  * @returns {Promise<Models.AttributePolygon>}
1398
1398
  * @deprecated Use the object parameter style method for a better developer experience.
1399
1399
  */
1400
- createPolygonAttribute(databaseId: string, collectionId: string, key: string, required: boolean, xdefault?: any[]): Promise<Models.AttributePolygon>;
1400
+ createPolygonAttribute(databaseId: string, collectionId: string, key: string, required: boolean, xdefault?: any[][]): Promise<Models.AttributePolygon>;
1401
1401
  /**
1402
1402
  * Update a polygon attribute. Changing the `default` value will not update already existing documents.
1403
1403
  *
@@ -1405,7 +1405,7 @@ export declare class Databases {
1405
1405
  * @param {string} params.collectionId - Collection ID. You can create a new collection using the Database service [server integration](https://appwrite.io/docs/server/databases#createCollection).
1406
1406
  * @param {string} params.key - Attribute Key.
1407
1407
  * @param {boolean} params.required - Is attribute required?
1408
- * @param {any[]} params.xdefault - Default value for attribute when not provided, three-dimensional array where the outer array holds one or more linear rings, [[[longitude, latitude], …], …], the first ring is the exterior boundary, any additional rings are interior holes, and each ring must start and end with the same coordinate pair. Cannot be set when attribute is required.
1408
+ * @param {any[][]} params.xdefault - Default value for attribute when not provided, three-dimensional array where the outer array holds one or more linear rings, [[[longitude, latitude], …], …], the first ring is the exterior boundary, any additional rings are interior holes, and each ring must start and end with the same coordinate pair. Cannot be set when attribute is required.
1409
1409
  * @param {string} params.newKey - New attribute key.
1410
1410
  * @throws {AppwriteException}
1411
1411
  * @returns {Promise<Models.AttributePolygon>}
@@ -1416,7 +1416,7 @@ export declare class Databases {
1416
1416
  collectionId: string;
1417
1417
  key: string;
1418
1418
  required: boolean;
1419
- xdefault?: any[];
1419
+ xdefault?: any[][];
1420
1420
  newKey?: string;
1421
1421
  }): Promise<Models.AttributePolygon>;
1422
1422
  /**
@@ -1426,13 +1426,13 @@ export declare class Databases {
1426
1426
  * @param {string} collectionId - Collection ID. You can create a new collection using the Database service [server integration](https://appwrite.io/docs/server/databases#createCollection).
1427
1427
  * @param {string} key - Attribute Key.
1428
1428
  * @param {boolean} required - Is attribute required?
1429
- * @param {any[]} xdefault - Default value for attribute when not provided, three-dimensional array where the outer array holds one or more linear rings, [[[longitude, latitude], …], …], the first ring is the exterior boundary, any additional rings are interior holes, and each ring must start and end with the same coordinate pair. Cannot be set when attribute is required.
1429
+ * @param {any[][]} xdefault - Default value for attribute when not provided, three-dimensional array where the outer array holds one or more linear rings, [[[longitude, latitude], …], …], the first ring is the exterior boundary, any additional rings are interior holes, and each ring must start and end with the same coordinate pair. Cannot be set when attribute is required.
1430
1430
  * @param {string} newKey - New attribute key.
1431
1431
  * @throws {AppwriteException}
1432
1432
  * @returns {Promise<Models.AttributePolygon>}
1433
1433
  * @deprecated Use the object parameter style method for a better developer experience.
1434
1434
  */
1435
- updatePolygonAttribute(databaseId: string, collectionId: string, key: string, required: boolean, xdefault?: any[], newKey?: string): Promise<Models.AttributePolygon>;
1435
+ updatePolygonAttribute(databaseId: string, collectionId: string, key: string, required: boolean, xdefault?: any[][], newKey?: string): Promise<Models.AttributePolygon>;
1436
1436
  /**
1437
1437
  * Create relationship attribute. [Learn more about relationship attributes](https://appwrite.io/docs/databases-relationships#relationship-attributes).
1438
1438
  *
@@ -35,6 +35,7 @@ export declare class DocumentsDB {
35
35
  * @param {string} params.databaseId - Unique Id. Choose a custom ID or generate a random ID with `ID.unique()`. 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.
36
36
  * @param {string} params.name - Database name. Max length: 128 chars.
37
37
  * @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.
38
+ * @param {string} params.dedicatedDatabaseId - Optional dedicated database (compute) ID to attach this database to. Leave empty to create a database on the shared pool.
38
39
  * @throws {AppwriteException}
39
40
  * @returns {Promise<Models.Database>}
40
41
  */
@@ -42,6 +43,7 @@ export declare class DocumentsDB {
42
43
  databaseId: string;
43
44
  name: string;
44
45
  enabled?: boolean;
46
+ dedicatedDatabaseId?: string;
45
47
  }): Promise<Models.Database>;
46
48
  /**
47
49
  * Create a new Database.
@@ -50,11 +52,12 @@ export declare class DocumentsDB {
50
52
  * @param {string} databaseId - Unique Id. Choose a custom ID or generate a random ID with `ID.unique()`. 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.
51
53
  * @param {string} name - Database name. Max length: 128 chars.
52
54
  * @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.
55
+ * @param {string} dedicatedDatabaseId - Optional dedicated database (compute) ID to attach this database to. Leave empty to create a database on the shared pool.
53
56
  * @throws {AppwriteException}
54
57
  * @returns {Promise<Models.Database>}
55
58
  * @deprecated Use the object parameter style method for a better developer experience.
56
59
  */
57
- create(databaseId: string, name: string, enabled?: boolean): Promise<Models.Database>;
60
+ create(databaseId: string, name: string, enabled?: boolean, dedicatedDatabaseId?: string): Promise<Models.Database>;
58
61
  /**
59
62
  * List transactions across all databases.
60
63
  *
@@ -640,22 +640,22 @@ export declare class Organizations {
640
640
  * @param {string} params.organizationId - Organization ID
641
641
  * @param {string} params.invoiceId - Invoice unique ID
642
642
  * @throws {AppwriteException}
643
- * @returns {Promise<Models.PaymentMethod>}
643
+ * @returns {string}
644
644
  */
645
645
  getInvoiceDownload(params: {
646
646
  organizationId: string;
647
647
  invoiceId: string;
648
- }): Promise<Models.PaymentMethod>;
648
+ }): string;
649
649
  /**
650
650
  * Download invoice in PDF
651
651
  *
652
652
  * @param {string} organizationId - Organization ID
653
653
  * @param {string} invoiceId - Invoice unique ID
654
654
  * @throws {AppwriteException}
655
- * @returns {Promise<Models.PaymentMethod>}
655
+ * @returns {string}
656
656
  * @deprecated Use the object parameter style method for a better developer experience.
657
657
  */
658
- getInvoiceDownload(organizationId: string, invoiceId: string): Promise<Models.PaymentMethod>;
658
+ getInvoiceDownload(organizationId: string, invoiceId: string): string;
659
659
  /**
660
660
  * Initiate payment for failed invoice to pay live from console
661
661
  *
@@ -709,22 +709,22 @@ export declare class Organizations {
709
709
  * @param {string} params.organizationId - Organization ID
710
710
  * @param {string} params.invoiceId - Invoice unique ID
711
711
  * @throws {AppwriteException}
712
- * @returns {Promise<Models.PaymentMethod>}
712
+ * @returns {string}
713
713
  */
714
714
  getInvoiceView(params: {
715
715
  organizationId: string;
716
716
  invoiceId: string;
717
- }): Promise<Models.PaymentMethod>;
717
+ }): string;
718
718
  /**
719
719
  * View invoice in PDF
720
720
  *
721
721
  * @param {string} organizationId - Organization ID
722
722
  * @param {string} invoiceId - Invoice unique ID
723
723
  * @throws {AppwriteException}
724
- * @returns {Promise<Models.PaymentMethod>}
724
+ * @returns {string}
725
725
  * @deprecated Use the object parameter style method for a better developer experience.
726
726
  */
727
- getInvoiceView(organizationId: string, invoiceId: string): Promise<Models.PaymentMethod>;
727
+ getInvoiceView(organizationId: string, invoiceId: string): string;
728
728
  /**
729
729
  * Set a organization's default payment method.
730
730
  *