node-appwrite 21.1.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 +329 -34
- package/dist/services/databases.d.ts +329 -34
- package/dist/services/databases.js +469 -9
- package/dist/services/databases.js.map +1 -1
- package/dist/services/databases.mjs +469 -9
- 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 +329 -32
- package/dist/services/tables-db.d.ts +329 -32
- package/dist/services/tables-db.js +469 -6
- package/dist/services/tables-db.js.map +1 -1
- package/dist/services/tables-db.mjs +469 -6
- 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
|
*
|
|
@@ -361,7 +362,7 @@ declare class TablesDB {
|
|
|
361
362
|
updateTable(params: {
|
|
362
363
|
databaseId: string;
|
|
363
364
|
tableId: string;
|
|
364
|
-
name
|
|
365
|
+
name?: string;
|
|
365
366
|
permissions?: string[];
|
|
366
367
|
rowSecurity?: boolean;
|
|
367
368
|
enabled?: boolean;
|
|
@@ -379,7 +380,7 @@ declare class TablesDB {
|
|
|
379
380
|
* @returns {Promise<Models.Table>}
|
|
380
381
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
381
382
|
*/
|
|
382
|
-
updateTable(databaseId: string, tableId: string, name
|
|
383
|
+
updateTable(databaseId: string, tableId: string, name?: string, permissions?: string[], rowSecurity?: boolean, enabled?: boolean): Promise<Models.Table>;
|
|
383
384
|
/**
|
|
384
385
|
* Delete a table by its unique ID. Only users with write permissions have access to delete this resource.
|
|
385
386
|
*
|
|
@@ -808,9 +809,9 @@ declare class TablesDB {
|
|
|
808
809
|
* @param {string} params.tableId - Table ID.
|
|
809
810
|
* @param {string} params.key - Column Key.
|
|
810
811
|
* @param {boolean} params.required - Is column required?
|
|
811
|
-
* @param {number} params.min - Minimum value
|
|
812
|
-
* @param {number} params.max - Maximum value
|
|
813
|
-
* @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.
|
|
814
815
|
* @param {boolean} params.array - Is column an array?
|
|
815
816
|
* @throws {AppwriteException}
|
|
816
817
|
* @returns {Promise<Models.ColumnInteger>}
|
|
@@ -820,9 +821,9 @@ declare class TablesDB {
|
|
|
820
821
|
tableId: string;
|
|
821
822
|
key: string;
|
|
822
823
|
required: boolean;
|
|
823
|
-
min?: number;
|
|
824
|
-
max?: number;
|
|
825
|
-
xdefault?: number;
|
|
824
|
+
min?: number | bigint;
|
|
825
|
+
max?: number | bigint;
|
|
826
|
+
xdefault?: number | bigint;
|
|
826
827
|
array?: boolean;
|
|
827
828
|
}): Promise<Models.ColumnInteger>;
|
|
828
829
|
/**
|
|
@@ -833,15 +834,15 @@ declare class TablesDB {
|
|
|
833
834
|
* @param {string} tableId - Table ID.
|
|
834
835
|
* @param {string} key - Column Key.
|
|
835
836
|
* @param {boolean} required - Is column required?
|
|
836
|
-
* @param {number} min - Minimum value
|
|
837
|
-
* @param {number} max - Maximum value
|
|
838
|
-
* @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.
|
|
839
840
|
* @param {boolean} array - Is column an array?
|
|
840
841
|
* @throws {AppwriteException}
|
|
841
842
|
* @returns {Promise<Models.ColumnInteger>}
|
|
842
843
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
843
844
|
*/
|
|
844
|
-
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>;
|
|
845
846
|
/**
|
|
846
847
|
* Update an integer column. Changing the `default` value will not update already existing rows.
|
|
847
848
|
*
|
|
@@ -850,9 +851,9 @@ declare class TablesDB {
|
|
|
850
851
|
* @param {string} params.tableId - Table ID.
|
|
851
852
|
* @param {string} params.key - Column Key.
|
|
852
853
|
* @param {boolean} params.required - Is column required?
|
|
853
|
-
* @param {number} params.xdefault - Default value. Cannot be set when column is required.
|
|
854
|
-
* @param {number} params.min - Minimum value
|
|
855
|
-
* @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
|
|
856
857
|
* @param {string} params.newKey - New Column Key.
|
|
857
858
|
* @throws {AppwriteException}
|
|
858
859
|
* @returns {Promise<Models.ColumnInteger>}
|
|
@@ -862,9 +863,9 @@ declare class TablesDB {
|
|
|
862
863
|
tableId: string;
|
|
863
864
|
key: string;
|
|
864
865
|
required: boolean;
|
|
865
|
-
xdefault?: number;
|
|
866
|
-
min?: number;
|
|
867
|
-
max?: number;
|
|
866
|
+
xdefault?: number | bigint;
|
|
867
|
+
min?: number | bigint;
|
|
868
|
+
max?: number | bigint;
|
|
868
869
|
newKey?: string;
|
|
869
870
|
}): Promise<Models.ColumnInteger>;
|
|
870
871
|
/**
|
|
@@ -875,15 +876,15 @@ declare class TablesDB {
|
|
|
875
876
|
* @param {string} tableId - Table ID.
|
|
876
877
|
* @param {string} key - Column Key.
|
|
877
878
|
* @param {boolean} required - Is column required?
|
|
878
|
-
* @param {number} xdefault - Default value. Cannot be set when column is required.
|
|
879
|
-
* @param {number} min - Minimum value
|
|
880
|
-
* @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
|
|
881
882
|
* @param {string} newKey - New Column Key.
|
|
882
883
|
* @throws {AppwriteException}
|
|
883
884
|
* @returns {Promise<Models.ColumnInteger>}
|
|
884
885
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
885
886
|
*/
|
|
886
|
-
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>;
|
|
887
888
|
/**
|
|
888
889
|
* Create IP address column.
|
|
889
890
|
*
|
|
@@ -1021,6 +1022,150 @@ declare class TablesDB {
|
|
|
1021
1022
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1022
1023
|
*/
|
|
1023
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>;
|
|
1024
1169
|
/**
|
|
1025
1170
|
* Create a geometric point column.
|
|
1026
1171
|
*
|
|
@@ -1207,6 +1352,7 @@ declare class TablesDB {
|
|
|
1207
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.
|
|
1208
1353
|
* @throws {AppwriteException}
|
|
1209
1354
|
* @returns {Promise<Models.ColumnString>}
|
|
1355
|
+
* @deprecated This API has been deprecated since 1.9.0. Please use `TablesDB.createTextColumn` instead.
|
|
1210
1356
|
*/
|
|
1211
1357
|
createStringColumn(params: {
|
|
1212
1358
|
databaseId: string;
|
|
@@ -1248,6 +1394,7 @@ declare class TablesDB {
|
|
|
1248
1394
|
* @param {string} params.newKey - New Column Key.
|
|
1249
1395
|
* @throws {AppwriteException}
|
|
1250
1396
|
* @returns {Promise<Models.ColumnString>}
|
|
1397
|
+
* @deprecated This API has been deprecated since 1.8.0. Please use `TablesDB.updateTextColumn` instead.
|
|
1251
1398
|
*/
|
|
1252
1399
|
updateStringColumn(params: {
|
|
1253
1400
|
databaseId: string;
|
|
@@ -1274,6 +1421,78 @@ declare class TablesDB {
|
|
|
1274
1421
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1275
1422
|
*/
|
|
1276
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>;
|
|
1277
1496
|
/**
|
|
1278
1497
|
* Create a URL column.
|
|
1279
1498
|
*
|
|
@@ -1346,6 +1565,84 @@ declare class TablesDB {
|
|
|
1346
1565
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1347
1566
|
*/
|
|
1348
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>;
|
|
1349
1646
|
/**
|
|
1350
1647
|
* Get column by ID.
|
|
1351
1648
|
*
|
|
@@ -1353,13 +1650,13 @@ declare class TablesDB {
|
|
|
1353
1650
|
* @param {string} params.tableId - Table ID.
|
|
1354
1651
|
* @param {string} params.key - Column Key.
|
|
1355
1652
|
* @throws {AppwriteException}
|
|
1356
|
-
* @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>}
|
|
1357
1654
|
*/
|
|
1358
1655
|
getColumn(params: {
|
|
1359
1656
|
databaseId: string;
|
|
1360
1657
|
tableId: string;
|
|
1361
1658
|
key: string;
|
|
1362
|
-
}): Promise<
|
|
1659
|
+
}): Promise<Models.ColumnBoolean | Models.ColumnInteger | Models.ColumnFloat | Models.ColumnEmail | Models.ColumnEnum | Models.ColumnUrl | Models.ColumnIp | Models.ColumnDatetime | Models.ColumnRelationship | Models.ColumnString>;
|
|
1363
1660
|
/**
|
|
1364
1661
|
* Get column by ID.
|
|
1365
1662
|
*
|
|
@@ -1367,10 +1664,10 @@ declare class TablesDB {
|
|
|
1367
1664
|
* @param {string} tableId - Table ID.
|
|
1368
1665
|
* @param {string} key - Column Key.
|
|
1369
1666
|
* @throws {AppwriteException}
|
|
1370
|
-
* @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>}
|
|
1371
1668
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1372
1669
|
*/
|
|
1373
|
-
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>;
|
|
1374
1671
|
/**
|
|
1375
1672
|
* Deletes a column.
|
|
1376
1673
|
*
|
|
@@ -1466,7 +1763,7 @@ declare class TablesDB {
|
|
|
1466
1763
|
* @param {string} params.key - Index Key.
|
|
1467
1764
|
* @param {IndexType} params.type - Index type.
|
|
1468
1765
|
* @param {string[]} params.columns - Array of columns to index. Maximum of 100 columns are allowed, each 32 characters long.
|
|
1469
|
-
* @param {
|
|
1766
|
+
* @param {OrderBy[]} params.orders - Array of index orders. Maximum of 100 orders are allowed.
|
|
1470
1767
|
* @param {number[]} params.lengths - Length of index. Maximum of 100
|
|
1471
1768
|
* @throws {AppwriteException}
|
|
1472
1769
|
* @returns {Promise<Models.ColumnIndex>}
|
|
@@ -1477,7 +1774,7 @@ declare class TablesDB {
|
|
|
1477
1774
|
key: string;
|
|
1478
1775
|
type: IndexType;
|
|
1479
1776
|
columns: string[];
|
|
1480
|
-
orders?:
|
|
1777
|
+
orders?: OrderBy[];
|
|
1481
1778
|
lengths?: number[];
|
|
1482
1779
|
}): Promise<Models.ColumnIndex>;
|
|
1483
1780
|
/**
|
|
@@ -1489,13 +1786,13 @@ declare class TablesDB {
|
|
|
1489
1786
|
* @param {string} key - Index Key.
|
|
1490
1787
|
* @param {IndexType} type - Index type.
|
|
1491
1788
|
* @param {string[]} columns - Array of columns to index. Maximum of 100 columns are allowed, each 32 characters long.
|
|
1492
|
-
* @param {
|
|
1789
|
+
* @param {OrderBy[]} orders - Array of index orders. Maximum of 100 orders are allowed.
|
|
1493
1790
|
* @param {number[]} lengths - Length of index. Maximum of 100
|
|
1494
1791
|
* @throws {AppwriteException}
|
|
1495
1792
|
* @returns {Promise<Models.ColumnIndex>}
|
|
1496
1793
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1497
1794
|
*/
|
|
1498
|
-
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>;
|
|
1499
1796
|
/**
|
|
1500
1797
|
* Get index by ID.
|
|
1501
1798
|
*
|