node-appwrite 20.0.0 → 20.1.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/client.js +2 -2
- package/dist/client.js.map +1 -1
- package/dist/client.mjs +2 -2
- package/dist/client.mjs.map +1 -1
- package/dist/services/account.d.mts +49 -0
- package/dist/services/account.d.ts +49 -0
- package/dist/services/account.js +70 -4
- package/dist/services/account.js.map +1 -1
- package/dist/services/account.mjs +70 -4
- package/dist/services/account.mjs.map +1 -1
- package/dist/services/functions.d.mts +2 -2
- package/dist/services/functions.d.ts +2 -2
- package/dist/services/functions.js.map +1 -1
- package/dist/services/functions.mjs.map +1 -1
- package/dist/services/sites.d.mts +2 -2
- package/dist/services/sites.d.ts +2 -2
- package/dist/services/sites.js.map +1 -1
- package/dist/services/sites.mjs.map +1 -1
- package/dist/services/tables-db.d.mts +50 -50
- package/dist/services/tables-db.d.ts +50 -50
- package/dist/services/tables-db.js.map +1 -1
- package/dist/services/tables-db.mjs.map +1 -1
- package/package.json +1 -1
|
@@ -156,7 +156,7 @@ declare class TablesDB {
|
|
|
156
156
|
*/
|
|
157
157
|
listTables(databaseId: string, queries?: string[], search?: string): Promise<Models.TableList>;
|
|
158
158
|
/**
|
|
159
|
-
* Create a new Table. Before using this route, you should create a new database resource using either a [server integration](https://appwrite.io/docs/server/
|
|
159
|
+
* 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.
|
|
160
160
|
*
|
|
161
161
|
* @param {string} params.databaseId - Database ID.
|
|
162
162
|
* @param {string} params.tableId - Unique Id. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.
|
|
@@ -176,7 +176,7 @@ declare class TablesDB {
|
|
|
176
176
|
enabled?: boolean;
|
|
177
177
|
}): Promise<Models.Table>;
|
|
178
178
|
/**
|
|
179
|
-
* Create a new Table. Before using this route, you should create a new database resource using either a [server integration](https://appwrite.io/docs/server/
|
|
179
|
+
* 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.
|
|
180
180
|
*
|
|
181
181
|
* @param {string} databaseId - Database ID.
|
|
182
182
|
* @param {string} tableId - Unique Id. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.
|
|
@@ -297,7 +297,7 @@ declare class TablesDB {
|
|
|
297
297
|
*
|
|
298
298
|
*
|
|
299
299
|
* @param {string} params.databaseId - Database ID.
|
|
300
|
-
* @param {string} params.tableId - Table ID. You can create a new table using the Database service [server integration](https://appwrite.io/docs/server/
|
|
300
|
+
* @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).
|
|
301
301
|
* @param {string} params.key - Column Key.
|
|
302
302
|
* @param {boolean} params.required - Is column required?
|
|
303
303
|
* @param {boolean} params.xdefault - Default value for column when not provided. Cannot be set when column is required.
|
|
@@ -318,7 +318,7 @@ declare class TablesDB {
|
|
|
318
318
|
*
|
|
319
319
|
*
|
|
320
320
|
* @param {string} databaseId - Database ID.
|
|
321
|
-
* @param {string} tableId - Table ID. You can create a new table using the Database service [server integration](https://appwrite.io/docs/server/
|
|
321
|
+
* @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).
|
|
322
322
|
* @param {string} key - Column Key.
|
|
323
323
|
* @param {boolean} required - Is column required?
|
|
324
324
|
* @param {boolean} xdefault - Default value for column when not provided. Cannot be set when column is required.
|
|
@@ -332,7 +332,7 @@ declare class TablesDB {
|
|
|
332
332
|
* Update a boolean column. Changing the `default` value will not update already existing rows.
|
|
333
333
|
*
|
|
334
334
|
* @param {string} params.databaseId - Database ID.
|
|
335
|
-
* @param {string} params.tableId - Table ID. You can create a new table using the Database service [server integration](https://appwrite.io/docs/server/
|
|
335
|
+
* @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).
|
|
336
336
|
* @param {string} params.key - Column Key.
|
|
337
337
|
* @param {boolean} params.required - Is column required?
|
|
338
338
|
* @param {boolean} params.xdefault - Default value for column when not provided. Cannot be set when column is required.
|
|
@@ -352,7 +352,7 @@ declare class TablesDB {
|
|
|
352
352
|
* Update a boolean column. Changing the `default` value will not update already existing rows.
|
|
353
353
|
*
|
|
354
354
|
* @param {string} databaseId - Database ID.
|
|
355
|
-
* @param {string} tableId - Table ID. You can create a new table using the Database service [server integration](https://appwrite.io/docs/server/
|
|
355
|
+
* @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).
|
|
356
356
|
* @param {string} key - Column Key.
|
|
357
357
|
* @param {boolean} required - Is column required?
|
|
358
358
|
* @param {boolean} xdefault - Default value for column when not provided. Cannot be set when column is required.
|
|
@@ -822,7 +822,7 @@ declare class TablesDB {
|
|
|
822
822
|
* Create a geometric line column.
|
|
823
823
|
*
|
|
824
824
|
* @param {string} params.databaseId - Database ID.
|
|
825
|
-
* @param {string} params.tableId - Table ID. You can create a new table using the TablesDB service [server integration](https://appwrite.io/docs/server/
|
|
825
|
+
* @param {string} params.tableId - Table ID. You can create a new table using the TablesDB service [server integration](https://appwrite.io/docs/references/cloud/server-dart/tablesDB#createTable).
|
|
826
826
|
* @param {string} params.key - Column Key.
|
|
827
827
|
* @param {boolean} params.required - Is column required?
|
|
828
828
|
* @param {any[]} params.xdefault - Default value for column when not provided, two-dimensional array of coordinate pairs, [[longitude, latitude], [longitude, latitude], …], listing the vertices of the line in order. Cannot be set when column is required.
|
|
@@ -840,7 +840,7 @@ declare class TablesDB {
|
|
|
840
840
|
* Create a geometric line column.
|
|
841
841
|
*
|
|
842
842
|
* @param {string} databaseId - Database ID.
|
|
843
|
-
* @param {string} tableId - Table ID. You can create a new table using the TablesDB service [server integration](https://appwrite.io/docs/server/
|
|
843
|
+
* @param {string} tableId - Table ID. You can create a new table using the TablesDB service [server integration](https://appwrite.io/docs/references/cloud/server-dart/tablesDB#createTable).
|
|
844
844
|
* @param {string} key - Column Key.
|
|
845
845
|
* @param {boolean} required - Is column required?
|
|
846
846
|
* @param {any[]} xdefault - Default value for column when not provided, two-dimensional array of coordinate pairs, [[longitude, latitude], [longitude, latitude], …], listing the vertices of the line in order. Cannot be set when column is required.
|
|
@@ -853,7 +853,7 @@ declare class TablesDB {
|
|
|
853
853
|
* Update a line column. Changing the `default` value will not update already existing rows.
|
|
854
854
|
*
|
|
855
855
|
* @param {string} params.databaseId - Database ID.
|
|
856
|
-
* @param {string} params.tableId - Table ID. You can create a new table using the TablesDB service [server integration](https://appwrite.io/docs/server/
|
|
856
|
+
* @param {string} params.tableId - Table ID. You can create a new table using the TablesDB service [server integration](https://appwrite.io/docs/references/cloud/server-dart/tablesDB#createTable).
|
|
857
857
|
* @param {string} params.key - Column Key.
|
|
858
858
|
* @param {boolean} params.required - Is column required?
|
|
859
859
|
* @param {any[]} params.xdefault - Default value for column when not provided, two-dimensional array of coordinate pairs, [[longitude, latitude], [longitude, latitude], …], listing the vertices of the line in order. Cannot be set when column is required.
|
|
@@ -873,7 +873,7 @@ declare class TablesDB {
|
|
|
873
873
|
* Update a line column. Changing the `default` value will not update already existing rows.
|
|
874
874
|
*
|
|
875
875
|
* @param {string} databaseId - Database ID.
|
|
876
|
-
* @param {string} tableId - Table ID. You can create a new table using the TablesDB service [server integration](https://appwrite.io/docs/server/
|
|
876
|
+
* @param {string} tableId - Table ID. You can create a new table using the TablesDB service [server integration](https://appwrite.io/docs/references/cloud/server-dart/tablesDB#createTable).
|
|
877
877
|
* @param {string} key - Column Key.
|
|
878
878
|
* @param {boolean} required - Is column required?
|
|
879
879
|
* @param {any[]} xdefault - Default value for column when not provided, two-dimensional array of coordinate pairs, [[longitude, latitude], [longitude, latitude], …], listing the vertices of the line in order. Cannot be set when column is required.
|
|
@@ -887,7 +887,7 @@ declare class TablesDB {
|
|
|
887
887
|
* Create a geometric point column.
|
|
888
888
|
*
|
|
889
889
|
* @param {string} params.databaseId - Database ID.
|
|
890
|
-
* @param {string} params.tableId - Table ID. You can create a new table using the TablesDB service [server integration](https://appwrite.io/docs/server/
|
|
890
|
+
* @param {string} params.tableId - Table ID. You can create a new table using the TablesDB service [server integration](https://appwrite.io/docs/references/cloud/server-dart/tablesDB#createTable).
|
|
891
891
|
* @param {string} params.key - Column Key.
|
|
892
892
|
* @param {boolean} params.required - Is column required?
|
|
893
893
|
* @param {any[]} params.xdefault - Default value for column when not provided, array of two numbers [longitude, latitude], representing a single coordinate. Cannot be set when column is required.
|
|
@@ -905,7 +905,7 @@ declare class TablesDB {
|
|
|
905
905
|
* Create a geometric point column.
|
|
906
906
|
*
|
|
907
907
|
* @param {string} databaseId - Database ID.
|
|
908
|
-
* @param {string} tableId - Table ID. You can create a new table using the TablesDB service [server integration](https://appwrite.io/docs/server/
|
|
908
|
+
* @param {string} tableId - Table ID. You can create a new table using the TablesDB service [server integration](https://appwrite.io/docs/references/cloud/server-dart/tablesDB#createTable).
|
|
909
909
|
* @param {string} key - Column Key.
|
|
910
910
|
* @param {boolean} required - Is column required?
|
|
911
911
|
* @param {any[]} xdefault - Default value for column when not provided, array of two numbers [longitude, latitude], representing a single coordinate. Cannot be set when column is required.
|
|
@@ -918,7 +918,7 @@ declare class TablesDB {
|
|
|
918
918
|
* Update a point column. Changing the `default` value will not update already existing rows.
|
|
919
919
|
*
|
|
920
920
|
* @param {string} params.databaseId - Database ID.
|
|
921
|
-
* @param {string} params.tableId - Table ID. You can create a new table using the TablesDB service [server integration](https://appwrite.io/docs/server/
|
|
921
|
+
* @param {string} params.tableId - Table ID. You can create a new table using the TablesDB service [server integration](https://appwrite.io/docs/references/cloud/server-dart/tablesDB#createTable).
|
|
922
922
|
* @param {string} params.key - Column Key.
|
|
923
923
|
* @param {boolean} params.required - Is column required?
|
|
924
924
|
* @param {any[]} params.xdefault - Default value for column when not provided, array of two numbers [longitude, latitude], representing a single coordinate. Cannot be set when column is required.
|
|
@@ -938,7 +938,7 @@ declare class TablesDB {
|
|
|
938
938
|
* Update a point column. Changing the `default` value will not update already existing rows.
|
|
939
939
|
*
|
|
940
940
|
* @param {string} databaseId - Database ID.
|
|
941
|
-
* @param {string} tableId - Table ID. You can create a new table using the TablesDB service [server integration](https://appwrite.io/docs/server/
|
|
941
|
+
* @param {string} tableId - Table ID. You can create a new table using the TablesDB service [server integration](https://appwrite.io/docs/references/cloud/server-dart/tablesDB#createTable).
|
|
942
942
|
* @param {string} key - Column Key.
|
|
943
943
|
* @param {boolean} required - Is column required?
|
|
944
944
|
* @param {any[]} xdefault - Default value for column when not provided, array of two numbers [longitude, latitude], representing a single coordinate. Cannot be set when column is required.
|
|
@@ -952,7 +952,7 @@ declare class TablesDB {
|
|
|
952
952
|
* Create a geometric polygon column.
|
|
953
953
|
*
|
|
954
954
|
* @param {string} params.databaseId - Database ID.
|
|
955
|
-
* @param {string} params.tableId - Table ID. You can create a new table using the TablesDB service [server integration](https://appwrite.io/docs/server/
|
|
955
|
+
* @param {string} params.tableId - Table ID. You can create a new table using the TablesDB service [server integration](https://appwrite.io/docs/references/cloud/server-dart/tablesDB#createTable).
|
|
956
956
|
* @param {string} params.key - Column Key.
|
|
957
957
|
* @param {boolean} params.required - Is column required?
|
|
958
958
|
* @param {any[]} params.xdefault - Default value for column when not provided, three-dimensional array where the outer array holds one or more linear rings, [[[longitude, latitude], …], …], the first ring is the exterior boundary, any additional rings are interior holes, and each ring must start and end with the same coordinate pair. Cannot be set when column is required.
|
|
@@ -970,7 +970,7 @@ declare class TablesDB {
|
|
|
970
970
|
* Create a geometric polygon column.
|
|
971
971
|
*
|
|
972
972
|
* @param {string} databaseId - Database ID.
|
|
973
|
-
* @param {string} tableId - Table ID. You can create a new table using the TablesDB service [server integration](https://appwrite.io/docs/server/
|
|
973
|
+
* @param {string} tableId - Table ID. You can create a new table using the TablesDB service [server integration](https://appwrite.io/docs/references/cloud/server-dart/tablesDB#createTable).
|
|
974
974
|
* @param {string} key - Column Key.
|
|
975
975
|
* @param {boolean} required - Is column required?
|
|
976
976
|
* @param {any[]} xdefault - Default value for column when not provided, three-dimensional array where the outer array holds one or more linear rings, [[[longitude, latitude], …], …], the first ring is the exterior boundary, any additional rings are interior holes, and each ring must start and end with the same coordinate pair. Cannot be set when column is required.
|
|
@@ -983,7 +983,7 @@ declare class TablesDB {
|
|
|
983
983
|
* Update a polygon column. Changing the `default` value will not update already existing rows.
|
|
984
984
|
*
|
|
985
985
|
* @param {string} params.databaseId - Database ID.
|
|
986
|
-
* @param {string} params.tableId - Table ID. You can create a new table using the TablesDB service [server integration](https://appwrite.io/docs/server/
|
|
986
|
+
* @param {string} params.tableId - Table ID. You can create a new table using the TablesDB service [server integration](https://appwrite.io/docs/references/cloud/server-dart/tablesDB#createTable).
|
|
987
987
|
* @param {string} params.key - Column Key.
|
|
988
988
|
* @param {boolean} params.required - Is column required?
|
|
989
989
|
* @param {any[]} params.xdefault - Default value for column when not provided, three-dimensional array where the outer array holds one or more linear rings, [[[longitude, latitude], …], …], the first ring is the exterior boundary, any additional rings are interior holes, and each ring must start and end with the same coordinate pair. Cannot be set when column is required.
|
|
@@ -1003,7 +1003,7 @@ declare class TablesDB {
|
|
|
1003
1003
|
* Update a polygon column. Changing the `default` value will not update already existing rows.
|
|
1004
1004
|
*
|
|
1005
1005
|
* @param {string} databaseId - Database ID.
|
|
1006
|
-
* @param {string} tableId - Table ID. You can create a new table using the TablesDB service [server integration](https://appwrite.io/docs/server/
|
|
1006
|
+
* @param {string} tableId - Table ID. You can create a new table using the TablesDB service [server integration](https://appwrite.io/docs/references/cloud/server-dart/tablesDB#createTable).
|
|
1007
1007
|
* @param {string} key - Column Key.
|
|
1008
1008
|
* @param {boolean} required - Is column required?
|
|
1009
1009
|
* @param {any[]} xdefault - Default value for column when not provided, three-dimensional array where the outer array holds one or more linear rings, [[[longitude, latitude], …], …], the first ring is the exterior boundary, any additional rings are interior holes, and each ring must start and end with the same coordinate pair. Cannot be set when column is required.
|
|
@@ -1060,7 +1060,7 @@ declare class TablesDB {
|
|
|
1060
1060
|
*
|
|
1061
1061
|
*
|
|
1062
1062
|
* @param {string} params.databaseId - Database ID.
|
|
1063
|
-
* @param {string} params.tableId - Table ID. You can create a new table using the Database service [server integration](https://appwrite.io/docs/server/
|
|
1063
|
+
* @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).
|
|
1064
1064
|
* @param {string} params.key - Column Key.
|
|
1065
1065
|
* @param {number} params.size - Column size for text columns, in number of characters.
|
|
1066
1066
|
* @param {boolean} params.required - Is column required?
|
|
@@ -1085,7 +1085,7 @@ declare class TablesDB {
|
|
|
1085
1085
|
*
|
|
1086
1086
|
*
|
|
1087
1087
|
* @param {string} databaseId - Database ID.
|
|
1088
|
-
* @param {string} tableId - Table ID. You can create a new table using the Database service [server integration](https://appwrite.io/docs/server/
|
|
1088
|
+
* @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).
|
|
1089
1089
|
* @param {string} key - Column Key.
|
|
1090
1090
|
* @param {number} size - Column size for text columns, in number of characters.
|
|
1091
1091
|
* @param {boolean} required - Is column required?
|
|
@@ -1102,7 +1102,7 @@ declare class TablesDB {
|
|
|
1102
1102
|
*
|
|
1103
1103
|
*
|
|
1104
1104
|
* @param {string} params.databaseId - Database ID.
|
|
1105
|
-
* @param {string} params.tableId - Table ID. You can create a new table using the Database service [server integration](https://appwrite.io/docs/server/
|
|
1105
|
+
* @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).
|
|
1106
1106
|
* @param {string} params.key - Column Key.
|
|
1107
1107
|
* @param {boolean} params.required - Is column required?
|
|
1108
1108
|
* @param {string} params.xdefault - Default value for column when not provided. Cannot be set when column is required.
|
|
@@ -1125,7 +1125,7 @@ declare class TablesDB {
|
|
|
1125
1125
|
*
|
|
1126
1126
|
*
|
|
1127
1127
|
* @param {string} databaseId - Database ID.
|
|
1128
|
-
* @param {string} tableId - Table ID. You can create a new table using the Database service [server integration](https://appwrite.io/docs/server/
|
|
1128
|
+
* @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).
|
|
1129
1129
|
* @param {string} key - Column Key.
|
|
1130
1130
|
* @param {boolean} required - Is column required?
|
|
1131
1131
|
* @param {string} xdefault - Default value for column when not provided. Cannot be set when column is required.
|
|
@@ -1295,7 +1295,7 @@ declare class TablesDB {
|
|
|
1295
1295
|
* List indexes on the table.
|
|
1296
1296
|
*
|
|
1297
1297
|
* @param {string} params.databaseId - Database ID.
|
|
1298
|
-
* @param {string} params.tableId - Table ID. You can create a new table using the Database service [server integration](https://appwrite.io/docs/server/
|
|
1298
|
+
* @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).
|
|
1299
1299
|
* @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. You may filter on the following columns: key, type, status, attributes, error
|
|
1300
1300
|
* @throws {AppwriteException}
|
|
1301
1301
|
* @returns {Promise<Models.ColumnIndexList>}
|
|
@@ -1309,7 +1309,7 @@ declare class TablesDB {
|
|
|
1309
1309
|
* List indexes on the table.
|
|
1310
1310
|
*
|
|
1311
1311
|
* @param {string} databaseId - Database ID.
|
|
1312
|
-
* @param {string} tableId - Table ID. You can create a new table using the Database service [server integration](https://appwrite.io/docs/server/
|
|
1312
|
+
* @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).
|
|
1313
1313
|
* @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. You may filter on the following columns: key, type, status, attributes, error
|
|
1314
1314
|
* @throws {AppwriteException}
|
|
1315
1315
|
* @returns {Promise<Models.ColumnIndexList>}
|
|
@@ -1321,7 +1321,7 @@ declare class TablesDB {
|
|
|
1321
1321
|
* Type can be `key`, `fulltext`, or `unique`.
|
|
1322
1322
|
*
|
|
1323
1323
|
* @param {string} params.databaseId - Database ID.
|
|
1324
|
-
* @param {string} params.tableId - Table ID. You can create a new table using the Database service [server integration](https://appwrite.io/docs/server/
|
|
1324
|
+
* @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).
|
|
1325
1325
|
* @param {string} params.key - Index Key.
|
|
1326
1326
|
* @param {IndexType} params.type - Index type.
|
|
1327
1327
|
* @param {string[]} params.columns - Array of columns to index. Maximum of 100 columns are allowed, each 32 characters long.
|
|
@@ -1344,7 +1344,7 @@ declare class TablesDB {
|
|
|
1344
1344
|
* Type can be `key`, `fulltext`, or `unique`.
|
|
1345
1345
|
*
|
|
1346
1346
|
* @param {string} databaseId - Database ID.
|
|
1347
|
-
* @param {string} tableId - Table ID. You can create a new table using the Database service [server integration](https://appwrite.io/docs/server/
|
|
1347
|
+
* @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).
|
|
1348
1348
|
* @param {string} key - Index Key.
|
|
1349
1349
|
* @param {IndexType} type - Index type.
|
|
1350
1350
|
* @param {string[]} columns - Array of columns to index. Maximum of 100 columns are allowed, each 32 characters long.
|
|
@@ -1359,7 +1359,7 @@ declare class TablesDB {
|
|
|
1359
1359
|
* Get index by ID.
|
|
1360
1360
|
*
|
|
1361
1361
|
* @param {string} params.databaseId - Database ID.
|
|
1362
|
-
* @param {string} params.tableId - Table ID. You can create a new table using the Database service [server integration](https://appwrite.io/docs/server/
|
|
1362
|
+
* @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).
|
|
1363
1363
|
* @param {string} params.key - Index Key.
|
|
1364
1364
|
* @throws {AppwriteException}
|
|
1365
1365
|
* @returns {Promise<Models.ColumnIndex>}
|
|
@@ -1373,7 +1373,7 @@ declare class TablesDB {
|
|
|
1373
1373
|
* Get index by ID.
|
|
1374
1374
|
*
|
|
1375
1375
|
* @param {string} databaseId - Database ID.
|
|
1376
|
-
* @param {string} tableId - Table ID. You can create a new table using the Database service [server integration](https://appwrite.io/docs/server/
|
|
1376
|
+
* @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).
|
|
1377
1377
|
* @param {string} key - Index Key.
|
|
1378
1378
|
* @throws {AppwriteException}
|
|
1379
1379
|
* @returns {Promise<Models.ColumnIndex>}
|
|
@@ -1384,7 +1384,7 @@ declare class TablesDB {
|
|
|
1384
1384
|
* Delete an index.
|
|
1385
1385
|
*
|
|
1386
1386
|
* @param {string} params.databaseId - Database ID.
|
|
1387
|
-
* @param {string} params.tableId - Table ID. You can create a new table using the
|
|
1387
|
+
* @param {string} params.tableId - Table ID. You can create a new table using the TablesDB service [server integration](https://appwrite.io/docs/references/cloud/server-dart/tablesDB#createTable).
|
|
1388
1388
|
* @param {string} params.key - Index Key.
|
|
1389
1389
|
* @throws {AppwriteException}
|
|
1390
1390
|
* @returns {Promise<{}>}
|
|
@@ -1398,7 +1398,7 @@ declare class TablesDB {
|
|
|
1398
1398
|
* Delete an index.
|
|
1399
1399
|
*
|
|
1400
1400
|
* @param {string} databaseId - Database ID.
|
|
1401
|
-
* @param {string} tableId - Table ID. You can create a new table using the
|
|
1401
|
+
* @param {string} tableId - Table ID. You can create a new table using the TablesDB service [server integration](https://appwrite.io/docs/references/cloud/server-dart/tablesDB#createTable).
|
|
1402
1402
|
* @param {string} key - Index Key.
|
|
1403
1403
|
* @throws {AppwriteException}
|
|
1404
1404
|
* @returns {Promise<{}>}
|
|
@@ -1409,7 +1409,7 @@ declare class TablesDB {
|
|
|
1409
1409
|
* Get a list of all the user's rows in a given table. You can use the query params to filter your results.
|
|
1410
1410
|
*
|
|
1411
1411
|
* @param {string} params.databaseId - Database ID.
|
|
1412
|
-
* @param {string} params.tableId - Table ID. You can create a new table using the
|
|
1412
|
+
* @param {string} params.tableId - Table ID. You can create a new table using the TablesDB service [server integration](https://appwrite.io/docs/products/databases/tables#create-table).
|
|
1413
1413
|
* @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.
|
|
1414
1414
|
* @throws {AppwriteException}
|
|
1415
1415
|
* @returns {Promise<Models.RowList<Row>>}
|
|
@@ -1423,7 +1423,7 @@ declare class TablesDB {
|
|
|
1423
1423
|
* Get a list of all the user's rows in a given table. You can use the query params to filter your results.
|
|
1424
1424
|
*
|
|
1425
1425
|
* @param {string} databaseId - Database ID.
|
|
1426
|
-
* @param {string} tableId - Table ID. You can create a new table using the
|
|
1426
|
+
* @param {string} tableId - Table ID. You can create a new table using the TablesDB service [server integration](https://appwrite.io/docs/products/databases/tables#create-table).
|
|
1427
1427
|
* @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.
|
|
1428
1428
|
* @throws {AppwriteException}
|
|
1429
1429
|
* @returns {Promise<Models.RowList<Row>>}
|
|
@@ -1431,10 +1431,10 @@ declare class TablesDB {
|
|
|
1431
1431
|
*/
|
|
1432
1432
|
listRows<Row extends Models.Row = Models.DefaultRow>(databaseId: string, tableId: string, queries?: string[]): Promise<Models.RowList<Row>>;
|
|
1433
1433
|
/**
|
|
1434
|
-
* Create a new Row. Before using this route, you should create a new table resource using either a [server integration](https://appwrite.io/docs/server/
|
|
1434
|
+
* Create a new Row. Before using this route, you should create a new table resource using either a [server integration](https://appwrite.io/docs/references/cloud/server-dart/tablesDB#createTable) API or directly from your database console.
|
|
1435
1435
|
*
|
|
1436
1436
|
* @param {string} params.databaseId - Database ID.
|
|
1437
|
-
* @param {string} params.tableId - Table ID. You can create a new table using the Database service [server integration](https://appwrite.io/docs/server/
|
|
1437
|
+
* @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). Make sure to define columns before creating rows.
|
|
1438
1438
|
* @param {string} params.rowId - Row ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.
|
|
1439
1439
|
* @param {Row extends Models.DefaultRow ? Partial<Models.Row> & Record<string, any> : Partial<Models.Row> & Omit<Row, keyof Models.Row>} params.data - Row data as JSON object.
|
|
1440
1440
|
* @param {string[]} params.permissions - An array of permissions strings. By default, only the current user is granted all permissions. [Learn more about permissions](https://appwrite.io/docs/permissions).
|
|
@@ -1449,10 +1449,10 @@ declare class TablesDB {
|
|
|
1449
1449
|
permissions?: string[];
|
|
1450
1450
|
}): Promise<Row>;
|
|
1451
1451
|
/**
|
|
1452
|
-
* Create a new Row. Before using this route, you should create a new table resource using either a [server integration](https://appwrite.io/docs/server/
|
|
1452
|
+
* Create a new Row. Before using this route, you should create a new table resource using either a [server integration](https://appwrite.io/docs/references/cloud/server-dart/tablesDB#createTable) API or directly from your database console.
|
|
1453
1453
|
*
|
|
1454
1454
|
* @param {string} databaseId - Database ID.
|
|
1455
|
-
* @param {string} tableId - Table ID. You can create a new table using the Database service [server integration](https://appwrite.io/docs/server/
|
|
1455
|
+
* @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). Make sure to define columns before creating rows.
|
|
1456
1456
|
* @param {string} rowId - Row ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.
|
|
1457
1457
|
* @param {Row extends Models.DefaultRow ? Partial<Models.Row> & Record<string, any> : Partial<Models.Row> & Omit<Row, keyof Models.Row>} data - Row data as JSON object.
|
|
1458
1458
|
* @param {string[]} permissions - An array of permissions strings. By default, only the current user is granted all permissions. [Learn more about permissions](https://appwrite.io/docs/permissions).
|
|
@@ -1462,10 +1462,10 @@ declare class TablesDB {
|
|
|
1462
1462
|
*/
|
|
1463
1463
|
createRow<Row extends Models.Row = Models.DefaultRow>(databaseId: string, tableId: string, rowId: string, data: Row extends Models.DefaultRow ? Partial<Models.Row> & Record<string, any> : Partial<Models.Row> & Omit<Row, keyof Models.Row>, permissions?: string[]): Promise<Row>;
|
|
1464
1464
|
/**
|
|
1465
|
-
* Create new Rows. Before using this route, you should create a new table resource using either a [server integration](https://appwrite.io/docs/server/
|
|
1465
|
+
* Create new Rows. Before using this route, you should create a new table resource using either a [server integration](https://appwrite.io/docs/references/cloud/server-dart/tablesDB#createTable) API or directly from your database console.
|
|
1466
1466
|
*
|
|
1467
1467
|
* @param {string} params.databaseId - Database ID.
|
|
1468
|
-
* @param {string} params.tableId - Table ID. You can create a new table using the Database service [server integration](https://appwrite.io/docs/server/
|
|
1468
|
+
* @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). Make sure to define columns before creating rows.
|
|
1469
1469
|
* @param {object[]} params.rows - Array of rows data as JSON objects.
|
|
1470
1470
|
* @throws {AppwriteException}
|
|
1471
1471
|
* @returns {Promise<Models.RowList<Row>>}
|
|
@@ -1476,10 +1476,10 @@ declare class TablesDB {
|
|
|
1476
1476
|
rows: object[];
|
|
1477
1477
|
}): Promise<Models.RowList<Row>>;
|
|
1478
1478
|
/**
|
|
1479
|
-
* Create new Rows. Before using this route, you should create a new table resource using either a [server integration](https://appwrite.io/docs/server/
|
|
1479
|
+
* Create new Rows. Before using this route, you should create a new table resource using either a [server integration](https://appwrite.io/docs/references/cloud/server-dart/tablesDB#createTable) API or directly from your database console.
|
|
1480
1480
|
*
|
|
1481
1481
|
* @param {string} databaseId - Database ID.
|
|
1482
|
-
* @param {string} tableId - Table ID. You can create a new table using the Database service [server integration](https://appwrite.io/docs/server/
|
|
1482
|
+
* @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). Make sure to define columns before creating rows.
|
|
1483
1483
|
* @param {object[]} rows - Array of rows data as JSON objects.
|
|
1484
1484
|
* @throws {AppwriteException}
|
|
1485
1485
|
* @returns {Promise<Models.RowList<Row>>}
|
|
@@ -1487,7 +1487,7 @@ declare class TablesDB {
|
|
|
1487
1487
|
*/
|
|
1488
1488
|
createRows<Row extends Models.Row = Models.DefaultRow>(databaseId: string, tableId: string, rows: object[]): Promise<Models.RowList<Row>>;
|
|
1489
1489
|
/**
|
|
1490
|
-
* Create or update Rows. Before using this route, you should create a new table resource using either a [server integration](https://appwrite.io/docs/server/
|
|
1490
|
+
* Create or update Rows. Before using this route, you should create a new table resource using either a [server integration](https://appwrite.io/docs/references/cloud/server-dart/tablesDB#createTable) API or directly from your database console.
|
|
1491
1491
|
*
|
|
1492
1492
|
*
|
|
1493
1493
|
* @param {string} params.databaseId - Database ID.
|
|
@@ -1502,7 +1502,7 @@ declare class TablesDB {
|
|
|
1502
1502
|
rows: object[];
|
|
1503
1503
|
}): Promise<Models.RowList<Row>>;
|
|
1504
1504
|
/**
|
|
1505
|
-
* Create or update Rows. Before using this route, you should create a new table resource using either a [server integration](https://appwrite.io/docs/server/
|
|
1505
|
+
* Create or update Rows. Before using this route, you should create a new table resource using either a [server integration](https://appwrite.io/docs/references/cloud/server-dart/tablesDB#createTable) API or directly from your database console.
|
|
1506
1506
|
*
|
|
1507
1507
|
*
|
|
1508
1508
|
* @param {string} databaseId - Database ID.
|
|
@@ -1545,7 +1545,7 @@ declare class TablesDB {
|
|
|
1545
1545
|
* Bulk delete rows using queries, if no queries are passed then all rows are deleted.
|
|
1546
1546
|
*
|
|
1547
1547
|
* @param {string} params.databaseId - Database ID.
|
|
1548
|
-
* @param {string} params.tableId - Table ID. You can create a new table using the Database service [server integration](https://appwrite.io/docs/server/
|
|
1548
|
+
* @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).
|
|
1549
1549
|
* @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.
|
|
1550
1550
|
* @throws {AppwriteException}
|
|
1551
1551
|
* @returns {Promise<Models.RowList<Row>>}
|
|
@@ -1559,7 +1559,7 @@ declare class TablesDB {
|
|
|
1559
1559
|
* Bulk delete rows using queries, if no queries are passed then all rows are deleted.
|
|
1560
1560
|
*
|
|
1561
1561
|
* @param {string} databaseId - Database ID.
|
|
1562
|
-
* @param {string} tableId - Table ID. You can create a new table using the Database service [server integration](https://appwrite.io/docs/server/
|
|
1562
|
+
* @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).
|
|
1563
1563
|
* @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.
|
|
1564
1564
|
* @throws {AppwriteException}
|
|
1565
1565
|
* @returns {Promise<Models.RowList<Row>>}
|
|
@@ -1570,7 +1570,7 @@ declare class TablesDB {
|
|
|
1570
1570
|
* Get a row by its unique ID. This endpoint response returns a JSON object with the row data.
|
|
1571
1571
|
*
|
|
1572
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/server/
|
|
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
1574
|
* @param {string} params.rowId - Row ID.
|
|
1575
1575
|
* @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.
|
|
1576
1576
|
* @throws {AppwriteException}
|
|
@@ -1586,7 +1586,7 @@ declare class TablesDB {
|
|
|
1586
1586
|
* Get a row by its unique ID. This endpoint response returns a JSON object with the row data.
|
|
1587
1587
|
*
|
|
1588
1588
|
* @param {string} databaseId - Database ID.
|
|
1589
|
-
* @param {string} tableId - Table ID. You can create a new table using the Database service [server integration](https://appwrite.io/docs/server/
|
|
1589
|
+
* @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).
|
|
1590
1590
|
* @param {string} rowId - Row ID.
|
|
1591
1591
|
* @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.
|
|
1592
1592
|
* @throws {AppwriteException}
|
|
@@ -1595,7 +1595,7 @@ declare class TablesDB {
|
|
|
1595
1595
|
*/
|
|
1596
1596
|
getRow<Row extends Models.Row = Models.DefaultRow>(databaseId: string, tableId: string, rowId: string, queries?: string[]): Promise<Row>;
|
|
1597
1597
|
/**
|
|
1598
|
-
* Create or update a Row. Before using this route, you should create a new table resource using either a [server integration](https://appwrite.io/docs/server/
|
|
1598
|
+
* Create or update a Row. Before using this route, you should create a new table resource using either a [server integration](https://appwrite.io/docs/references/cloud/server-dart/tablesDB#createTable) API or directly from your database console.
|
|
1599
1599
|
*
|
|
1600
1600
|
* @param {string} params.databaseId - Database ID.
|
|
1601
1601
|
* @param {string} params.tableId - Table ID.
|
|
@@ -1613,7 +1613,7 @@ declare class TablesDB {
|
|
|
1613
1613
|
permissions?: string[];
|
|
1614
1614
|
}): Promise<Row>;
|
|
1615
1615
|
/**
|
|
1616
|
-
* Create or update a Row. Before using this route, you should create a new table resource using either a [server integration](https://appwrite.io/docs/server/
|
|
1616
|
+
* Create or update a Row. Before using this route, you should create a new table resource using either a [server integration](https://appwrite.io/docs/references/cloud/server-dart/tablesDB#createTable) API or directly from your database console.
|
|
1617
1617
|
*
|
|
1618
1618
|
* @param {string} databaseId - Database ID.
|
|
1619
1619
|
* @param {string} tableId - Table ID.
|
|
@@ -1660,7 +1660,7 @@ declare class TablesDB {
|
|
|
1660
1660
|
* Delete a row by its unique ID.
|
|
1661
1661
|
*
|
|
1662
1662
|
* @param {string} params.databaseId - Database ID.
|
|
1663
|
-
* @param {string} params.tableId - Table ID. You can create a new table using the Database service [server integration](https://appwrite.io/docs/server/
|
|
1663
|
+
* @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).
|
|
1664
1664
|
* @param {string} params.rowId - Row ID.
|
|
1665
1665
|
* @throws {AppwriteException}
|
|
1666
1666
|
* @returns {Promise<{}>}
|
|
@@ -1674,7 +1674,7 @@ declare class TablesDB {
|
|
|
1674
1674
|
* Delete a row by its unique ID.
|
|
1675
1675
|
*
|
|
1676
1676
|
* @param {string} databaseId - Database ID.
|
|
1677
|
-
* @param {string} tableId - Table ID. You can create a new table using the Database service [server integration](https://appwrite.io/docs/server/
|
|
1677
|
+
* @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).
|
|
1678
1678
|
* @param {string} rowId - Row ID.
|
|
1679
1679
|
* @throws {AppwriteException}
|
|
1680
1680
|
* @returns {Promise<{}>}
|