node-appwrite 21.0.0 → 22.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +1 -1
- package/README.md +2 -2
- package/dist/client.js +37 -5
- package/dist/client.js.map +1 -1
- package/dist/client.mjs +1505 -5
- package/dist/client.mjs.map +1 -1
- package/dist/enums/browser-permission.d.mts +24 -0
- package/dist/enums/browser-permission.d.ts +24 -0
- package/dist/enums/browser-permission.js +29 -0
- package/dist/enums/browser-permission.js.map +1 -0
- package/dist/enums/browser-permission.mjs +28 -0
- package/dist/enums/browser-permission.mjs.map +1 -0
- package/dist/enums/deployment-status.d.mts +1 -0
- package/dist/enums/deployment-status.d.ts +1 -0
- package/dist/enums/deployment-status.js +1 -0
- package/dist/enums/deployment-status.js.map +1 -1
- package/dist/enums/deployment-status.mjs +1 -0
- package/dist/enums/deployment-status.mjs.map +1 -1
- package/dist/enums/name.d.mts +1 -0
- package/dist/enums/name.d.ts +1 -0
- package/dist/enums/name.js +1 -0
- package/dist/enums/name.js.map +1 -1
- package/dist/enums/name.mjs +1 -0
- package/dist/enums/name.mjs.map +1 -1
- package/dist/enums/o-auth-provider.d.mts +1 -2
- package/dist/enums/o-auth-provider.d.ts +1 -2
- package/dist/enums/o-auth-provider.js +0 -1
- package/dist/enums/o-auth-provider.js.map +1 -1
- package/dist/enums/o-auth-provider.mjs +0 -1
- package/dist/enums/o-auth-provider.mjs.map +1 -1
- package/dist/enums/order-by.d.mts +6 -0
- package/dist/enums/order-by.d.ts +6 -0
- package/dist/enums/order-by.js +11 -0
- package/dist/enums/order-by.js.map +1 -0
- package/dist/enums/order-by.mjs +10 -0
- package/dist/enums/order-by.mjs.map +1 -0
- package/dist/enums/roles.d.mts +7 -0
- package/dist/enums/roles.d.ts +7 -0
- package/dist/enums/roles.js +12 -0
- package/dist/enums/roles.js.map +1 -0
- package/dist/enums/roles.mjs +11 -0
- package/dist/enums/roles.mjs.map +1 -0
- package/dist/enums/scopes.d.mts +59 -0
- package/dist/enums/scopes.d.ts +59 -0
- package/dist/enums/scopes.js +64 -0
- package/dist/enums/scopes.js.map +1 -0
- package/dist/enums/scopes.mjs +63 -0
- package/dist/enums/scopes.mjs.map +1 -0
- package/dist/index.d.mts +5 -2
- package/dist/index.d.ts +5 -2
- package/dist/index.js +21 -6
- package/dist/index.js.map +1 -1
- package/dist/index.mjs +5 -2
- package/dist/index.mjs.map +1 -1
- package/dist/models.d.mts +367 -6
- package/dist/models.d.ts +367 -6
- package/dist/query.d.mts +38 -8
- package/dist/query.d.ts +38 -8
- package/dist/query.js +48 -7
- package/dist/query.js.map +1 -1
- package/dist/query.mjs +44 -7
- package/dist/query.mjs.map +1 -1
- package/dist/services/account.d.mts +13 -1
- package/dist/services/account.d.ts +13 -1
- package/dist/services/account.js +13 -7
- package/dist/services/account.js.map +1 -1
- package/dist/services/account.mjs +13 -7
- package/dist/services/account.mjs.map +1 -1
- package/dist/services/avatars.d.mts +9 -8
- package/dist/services/avatars.d.ts +9 -8
- package/dist/services/avatars.js.map +1 -1
- package/dist/services/avatars.mjs.map +1 -1
- package/dist/services/databases.d.mts +336 -35
- package/dist/services/databases.d.ts +336 -35
- package/dist/services/databases.js +480 -10
- package/dist/services/databases.js.map +1 -1
- package/dist/services/databases.mjs +480 -10
- package/dist/services/databases.mjs.map +1 -1
- package/dist/services/functions.d.mts +9 -8
- package/dist/services/functions.d.ts +9 -8
- package/dist/services/functions.js.map +1 -1
- package/dist/services/functions.mjs.map +1 -1
- package/dist/services/graphql.js.map +1 -1
- package/dist/services/graphql.mjs.map +1 -1
- package/dist/services/health.d.mts +25 -6
- package/dist/services/health.d.ts +25 -6
- package/dist/services/health.js +27 -3
- package/dist/services/health.js.map +1 -1
- package/dist/services/health.mjs +27 -3
- package/dist/services/health.mjs.map +1 -1
- package/dist/services/messaging.js.map +1 -1
- package/dist/services/messaging.mjs.map +1 -1
- package/dist/services/sites.js.map +1 -1
- package/dist/services/sites.mjs.map +1 -1
- package/dist/services/storage.d.mts +12 -12
- package/dist/services/storage.d.ts +12 -12
- package/dist/services/storage.js.map +1 -1
- package/dist/services/storage.mjs.map +1 -1
- package/dist/services/tables-db.d.mts +336 -33
- package/dist/services/tables-db.d.ts +336 -33
- package/dist/services/tables-db.js +480 -7
- package/dist/services/tables-db.js.map +1 -1
- package/dist/services/tables-db.mjs +480 -7
- package/dist/services/tables-db.mjs.map +1 -1
- package/dist/services/teams.d.mts +9 -8
- package/dist/services/teams.d.ts +9 -8
- package/dist/services/teams.js.map +1 -1
- package/dist/services/teams.mjs.map +1 -1
- package/dist/services/tokens.js.map +1 -1
- package/dist/services/tokens.mjs.map +1 -1
- package/dist/services/users.js.map +1 -1
- package/dist/services/users.mjs.map +1 -1
- package/package.json +4 -2
- package/dist/enums/output.d.mts +0 -11
- package/dist/enums/output.d.ts +0 -11
- package/dist/enums/output.js +0 -16
- package/dist/enums/output.js.map +0 -1
- package/dist/enums/output.mjs +0 -15
- package/dist/enums/output.mjs.map +0 -1
|
@@ -3,6 +3,7 @@ import { Models } from '../models.mjs';
|
|
|
3
3
|
import { RelationshipType } from '../enums/relationship-type.mjs';
|
|
4
4
|
import { RelationMutate } from '../enums/relation-mutate.mjs';
|
|
5
5
|
import { IndexType } from '../enums/index-type.mjs';
|
|
6
|
+
import { OrderBy } from '../enums/order-by.mjs';
|
|
6
7
|
import '../query.mjs';
|
|
7
8
|
import '../enums/database-type.mjs';
|
|
8
9
|
import '../enums/attribute-status.mjs';
|
|
@@ -223,7 +224,7 @@ declare class TablesDB {
|
|
|
223
224
|
*/
|
|
224
225
|
update(params: {
|
|
225
226
|
databaseId: string;
|
|
226
|
-
name
|
|
227
|
+
name?: string;
|
|
227
228
|
enabled?: boolean;
|
|
228
229
|
}): Promise<Models.Database>;
|
|
229
230
|
/**
|
|
@@ -236,7 +237,7 @@ declare class TablesDB {
|
|
|
236
237
|
* @returns {Promise<Models.Database>}
|
|
237
238
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
238
239
|
*/
|
|
239
|
-
update(databaseId: string, name
|
|
240
|
+
update(databaseId: string, name?: string, enabled?: boolean): Promise<Models.Database>;
|
|
240
241
|
/**
|
|
241
242
|
* Delete a database by its unique ID. Only API keys with with databases.write scope can delete a database.
|
|
242
243
|
*
|
|
@@ -293,6 +294,8 @@ declare class TablesDB {
|
|
|
293
294
|
* @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).
|
|
294
295
|
* @param {boolean} params.rowSecurity - Enables configuring permissions for individual rows. A user needs one of row or table level permissions to access a row. [Learn more about permissions](https://appwrite.io/docs/permissions).
|
|
295
296
|
* @param {boolean} params.enabled - Is table enabled? When set to 'disabled', users cannot access the table but Server SDKs with and API key can still read and write to the table. No data is lost when this is toggled.
|
|
297
|
+
* @param {object[]} params.columns - Array of column definitions to create. Each column should contain: key (string), type (string: string, integer, float, boolean, datetime, relationship), size (integer, required for string type), required (boolean, optional), default (mixed, optional), array (boolean, optional), and type-specific options.
|
|
298
|
+
* @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 column keys), orders (array of ASC/DESC, optional), and lengths (array of integers, optional).
|
|
296
299
|
* @throws {AppwriteException}
|
|
297
300
|
* @returns {Promise<Models.Table>}
|
|
298
301
|
*/
|
|
@@ -303,6 +306,8 @@ declare class TablesDB {
|
|
|
303
306
|
permissions?: string[];
|
|
304
307
|
rowSecurity?: boolean;
|
|
305
308
|
enabled?: boolean;
|
|
309
|
+
columns?: object[];
|
|
310
|
+
indexes?: object[];
|
|
306
311
|
}): Promise<Models.Table>;
|
|
307
312
|
/**
|
|
308
313
|
* Create a new Table. Before using this route, you should create a new database resource using either a [server integration](https://appwrite.io/docs/references/cloud/server-dart/tablesDB#createTable) API or directly from your database console.
|
|
@@ -313,11 +318,13 @@ declare class TablesDB {
|
|
|
313
318
|
* @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).
|
|
314
319
|
* @param {boolean} rowSecurity - Enables configuring permissions for individual rows. A user needs one of row or table level permissions to access a row. [Learn more about permissions](https://appwrite.io/docs/permissions).
|
|
315
320
|
* @param {boolean} enabled - Is table enabled? When set to 'disabled', users cannot access the table but Server SDKs with and API key can still read and write to the table. No data is lost when this is toggled.
|
|
321
|
+
* @param {object[]} columns - Array of column definitions to create. Each column should contain: key (string), type (string: string, integer, float, boolean, datetime, relationship), size (integer, required for string type), required (boolean, optional), default (mixed, optional), array (boolean, optional), and type-specific options.
|
|
322
|
+
* @param {object[]} indexes - Array of index definitions to create. Each index should contain: key (string), type (string: key, fulltext, unique, spatial), attributes (array of column keys), orders (array of ASC/DESC, optional), and lengths (array of integers, optional).
|
|
316
323
|
* @throws {AppwriteException}
|
|
317
324
|
* @returns {Promise<Models.Table>}
|
|
318
325
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
319
326
|
*/
|
|
320
|
-
createTable(databaseId: string, tableId: string, name: string, permissions?: string[], rowSecurity?: boolean, enabled?: boolean): Promise<Models.Table>;
|
|
327
|
+
createTable(databaseId: string, tableId: string, name: string, permissions?: string[], rowSecurity?: boolean, enabled?: boolean, columns?: object[], indexes?: object[]): Promise<Models.Table>;
|
|
321
328
|
/**
|
|
322
329
|
* Get a table by its unique ID. This endpoint response returns a JSON object with the table metadata.
|
|
323
330
|
*
|
|
@@ -355,7 +362,7 @@ declare class TablesDB {
|
|
|
355
362
|
updateTable(params: {
|
|
356
363
|
databaseId: string;
|
|
357
364
|
tableId: string;
|
|
358
|
-
name
|
|
365
|
+
name?: string;
|
|
359
366
|
permissions?: string[];
|
|
360
367
|
rowSecurity?: boolean;
|
|
361
368
|
enabled?: boolean;
|
|
@@ -373,7 +380,7 @@ declare class TablesDB {
|
|
|
373
380
|
* @returns {Promise<Models.Table>}
|
|
374
381
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
375
382
|
*/
|
|
376
|
-
updateTable(databaseId: string, tableId: string, name
|
|
383
|
+
updateTable(databaseId: string, tableId: string, name?: string, permissions?: string[], rowSecurity?: boolean, enabled?: boolean): Promise<Models.Table>;
|
|
377
384
|
/**
|
|
378
385
|
* Delete a table by its unique ID. Only users with write permissions have access to delete this resource.
|
|
379
386
|
*
|
|
@@ -802,9 +809,9 @@ declare class TablesDB {
|
|
|
802
809
|
* @param {string} params.tableId - Table ID.
|
|
803
810
|
* @param {string} params.key - Column Key.
|
|
804
811
|
* @param {boolean} params.required - Is column required?
|
|
805
|
-
* @param {number} params.min - Minimum value
|
|
806
|
-
* @param {number} params.max - Maximum value
|
|
807
|
-
* @param {number} params.xdefault - Default value. Cannot be set when column is required.
|
|
812
|
+
* @param {number | bigint} params.min - Minimum value
|
|
813
|
+
* @param {number | bigint} params.max - Maximum value
|
|
814
|
+
* @param {number | bigint} params.xdefault - Default value. Cannot be set when column is required.
|
|
808
815
|
* @param {boolean} params.array - Is column an array?
|
|
809
816
|
* @throws {AppwriteException}
|
|
810
817
|
* @returns {Promise<Models.ColumnInteger>}
|
|
@@ -814,9 +821,9 @@ declare class TablesDB {
|
|
|
814
821
|
tableId: string;
|
|
815
822
|
key: string;
|
|
816
823
|
required: boolean;
|
|
817
|
-
min?: number;
|
|
818
|
-
max?: number;
|
|
819
|
-
xdefault?: number;
|
|
824
|
+
min?: number | bigint;
|
|
825
|
+
max?: number | bigint;
|
|
826
|
+
xdefault?: number | bigint;
|
|
820
827
|
array?: boolean;
|
|
821
828
|
}): Promise<Models.ColumnInteger>;
|
|
822
829
|
/**
|
|
@@ -827,15 +834,15 @@ declare class TablesDB {
|
|
|
827
834
|
* @param {string} tableId - Table ID.
|
|
828
835
|
* @param {string} key - Column Key.
|
|
829
836
|
* @param {boolean} required - Is column required?
|
|
830
|
-
* @param {number} min - Minimum value
|
|
831
|
-
* @param {number} max - Maximum value
|
|
832
|
-
* @param {number} xdefault - Default value. Cannot be set when column is required.
|
|
837
|
+
* @param {number | bigint} min - Minimum value
|
|
838
|
+
* @param {number | bigint} max - Maximum value
|
|
839
|
+
* @param {number | bigint} xdefault - Default value. Cannot be set when column is required.
|
|
833
840
|
* @param {boolean} array - Is column an array?
|
|
834
841
|
* @throws {AppwriteException}
|
|
835
842
|
* @returns {Promise<Models.ColumnInteger>}
|
|
836
843
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
837
844
|
*/
|
|
838
|
-
createIntegerColumn(databaseId: string, tableId: string, key: string, required: boolean, min?: number, max?: number, xdefault?: number, array?: boolean): Promise<Models.ColumnInteger>;
|
|
845
|
+
createIntegerColumn(databaseId: string, tableId: string, key: string, required: boolean, min?: number | bigint, max?: number | bigint, xdefault?: number | bigint, array?: boolean): Promise<Models.ColumnInteger>;
|
|
839
846
|
/**
|
|
840
847
|
* Update an integer column. Changing the `default` value will not update already existing rows.
|
|
841
848
|
*
|
|
@@ -844,9 +851,9 @@ declare class TablesDB {
|
|
|
844
851
|
* @param {string} params.tableId - Table ID.
|
|
845
852
|
* @param {string} params.key - Column Key.
|
|
846
853
|
* @param {boolean} params.required - Is column required?
|
|
847
|
-
* @param {number} params.xdefault - Default value. Cannot be set when column is required.
|
|
848
|
-
* @param {number} params.min - Minimum value
|
|
849
|
-
* @param {number} params.max - Maximum value
|
|
854
|
+
* @param {number | bigint} params.xdefault - Default value. Cannot be set when column is required.
|
|
855
|
+
* @param {number | bigint} params.min - Minimum value
|
|
856
|
+
* @param {number | bigint} params.max - Maximum value
|
|
850
857
|
* @param {string} params.newKey - New Column Key.
|
|
851
858
|
* @throws {AppwriteException}
|
|
852
859
|
* @returns {Promise<Models.ColumnInteger>}
|
|
@@ -856,9 +863,9 @@ declare class TablesDB {
|
|
|
856
863
|
tableId: string;
|
|
857
864
|
key: string;
|
|
858
865
|
required: boolean;
|
|
859
|
-
xdefault?: number;
|
|
860
|
-
min?: number;
|
|
861
|
-
max?: number;
|
|
866
|
+
xdefault?: number | bigint;
|
|
867
|
+
min?: number | bigint;
|
|
868
|
+
max?: number | bigint;
|
|
862
869
|
newKey?: string;
|
|
863
870
|
}): Promise<Models.ColumnInteger>;
|
|
864
871
|
/**
|
|
@@ -869,15 +876,15 @@ declare class TablesDB {
|
|
|
869
876
|
* @param {string} tableId - Table ID.
|
|
870
877
|
* @param {string} key - Column Key.
|
|
871
878
|
* @param {boolean} required - Is column required?
|
|
872
|
-
* @param {number} xdefault - Default value. Cannot be set when column is required.
|
|
873
|
-
* @param {number} min - Minimum value
|
|
874
|
-
* @param {number} max - Maximum value
|
|
879
|
+
* @param {number | bigint} xdefault - Default value. Cannot be set when column is required.
|
|
880
|
+
* @param {number | bigint} min - Minimum value
|
|
881
|
+
* @param {number | bigint} max - Maximum value
|
|
875
882
|
* @param {string} newKey - New Column Key.
|
|
876
883
|
* @throws {AppwriteException}
|
|
877
884
|
* @returns {Promise<Models.ColumnInteger>}
|
|
878
885
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
879
886
|
*/
|
|
880
|
-
updateIntegerColumn(databaseId: string, tableId: string, key: string, required: boolean, xdefault?: number, min?: number, max?: number, newKey?: string): Promise<Models.ColumnInteger>;
|
|
887
|
+
updateIntegerColumn(databaseId: string, tableId: string, key: string, required: boolean, xdefault?: number | bigint, min?: number | bigint, max?: number | bigint, newKey?: string): Promise<Models.ColumnInteger>;
|
|
881
888
|
/**
|
|
882
889
|
* Create IP address column.
|
|
883
890
|
*
|
|
@@ -1015,6 +1022,150 @@ declare class TablesDB {
|
|
|
1015
1022
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1016
1023
|
*/
|
|
1017
1024
|
updateLineColumn(databaseId: string, tableId: string, key: string, required: boolean, xdefault?: any[], newKey?: string): Promise<Models.ColumnLine>;
|
|
1025
|
+
/**
|
|
1026
|
+
* Create a longtext column.
|
|
1027
|
+
*
|
|
1028
|
+
*
|
|
1029
|
+
* @param {string} params.databaseId - Database ID.
|
|
1030
|
+
* @param {string} params.tableId - Table ID. You can create a new table using the Database service [server integration](https://appwrite.io/docs/references/cloud/server-dart/tablesDB#createTable).
|
|
1031
|
+
* @param {string} params.key - Column Key.
|
|
1032
|
+
* @param {boolean} params.required - Is column required?
|
|
1033
|
+
* @param {string} params.xdefault - Default value for column when not provided. Cannot be set when column is required.
|
|
1034
|
+
* @param {boolean} params.array - Is column an array?
|
|
1035
|
+
* @throws {AppwriteException}
|
|
1036
|
+
* @returns {Promise<Models.ColumnLongtext>}
|
|
1037
|
+
*/
|
|
1038
|
+
createLongtextColumn(params: {
|
|
1039
|
+
databaseId: string;
|
|
1040
|
+
tableId: string;
|
|
1041
|
+
key: string;
|
|
1042
|
+
required: boolean;
|
|
1043
|
+
xdefault?: string;
|
|
1044
|
+
array?: boolean;
|
|
1045
|
+
}): Promise<Models.ColumnLongtext>;
|
|
1046
|
+
/**
|
|
1047
|
+
* Create a longtext column.
|
|
1048
|
+
*
|
|
1049
|
+
*
|
|
1050
|
+
* @param {string} databaseId - Database ID.
|
|
1051
|
+
* @param {string} tableId - Table ID. You can create a new table using the Database service [server integration](https://appwrite.io/docs/references/cloud/server-dart/tablesDB#createTable).
|
|
1052
|
+
* @param {string} key - Column Key.
|
|
1053
|
+
* @param {boolean} required - Is column required?
|
|
1054
|
+
* @param {string} xdefault - Default value for column when not provided. Cannot be set when column is required.
|
|
1055
|
+
* @param {boolean} array - Is column an array?
|
|
1056
|
+
* @throws {AppwriteException}
|
|
1057
|
+
* @returns {Promise<Models.ColumnLongtext>}
|
|
1058
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1059
|
+
*/
|
|
1060
|
+
createLongtextColumn(databaseId: string, tableId: string, key: string, required: boolean, xdefault?: string, array?: boolean): Promise<Models.ColumnLongtext>;
|
|
1061
|
+
/**
|
|
1062
|
+
* Update a longtext column. Changing the `default` value will not update already existing rows.
|
|
1063
|
+
*
|
|
1064
|
+
*
|
|
1065
|
+
* @param {string} params.databaseId - Database ID.
|
|
1066
|
+
* @param {string} params.tableId - Table ID. You can create a new table using the Database service [server integration](https://appwrite.io/docs/references/cloud/server-dart/tablesDB#createTable).
|
|
1067
|
+
* @param {string} params.key - Column Key.
|
|
1068
|
+
* @param {boolean} params.required - Is column required?
|
|
1069
|
+
* @param {string} params.xdefault - Default value for column when not provided. Cannot be set when column is required.
|
|
1070
|
+
* @param {string} params.newKey - New Column Key.
|
|
1071
|
+
* @throws {AppwriteException}
|
|
1072
|
+
* @returns {Promise<Models.ColumnLongtext>}
|
|
1073
|
+
*/
|
|
1074
|
+
updateLongtextColumn(params: {
|
|
1075
|
+
databaseId: string;
|
|
1076
|
+
tableId: string;
|
|
1077
|
+
key: string;
|
|
1078
|
+
required: boolean;
|
|
1079
|
+
xdefault?: string;
|
|
1080
|
+
newKey?: string;
|
|
1081
|
+
}): Promise<Models.ColumnLongtext>;
|
|
1082
|
+
/**
|
|
1083
|
+
* Update a longtext column. Changing the `default` value will not update already existing rows.
|
|
1084
|
+
*
|
|
1085
|
+
*
|
|
1086
|
+
* @param {string} databaseId - Database ID.
|
|
1087
|
+
* @param {string} tableId - Table ID. You can create a new table using the Database service [server integration](https://appwrite.io/docs/references/cloud/server-dart/tablesDB#createTable).
|
|
1088
|
+
* @param {string} key - Column Key.
|
|
1089
|
+
* @param {boolean} required - Is column required?
|
|
1090
|
+
* @param {string} xdefault - Default value for column when not provided. Cannot be set when column is required.
|
|
1091
|
+
* @param {string} newKey - New Column Key.
|
|
1092
|
+
* @throws {AppwriteException}
|
|
1093
|
+
* @returns {Promise<Models.ColumnLongtext>}
|
|
1094
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1095
|
+
*/
|
|
1096
|
+
updateLongtextColumn(databaseId: string, tableId: string, key: string, required: boolean, xdefault?: string, newKey?: string): Promise<Models.ColumnLongtext>;
|
|
1097
|
+
/**
|
|
1098
|
+
* Create a mediumtext column.
|
|
1099
|
+
*
|
|
1100
|
+
*
|
|
1101
|
+
* @param {string} params.databaseId - Database ID.
|
|
1102
|
+
* @param {string} params.tableId - Table ID. You can create a new table using the Database service [server integration](https://appwrite.io/docs/references/cloud/server-dart/tablesDB#createTable).
|
|
1103
|
+
* @param {string} params.key - Column Key.
|
|
1104
|
+
* @param {boolean} params.required - Is column required?
|
|
1105
|
+
* @param {string} params.xdefault - Default value for column when not provided. Cannot be set when column is required.
|
|
1106
|
+
* @param {boolean} params.array - Is column an array?
|
|
1107
|
+
* @throws {AppwriteException}
|
|
1108
|
+
* @returns {Promise<Models.ColumnMediumtext>}
|
|
1109
|
+
*/
|
|
1110
|
+
createMediumtextColumn(params: {
|
|
1111
|
+
databaseId: string;
|
|
1112
|
+
tableId: string;
|
|
1113
|
+
key: string;
|
|
1114
|
+
required: boolean;
|
|
1115
|
+
xdefault?: string;
|
|
1116
|
+
array?: boolean;
|
|
1117
|
+
}): Promise<Models.ColumnMediumtext>;
|
|
1118
|
+
/**
|
|
1119
|
+
* Create a mediumtext column.
|
|
1120
|
+
*
|
|
1121
|
+
*
|
|
1122
|
+
* @param {string} databaseId - Database ID.
|
|
1123
|
+
* @param {string} tableId - Table ID. You can create a new table using the Database service [server integration](https://appwrite.io/docs/references/cloud/server-dart/tablesDB#createTable).
|
|
1124
|
+
* @param {string} key - Column Key.
|
|
1125
|
+
* @param {boolean} required - Is column required?
|
|
1126
|
+
* @param {string} xdefault - Default value for column when not provided. Cannot be set when column is required.
|
|
1127
|
+
* @param {boolean} array - Is column an array?
|
|
1128
|
+
* @throws {AppwriteException}
|
|
1129
|
+
* @returns {Promise<Models.ColumnMediumtext>}
|
|
1130
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1131
|
+
*/
|
|
1132
|
+
createMediumtextColumn(databaseId: string, tableId: string, key: string, required: boolean, xdefault?: string, array?: boolean): Promise<Models.ColumnMediumtext>;
|
|
1133
|
+
/**
|
|
1134
|
+
* Update a mediumtext column. Changing the `default` value will not update already existing rows.
|
|
1135
|
+
*
|
|
1136
|
+
*
|
|
1137
|
+
* @param {string} params.databaseId - Database ID.
|
|
1138
|
+
* @param {string} params.tableId - Table ID. You can create a new table using the Database service [server integration](https://appwrite.io/docs/references/cloud/server-dart/tablesDB#createTable).
|
|
1139
|
+
* @param {string} params.key - Column Key.
|
|
1140
|
+
* @param {boolean} params.required - Is column required?
|
|
1141
|
+
* @param {string} params.xdefault - Default value for column when not provided. Cannot be set when column is required.
|
|
1142
|
+
* @param {string} params.newKey - New Column Key.
|
|
1143
|
+
* @throws {AppwriteException}
|
|
1144
|
+
* @returns {Promise<Models.ColumnMediumtext>}
|
|
1145
|
+
*/
|
|
1146
|
+
updateMediumtextColumn(params: {
|
|
1147
|
+
databaseId: string;
|
|
1148
|
+
tableId: string;
|
|
1149
|
+
key: string;
|
|
1150
|
+
required: boolean;
|
|
1151
|
+
xdefault?: string;
|
|
1152
|
+
newKey?: string;
|
|
1153
|
+
}): Promise<Models.ColumnMediumtext>;
|
|
1154
|
+
/**
|
|
1155
|
+
* Update a mediumtext column. Changing the `default` value will not update already existing rows.
|
|
1156
|
+
*
|
|
1157
|
+
*
|
|
1158
|
+
* @param {string} databaseId - Database ID.
|
|
1159
|
+
* @param {string} tableId - Table ID. You can create a new table using the Database service [server integration](https://appwrite.io/docs/references/cloud/server-dart/tablesDB#createTable).
|
|
1160
|
+
* @param {string} key - Column Key.
|
|
1161
|
+
* @param {boolean} required - Is column required?
|
|
1162
|
+
* @param {string} xdefault - Default value for column when not provided. Cannot be set when column is required.
|
|
1163
|
+
* @param {string} newKey - New Column Key.
|
|
1164
|
+
* @throws {AppwriteException}
|
|
1165
|
+
* @returns {Promise<Models.ColumnMediumtext>}
|
|
1166
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1167
|
+
*/
|
|
1168
|
+
updateMediumtextColumn(databaseId: string, tableId: string, key: string, required: boolean, xdefault?: string, newKey?: string): Promise<Models.ColumnMediumtext>;
|
|
1018
1169
|
/**
|
|
1019
1170
|
* Create a geometric point column.
|
|
1020
1171
|
*
|
|
@@ -1201,6 +1352,7 @@ declare class TablesDB {
|
|
|
1201
1352
|
* @param {boolean} params.encrypt - Toggle encryption for the column. Encryption enhances security by not storing any plain text values in the database. However, encrypted columns cannot be queried.
|
|
1202
1353
|
* @throws {AppwriteException}
|
|
1203
1354
|
* @returns {Promise<Models.ColumnString>}
|
|
1355
|
+
* @deprecated This API has been deprecated since 1.9.0. Please use `TablesDB.createTextColumn` instead.
|
|
1204
1356
|
*/
|
|
1205
1357
|
createStringColumn(params: {
|
|
1206
1358
|
databaseId: string;
|
|
@@ -1242,6 +1394,7 @@ declare class TablesDB {
|
|
|
1242
1394
|
* @param {string} params.newKey - New Column Key.
|
|
1243
1395
|
* @throws {AppwriteException}
|
|
1244
1396
|
* @returns {Promise<Models.ColumnString>}
|
|
1397
|
+
* @deprecated This API has been deprecated since 1.8.0. Please use `TablesDB.updateTextColumn` instead.
|
|
1245
1398
|
*/
|
|
1246
1399
|
updateStringColumn(params: {
|
|
1247
1400
|
databaseId: string;
|
|
@@ -1268,6 +1421,78 @@ declare class TablesDB {
|
|
|
1268
1421
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1269
1422
|
*/
|
|
1270
1423
|
updateStringColumn(databaseId: string, tableId: string, key: string, required: boolean, xdefault?: string, size?: number, newKey?: string): Promise<Models.ColumnString>;
|
|
1424
|
+
/**
|
|
1425
|
+
* Create a text column.
|
|
1426
|
+
*
|
|
1427
|
+
*
|
|
1428
|
+
* @param {string} params.databaseId - Database ID.
|
|
1429
|
+
* @param {string} params.tableId - Table ID. You can create a new table using the Database service [server integration](https://appwrite.io/docs/references/cloud/server-dart/tablesDB#createTable).
|
|
1430
|
+
* @param {string} params.key - Column Key.
|
|
1431
|
+
* @param {boolean} params.required - Is column required?
|
|
1432
|
+
* @param {string} params.xdefault - Default value for column when not provided. Cannot be set when column is required.
|
|
1433
|
+
* @param {boolean} params.array - Is column an array?
|
|
1434
|
+
* @throws {AppwriteException}
|
|
1435
|
+
* @returns {Promise<Models.ColumnText>}
|
|
1436
|
+
*/
|
|
1437
|
+
createTextColumn(params: {
|
|
1438
|
+
databaseId: string;
|
|
1439
|
+
tableId: string;
|
|
1440
|
+
key: string;
|
|
1441
|
+
required: boolean;
|
|
1442
|
+
xdefault?: string;
|
|
1443
|
+
array?: boolean;
|
|
1444
|
+
}): Promise<Models.ColumnText>;
|
|
1445
|
+
/**
|
|
1446
|
+
* Create a text column.
|
|
1447
|
+
*
|
|
1448
|
+
*
|
|
1449
|
+
* @param {string} databaseId - Database ID.
|
|
1450
|
+
* @param {string} tableId - Table ID. You can create a new table using the Database service [server integration](https://appwrite.io/docs/references/cloud/server-dart/tablesDB#createTable).
|
|
1451
|
+
* @param {string} key - Column Key.
|
|
1452
|
+
* @param {boolean} required - Is column required?
|
|
1453
|
+
* @param {string} xdefault - Default value for column when not provided. Cannot be set when column is required.
|
|
1454
|
+
* @param {boolean} array - Is column an array?
|
|
1455
|
+
* @throws {AppwriteException}
|
|
1456
|
+
* @returns {Promise<Models.ColumnText>}
|
|
1457
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1458
|
+
*/
|
|
1459
|
+
createTextColumn(databaseId: string, tableId: string, key: string, required: boolean, xdefault?: string, array?: boolean): Promise<Models.ColumnText>;
|
|
1460
|
+
/**
|
|
1461
|
+
* Update a text column. Changing the `default` value will not update already existing rows.
|
|
1462
|
+
*
|
|
1463
|
+
*
|
|
1464
|
+
* @param {string} params.databaseId - Database ID.
|
|
1465
|
+
* @param {string} params.tableId - Table ID. You can create a new table using the Database service [server integration](https://appwrite.io/docs/references/cloud/server-dart/tablesDB#createTable).
|
|
1466
|
+
* @param {string} params.key - Column Key.
|
|
1467
|
+
* @param {boolean} params.required - Is column required?
|
|
1468
|
+
* @param {string} params.xdefault - Default value for column when not provided. Cannot be set when column is required.
|
|
1469
|
+
* @param {string} params.newKey - New Column Key.
|
|
1470
|
+
* @throws {AppwriteException}
|
|
1471
|
+
* @returns {Promise<Models.ColumnText>}
|
|
1472
|
+
*/
|
|
1473
|
+
updateTextColumn(params: {
|
|
1474
|
+
databaseId: string;
|
|
1475
|
+
tableId: string;
|
|
1476
|
+
key: string;
|
|
1477
|
+
required: boolean;
|
|
1478
|
+
xdefault?: string;
|
|
1479
|
+
newKey?: string;
|
|
1480
|
+
}): Promise<Models.ColumnText>;
|
|
1481
|
+
/**
|
|
1482
|
+
* Update a text column. Changing the `default` value will not update already existing rows.
|
|
1483
|
+
*
|
|
1484
|
+
*
|
|
1485
|
+
* @param {string} databaseId - Database ID.
|
|
1486
|
+
* @param {string} tableId - Table ID. You can create a new table using the Database service [server integration](https://appwrite.io/docs/references/cloud/server-dart/tablesDB#createTable).
|
|
1487
|
+
* @param {string} key - Column Key.
|
|
1488
|
+
* @param {boolean} required - Is column required?
|
|
1489
|
+
* @param {string} xdefault - Default value for column when not provided. Cannot be set when column is required.
|
|
1490
|
+
* @param {string} newKey - New Column Key.
|
|
1491
|
+
* @throws {AppwriteException}
|
|
1492
|
+
* @returns {Promise<Models.ColumnText>}
|
|
1493
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1494
|
+
*/
|
|
1495
|
+
updateTextColumn(databaseId: string, tableId: string, key: string, required: boolean, xdefault?: string, newKey?: string): Promise<Models.ColumnText>;
|
|
1271
1496
|
/**
|
|
1272
1497
|
* Create a URL column.
|
|
1273
1498
|
*
|
|
@@ -1340,6 +1565,84 @@ declare class TablesDB {
|
|
|
1340
1565
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1341
1566
|
*/
|
|
1342
1567
|
updateUrlColumn(databaseId: string, tableId: string, key: string, required: boolean, xdefault?: string, newKey?: string): Promise<Models.ColumnUrl>;
|
|
1568
|
+
/**
|
|
1569
|
+
* Create a varchar column.
|
|
1570
|
+
*
|
|
1571
|
+
*
|
|
1572
|
+
* @param {string} params.databaseId - Database ID.
|
|
1573
|
+
* @param {string} params.tableId - Table ID. You can create a new table using the Database service [server integration](https://appwrite.io/docs/references/cloud/server-dart/tablesDB#createTable).
|
|
1574
|
+
* @param {string} params.key - Column Key.
|
|
1575
|
+
* @param {number} params.size - Column size for varchar columns, in number of characters. Maximum size is 16381.
|
|
1576
|
+
* @param {boolean} params.required - Is column required?
|
|
1577
|
+
* @param {string} params.xdefault - Default value for column when not provided. Cannot be set when column is required.
|
|
1578
|
+
* @param {boolean} params.array - Is column an array?
|
|
1579
|
+
* @throws {AppwriteException}
|
|
1580
|
+
* @returns {Promise<Models.ColumnVarchar>}
|
|
1581
|
+
*/
|
|
1582
|
+
createVarcharColumn(params: {
|
|
1583
|
+
databaseId: string;
|
|
1584
|
+
tableId: string;
|
|
1585
|
+
key: string;
|
|
1586
|
+
size: number;
|
|
1587
|
+
required: boolean;
|
|
1588
|
+
xdefault?: string;
|
|
1589
|
+
array?: boolean;
|
|
1590
|
+
}): Promise<Models.ColumnVarchar>;
|
|
1591
|
+
/**
|
|
1592
|
+
* Create a varchar column.
|
|
1593
|
+
*
|
|
1594
|
+
*
|
|
1595
|
+
* @param {string} databaseId - Database ID.
|
|
1596
|
+
* @param {string} tableId - Table ID. You can create a new table using the Database service [server integration](https://appwrite.io/docs/references/cloud/server-dart/tablesDB#createTable).
|
|
1597
|
+
* @param {string} key - Column Key.
|
|
1598
|
+
* @param {number} size - Column size for varchar columns, in number of characters. Maximum size is 16381.
|
|
1599
|
+
* @param {boolean} required - Is column required?
|
|
1600
|
+
* @param {string} xdefault - Default value for column when not provided. Cannot be set when column is required.
|
|
1601
|
+
* @param {boolean} array - Is column an array?
|
|
1602
|
+
* @throws {AppwriteException}
|
|
1603
|
+
* @returns {Promise<Models.ColumnVarchar>}
|
|
1604
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1605
|
+
*/
|
|
1606
|
+
createVarcharColumn(databaseId: string, tableId: string, key: string, size: number, required: boolean, xdefault?: string, array?: boolean): Promise<Models.ColumnVarchar>;
|
|
1607
|
+
/**
|
|
1608
|
+
* Update a varchar column. Changing the `default` value will not update already existing rows.
|
|
1609
|
+
*
|
|
1610
|
+
*
|
|
1611
|
+
* @param {string} params.databaseId - Database ID.
|
|
1612
|
+
* @param {string} params.tableId - Table ID. You can create a new table using the Database service [server integration](https://appwrite.io/docs/references/cloud/server-dart/tablesDB#createTable).
|
|
1613
|
+
* @param {string} params.key - Column Key.
|
|
1614
|
+
* @param {boolean} params.required - Is column required?
|
|
1615
|
+
* @param {string} params.xdefault - Default value for column when not provided. Cannot be set when column is required.
|
|
1616
|
+
* @param {number} params.size - Maximum size of the varchar column.
|
|
1617
|
+
* @param {string} params.newKey - New Column Key.
|
|
1618
|
+
* @throws {AppwriteException}
|
|
1619
|
+
* @returns {Promise<Models.ColumnVarchar>}
|
|
1620
|
+
*/
|
|
1621
|
+
updateVarcharColumn(params: {
|
|
1622
|
+
databaseId: string;
|
|
1623
|
+
tableId: string;
|
|
1624
|
+
key: string;
|
|
1625
|
+
required: boolean;
|
|
1626
|
+
xdefault?: string;
|
|
1627
|
+
size?: number;
|
|
1628
|
+
newKey?: string;
|
|
1629
|
+
}): Promise<Models.ColumnVarchar>;
|
|
1630
|
+
/**
|
|
1631
|
+
* Update a varchar column. Changing the `default` value will not update already existing rows.
|
|
1632
|
+
*
|
|
1633
|
+
*
|
|
1634
|
+
* @param {string} databaseId - Database ID.
|
|
1635
|
+
* @param {string} tableId - Table ID. You can create a new table using the Database service [server integration](https://appwrite.io/docs/references/cloud/server-dart/tablesDB#createTable).
|
|
1636
|
+
* @param {string} key - Column Key.
|
|
1637
|
+
* @param {boolean} required - Is column required?
|
|
1638
|
+
* @param {string} xdefault - Default value for column when not provided. Cannot be set when column is required.
|
|
1639
|
+
* @param {number} size - Maximum size of the varchar column.
|
|
1640
|
+
* @param {string} newKey - New Column Key.
|
|
1641
|
+
* @throws {AppwriteException}
|
|
1642
|
+
* @returns {Promise<Models.ColumnVarchar>}
|
|
1643
|
+
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1644
|
+
*/
|
|
1645
|
+
updateVarcharColumn(databaseId: string, tableId: string, key: string, required: boolean, xdefault?: string, size?: number, newKey?: string): Promise<Models.ColumnVarchar>;
|
|
1343
1646
|
/**
|
|
1344
1647
|
* Get column by ID.
|
|
1345
1648
|
*
|
|
@@ -1347,13 +1650,13 @@ declare class TablesDB {
|
|
|
1347
1650
|
* @param {string} params.tableId - Table ID.
|
|
1348
1651
|
* @param {string} params.key - Column Key.
|
|
1349
1652
|
* @throws {AppwriteException}
|
|
1350
|
-
* @returns {Promise<
|
|
1653
|
+
* @returns {Promise<Models.ColumnBoolean | Models.ColumnInteger | Models.ColumnFloat | Models.ColumnEmail | Models.ColumnEnum | Models.ColumnUrl | Models.ColumnIp | Models.ColumnDatetime | Models.ColumnRelationship | Models.ColumnString>}
|
|
1351
1654
|
*/
|
|
1352
1655
|
getColumn(params: {
|
|
1353
1656
|
databaseId: string;
|
|
1354
1657
|
tableId: string;
|
|
1355
1658
|
key: string;
|
|
1356
|
-
}): Promise<
|
|
1659
|
+
}): Promise<Models.ColumnBoolean | Models.ColumnInteger | Models.ColumnFloat | Models.ColumnEmail | Models.ColumnEnum | Models.ColumnUrl | Models.ColumnIp | Models.ColumnDatetime | Models.ColumnRelationship | Models.ColumnString>;
|
|
1357
1660
|
/**
|
|
1358
1661
|
* Get column by ID.
|
|
1359
1662
|
*
|
|
@@ -1361,10 +1664,10 @@ declare class TablesDB {
|
|
|
1361
1664
|
* @param {string} tableId - Table ID.
|
|
1362
1665
|
* @param {string} key - Column Key.
|
|
1363
1666
|
* @throws {AppwriteException}
|
|
1364
|
-
* @returns {Promise<
|
|
1667
|
+
* @returns {Promise<Models.ColumnBoolean | Models.ColumnInteger | Models.ColumnFloat | Models.ColumnEmail | Models.ColumnEnum | Models.ColumnUrl | Models.ColumnIp | Models.ColumnDatetime | Models.ColumnRelationship | Models.ColumnString>}
|
|
1365
1668
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1366
1669
|
*/
|
|
1367
|
-
getColumn(databaseId: string, tableId: string, key: string): Promise<
|
|
1670
|
+
getColumn(databaseId: string, tableId: string, key: string): Promise<Models.ColumnBoolean | Models.ColumnInteger | Models.ColumnFloat | Models.ColumnEmail | Models.ColumnEnum | Models.ColumnUrl | Models.ColumnIp | Models.ColumnDatetime | Models.ColumnRelationship | Models.ColumnString>;
|
|
1368
1671
|
/**
|
|
1369
1672
|
* Deletes a column.
|
|
1370
1673
|
*
|
|
@@ -1460,7 +1763,7 @@ declare class TablesDB {
|
|
|
1460
1763
|
* @param {string} params.key - Index Key.
|
|
1461
1764
|
* @param {IndexType} params.type - Index type.
|
|
1462
1765
|
* @param {string[]} params.columns - Array of columns to index. Maximum of 100 columns are allowed, each 32 characters long.
|
|
1463
|
-
* @param {
|
|
1766
|
+
* @param {OrderBy[]} params.orders - Array of index orders. Maximum of 100 orders are allowed.
|
|
1464
1767
|
* @param {number[]} params.lengths - Length of index. Maximum of 100
|
|
1465
1768
|
* @throws {AppwriteException}
|
|
1466
1769
|
* @returns {Promise<Models.ColumnIndex>}
|
|
@@ -1471,7 +1774,7 @@ declare class TablesDB {
|
|
|
1471
1774
|
key: string;
|
|
1472
1775
|
type: IndexType;
|
|
1473
1776
|
columns: string[];
|
|
1474
|
-
orders?:
|
|
1777
|
+
orders?: OrderBy[];
|
|
1475
1778
|
lengths?: number[];
|
|
1476
1779
|
}): Promise<Models.ColumnIndex>;
|
|
1477
1780
|
/**
|
|
@@ -1483,13 +1786,13 @@ declare class TablesDB {
|
|
|
1483
1786
|
* @param {string} key - Index Key.
|
|
1484
1787
|
* @param {IndexType} type - Index type.
|
|
1485
1788
|
* @param {string[]} columns - Array of columns to index. Maximum of 100 columns are allowed, each 32 characters long.
|
|
1486
|
-
* @param {
|
|
1789
|
+
* @param {OrderBy[]} orders - Array of index orders. Maximum of 100 orders are allowed.
|
|
1487
1790
|
* @param {number[]} lengths - Length of index. Maximum of 100
|
|
1488
1791
|
* @throws {AppwriteException}
|
|
1489
1792
|
* @returns {Promise<Models.ColumnIndex>}
|
|
1490
1793
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1491
1794
|
*/
|
|
1492
|
-
createIndex(databaseId: string, tableId: string, key: string, type: IndexType, columns: string[], orders?:
|
|
1795
|
+
createIndex(databaseId: string, tableId: string, key: string, type: IndexType, columns: string[], orders?: OrderBy[], lengths?: number[]): Promise<Models.ColumnIndex>;
|
|
1493
1796
|
/**
|
|
1494
1797
|
* Get index by ID.
|
|
1495
1798
|
*
|