@appwrite.io/console 15.3.0-rc.1 → 15.4.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 +3 -3
- package/dist/cjs/sdk.js +2524 -2066
- package/dist/cjs/sdk.js.map +1 -1
- package/dist/esm/sdk.js +2524 -2066
- package/dist/esm/sdk.js.map +1 -1
- package/dist/iife/sdk.js +2524 -2066
- package/package.json +4 -4
- package/types/enums/database-status.d.ts +12 -1
- package/types/enums/database-type.d.ts +4 -1
- package/types/enums/o-auth-provider.d.ts +1 -0
- package/types/enums/project-key-scopes.d.ts +5 -2
- package/types/enums/project-o-auth-provider-id.d.ts +1 -0
- package/types/enums/query-suggestion-resource.d.ts +6 -1
- package/types/enums/waf-rule-action.d.ts +7 -0
- package/types/index.d.ts +3 -5
- package/types/models.d.ts +3260 -3404
- package/types/services/account.d.ts +133 -4
- package/types/services/apps.d.ts +39 -10
- package/types/services/backups.d.ts +17 -8
- package/types/services/databases.d.ts +0 -70
- package/types/services/documents-db.d.ts +75 -2
- package/types/services/functions.d.ts +4 -43
- package/types/services/locale.d.ts +2 -2
- package/types/services/migrations.d.ts +30 -18
- package/types/services/mongo.d.ts +13 -4
- package/types/services/mysql.d.ts +13 -4
- package/types/services/oauth-2.d.ts +119 -15
- package/types/services/postgresql.d.ts +13 -4
- package/types/services/project.d.ts +29 -1
- package/types/services/sites.d.ts +4 -43
- package/types/services/storage.d.ts +0 -46
- package/types/services/tables-db.d.ts +75 -69
- package/types/services/usage.d.ts +10 -10
- package/types/services/vectors-db.d.ts +75 -2
- package/types/services/waf.d.ts +435 -0
- package/types/enums/health-antivirus-status.d.ts +0 -5
- package/types/enums/health-check-status.d.ts +0 -4
- package/types/enums/health-queue-name.d.ts +0 -16
- package/types/services/health.d.ts +0 -483
|
@@ -3,7 +3,6 @@ import type { Models } from '../models';
|
|
|
3
3
|
import { Runtime } from '../enums/runtime';
|
|
4
4
|
import { ProjectKeyScopes } from '../enums/project-key-scopes';
|
|
5
5
|
import { FunctionTemplateUseCase } from '../enums/function-template-use-case';
|
|
6
|
-
import { UsageRange } from '../enums/usage-range';
|
|
7
6
|
import { TemplateReferenceType } from '../enums/template-reference-type';
|
|
8
7
|
import { VCSReferenceType } from '../enums/vcs-reference-type';
|
|
9
8
|
import { DeploymentDownloadType } from '../enums/deployment-download-type';
|
|
@@ -194,25 +193,6 @@ export declare class Functions {
|
|
|
194
193
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
195
194
|
*/
|
|
196
195
|
getTemplate(templateId: string): Promise<Models.TemplateFunction>;
|
|
197
|
-
/**
|
|
198
|
-
* Get usage metrics and statistics for all functions in the project. View statistics including total deployments, builds, logs, storage usage, and compute time. The response includes both current totals and historical data for each metric. Use the optional range parameter to specify the time window for historical data: 24h (last 24 hours), 30d (last 30 days), or 90d (last 90 days). If not specified, defaults to 30 days.
|
|
199
|
-
*
|
|
200
|
-
* @param {UsageRange} params.range - Date range.
|
|
201
|
-
* @throws {AppwriteException}
|
|
202
|
-
* @returns {Promise<Models.UsageFunctions>}
|
|
203
|
-
*/
|
|
204
|
-
listUsage(params?: {
|
|
205
|
-
range?: UsageRange;
|
|
206
|
-
}): Promise<Models.UsageFunctions>;
|
|
207
|
-
/**
|
|
208
|
-
* Get usage metrics and statistics for all functions in the project. View statistics including total deployments, builds, logs, storage usage, and compute time. The response includes both current totals and historical data for each metric. Use the optional range parameter to specify the time window for historical data: 24h (last 24 hours), 30d (last 30 days), or 90d (last 90 days). If not specified, defaults to 30 days.
|
|
209
|
-
*
|
|
210
|
-
* @param {UsageRange} range - Date range.
|
|
211
|
-
* @throws {AppwriteException}
|
|
212
|
-
* @returns {Promise<Models.UsageFunctions>}
|
|
213
|
-
* @deprecated Use the object parameter style method for a better developer experience.
|
|
214
|
-
*/
|
|
215
|
-
listUsage(range?: UsageRange): Promise<Models.UsageFunctions>;
|
|
216
196
|
/**
|
|
217
197
|
* Get a function by its unique ID.
|
|
218
198
|
*
|
|
@@ -571,6 +551,7 @@ export declare class Functions {
|
|
|
571
551
|
* @param {string} params.functionId - Function ID.
|
|
572
552
|
* @param {string} params.deploymentId - Deployment ID.
|
|
573
553
|
* @param {DeploymentDownloadType} params.type - Deployment file to download. Can be: "source", "output".
|
|
554
|
+
* @param {string} params.token - Presigned source-download token for accessing this deployment without a session (jobs-service).
|
|
574
555
|
* @throws {AppwriteException}
|
|
575
556
|
* @returns {string}
|
|
576
557
|
*/
|
|
@@ -578,6 +559,7 @@ export declare class Functions {
|
|
|
578
559
|
functionId: string;
|
|
579
560
|
deploymentId: string;
|
|
580
561
|
type?: DeploymentDownloadType;
|
|
562
|
+
token?: string;
|
|
581
563
|
}): string;
|
|
582
564
|
/**
|
|
583
565
|
* Get a function deployment content by its unique ID. The endpoint response return with a 'Content-Disposition: attachment' header that tells the browser to start downloading the file to user downloads directory.
|
|
@@ -585,11 +567,12 @@ export declare class Functions {
|
|
|
585
567
|
* @param {string} functionId - Function ID.
|
|
586
568
|
* @param {string} deploymentId - Deployment ID.
|
|
587
569
|
* @param {DeploymentDownloadType} type - Deployment file to download. Can be: "source", "output".
|
|
570
|
+
* @param {string} token - Presigned source-download token for accessing this deployment without a session (jobs-service).
|
|
588
571
|
* @throws {AppwriteException}
|
|
589
572
|
* @returns {string}
|
|
590
573
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
591
574
|
*/
|
|
592
|
-
getDeploymentDownload(functionId: string, deploymentId: string, type?: DeploymentDownloadType): string;
|
|
575
|
+
getDeploymentDownload(functionId: string, deploymentId: string, type?: DeploymentDownloadType, token?: string): string;
|
|
593
576
|
/**
|
|
594
577
|
* Cancel an ongoing function deployment build. If the build is already in progress, it will be stopped and marked as canceled. If the build hasn't started yet, it will be marked as canceled without executing. You cannot cancel builds that have already completed (status 'ready') or failed. The response includes the final build status and details.
|
|
595
578
|
*
|
|
@@ -718,28 +701,6 @@ export declare class Functions {
|
|
|
718
701
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
719
702
|
*/
|
|
720
703
|
deleteExecution(functionId: string, executionId: string): Promise<{}>;
|
|
721
|
-
/**
|
|
722
|
-
* Get usage metrics and statistics for a for a specific function. View statistics including total deployments, builds, executions, storage usage, and compute time. The response includes both current totals and historical data for each metric. Use the optional range parameter to specify the time window for historical data: 24h (last 24 hours), 30d (last 30 days), or 90d (last 90 days). If not specified, defaults to 30 days.
|
|
723
|
-
*
|
|
724
|
-
* @param {string} params.functionId - Function ID.
|
|
725
|
-
* @param {UsageRange} params.range - Date range.
|
|
726
|
-
* @throws {AppwriteException}
|
|
727
|
-
* @returns {Promise<Models.UsageFunction>}
|
|
728
|
-
*/
|
|
729
|
-
getUsage(params: {
|
|
730
|
-
functionId: string;
|
|
731
|
-
range?: UsageRange;
|
|
732
|
-
}): Promise<Models.UsageFunction>;
|
|
733
|
-
/**
|
|
734
|
-
* Get usage metrics and statistics for a for a specific function. View statistics including total deployments, builds, executions, storage usage, and compute time. The response includes both current totals and historical data for each metric. Use the optional range parameter to specify the time window for historical data: 24h (last 24 hours), 30d (last 30 days), or 90d (last 90 days). If not specified, defaults to 30 days.
|
|
735
|
-
*
|
|
736
|
-
* @param {string} functionId - Function ID.
|
|
737
|
-
* @param {UsageRange} range - Date range.
|
|
738
|
-
* @throws {AppwriteException}
|
|
739
|
-
* @returns {Promise<Models.UsageFunction>}
|
|
740
|
-
* @deprecated Use the object parameter style method for a better developer experience.
|
|
741
|
-
*/
|
|
742
|
-
getUsage(functionId: string, range?: UsageRange): Promise<Models.UsageFunction>;
|
|
743
704
|
/**
|
|
744
705
|
* Get a list of all variables of a specific function.
|
|
745
706
|
*
|
|
@@ -9,9 +9,9 @@ export declare class Locale {
|
|
|
9
9
|
* ([IP Geolocation by DB-IP](https://db-ip.com))
|
|
10
10
|
*
|
|
11
11
|
* @throws {AppwriteException}
|
|
12
|
-
* @returns {Promise<Models.
|
|
12
|
+
* @returns {Promise<Models.Locale>}
|
|
13
13
|
*/
|
|
14
|
-
get(): Promise<Models.
|
|
14
|
+
get(): Promise<Models.Locale>;
|
|
15
15
|
/**
|
|
16
16
|
* List of all locale codes in [ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes).
|
|
17
17
|
*
|
|
@@ -11,7 +11,7 @@ export declare class Migrations {
|
|
|
11
11
|
/**
|
|
12
12
|
* List all migrations in the current project. This endpoint returns a list of all migrations including their status, progress, and any errors that occurred during the migration process.
|
|
13
13
|
*
|
|
14
|
-
* @param {string[]} params.queries - Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/databases#querying-documents). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: status, stage, source, destination, resources, resourceId, resourceType, statusCounters, resourceData, errors
|
|
14
|
+
* @param {string[]} params.queries - Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/databases#querying-documents). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: status, stage, source, destination, resources, resourceId, resourceInternalId, resourceType, parentResourceId, parentResourceInternalId, parentResourceType, destinationResourceId, destinationResourceInternalId, destinationResourceType, statusCounters, resourceData, errors
|
|
15
15
|
* @param {string} params.search - Search term to filter your list results. Max length: 256 chars.
|
|
16
16
|
* @param {boolean} params.total - When set to false, the total count returned will be 0 and will not be calculated.
|
|
17
17
|
* @throws {AppwriteException}
|
|
@@ -25,7 +25,7 @@ export declare class Migrations {
|
|
|
25
25
|
/**
|
|
26
26
|
* List all migrations in the current project. This endpoint returns a list of all migrations including their status, progress, and any errors that occurred during the migration process.
|
|
27
27
|
*
|
|
28
|
-
* @param {string[]} queries - Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/databases#querying-documents). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: status, stage, source, destination, resources, resourceId, resourceType, statusCounters, resourceData, errors
|
|
28
|
+
* @param {string[]} queries - Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/databases#querying-documents). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: status, stage, source, destination, resources, resourceId, resourceInternalId, resourceType, parentResourceId, parentResourceInternalId, parentResourceType, destinationResourceId, destinationResourceInternalId, destinationResourceType, statusCounters, resourceData, errors
|
|
29
29
|
* @param {string} search - Search term to filter your list results. Max length: 256 chars.
|
|
30
30
|
* @param {boolean} total - When set to false, the total count returned will be 0 and will not be calculated.
|
|
31
31
|
* @throws {AppwriteException}
|
|
@@ -95,7 +95,8 @@ export declare class Migrations {
|
|
|
95
95
|
/**
|
|
96
96
|
* Export documents to a CSV file from your Appwrite database. This endpoint allows you to export documents to a CSV file stored in a secure internal bucket. You'll receive an email with a download link when the export is complete.
|
|
97
97
|
*
|
|
98
|
-
* @param {string} params.
|
|
98
|
+
* @param {string} params.databaseId - Database ID containing the source collection.
|
|
99
|
+
* @param {string} params.collectionId - Collection ID to export documents from.
|
|
99
100
|
* @param {string} params.filename - The name of the file to be created for the export, excluding the .csv extension.
|
|
100
101
|
* @param {string[]} params.columns - List of attributes to export. If empty, all attributes will be exported. You can use the `*` wildcard to export all attributes from the collection.
|
|
101
102
|
* @param {string[]} params.queries - Array of query strings generated using the Query class provided by the SDK to filter documents to export. [Learn more about queries](https://appwrite.io/docs/databases#querying-documents). Maximum of 100 queries are allowed, each 4096 characters long.
|
|
@@ -108,7 +109,8 @@ export declare class Migrations {
|
|
|
108
109
|
* @returns {Promise<Models.Migration>}
|
|
109
110
|
*/
|
|
110
111
|
createCSVExport(params: {
|
|
111
|
-
|
|
112
|
+
databaseId: string;
|
|
113
|
+
collectionId: string;
|
|
112
114
|
filename: string;
|
|
113
115
|
columns?: string[];
|
|
114
116
|
queries?: string[];
|
|
@@ -121,7 +123,8 @@ export declare class Migrations {
|
|
|
121
123
|
/**
|
|
122
124
|
* Export documents to a CSV file from your Appwrite database. This endpoint allows you to export documents to a CSV file stored in a secure internal bucket. You'll receive an email with a download link when the export is complete.
|
|
123
125
|
*
|
|
124
|
-
* @param {string}
|
|
126
|
+
* @param {string} databaseId - Database ID containing the source collection.
|
|
127
|
+
* @param {string} collectionId - Collection ID to export documents from.
|
|
125
128
|
* @param {string} filename - The name of the file to be created for the export, excluding the .csv extension.
|
|
126
129
|
* @param {string[]} columns - List of attributes to export. If empty, all attributes will be exported. You can use the `*` wildcard to export all attributes from the collection.
|
|
127
130
|
* @param {string[]} queries - Array of query strings generated using the Query class provided by the SDK to filter documents to export. [Learn more about queries](https://appwrite.io/docs/databases#querying-documents). Maximum of 100 queries are allowed, each 4096 characters long.
|
|
@@ -134,13 +137,14 @@ export declare class Migrations {
|
|
|
134
137
|
* @returns {Promise<Models.Migration>}
|
|
135
138
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
136
139
|
*/
|
|
137
|
-
createCSVExport(
|
|
140
|
+
createCSVExport(databaseId: string, collectionId: string, filename: string, columns?: string[], queries?: string[], delimiter?: string, enclosure?: string, escape?: string, header?: boolean, notify?: boolean): Promise<Models.Migration>;
|
|
138
141
|
/**
|
|
139
142
|
* Import documents from a CSV file into your Appwrite database. This endpoint allows you to import documents from a CSV file uploaded to Appwrite Storage bucket.
|
|
140
143
|
*
|
|
141
144
|
* @param {string} params.bucketId - Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https://appwrite.io/docs/server/storage#createBucket).
|
|
142
145
|
* @param {string} params.fileId - File ID.
|
|
143
|
-
* @param {string} params.
|
|
146
|
+
* @param {string} params.databaseId - Database ID containing the target collection.
|
|
147
|
+
* @param {string} params.collectionId - Collection ID to import documents into.
|
|
144
148
|
* @param {boolean} params.internalFile - Is the file stored in an internal bucket?
|
|
145
149
|
* @param {OnDuplicate} params.onDuplicate - Behavior when a row with an existing $id is encountered. "fail" (default): abort on first conflict. "skip": silently ignore. "overwrite": replace existing row.
|
|
146
150
|
* @throws {AppwriteException}
|
|
@@ -149,7 +153,8 @@ export declare class Migrations {
|
|
|
149
153
|
createCSVImport(params: {
|
|
150
154
|
bucketId: string;
|
|
151
155
|
fileId: string;
|
|
152
|
-
|
|
156
|
+
databaseId: string;
|
|
157
|
+
collectionId: string;
|
|
153
158
|
internalFile?: boolean;
|
|
154
159
|
onDuplicate?: OnDuplicate;
|
|
155
160
|
}): Promise<Models.Migration>;
|
|
@@ -158,14 +163,15 @@ export declare class Migrations {
|
|
|
158
163
|
*
|
|
159
164
|
* @param {string} bucketId - Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https://appwrite.io/docs/server/storage#createBucket).
|
|
160
165
|
* @param {string} fileId - File ID.
|
|
161
|
-
* @param {string}
|
|
166
|
+
* @param {string} databaseId - Database ID containing the target collection.
|
|
167
|
+
* @param {string} collectionId - Collection ID to import documents into.
|
|
162
168
|
* @param {boolean} internalFile - Is the file stored in an internal bucket?
|
|
163
169
|
* @param {OnDuplicate} onDuplicate - Behavior when a row with an existing $id is encountered. "fail" (default): abort on first conflict. "skip": silently ignore. "overwrite": replace existing row.
|
|
164
170
|
* @throws {AppwriteException}
|
|
165
171
|
* @returns {Promise<Models.Migration>}
|
|
166
172
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
167
173
|
*/
|
|
168
|
-
createCSVImport(bucketId: string, fileId: string,
|
|
174
|
+
createCSVImport(bucketId: string, fileId: string, databaseId: string, collectionId: string, internalFile?: boolean, onDuplicate?: OnDuplicate): Promise<Models.Migration>;
|
|
169
175
|
/**
|
|
170
176
|
* Migrate data from a Firebase project to your Appwrite project. This endpoint allows you to migrate resources like authentication and other supported services from a Firebase project.
|
|
171
177
|
*
|
|
@@ -214,7 +220,8 @@ export declare class Migrations {
|
|
|
214
220
|
* Export documents to a JSON file from your Appwrite database. This endpoint allows you to export documents to a JSON file stored in a secure internal bucket. You'll receive an email with a download link when the export is complete.
|
|
215
221
|
*
|
|
216
222
|
*
|
|
217
|
-
* @param {string} params.
|
|
223
|
+
* @param {string} params.databaseId - Database ID containing the source collection.
|
|
224
|
+
* @param {string} params.collectionId - Collection ID to export documents from.
|
|
218
225
|
* @param {string} params.filename - The name of the file to be created for the export, excluding the .json extension.
|
|
219
226
|
* @param {string[]} params.columns - List of attributes to export. If empty, all attributes will be exported. You can use the `*` wildcard to export all attributes from the collection.
|
|
220
227
|
* @param {string[]} params.queries - Array of query strings generated using the Query class provided by the SDK to filter documents to export. [Learn more about queries](https://appwrite.io/docs/databases#querying-documents). Maximum of 100 queries are allowed, each 4096 characters long.
|
|
@@ -223,7 +230,8 @@ export declare class Migrations {
|
|
|
223
230
|
* @returns {Promise<Models.Migration>}
|
|
224
231
|
*/
|
|
225
232
|
createJSONExport(params: {
|
|
226
|
-
|
|
233
|
+
databaseId: string;
|
|
234
|
+
collectionId: string;
|
|
227
235
|
filename: string;
|
|
228
236
|
columns?: string[];
|
|
229
237
|
queries?: string[];
|
|
@@ -233,7 +241,8 @@ export declare class Migrations {
|
|
|
233
241
|
* Export documents to a JSON file from your Appwrite database. This endpoint allows you to export documents to a JSON file stored in a secure internal bucket. You'll receive an email with a download link when the export is complete.
|
|
234
242
|
*
|
|
235
243
|
*
|
|
236
|
-
* @param {string}
|
|
244
|
+
* @param {string} databaseId - Database ID containing the source collection.
|
|
245
|
+
* @param {string} collectionId - Collection ID to export documents from.
|
|
237
246
|
* @param {string} filename - The name of the file to be created for the export, excluding the .json extension.
|
|
238
247
|
* @param {string[]} columns - List of attributes to export. If empty, all attributes will be exported. You can use the `*` wildcard to export all attributes from the collection.
|
|
239
248
|
* @param {string[]} queries - Array of query strings generated using the Query class provided by the SDK to filter documents to export. [Learn more about queries](https://appwrite.io/docs/databases#querying-documents). Maximum of 100 queries are allowed, each 4096 characters long.
|
|
@@ -242,14 +251,15 @@ export declare class Migrations {
|
|
|
242
251
|
* @returns {Promise<Models.Migration>}
|
|
243
252
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
244
253
|
*/
|
|
245
|
-
createJSONExport(
|
|
254
|
+
createJSONExport(databaseId: string, collectionId: string, filename: string, columns?: string[], queries?: string[], notify?: boolean): Promise<Models.Migration>;
|
|
246
255
|
/**
|
|
247
256
|
* Import documents from a JSON file into your Appwrite database. This endpoint allows you to import documents from a JSON file uploaded to Appwrite Storage bucket.
|
|
248
257
|
*
|
|
249
258
|
*
|
|
250
259
|
* @param {string} params.bucketId - Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https://appwrite.io/docs/server/storage#createBucket).
|
|
251
260
|
* @param {string} params.fileId - File ID.
|
|
252
|
-
* @param {string} params.
|
|
261
|
+
* @param {string} params.databaseId - Database ID containing the target collection.
|
|
262
|
+
* @param {string} params.collectionId - Collection ID to import documents into.
|
|
253
263
|
* @param {boolean} params.internalFile - Is the file stored in an internal bucket?
|
|
254
264
|
* @param {OnDuplicate} params.onDuplicate - Behavior when a row with an existing $id is encountered. "fail" (default): abort on first conflict. "skip": silently ignore. "overwrite": replace existing row.
|
|
255
265
|
* @throws {AppwriteException}
|
|
@@ -258,7 +268,8 @@ export declare class Migrations {
|
|
|
258
268
|
createJSONImport(params: {
|
|
259
269
|
bucketId: string;
|
|
260
270
|
fileId: string;
|
|
261
|
-
|
|
271
|
+
databaseId: string;
|
|
272
|
+
collectionId: string;
|
|
262
273
|
internalFile?: boolean;
|
|
263
274
|
onDuplicate?: OnDuplicate;
|
|
264
275
|
}): Promise<Models.Migration>;
|
|
@@ -268,14 +279,15 @@ export declare class Migrations {
|
|
|
268
279
|
*
|
|
269
280
|
* @param {string} bucketId - Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https://appwrite.io/docs/server/storage#createBucket).
|
|
270
281
|
* @param {string} fileId - File ID.
|
|
271
|
-
* @param {string}
|
|
282
|
+
* @param {string} databaseId - Database ID containing the target collection.
|
|
283
|
+
* @param {string} collectionId - Collection ID to import documents into.
|
|
272
284
|
* @param {boolean} internalFile - Is the file stored in an internal bucket?
|
|
273
285
|
* @param {OnDuplicate} onDuplicate - Behavior when a row with an existing $id is encountered. "fail" (default): abort on first conflict. "skip": silently ignore. "overwrite": replace existing row.
|
|
274
286
|
* @throws {AppwriteException}
|
|
275
287
|
* @returns {Promise<Models.Migration>}
|
|
276
288
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
277
289
|
*/
|
|
278
|
-
createJSONImport(bucketId: string, fileId: string,
|
|
290
|
+
createJSONImport(bucketId: string, fileId: string, databaseId: string, collectionId: string, internalFile?: boolean, onDuplicate?: OnDuplicate): Promise<Models.Migration>;
|
|
279
291
|
/**
|
|
280
292
|
* Migrate data from an NHost project to your Appwrite project. This endpoint allows you to migrate resources like authentication, databases, and other supported services from an NHost project.
|
|
281
293
|
*
|
|
@@ -31,6 +31,7 @@ export declare class Mongo {
|
|
|
31
31
|
* @param {string} params.specification - Specification identifier. Drives the allocated CPU, memory, storage, storage class, and connection ceiling.
|
|
32
32
|
* @param {number} params.replicas - Number of high availability replicas (0-5). High availability is enabled when greater than 0.
|
|
33
33
|
* @param {string} params.syncMode - Replication sync mode preference. Allowed values: async, sync, quorum.
|
|
34
|
+
* @param {string} params.standbyRegion - Standby region for a cross-region replica. When set, a replica is provisioned in this region for cross-region high availability. Must differ from the database region.
|
|
34
35
|
* @param {number} params.networkIdleTimeoutSeconds - Connection idle timeout in seconds.
|
|
35
36
|
* @param {string[]} params.networkIPAllowlist - IP addresses/CIDR ranges allowed to connect.
|
|
36
37
|
* @param {number} params.idleTimeoutMinutes - Minutes of inactivity before container scales to zero.
|
|
@@ -39,7 +40,7 @@ export declare class Mongo {
|
|
|
39
40
|
* @param {boolean} params.storageAutoscaling - Enable automatic storage expansion when usage exceeds threshold.
|
|
40
41
|
* @param {number} params.storageAutoscalingThresholdPercent - Storage usage percentage (50-95) that triggers automatic expansion.
|
|
41
42
|
* @param {number} params.storageAutoscalingMaxGb - Maximum storage size in GB for autoscaling. 0 means no limit.
|
|
42
|
-
* @param {string} params.api - Product API that owns this database:
|
|
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.
|
|
43
44
|
* @throws {AppwriteException}
|
|
44
45
|
* @returns {Promise<Models.DedicatedDatabase>}
|
|
45
46
|
*/
|
|
@@ -50,6 +51,7 @@ export declare class Mongo {
|
|
|
50
51
|
specification?: string;
|
|
51
52
|
replicas?: number;
|
|
52
53
|
syncMode?: string;
|
|
54
|
+
standbyRegion?: string;
|
|
53
55
|
networkIdleTimeoutSeconds?: number;
|
|
54
56
|
networkIPAllowlist?: string[];
|
|
55
57
|
idleTimeoutMinutes?: number;
|
|
@@ -69,6 +71,7 @@ export declare class Mongo {
|
|
|
69
71
|
* @param {string} specification - Specification identifier. Drives the allocated CPU, memory, storage, storage class, and connection ceiling.
|
|
70
72
|
* @param {number} replicas - Number of high availability replicas (0-5). High availability is enabled when greater than 0.
|
|
71
73
|
* @param {string} syncMode - Replication sync mode preference. Allowed values: async, sync, quorum.
|
|
74
|
+
* @param {string} standbyRegion - Standby region for a cross-region replica. When set, a replica is provisioned in this region for cross-region high availability. Must differ from the database region.
|
|
72
75
|
* @param {number} networkIdleTimeoutSeconds - Connection idle timeout in seconds.
|
|
73
76
|
* @param {string[]} networkIPAllowlist - IP addresses/CIDR ranges allowed to connect.
|
|
74
77
|
* @param {number} idleTimeoutMinutes - Minutes of inactivity before container scales to zero.
|
|
@@ -77,12 +80,12 @@ export declare class Mongo {
|
|
|
77
80
|
* @param {boolean} storageAutoscaling - Enable automatic storage expansion when usage exceeds threshold.
|
|
78
81
|
* @param {number} storageAutoscalingThresholdPercent - Storage usage percentage (50-95) that triggers automatic expansion.
|
|
79
82
|
* @param {number} storageAutoscalingMaxGb - Maximum storage size in GB for autoscaling. 0 means no limit.
|
|
80
|
-
* @param {string} api - Product API that owns this database:
|
|
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.
|
|
81
84
|
* @throws {AppwriteException}
|
|
82
85
|
* @returns {Promise<Models.DedicatedDatabase>}
|
|
83
86
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
84
87
|
*/
|
|
85
|
-
create(databaseId: string, name: string, version?: string, specification?: string, replicas?: number, syncMode?: string, networkIdleTimeoutSeconds?: number, networkIPAllowlist?: string[], idleTimeoutMinutes?: number, pitr?: boolean, pitrRetentionDays?: number, storageAutoscaling?: boolean, storageAutoscalingThresholdPercent?: number, storageAutoscalingMaxGb?: number, api?: string): Promise<Models.DedicatedDatabase>;
|
|
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, api?: string): Promise<Models.DedicatedDatabase>;
|
|
86
89
|
/**
|
|
87
90
|
* 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.
|
|
88
91
|
*
|
|
@@ -118,6 +121,8 @@ export declare class Mongo {
|
|
|
118
121
|
* @param {string} params.specification - Specification. Changes cpu, memory, storage, connection ceiling, and node pool based on specification config. Resource changes are applied via rolling cutover with zero downtime.
|
|
119
122
|
* @param {number} params.replicas - Number of high availability replicas (0-5). High availability is enabled when greater than 0.
|
|
120
123
|
* @param {string} params.syncMode - Replication sync mode preference. Allowed values: async, sync, quorum.
|
|
124
|
+
* @param {number} params.crossRegionReplicas - Number of cross-region standby replicas (0-1). Cross-region replication is enabled when greater than 0.
|
|
125
|
+
* @param {string} params.standbyRegion - Standby region for the cross-region replica. Required when enabling cross-region replication and no standby region is already configured. Must differ from the database region.
|
|
121
126
|
* @param {number} params.networkIdleTimeoutSeconds - Connection idle timeout in seconds (60-86400).
|
|
122
127
|
* @param {string[]} params.networkIPAllowlist - IP addresses/CIDR ranges allowed to connect.
|
|
123
128
|
* @param {number} params.idleTimeoutMinutes - Minutes before container scales to zero.
|
|
@@ -143,6 +148,8 @@ export declare class Mongo {
|
|
|
143
148
|
specification?: string;
|
|
144
149
|
replicas?: number;
|
|
145
150
|
syncMode?: string;
|
|
151
|
+
crossRegionReplicas?: number;
|
|
152
|
+
standbyRegion?: string;
|
|
146
153
|
networkIdleTimeoutSeconds?: number;
|
|
147
154
|
networkIPAllowlist?: string[];
|
|
148
155
|
idleTimeoutMinutes?: number;
|
|
@@ -168,6 +175,8 @@ export declare class Mongo {
|
|
|
168
175
|
* @param {string} specification - Specification. Changes cpu, memory, storage, connection ceiling, and node pool based on specification config. Resource changes are applied via rolling cutover with zero downtime.
|
|
169
176
|
* @param {number} replicas - Number of high availability replicas (0-5). High availability is enabled when greater than 0.
|
|
170
177
|
* @param {string} syncMode - Replication sync mode preference. Allowed values: async, sync, quorum.
|
|
178
|
+
* @param {number} crossRegionReplicas - Number of cross-region standby replicas (0-1). Cross-region replication is enabled when greater than 0.
|
|
179
|
+
* @param {string} standbyRegion - Standby region for the cross-region replica. Required when enabling cross-region replication and no standby region is already configured. Must differ from the database region.
|
|
171
180
|
* @param {number} networkIdleTimeoutSeconds - Connection idle timeout in seconds (60-86400).
|
|
172
181
|
* @param {string[]} networkIPAllowlist - IP addresses/CIDR ranges allowed to connect.
|
|
173
182
|
* @param {number} idleTimeoutMinutes - Minutes before container scales to zero.
|
|
@@ -187,7 +196,7 @@ export declare class Mongo {
|
|
|
187
196
|
* @returns {Promise<Models.DedicatedDatabase>}
|
|
188
197
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
189
198
|
*/
|
|
190
|
-
update(databaseId: string, name?: string, status?: string, specification?: string, replicas?: number, syncMode?: string, networkIdleTimeoutSeconds?: number, networkIPAllowlist?: string[], idleTimeoutMinutes?: number, pitr?: boolean, pitrRetentionDays?: number, storageAutoscaling?: boolean, storageAutoscalingThresholdPercent?: number, storageAutoscalingMaxGb?: number, metricsTraceSampleRate?: number, metricsSlowQueryLogThresholdMs?: number, sqlApiEnabled?: boolean, sqlApiAllowedStatements?: string[], sqlApiMaxRows?: number, sqlApiMaxBytes?: number, sqlApiTimeoutSeconds?: number): Promise<Models.DedicatedDatabase>;
|
|
199
|
+
update(databaseId: string, name?: string, status?: string, specification?: string, replicas?: number, syncMode?: string, crossRegionReplicas?: number, standbyRegion?: string, networkIdleTimeoutSeconds?: number, networkIPAllowlist?: string[], idleTimeoutMinutes?: number, pitr?: boolean, pitrRetentionDays?: number, storageAutoscaling?: boolean, storageAutoscalingThresholdPercent?: number, storageAutoscalingMaxGb?: number, metricsTraceSampleRate?: number, metricsSlowQueryLogThresholdMs?: number, sqlApiEnabled?: boolean, sqlApiAllowedStatements?: string[], sqlApiMaxRows?: number, sqlApiMaxBytes?: number, sqlApiTimeoutSeconds?: number): Promise<Models.DedicatedDatabase>;
|
|
191
200
|
/**
|
|
192
201
|
* 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.
|
|
193
202
|
*
|
|
@@ -31,6 +31,7 @@ export declare class Mysql {
|
|
|
31
31
|
* @param {string} params.specification - Specification identifier. Drives the allocated CPU, memory, storage, storage class, and connection ceiling.
|
|
32
32
|
* @param {number} params.replicas - Number of high availability replicas (0-5). High availability is enabled when greater than 0.
|
|
33
33
|
* @param {string} params.syncMode - Replication sync mode preference. Allowed values: async, sync, quorum.
|
|
34
|
+
* @param {string} params.standbyRegion - Standby region for a cross-region replica. When set, a replica is provisioned in this region for cross-region high availability. Must differ from the database region.
|
|
34
35
|
* @param {number} params.networkIdleTimeoutSeconds - Connection idle timeout in seconds.
|
|
35
36
|
* @param {string[]} params.networkIPAllowlist - IP addresses/CIDR ranges allowed to connect.
|
|
36
37
|
* @param {number} params.idleTimeoutMinutes - Minutes of inactivity before container scales to zero.
|
|
@@ -39,7 +40,7 @@ export declare class Mysql {
|
|
|
39
40
|
* @param {boolean} params.storageAutoscaling - Enable automatic storage expansion when usage exceeds threshold.
|
|
40
41
|
* @param {number} params.storageAutoscalingThresholdPercent - Storage usage percentage (50-95) that triggers automatic expansion.
|
|
41
42
|
* @param {number} params.storageAutoscalingMaxGb - Maximum storage size in GB for autoscaling. 0 means no limit.
|
|
42
|
-
* @param {string} params.api - Product API that owns this database:
|
|
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.
|
|
43
44
|
* @throws {AppwriteException}
|
|
44
45
|
* @returns {Promise<Models.DedicatedDatabase>}
|
|
45
46
|
*/
|
|
@@ -50,6 +51,7 @@ export declare class Mysql {
|
|
|
50
51
|
specification?: string;
|
|
51
52
|
replicas?: number;
|
|
52
53
|
syncMode?: string;
|
|
54
|
+
standbyRegion?: string;
|
|
53
55
|
networkIdleTimeoutSeconds?: number;
|
|
54
56
|
networkIPAllowlist?: string[];
|
|
55
57
|
idleTimeoutMinutes?: number;
|
|
@@ -69,6 +71,7 @@ export declare class Mysql {
|
|
|
69
71
|
* @param {string} specification - Specification identifier. Drives the allocated CPU, memory, storage, storage class, and connection ceiling.
|
|
70
72
|
* @param {number} replicas - Number of high availability replicas (0-5). High availability is enabled when greater than 0.
|
|
71
73
|
* @param {string} syncMode - Replication sync mode preference. Allowed values: async, sync, quorum.
|
|
74
|
+
* @param {string} standbyRegion - Standby region for a cross-region replica. When set, a replica is provisioned in this region for cross-region high availability. Must differ from the database region.
|
|
72
75
|
* @param {number} networkIdleTimeoutSeconds - Connection idle timeout in seconds.
|
|
73
76
|
* @param {string[]} networkIPAllowlist - IP addresses/CIDR ranges allowed to connect.
|
|
74
77
|
* @param {number} idleTimeoutMinutes - Minutes of inactivity before container scales to zero.
|
|
@@ -77,12 +80,12 @@ export declare class Mysql {
|
|
|
77
80
|
* @param {boolean} storageAutoscaling - Enable automatic storage expansion when usage exceeds threshold.
|
|
78
81
|
* @param {number} storageAutoscalingThresholdPercent - Storage usage percentage (50-95) that triggers automatic expansion.
|
|
79
82
|
* @param {number} storageAutoscalingMaxGb - Maximum storage size in GB for autoscaling. 0 means no limit.
|
|
80
|
-
* @param {string} api - Product API that owns this database:
|
|
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.
|
|
81
84
|
* @throws {AppwriteException}
|
|
82
85
|
* @returns {Promise<Models.DedicatedDatabase>}
|
|
83
86
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
84
87
|
*/
|
|
85
|
-
create(databaseId: string, name: string, version?: string, specification?: string, replicas?: number, syncMode?: string, networkIdleTimeoutSeconds?: number, networkIPAllowlist?: string[], idleTimeoutMinutes?: number, pitr?: boolean, pitrRetentionDays?: number, storageAutoscaling?: boolean, storageAutoscalingThresholdPercent?: number, storageAutoscalingMaxGb?: number, api?: string): Promise<Models.DedicatedDatabase>;
|
|
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, api?: string): Promise<Models.DedicatedDatabase>;
|
|
86
89
|
/**
|
|
87
90
|
* 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.
|
|
88
91
|
*
|
|
@@ -118,6 +121,8 @@ export declare class Mysql {
|
|
|
118
121
|
* @param {string} params.specification - Specification. Changes cpu, memory, storage, connection ceiling, and node pool based on specification config. Resource changes are applied via rolling cutover with zero downtime.
|
|
119
122
|
* @param {number} params.replicas - Number of high availability replicas (0-5). High availability is enabled when greater than 0.
|
|
120
123
|
* @param {string} params.syncMode - Replication sync mode preference. Allowed values: async, sync, quorum.
|
|
124
|
+
* @param {number} params.crossRegionReplicas - Number of cross-region standby replicas (0-1). Cross-region replication is enabled when greater than 0.
|
|
125
|
+
* @param {string} params.standbyRegion - Standby region for the cross-region replica. Required when enabling cross-region replication and no standby region is already configured. Must differ from the database region.
|
|
121
126
|
* @param {number} params.networkIdleTimeoutSeconds - Connection idle timeout in seconds (60-86400).
|
|
122
127
|
* @param {string[]} params.networkIPAllowlist - IP addresses/CIDR ranges allowed to connect.
|
|
123
128
|
* @param {number} params.idleTimeoutMinutes - Minutes before container scales to zero.
|
|
@@ -143,6 +148,8 @@ export declare class Mysql {
|
|
|
143
148
|
specification?: string;
|
|
144
149
|
replicas?: number;
|
|
145
150
|
syncMode?: string;
|
|
151
|
+
crossRegionReplicas?: number;
|
|
152
|
+
standbyRegion?: string;
|
|
146
153
|
networkIdleTimeoutSeconds?: number;
|
|
147
154
|
networkIPAllowlist?: string[];
|
|
148
155
|
idleTimeoutMinutes?: number;
|
|
@@ -168,6 +175,8 @@ export declare class Mysql {
|
|
|
168
175
|
* @param {string} specification - Specification. Changes cpu, memory, storage, connection ceiling, and node pool based on specification config. Resource changes are applied via rolling cutover with zero downtime.
|
|
169
176
|
* @param {number} replicas - Number of high availability replicas (0-5). High availability is enabled when greater than 0.
|
|
170
177
|
* @param {string} syncMode - Replication sync mode preference. Allowed values: async, sync, quorum.
|
|
178
|
+
* @param {number} crossRegionReplicas - Number of cross-region standby replicas (0-1). Cross-region replication is enabled when greater than 0.
|
|
179
|
+
* @param {string} standbyRegion - Standby region for the cross-region replica. Required when enabling cross-region replication and no standby region is already configured. Must differ from the database region.
|
|
171
180
|
* @param {number} networkIdleTimeoutSeconds - Connection idle timeout in seconds (60-86400).
|
|
172
181
|
* @param {string[]} networkIPAllowlist - IP addresses/CIDR ranges allowed to connect.
|
|
173
182
|
* @param {number} idleTimeoutMinutes - Minutes before container scales to zero.
|
|
@@ -187,7 +196,7 @@ export declare class Mysql {
|
|
|
187
196
|
* @returns {Promise<Models.DedicatedDatabase>}
|
|
188
197
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
189
198
|
*/
|
|
190
|
-
update(databaseId: string, name?: string, status?: string, specification?: string, replicas?: number, syncMode?: string, networkIdleTimeoutSeconds?: number, networkIPAllowlist?: string[], idleTimeoutMinutes?: number, pitr?: boolean, pitrRetentionDays?: number, storageAutoscaling?: boolean, storageAutoscalingThresholdPercent?: number, storageAutoscalingMaxGb?: number, metricsTraceSampleRate?: number, metricsSlowQueryLogThresholdMs?: number, sqlApiEnabled?: boolean, sqlApiAllowedStatements?: string[], sqlApiMaxRows?: number, sqlApiMaxBytes?: number, sqlApiTimeoutSeconds?: number): Promise<Models.DedicatedDatabase>;
|
|
199
|
+
update(databaseId: string, name?: string, status?: string, specification?: string, replicas?: number, syncMode?: string, crossRegionReplicas?: number, standbyRegion?: string, networkIdleTimeoutSeconds?: number, networkIPAllowlist?: string[], idleTimeoutMinutes?: number, pitr?: boolean, pitrRetentionDays?: number, storageAutoscaling?: boolean, storageAutoscalingThresholdPercent?: number, storageAutoscalingMaxGb?: number, metricsTraceSampleRate?: number, metricsSlowQueryLogThresholdMs?: number, sqlApiEnabled?: boolean, sqlApiAllowedStatements?: string[], sqlApiMaxRows?: number, sqlApiMaxBytes?: number, sqlApiTimeoutSeconds?: number): Promise<Models.DedicatedDatabase>;
|
|
191
200
|
/**
|
|
192
201
|
* 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.
|
|
193
202
|
*
|