appbuild-oceanbase-console 1.12.2 → 1.13.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/dist/cjs/package.json +3 -0
- package/dist/cjs/sdk.js +3837 -1017
- package/dist/cjs/sdk.js.map +1 -1
- package/dist/esm/package.json +3 -0
- package/dist/esm/sdk.js +3831 -1018
- package/dist/esm/sdk.js.map +1 -1
- package/dist/iife/sdk.js +10131 -3554
- package/package.json +7 -2
- package/types/channel.d.ts +74 -0
- package/types/client.d.ts +84 -16
- package/types/enums/appwrite-migration-resource.d.ts +25 -0
- package/types/enums/backup-services.d.ts +5 -0
- package/types/enums/billing-plan-group.d.ts +5 -0
- package/types/enums/browser-permission.d.ts +22 -0
- package/types/enums/domain-purchase-status.d.ts +6 -0
- package/types/enums/domain-transfer-status-enum.d.ts +10 -0
- package/types/enums/filter-type.d.ts +4 -0
- package/types/enums/firebase-migration-resource.d.ts +12 -0
- package/types/enums/frameworks.d.ts +17 -0
- package/types/enums/n-host-migration-resource.d.ts +13 -0
- package/types/enums/order-by.d.ts +4 -0
- package/types/enums/registration-type.d.ts +6 -0
- package/types/enums/resource-type.d.ts +6 -0
- package/types/enums/runtimes.d.ts +180 -0
- package/types/enums/scopes.d.ts +70 -0
- package/types/enums/supabase-migration-resource.d.ts +13 -0
- package/types/enums/template-reference-type.d.ts +5 -0
- package/types/enums/use-cases.d.ts +11 -0
- package/types/enums/vcs-reference-type.d.ts +5 -0
- package/types/index.d.ts +119 -96
- package/types/migrations.d.ts +10 -9
- package/types/models.d.ts +1270 -136
- package/types/query.d.ts +60 -8
- package/types/services/account.d.ts +162 -39
- package/types/services/activities.d.ts +46 -0
- package/types/services/avatars.d.ts +9 -8
- package/types/services/backups.d.ts +13 -12
- package/types/services/console.d.ts +41 -3
- package/types/services/databases.d.ts +384 -68
- package/types/services/domains.d.ts +223 -0
- package/types/services/functions.d.ts +46 -31
- package/types/services/health.d.ts +49 -6
- package/types/services/messaging.d.ts +2 -2
- package/types/services/organizations.d.ts +203 -36
- package/types/services/projects.d.ts +151 -210
- package/types/services/realtime.d.ts +26 -10
- package/types/services/sites.d.ts +49 -29
- package/types/services/storage.d.ts +12 -12
- package/types/services/tables-db.d.ts +352 -34
- package/types/services/teams.d.ts +4 -4
- package/types/services/users.d.ts +26 -2
- package/types/services/vcs.d.ts +4 -1
- package/types/services/webhooks.d.ts +165 -0
|
@@ -4,6 +4,7 @@ import { UsageRange } from '../enums/usage-range';
|
|
|
4
4
|
import { RelationshipType } from '../enums/relationship-type';
|
|
5
5
|
import { RelationMutate } from '../enums/relation-mutate';
|
|
6
6
|
import { IndexType } from '../enums/index-type';
|
|
7
|
+
import { OrderBy } from '../enums/order-by';
|
|
7
8
|
export declare class Databases {
|
|
8
9
|
client: Client;
|
|
9
10
|
constructor(client: Client);
|
|
@@ -236,7 +237,7 @@ export declare class Databases {
|
|
|
236
237
|
*/
|
|
237
238
|
update(params: {
|
|
238
239
|
databaseId: string;
|
|
239
|
-
name
|
|
240
|
+
name?: string;
|
|
240
241
|
enabled?: boolean;
|
|
241
242
|
}): Promise<Models.Database>;
|
|
242
243
|
/**
|
|
@@ -249,7 +250,7 @@ export declare class Databases {
|
|
|
249
250
|
* @returns {Promise<Models.Database>}
|
|
250
251
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
251
252
|
*/
|
|
252
|
-
update(databaseId: string, name
|
|
253
|
+
update(databaseId: string, name?: string, enabled?: boolean): Promise<Models.Database>;
|
|
253
254
|
/**
|
|
254
255
|
* Delete a database by its unique ID. Only API keys with with databases.write scope can delete a database.
|
|
255
256
|
*
|
|
@@ -308,6 +309,8 @@ export declare class Databases {
|
|
|
308
309
|
* @param {string[]} params.permissions - An array of permissions strings. By default, no user is granted with any permissions. [Learn more about permissions](https://appwrite.io/docs/permissions).
|
|
309
310
|
* @param {boolean} params.documentSecurity - Enables configuring permissions for individual documents. A user needs one of document or collection level permissions to access a document. [Learn more about permissions](https://appwrite.io/docs/permissions).
|
|
310
311
|
* @param {boolean} params.enabled - Is collection enabled? When set to 'disabled', users cannot access the collection but Server SDKs with and API key can still read and write to the collection. No data is lost when this is toggled.
|
|
312
|
+
* @param {object[]} params.attributes - Array of attribute definitions to create. Each attribute should contain: key (string), type (string: string, integer, float, boolean, datetime), size (integer, required for string type), required (boolean, optional), default (mixed, optional), array (boolean, optional), and type-specific options.
|
|
313
|
+
* @param {object[]} params.indexes - Array of index definitions to create. Each index should contain: key (string), type (string: key, fulltext, unique, spatial), attributes (array of attribute keys), orders (array of ASC/DESC, optional), and lengths (array of integers, optional).
|
|
311
314
|
* @throws {AppwriteException}
|
|
312
315
|
* @returns {Promise<Models.Collection>}
|
|
313
316
|
* @deprecated This API has been deprecated since 1.8.0. Please use `TablesDB.createTable` instead.
|
|
@@ -319,6 +322,8 @@ export declare class Databases {
|
|
|
319
322
|
permissions?: string[];
|
|
320
323
|
documentSecurity?: boolean;
|
|
321
324
|
enabled?: boolean;
|
|
325
|
+
attributes?: object[];
|
|
326
|
+
indexes?: object[];
|
|
322
327
|
}): Promise<Models.Collection>;
|
|
323
328
|
/**
|
|
324
329
|
* Create a new Collection. Before using this route, you should create a new database resource using either a [server integration](https://appwrite.io/docs/server/databases#databasesCreateCollection) API or directly from your database console.
|
|
@@ -329,11 +334,13 @@ export declare class Databases {
|
|
|
329
334
|
* @param {string[]} permissions - An array of permissions strings. By default, no user is granted with any permissions. [Learn more about permissions](https://appwrite.io/docs/permissions).
|
|
330
335
|
* @param {boolean} documentSecurity - Enables configuring permissions for individual documents. A user needs one of document or collection level permissions to access a document. [Learn more about permissions](https://appwrite.io/docs/permissions).
|
|
331
336
|
* @param {boolean} enabled - Is collection enabled? When set to 'disabled', users cannot access the collection but Server SDKs with and API key can still read and write to the collection. No data is lost when this is toggled.
|
|
337
|
+
* @param {object[]} attributes - Array of attribute definitions to create. Each attribute should contain: key (string), type (string: string, integer, float, boolean, datetime), size (integer, required for string type), required (boolean, optional), default (mixed, optional), array (boolean, optional), and type-specific options.
|
|
338
|
+
* @param {object[]} indexes - Array of index definitions to create. Each index should contain: key (string), type (string: key, fulltext, unique, spatial), attributes (array of attribute keys), orders (array of ASC/DESC, optional), and lengths (array of integers, optional).
|
|
332
339
|
* @throws {AppwriteException}
|
|
333
340
|
* @returns {Promise<Models.Collection>}
|
|
334
341
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
335
342
|
*/
|
|
336
|
-
createCollection(databaseId: string, collectionId: string, name: string, permissions?: string[], documentSecurity?: boolean, enabled?: boolean): Promise<Models.Collection>;
|
|
343
|
+
createCollection(databaseId: string, collectionId: string, name: string, permissions?: string[], documentSecurity?: boolean, enabled?: boolean, attributes?: object[], indexes?: object[]): Promise<Models.Collection>;
|
|
337
344
|
/**
|
|
338
345
|
* Get a collection by its unique ID. This endpoint response returns a JSON object with the collection metadata.
|
|
339
346
|
*
|
|
@@ -373,7 +380,7 @@ export declare class Databases {
|
|
|
373
380
|
updateCollection(params: {
|
|
374
381
|
databaseId: string;
|
|
375
382
|
collectionId: string;
|
|
376
|
-
name
|
|
383
|
+
name?: string;
|
|
377
384
|
permissions?: string[];
|
|
378
385
|
documentSecurity?: boolean;
|
|
379
386
|
enabled?: boolean;
|
|
@@ -391,7 +398,7 @@ export declare class Databases {
|
|
|
391
398
|
* @returns {Promise<Models.Collection>}
|
|
392
399
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
393
400
|
*/
|
|
394
|
-
updateCollection(databaseId: string, collectionId: string, name
|
|
401
|
+
updateCollection(databaseId: string, collectionId: string, name?: string, permissions?: string[], documentSecurity?: boolean, enabled?: boolean): Promise<Models.Collection>;
|
|
395
402
|
/**
|
|
396
403
|
* Delete a collection by its unique ID. Only users with write permissions have access to delete this resource.
|
|
397
404
|
*
|
|
@@ -449,7 +456,7 @@ export declare class Databases {
|
|
|
449
456
|
*
|
|
450
457
|
*
|
|
451
458
|
* @param {string} params.databaseId - Database ID.
|
|
452
|
-
* @param {string} params.collectionId - Collection ID. You can create a new
|
|
459
|
+
* @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).
|
|
453
460
|
* @param {string} params.key - Attribute Key.
|
|
454
461
|
* @param {boolean} params.required - Is attribute required?
|
|
455
462
|
* @param {boolean} params.xdefault - Default value for attribute when not provided. Cannot be set when attribute is required.
|
|
@@ -471,7 +478,7 @@ export declare class Databases {
|
|
|
471
478
|
*
|
|
472
479
|
*
|
|
473
480
|
* @param {string} databaseId - Database ID.
|
|
474
|
-
* @param {string} collectionId - Collection ID. You can create a new
|
|
481
|
+
* @param {string} collectionId - Collection ID. You can create a new collection using the Database service [server integration](https://appwrite.io/docs/server/databases#databasesCreateCollection).
|
|
475
482
|
* @param {string} key - Attribute Key.
|
|
476
483
|
* @param {boolean} required - Is attribute required?
|
|
477
484
|
* @param {boolean} xdefault - Default value for attribute when not provided. Cannot be set when attribute is required.
|
|
@@ -834,9 +841,9 @@ export declare class Databases {
|
|
|
834
841
|
* @param {string} params.collectionId - Collection ID.
|
|
835
842
|
* @param {string} params.key - Attribute Key.
|
|
836
843
|
* @param {boolean} params.required - Is attribute required?
|
|
837
|
-
* @param {number} params.min - Minimum value
|
|
838
|
-
* @param {number} params.max - Maximum value
|
|
839
|
-
* @param {number} params.xdefault - Default value. Cannot be set when attribute is required.
|
|
844
|
+
* @param {number | bigint} params.min - Minimum value
|
|
845
|
+
* @param {number | bigint} params.max - Maximum value
|
|
846
|
+
* @param {number | bigint} params.xdefault - Default value. Cannot be set when attribute is required.
|
|
840
847
|
* @param {boolean} params.array - Is attribute an array?
|
|
841
848
|
* @throws {AppwriteException}
|
|
842
849
|
* @returns {Promise<Models.AttributeInteger>}
|
|
@@ -847,9 +854,9 @@ export declare class Databases {
|
|
|
847
854
|
collectionId: string;
|
|
848
855
|
key: string;
|
|
849
856
|
required: boolean;
|
|
850
|
-
min?: number;
|
|
851
|
-
max?: number;
|
|
852
|
-
xdefault?: number;
|
|
857
|
+
min?: number | bigint;
|
|
858
|
+
max?: number | bigint;
|
|
859
|
+
xdefault?: number | bigint;
|
|
853
860
|
array?: boolean;
|
|
854
861
|
}): Promise<Models.AttributeInteger>;
|
|
855
862
|
/**
|
|
@@ -860,15 +867,15 @@ export declare class Databases {
|
|
|
860
867
|
* @param {string} collectionId - Collection ID.
|
|
861
868
|
* @param {string} key - Attribute Key.
|
|
862
869
|
* @param {boolean} required - Is attribute required?
|
|
863
|
-
* @param {number} min - Minimum value
|
|
864
|
-
* @param {number} max - Maximum value
|
|
865
|
-
* @param {number} xdefault - Default value. Cannot be set when attribute is required.
|
|
870
|
+
* @param {number | bigint} min - Minimum value
|
|
871
|
+
* @param {number | bigint} max - Maximum value
|
|
872
|
+
* @param {number | bigint} xdefault - Default value. Cannot be set when attribute is required.
|
|
866
873
|
* @param {boolean} array - Is attribute an array?
|
|
867
874
|
* @throws {AppwriteException}
|
|
868
875
|
* @returns {Promise<Models.AttributeInteger>}
|
|
869
876
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
870
877
|
*/
|
|
871
|
-
createIntegerAttribute(databaseId: string, collectionId: string, key: string, required: boolean, min?: number, max?: number, xdefault?: number, array?: boolean): Promise<Models.AttributeInteger>;
|
|
878
|
+
createIntegerAttribute(databaseId: string, collectionId: string, key: string, required: boolean, min?: number | bigint, max?: number | bigint, xdefault?: number | bigint, array?: boolean): Promise<Models.AttributeInteger>;
|
|
872
879
|
/**
|
|
873
880
|
* Update an integer attribute. Changing the `default` value will not update already existing documents.
|
|
874
881
|
*
|
|
@@ -877,9 +884,9 @@ export declare class Databases {
|
|
|
877
884
|
* @param {string} params.collectionId - Collection ID.
|
|
878
885
|
* @param {string} params.key - Attribute Key.
|
|
879
886
|
* @param {boolean} params.required - Is attribute required?
|
|
880
|
-
* @param {number} params.xdefault - Default value. Cannot be set when attribute is required.
|
|
881
|
-
* @param {number} params.min - Minimum value
|
|
882
|
-
* @param {number} params.max - Maximum value
|
|
887
|
+
* @param {number | bigint} params.xdefault - Default value. Cannot be set when attribute is required.
|
|
888
|
+
* @param {number | bigint} params.min - Minimum value
|
|
889
|
+
* @param {number | bigint} params.max - Maximum value
|
|
883
890
|
* @param {string} params.newKey - New Attribute Key.
|
|
884
891
|
* @throws {AppwriteException}
|
|
885
892
|
* @returns {Promise<Models.AttributeInteger>}
|
|
@@ -890,9 +897,9 @@ export declare class Databases {
|
|
|
890
897
|
collectionId: string;
|
|
891
898
|
key: string;
|
|
892
899
|
required: boolean;
|
|
893
|
-
xdefault?: number;
|
|
894
|
-
min?: number;
|
|
895
|
-
max?: number;
|
|
900
|
+
xdefault?: number | bigint;
|
|
901
|
+
min?: number | bigint;
|
|
902
|
+
max?: number | bigint;
|
|
896
903
|
newKey?: string;
|
|
897
904
|
}): Promise<Models.AttributeInteger>;
|
|
898
905
|
/**
|
|
@@ -903,15 +910,15 @@ export declare class Databases {
|
|
|
903
910
|
* @param {string} collectionId - Collection ID.
|
|
904
911
|
* @param {string} key - Attribute Key.
|
|
905
912
|
* @param {boolean} required - Is attribute required?
|
|
906
|
-
* @param {number} xdefault - Default value. Cannot be set when attribute is required.
|
|
907
|
-
* @param {number} min - Minimum value
|
|
908
|
-
* @param {number} max - Maximum value
|
|
913
|
+
* @param {number | bigint} xdefault - Default value. Cannot be set when attribute is required.
|
|
914
|
+
* @param {number | bigint} min - Minimum value
|
|
915
|
+
* @param {number | bigint} max - Maximum value
|
|
909
916
|
* @param {string} newKey - New Attribute Key.
|
|
910
917
|
* @throws {AppwriteException}
|
|
911
918
|
* @returns {Promise<Models.AttributeInteger>}
|
|
912
919
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
913
920
|
*/
|
|
914
|
-
updateIntegerAttribute(databaseId: string, collectionId: string, key: string, required: boolean, xdefault?: number, min?: number, max?: number, newKey?: string): Promise<Models.AttributeInteger>;
|
|
921
|
+
updateIntegerAttribute(databaseId: string, collectionId: string, key: string, required: boolean, xdefault?: number | bigint, min?: number | bigint, max?: number | bigint, newKey?: string): Promise<Models.AttributeInteger>;
|
|
915
922
|
/**
|
|
916
923
|
* Create IP address attribute.
|
|
917
924
|
*
|
|
@@ -1053,6 +1060,156 @@ export declare class Databases {
|
|
|
1053
1060
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1054
1061
|
*/
|
|
1055
1062
|
updateLineAttribute(databaseId: string, collectionId: string, key: string, required: boolean, xdefault?: any[], newKey?: string): Promise<Models.AttributeLine>;
|
|
1063
|
+
/**
|
|
1064
|
+
* Create a longtext attribute.
|
|
1065
|
+
*
|
|
1066
|
+
*
|
|
1067
|
+
* @param {string} params.databaseId - Database ID.
|
|
1068
|
+
* @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).
|
|
1069
|
+
* @param {string} params.key - Attribute Key.
|
|
1070
|
+
* @param {boolean} params.required - Is attribute required?
|
|
1071
|
+
* @param {string} params.xdefault - Default value for attribute when not provided. Cannot be set when attribute is required.
|
|
1072
|
+
* @param {boolean} params.array - Is attribute an array?
|
|
1073
|
+
* @param {boolean} params.encrypt - Toggle encryption for the attribute. Encryption enhances security by not storing any plain text values in the database. However, encrypted attributes cannot be queried.
|
|
1074
|
+
* @throws {AppwriteException}
|
|
1075
|
+
* @returns {Promise<Models.AttributeLongtext>}
|
|
1076
|
+
*/
|
|
1077
|
+
createLongtextAttribute(params: {
|
|
1078
|
+
databaseId: string;
|
|
1079
|
+
collectionId: string;
|
|
1080
|
+
key: string;
|
|
1081
|
+
required: boolean;
|
|
1082
|
+
xdefault?: string;
|
|
1083
|
+
array?: boolean;
|
|
1084
|
+
encrypt?: boolean;
|
|
1085
|
+
}): Promise<Models.AttributeLongtext>;
|
|
1086
|
+
/**
|
|
1087
|
+
* Create a longtext attribute.
|
|
1088
|
+
*
|
|
1089
|
+
*
|
|
1090
|
+
* @param {string} databaseId - Database ID.
|
|
1091
|
+
* @param {string} collectionId - Collection ID. You can create a new collection using the Database service [server integration](https://appwrite.io/docs/server/databases#databasesCreateCollection).
|
|
1092
|
+
* @param {string} key - Attribute Key.
|
|
1093
|
+
* @param {boolean} required - Is attribute required?
|
|
1094
|
+
* @param {string} xdefault - Default value for attribute when not provided. Cannot be set when attribute is required.
|
|
1095
|
+
* @param {boolean} array - Is attribute an array?
|
|
1096
|
+
* @param {boolean} encrypt - Toggle encryption for the attribute. Encryption enhances security by not storing any plain text values in the database. However, encrypted attributes cannot be queried.
|
|
1097
|
+
* @throws {AppwriteException}
|
|
1098
|
+
* @returns {Promise<Models.AttributeLongtext>}
|
|
1099
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1100
|
+
*/
|
|
1101
|
+
createLongtextAttribute(databaseId: string, collectionId: string, key: string, required: boolean, xdefault?: string, array?: boolean, encrypt?: boolean): Promise<Models.AttributeLongtext>;
|
|
1102
|
+
/**
|
|
1103
|
+
* Update a longtext attribute. Changing the `default` value will not update already existing documents.
|
|
1104
|
+
*
|
|
1105
|
+
*
|
|
1106
|
+
* @param {string} params.databaseId - Database ID.
|
|
1107
|
+
* @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).
|
|
1108
|
+
* @param {string} params.key - Attribute Key.
|
|
1109
|
+
* @param {boolean} params.required - Is attribute required?
|
|
1110
|
+
* @param {string} params.xdefault - Default value for attribute when not provided. Cannot be set when attribute is required.
|
|
1111
|
+
* @param {string} params.newKey - New Attribute Key.
|
|
1112
|
+
* @throws {AppwriteException}
|
|
1113
|
+
* @returns {Promise<Models.AttributeLongtext>}
|
|
1114
|
+
*/
|
|
1115
|
+
updateLongtextAttribute(params: {
|
|
1116
|
+
databaseId: string;
|
|
1117
|
+
collectionId: string;
|
|
1118
|
+
key: string;
|
|
1119
|
+
required: boolean;
|
|
1120
|
+
xdefault?: string;
|
|
1121
|
+
newKey?: string;
|
|
1122
|
+
}): Promise<Models.AttributeLongtext>;
|
|
1123
|
+
/**
|
|
1124
|
+
* Update a longtext attribute. Changing the `default` value will not update already existing documents.
|
|
1125
|
+
*
|
|
1126
|
+
*
|
|
1127
|
+
* @param {string} databaseId - Database ID.
|
|
1128
|
+
* @param {string} collectionId - Collection ID. You can create a new collection using the Database service [server integration](https://appwrite.io/docs/server/databases#databasesCreateCollection).
|
|
1129
|
+
* @param {string} key - Attribute Key.
|
|
1130
|
+
* @param {boolean} required - Is attribute required?
|
|
1131
|
+
* @param {string} xdefault - Default value for attribute when not provided. Cannot be set when attribute is required.
|
|
1132
|
+
* @param {string} newKey - New Attribute Key.
|
|
1133
|
+
* @throws {AppwriteException}
|
|
1134
|
+
* @returns {Promise<Models.AttributeLongtext>}
|
|
1135
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1136
|
+
*/
|
|
1137
|
+
updateLongtextAttribute(databaseId: string, collectionId: string, key: string, required: boolean, xdefault?: string, newKey?: string): Promise<Models.AttributeLongtext>;
|
|
1138
|
+
/**
|
|
1139
|
+
* Create a mediumtext attribute.
|
|
1140
|
+
*
|
|
1141
|
+
*
|
|
1142
|
+
* @param {string} params.databaseId - Database ID.
|
|
1143
|
+
* @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).
|
|
1144
|
+
* @param {string} params.key - Attribute Key.
|
|
1145
|
+
* @param {boolean} params.required - Is attribute required?
|
|
1146
|
+
* @param {string} params.xdefault - Default value for attribute when not provided. Cannot be set when attribute is required.
|
|
1147
|
+
* @param {boolean} params.array - Is attribute an array?
|
|
1148
|
+
* @param {boolean} params.encrypt - Toggle encryption for the attribute. Encryption enhances security by not storing any plain text values in the database. However, encrypted attributes cannot be queried.
|
|
1149
|
+
* @throws {AppwriteException}
|
|
1150
|
+
* @returns {Promise<Models.AttributeMediumtext>}
|
|
1151
|
+
*/
|
|
1152
|
+
createMediumtextAttribute(params: {
|
|
1153
|
+
databaseId: string;
|
|
1154
|
+
collectionId: string;
|
|
1155
|
+
key: string;
|
|
1156
|
+
required: boolean;
|
|
1157
|
+
xdefault?: string;
|
|
1158
|
+
array?: boolean;
|
|
1159
|
+
encrypt?: boolean;
|
|
1160
|
+
}): Promise<Models.AttributeMediumtext>;
|
|
1161
|
+
/**
|
|
1162
|
+
* Create a mediumtext attribute.
|
|
1163
|
+
*
|
|
1164
|
+
*
|
|
1165
|
+
* @param {string} databaseId - Database ID.
|
|
1166
|
+
* @param {string} collectionId - Collection ID. You can create a new collection using the Database service [server integration](https://appwrite.io/docs/server/databases#databasesCreateCollection).
|
|
1167
|
+
* @param {string} key - Attribute Key.
|
|
1168
|
+
* @param {boolean} required - Is attribute required?
|
|
1169
|
+
* @param {string} xdefault - Default value for attribute when not provided. Cannot be set when attribute is required.
|
|
1170
|
+
* @param {boolean} array - Is attribute an array?
|
|
1171
|
+
* @param {boolean} encrypt - Toggle encryption for the attribute. Encryption enhances security by not storing any plain text values in the database. However, encrypted attributes cannot be queried.
|
|
1172
|
+
* @throws {AppwriteException}
|
|
1173
|
+
* @returns {Promise<Models.AttributeMediumtext>}
|
|
1174
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1175
|
+
*/
|
|
1176
|
+
createMediumtextAttribute(databaseId: string, collectionId: string, key: string, required: boolean, xdefault?: string, array?: boolean, encrypt?: boolean): Promise<Models.AttributeMediumtext>;
|
|
1177
|
+
/**
|
|
1178
|
+
* Update a mediumtext attribute. Changing the `default` value will not update already existing documents.
|
|
1179
|
+
*
|
|
1180
|
+
*
|
|
1181
|
+
* @param {string} params.databaseId - Database ID.
|
|
1182
|
+
* @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).
|
|
1183
|
+
* @param {string} params.key - Attribute Key.
|
|
1184
|
+
* @param {boolean} params.required - Is attribute required?
|
|
1185
|
+
* @param {string} params.xdefault - Default value for attribute when not provided. Cannot be set when attribute is required.
|
|
1186
|
+
* @param {string} params.newKey - New Attribute Key.
|
|
1187
|
+
* @throws {AppwriteException}
|
|
1188
|
+
* @returns {Promise<Models.AttributeMediumtext>}
|
|
1189
|
+
*/
|
|
1190
|
+
updateMediumtextAttribute(params: {
|
|
1191
|
+
databaseId: string;
|
|
1192
|
+
collectionId: string;
|
|
1193
|
+
key: string;
|
|
1194
|
+
required: boolean;
|
|
1195
|
+
xdefault?: string;
|
|
1196
|
+
newKey?: string;
|
|
1197
|
+
}): Promise<Models.AttributeMediumtext>;
|
|
1198
|
+
/**
|
|
1199
|
+
* Update a mediumtext attribute. Changing the `default` value will not update already existing documents.
|
|
1200
|
+
*
|
|
1201
|
+
*
|
|
1202
|
+
* @param {string} databaseId - Database ID.
|
|
1203
|
+
* @param {string} collectionId - Collection ID. You can create a new collection using the Database service [server integration](https://appwrite.io/docs/server/databases#databasesCreateCollection).
|
|
1204
|
+
* @param {string} key - Attribute Key.
|
|
1205
|
+
* @param {boolean} required - Is attribute required?
|
|
1206
|
+
* @param {string} xdefault - Default value for attribute when not provided. Cannot be set when attribute is required.
|
|
1207
|
+
* @param {string} newKey - New Attribute Key.
|
|
1208
|
+
* @throws {AppwriteException}
|
|
1209
|
+
* @returns {Promise<Models.AttributeMediumtext>}
|
|
1210
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1211
|
+
*/
|
|
1212
|
+
updateMediumtextAttribute(databaseId: string, collectionId: string, key: string, required: boolean, xdefault?: string, newKey?: string): Promise<Models.AttributeMediumtext>;
|
|
1056
1213
|
/**
|
|
1057
1214
|
* Create a geometric point attribute.
|
|
1058
1215
|
*
|
|
@@ -1230,6 +1387,40 @@ export declare class Databases {
|
|
|
1230
1387
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1231
1388
|
*/
|
|
1232
1389
|
createRelationshipAttribute(databaseId: string, collectionId: string, relatedCollectionId: string, type: RelationshipType, twoWay?: boolean, key?: string, twoWayKey?: string, onDelete?: RelationMutate): Promise<Models.AttributeRelationship>;
|
|
1390
|
+
/**
|
|
1391
|
+
* Update relationship attribute. [Learn more about relationship attributes](https://appwrite.io/docs/databases-relationships#relationship-attributes).
|
|
1392
|
+
*
|
|
1393
|
+
*
|
|
1394
|
+
* @param {string} params.databaseId - Database ID.
|
|
1395
|
+
* @param {string} params.collectionId - Collection ID.
|
|
1396
|
+
* @param {string} params.key - Attribute Key.
|
|
1397
|
+
* @param {RelationMutate} params.onDelete - Constraints option
|
|
1398
|
+
* @param {string} params.newKey - New Attribute Key.
|
|
1399
|
+
* @throws {AppwriteException}
|
|
1400
|
+
* @returns {Promise<Models.AttributeRelationship>}
|
|
1401
|
+
* @deprecated This API has been deprecated since 1.8.0. Please use `TablesDB.updateRelationshipColumn` instead.
|
|
1402
|
+
*/
|
|
1403
|
+
updateRelationshipAttribute(params: {
|
|
1404
|
+
databaseId: string;
|
|
1405
|
+
collectionId: string;
|
|
1406
|
+
key: string;
|
|
1407
|
+
onDelete?: RelationMutate;
|
|
1408
|
+
newKey?: string;
|
|
1409
|
+
}): Promise<Models.AttributeRelationship>;
|
|
1410
|
+
/**
|
|
1411
|
+
* Update relationship attribute. [Learn more about relationship attributes](https://appwrite.io/docs/databases-relationships#relationship-attributes).
|
|
1412
|
+
*
|
|
1413
|
+
*
|
|
1414
|
+
* @param {string} databaseId - Database ID.
|
|
1415
|
+
* @param {string} collectionId - Collection ID.
|
|
1416
|
+
* @param {string} key - Attribute Key.
|
|
1417
|
+
* @param {RelationMutate} onDelete - Constraints option
|
|
1418
|
+
* @param {string} newKey - New Attribute Key.
|
|
1419
|
+
* @throws {AppwriteException}
|
|
1420
|
+
* @returns {Promise<Models.AttributeRelationship>}
|
|
1421
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1422
|
+
*/
|
|
1423
|
+
updateRelationshipAttribute(databaseId: string, collectionId: string, key: string, onDelete?: RelationMutate, newKey?: string): Promise<Models.AttributeRelationship>;
|
|
1233
1424
|
/**
|
|
1234
1425
|
* Create a string attribute.
|
|
1235
1426
|
*
|
|
@@ -1313,6 +1504,81 @@ export declare class Databases {
|
|
|
1313
1504
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1314
1505
|
*/
|
|
1315
1506
|
updateStringAttribute(databaseId: string, collectionId: string, key: string, required: boolean, xdefault?: string, size?: number, newKey?: string): Promise<Models.AttributeString>;
|
|
1507
|
+
/**
|
|
1508
|
+
* Create a text attribute.
|
|
1509
|
+
*
|
|
1510
|
+
*
|
|
1511
|
+
* @param {string} params.databaseId - Database ID.
|
|
1512
|
+
* @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).
|
|
1513
|
+
* @param {string} params.key - Attribute Key.
|
|
1514
|
+
* @param {boolean} params.required - Is attribute required?
|
|
1515
|
+
* @param {string} params.xdefault - Default value for attribute when not provided. Cannot be set when attribute is required.
|
|
1516
|
+
* @param {boolean} params.array - Is attribute an array?
|
|
1517
|
+
* @param {boolean} params.encrypt - Toggle encryption for the attribute. Encryption enhances security by not storing any plain text values in the database. However, encrypted attributes cannot be queried.
|
|
1518
|
+
* @throws {AppwriteException}
|
|
1519
|
+
* @returns {Promise<Models.AttributeText>}
|
|
1520
|
+
*/
|
|
1521
|
+
createTextAttribute(params: {
|
|
1522
|
+
databaseId: string;
|
|
1523
|
+
collectionId: string;
|
|
1524
|
+
key: string;
|
|
1525
|
+
required: boolean;
|
|
1526
|
+
xdefault?: string;
|
|
1527
|
+
array?: boolean;
|
|
1528
|
+
encrypt?: boolean;
|
|
1529
|
+
}): Promise<Models.AttributeText>;
|
|
1530
|
+
/**
|
|
1531
|
+
* Create a text attribute.
|
|
1532
|
+
*
|
|
1533
|
+
*
|
|
1534
|
+
* @param {string} databaseId - Database ID.
|
|
1535
|
+
* @param {string} collectionId - Collection ID. You can create a new collection using the Database service [server integration](https://appwrite.io/docs/server/databases#databasesCreateCollection).
|
|
1536
|
+
* @param {string} key - Attribute Key.
|
|
1537
|
+
* @param {boolean} required - Is attribute required?
|
|
1538
|
+
* @param {string} xdefault - Default value for attribute when not provided. Cannot be set when attribute is required.
|
|
1539
|
+
* @param {boolean} array - Is attribute an array?
|
|
1540
|
+
* @param {boolean} encrypt - Toggle encryption for the attribute. Encryption enhances security by not storing any plain text values in the database. However, encrypted attributes cannot be queried.
|
|
1541
|
+
* @throws {AppwriteException}
|
|
1542
|
+
* @returns {Promise<Models.AttributeText>}
|
|
1543
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1544
|
+
*/
|
|
1545
|
+
createTextAttribute(databaseId: string, collectionId: string, key: string, required: boolean, xdefault?: string, array?: boolean, encrypt?: boolean): Promise<Models.AttributeText>;
|
|
1546
|
+
/**
|
|
1547
|
+
* Update a text attribute. Changing the `default` value will not update already existing documents.
|
|
1548
|
+
*
|
|
1549
|
+
*
|
|
1550
|
+
* @param {string} params.databaseId - Database ID.
|
|
1551
|
+
* @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).
|
|
1552
|
+
* @param {string} params.key - Attribute Key.
|
|
1553
|
+
* @param {boolean} params.required - Is attribute required?
|
|
1554
|
+
* @param {string} params.xdefault - Default value for attribute when not provided. Cannot be set when attribute is required.
|
|
1555
|
+
* @param {string} params.newKey - New Attribute Key.
|
|
1556
|
+
* @throws {AppwriteException}
|
|
1557
|
+
* @returns {Promise<Models.AttributeText>}
|
|
1558
|
+
*/
|
|
1559
|
+
updateTextAttribute(params: {
|
|
1560
|
+
databaseId: string;
|
|
1561
|
+
collectionId: string;
|
|
1562
|
+
key: string;
|
|
1563
|
+
required: boolean;
|
|
1564
|
+
xdefault?: string;
|
|
1565
|
+
newKey?: string;
|
|
1566
|
+
}): Promise<Models.AttributeText>;
|
|
1567
|
+
/**
|
|
1568
|
+
* Update a text attribute. Changing the `default` value will not update already existing documents.
|
|
1569
|
+
*
|
|
1570
|
+
*
|
|
1571
|
+
* @param {string} databaseId - Database ID.
|
|
1572
|
+
* @param {string} collectionId - Collection ID. You can create a new collection using the Database service [server integration](https://appwrite.io/docs/server/databases#databasesCreateCollection).
|
|
1573
|
+
* @param {string} key - Attribute Key.
|
|
1574
|
+
* @param {boolean} required - Is attribute required?
|
|
1575
|
+
* @param {string} xdefault - Default value for attribute when not provided. Cannot be set when attribute is required.
|
|
1576
|
+
* @param {string} newKey - New Attribute Key.
|
|
1577
|
+
* @throws {AppwriteException}
|
|
1578
|
+
* @returns {Promise<Models.AttributeText>}
|
|
1579
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1580
|
+
*/
|
|
1581
|
+
updateTextAttribute(databaseId: string, collectionId: string, key: string, required: boolean, xdefault?: string, newKey?: string): Promise<Models.AttributeText>;
|
|
1316
1582
|
/**
|
|
1317
1583
|
* Create a URL attribute.
|
|
1318
1584
|
*
|
|
@@ -1388,91 +1654,138 @@ export declare class Databases {
|
|
|
1388
1654
|
*/
|
|
1389
1655
|
updateUrlAttribute(databaseId: string, collectionId: string, key: string, required: boolean, xdefault?: string, newKey?: string): Promise<Models.AttributeUrl>;
|
|
1390
1656
|
/**
|
|
1391
|
-
*
|
|
1657
|
+
* Create a varchar attribute.
|
|
1658
|
+
*
|
|
1392
1659
|
*
|
|
1393
1660
|
* @param {string} params.databaseId - Database ID.
|
|
1394
|
-
* @param {string} params.collectionId - Collection ID.
|
|
1661
|
+
* @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).
|
|
1395
1662
|
* @param {string} params.key - Attribute Key.
|
|
1663
|
+
* @param {number} params.size - Attribute size for varchar attributes, in number of characters. Maximum size is 16381.
|
|
1664
|
+
* @param {boolean} params.required - Is attribute required?
|
|
1665
|
+
* @param {string} params.xdefault - Default value for attribute when not provided. Cannot be set when attribute is required.
|
|
1666
|
+
* @param {boolean} params.array - Is attribute an array?
|
|
1667
|
+
* @param {boolean} params.encrypt - Toggle encryption for the attribute. Encryption enhances security by not storing any plain text values in the database. However, encrypted attributes cannot be queried.
|
|
1396
1668
|
* @throws {AppwriteException}
|
|
1397
|
-
* @returns {Promise<
|
|
1398
|
-
* @deprecated This API has been deprecated since 1.8.0. Please use `TablesDB.getColumn` instead.
|
|
1669
|
+
* @returns {Promise<Models.AttributeVarchar>}
|
|
1399
1670
|
*/
|
|
1400
|
-
|
|
1671
|
+
createVarcharAttribute(params: {
|
|
1401
1672
|
databaseId: string;
|
|
1402
1673
|
collectionId: string;
|
|
1403
1674
|
key: string;
|
|
1404
|
-
|
|
1675
|
+
size: number;
|
|
1676
|
+
required: boolean;
|
|
1677
|
+
xdefault?: string;
|
|
1678
|
+
array?: boolean;
|
|
1679
|
+
encrypt?: boolean;
|
|
1680
|
+
}): Promise<Models.AttributeVarchar>;
|
|
1405
1681
|
/**
|
|
1406
|
-
*
|
|
1682
|
+
* Create a varchar attribute.
|
|
1683
|
+
*
|
|
1407
1684
|
*
|
|
1408
1685
|
* @param {string} databaseId - Database ID.
|
|
1409
|
-
* @param {string} collectionId - Collection ID.
|
|
1686
|
+
* @param {string} collectionId - Collection ID. You can create a new collection using the Database service [server integration](https://appwrite.io/docs/server/databases#databasesCreateCollection).
|
|
1410
1687
|
* @param {string} key - Attribute Key.
|
|
1688
|
+
* @param {number} size - Attribute size for varchar attributes, in number of characters. Maximum size is 16381.
|
|
1689
|
+
* @param {boolean} required - Is attribute required?
|
|
1690
|
+
* @param {string} xdefault - Default value for attribute when not provided. Cannot be set when attribute is required.
|
|
1691
|
+
* @param {boolean} array - Is attribute an array?
|
|
1692
|
+
* @param {boolean} encrypt - Toggle encryption for the attribute. Encryption enhances security by not storing any plain text values in the database. However, encrypted attributes cannot be queried.
|
|
1411
1693
|
* @throws {AppwriteException}
|
|
1412
|
-
* @returns {Promise<
|
|
1694
|
+
* @returns {Promise<Models.AttributeVarchar>}
|
|
1413
1695
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1414
1696
|
*/
|
|
1415
|
-
|
|
1697
|
+
createVarcharAttribute(databaseId: string, collectionId: string, key: string, size: number, required: boolean, xdefault?: string, array?: boolean, encrypt?: boolean): Promise<Models.AttributeVarchar>;
|
|
1416
1698
|
/**
|
|
1417
|
-
*
|
|
1699
|
+
* Update a varchar attribute. Changing the `default` value will not update already existing documents.
|
|
1700
|
+
*
|
|
1701
|
+
*
|
|
1702
|
+
* @param {string} params.databaseId - Database ID.
|
|
1703
|
+
* @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).
|
|
1704
|
+
* @param {string} params.key - Attribute Key.
|
|
1705
|
+
* @param {boolean} params.required - Is attribute required?
|
|
1706
|
+
* @param {string} params.xdefault - Default value for attribute when not provided. Cannot be set when attribute is required.
|
|
1707
|
+
* @param {number} params.size - Maximum size of the varchar attribute.
|
|
1708
|
+
* @param {string} params.newKey - New Attribute Key.
|
|
1709
|
+
* @throws {AppwriteException}
|
|
1710
|
+
* @returns {Promise<Models.AttributeVarchar>}
|
|
1711
|
+
*/
|
|
1712
|
+
updateVarcharAttribute(params: {
|
|
1713
|
+
databaseId: string;
|
|
1714
|
+
collectionId: string;
|
|
1715
|
+
key: string;
|
|
1716
|
+
required: boolean;
|
|
1717
|
+
xdefault?: string;
|
|
1718
|
+
size?: number;
|
|
1719
|
+
newKey?: string;
|
|
1720
|
+
}): Promise<Models.AttributeVarchar>;
|
|
1721
|
+
/**
|
|
1722
|
+
* Update a varchar attribute. Changing the `default` value will not update already existing documents.
|
|
1723
|
+
*
|
|
1724
|
+
*
|
|
1725
|
+
* @param {string} databaseId - Database ID.
|
|
1726
|
+
* @param {string} collectionId - Collection ID. You can create a new collection using the Database service [server integration](https://appwrite.io/docs/server/databases#databasesCreateCollection).
|
|
1727
|
+
* @param {string} key - Attribute Key.
|
|
1728
|
+
* @param {boolean} required - Is attribute required?
|
|
1729
|
+
* @param {string} xdefault - Default value for attribute when not provided. Cannot be set when attribute is required.
|
|
1730
|
+
* @param {number} size - Maximum size of the varchar attribute.
|
|
1731
|
+
* @param {string} newKey - New Attribute Key.
|
|
1732
|
+
* @throws {AppwriteException}
|
|
1733
|
+
* @returns {Promise<Models.AttributeVarchar>}
|
|
1734
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1735
|
+
*/
|
|
1736
|
+
updateVarcharAttribute(databaseId: string, collectionId: string, key: string, required: boolean, xdefault?: string, size?: number, newKey?: string): Promise<Models.AttributeVarchar>;
|
|
1737
|
+
/**
|
|
1738
|
+
* Get attribute by ID.
|
|
1418
1739
|
*
|
|
1419
1740
|
* @param {string} params.databaseId - Database ID.
|
|
1420
1741
|
* @param {string} params.collectionId - Collection ID.
|
|
1421
1742
|
* @param {string} params.key - Attribute Key.
|
|
1422
1743
|
* @throws {AppwriteException}
|
|
1423
|
-
* @returns {Promise<
|
|
1424
|
-
* @deprecated This API has been deprecated since 1.8.0. Please use `TablesDB.
|
|
1744
|
+
* @returns {Promise<Models.AttributeBoolean | Models.AttributeInteger | Models.AttributeFloat | Models.AttributeEmail | Models.AttributeEnum | Models.AttributeUrl | Models.AttributeIp | Models.AttributeDatetime | Models.AttributeRelationship | Models.AttributeString>}
|
|
1745
|
+
* @deprecated This API has been deprecated since 1.8.0. Please use `TablesDB.getColumn` instead.
|
|
1425
1746
|
*/
|
|
1426
|
-
|
|
1747
|
+
getAttribute(params: {
|
|
1427
1748
|
databaseId: string;
|
|
1428
1749
|
collectionId: string;
|
|
1429
1750
|
key: string;
|
|
1430
|
-
}): Promise<
|
|
1751
|
+
}): Promise<Models.AttributeBoolean | Models.AttributeInteger | Models.AttributeFloat | Models.AttributeEmail | Models.AttributeEnum | Models.AttributeUrl | Models.AttributeIp | Models.AttributeDatetime | Models.AttributeRelationship | Models.AttributeString>;
|
|
1431
1752
|
/**
|
|
1432
|
-
*
|
|
1753
|
+
* Get attribute by ID.
|
|
1433
1754
|
*
|
|
1434
1755
|
* @param {string} databaseId - Database ID.
|
|
1435
1756
|
* @param {string} collectionId - Collection ID.
|
|
1436
1757
|
* @param {string} key - Attribute Key.
|
|
1437
1758
|
* @throws {AppwriteException}
|
|
1438
|
-
* @returns {Promise<
|
|
1759
|
+
* @returns {Promise<Models.AttributeBoolean | Models.AttributeInteger | Models.AttributeFloat | Models.AttributeEmail | Models.AttributeEnum | Models.AttributeUrl | Models.AttributeIp | Models.AttributeDatetime | Models.AttributeRelationship | Models.AttributeString>}
|
|
1439
1760
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1440
1761
|
*/
|
|
1441
|
-
|
|
1762
|
+
getAttribute(databaseId: string, collectionId: string, key: string): Promise<Models.AttributeBoolean | Models.AttributeInteger | Models.AttributeFloat | Models.AttributeEmail | Models.AttributeEnum | Models.AttributeUrl | Models.AttributeIp | Models.AttributeDatetime | Models.AttributeRelationship | Models.AttributeString>;
|
|
1442
1763
|
/**
|
|
1443
|
-
*
|
|
1444
|
-
*
|
|
1764
|
+
* Deletes an attribute.
|
|
1445
1765
|
*
|
|
1446
1766
|
* @param {string} params.databaseId - Database ID.
|
|
1447
1767
|
* @param {string} params.collectionId - Collection ID.
|
|
1448
1768
|
* @param {string} params.key - Attribute Key.
|
|
1449
|
-
* @param {RelationMutate} params.onDelete - Constraints option
|
|
1450
|
-
* @param {string} params.newKey - New Attribute Key.
|
|
1451
1769
|
* @throws {AppwriteException}
|
|
1452
|
-
* @returns {Promise<
|
|
1453
|
-
* @deprecated This API has been deprecated since 1.8.0. Please use `TablesDB.
|
|
1770
|
+
* @returns {Promise<{}>}
|
|
1771
|
+
* @deprecated This API has been deprecated since 1.8.0. Please use `TablesDB.deleteColumn` instead.
|
|
1454
1772
|
*/
|
|
1455
|
-
|
|
1773
|
+
deleteAttribute(params: {
|
|
1456
1774
|
databaseId: string;
|
|
1457
1775
|
collectionId: string;
|
|
1458
1776
|
key: string;
|
|
1459
|
-
|
|
1460
|
-
newKey?: string;
|
|
1461
|
-
}): Promise<Models.AttributeRelationship>;
|
|
1777
|
+
}): Promise<{}>;
|
|
1462
1778
|
/**
|
|
1463
|
-
*
|
|
1464
|
-
*
|
|
1779
|
+
* Deletes an attribute.
|
|
1465
1780
|
*
|
|
1466
1781
|
* @param {string} databaseId - Database ID.
|
|
1467
1782
|
* @param {string} collectionId - Collection ID.
|
|
1468
1783
|
* @param {string} key - Attribute Key.
|
|
1469
|
-
* @param {RelationMutate} onDelete - Constraints option
|
|
1470
|
-
* @param {string} newKey - New Attribute Key.
|
|
1471
1784
|
* @throws {AppwriteException}
|
|
1472
|
-
* @returns {Promise<
|
|
1785
|
+
* @returns {Promise<{}>}
|
|
1473
1786
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1474
1787
|
*/
|
|
1475
|
-
|
|
1788
|
+
deleteAttribute(databaseId: string, collectionId: string, key: string): Promise<{}>;
|
|
1476
1789
|
/**
|
|
1477
1790
|
* Get a list of all the user's documents in a given collection. You can use the query params to filter your results.
|
|
1478
1791
|
*
|
|
@@ -1481,6 +1794,7 @@ export declare class Databases {
|
|
|
1481
1794
|
* @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/queries). Maximum of 100 queries are allowed, each 4096 characters long.
|
|
1482
1795
|
* @param {string} params.transactionId - Transaction ID to read uncommitted changes within the transaction.
|
|
1483
1796
|
* @param {boolean} params.total - When set to false, the total count returned will be 0 and will not be calculated.
|
|
1797
|
+
* @param {number} params.ttl - TTL (seconds) for cached responses when caching is enabled for select queries. Must be between 0 and 86400 (24 hours).
|
|
1484
1798
|
* @throws {AppwriteException}
|
|
1485
1799
|
* @returns {Promise<Models.DocumentList<Document>>}
|
|
1486
1800
|
* @deprecated This API has been deprecated since 1.8.0. Please use `TablesDB.listRows` instead.
|
|
@@ -1491,6 +1805,7 @@ export declare class Databases {
|
|
|
1491
1805
|
queries?: string[];
|
|
1492
1806
|
transactionId?: string;
|
|
1493
1807
|
total?: boolean;
|
|
1808
|
+
ttl?: number;
|
|
1494
1809
|
}): Promise<Models.DocumentList<Document>>;
|
|
1495
1810
|
/**
|
|
1496
1811
|
* Get a list of all the user's documents in a given collection. You can use the query params to filter your results.
|
|
@@ -1500,11 +1815,12 @@ export declare class Databases {
|
|
|
1500
1815
|
* @param {string[]} queries - Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Maximum of 100 queries are allowed, each 4096 characters long.
|
|
1501
1816
|
* @param {string} transactionId - Transaction ID to read uncommitted changes within the transaction.
|
|
1502
1817
|
* @param {boolean} total - When set to false, the total count returned will be 0 and will not be calculated.
|
|
1818
|
+
* @param {number} ttl - TTL (seconds) for cached responses when caching is enabled for select queries. Must be between 0 and 86400 (24 hours).
|
|
1503
1819
|
* @throws {AppwriteException}
|
|
1504
1820
|
* @returns {Promise<Models.DocumentList<Document>>}
|
|
1505
1821
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1506
1822
|
*/
|
|
1507
|
-
listDocuments<Document extends Models.Document = Models.DefaultDocument>(databaseId: string, collectionId: string, queries?: string[], transactionId?: string, total?: boolean): Promise<Models.DocumentList<Document>>;
|
|
1823
|
+
listDocuments<Document extends Models.Document = Models.DefaultDocument>(databaseId: string, collectionId: string, queries?: string[], transactionId?: string, total?: boolean, ttl?: number): Promise<Models.DocumentList<Document>>;
|
|
1508
1824
|
/**
|
|
1509
1825
|
* Create a new Document. Before using this route, you should create a new collection resource using either a [server integration](https://appwrite.io/docs/server/databases#databasesCreateCollection) API or directly from your database console.
|
|
1510
1826
|
*
|
|
@@ -1710,7 +2026,7 @@ export declare class Databases {
|
|
|
1710
2026
|
databaseId: string;
|
|
1711
2027
|
collectionId: string;
|
|
1712
2028
|
documentId: string;
|
|
1713
|
-
data
|
|
2029
|
+
data?: Document extends Models.DefaultDocument ? Partial<Models.Document> & Record<string, any> : Partial<Models.Document> & Partial<Omit<Document, keyof Models.Document>>;
|
|
1714
2030
|
permissions?: string[];
|
|
1715
2031
|
transactionId?: string;
|
|
1716
2032
|
}): Promise<Document>;
|
|
@@ -1727,7 +2043,7 @@ export declare class Databases {
|
|
|
1727
2043
|
* @returns {Promise<Document>}
|
|
1728
2044
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1729
2045
|
*/
|
|
1730
|
-
upsertDocument<Document extends Models.Document = Models.DefaultDocument>(databaseId: string, collectionId: string, documentId: string, data
|
|
2046
|
+
upsertDocument<Document extends Models.Document = Models.DefaultDocument>(databaseId: string, collectionId: string, documentId: string, data?: Document extends Models.DefaultDocument ? Partial<Models.Document> & Record<string, any> : Partial<Models.Document> & Partial<Omit<Document, keyof Models.Document>>, permissions?: string[], transactionId?: string): Promise<Document>;
|
|
1731
2047
|
/**
|
|
1732
2048
|
* Update a document by its unique ID. Using the patch method you can pass only specific fields that will get updated.
|
|
1733
2049
|
*
|
|
@@ -1935,7 +2251,7 @@ export declare class Databases {
|
|
|
1935
2251
|
* @param {string} params.key - Index Key.
|
|
1936
2252
|
* @param {IndexType} params.type - Index type.
|
|
1937
2253
|
* @param {string[]} params.attributes - Array of attributes to index. Maximum of 100 attributes are allowed, each 32 characters long.
|
|
1938
|
-
* @param {
|
|
2254
|
+
* @param {OrderBy[]} params.orders - Array of index orders. Maximum of 100 orders are allowed.
|
|
1939
2255
|
* @param {number[]} params.lengths - Length of index. Maximum of 100
|
|
1940
2256
|
* @throws {AppwriteException}
|
|
1941
2257
|
* @returns {Promise<Models.Index>}
|
|
@@ -1947,7 +2263,7 @@ export declare class Databases {
|
|
|
1947
2263
|
key: string;
|
|
1948
2264
|
type: IndexType;
|
|
1949
2265
|
attributes: string[];
|
|
1950
|
-
orders?:
|
|
2266
|
+
orders?: OrderBy[];
|
|
1951
2267
|
lengths?: number[];
|
|
1952
2268
|
}): Promise<Models.Index>;
|
|
1953
2269
|
/**
|
|
@@ -1959,13 +2275,13 @@ export declare class Databases {
|
|
|
1959
2275
|
* @param {string} key - Index Key.
|
|
1960
2276
|
* @param {IndexType} type - Index type.
|
|
1961
2277
|
* @param {string[]} attributes - Array of attributes to index. Maximum of 100 attributes are allowed, each 32 characters long.
|
|
1962
|
-
* @param {
|
|
2278
|
+
* @param {OrderBy[]} orders - Array of index orders. Maximum of 100 orders are allowed.
|
|
1963
2279
|
* @param {number[]} lengths - Length of index. Maximum of 100
|
|
1964
2280
|
* @throws {AppwriteException}
|
|
1965
2281
|
* @returns {Promise<Models.Index>}
|
|
1966
2282
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1967
2283
|
*/
|
|
1968
|
-
createIndex(databaseId: string, collectionId: string, key: string, type: IndexType, attributes: string[], orders?:
|
|
2284
|
+
createIndex(databaseId: string, collectionId: string, key: string, type: IndexType, attributes: string[], orders?: OrderBy[], lengths?: number[]): Promise<Models.Index>;
|
|
1969
2285
|
/**
|
|
1970
2286
|
* Get an index by its unique ID.
|
|
1971
2287
|
*
|