node-appwrite 19.2.0-rc.1 → 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.d.mts +10 -0
- package/dist/client.d.ts +10 -0
- 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/enums/attribute-status.d.mts +9 -0
- package/dist/enums/attribute-status.d.ts +9 -0
- package/dist/enums/attribute-status.js +14 -0
- package/dist/enums/attribute-status.js.map +1 -0
- package/dist/enums/attribute-status.mjs +13 -0
- package/dist/enums/attribute-status.mjs.map +1 -0
- package/dist/enums/column-status.d.mts +9 -0
- package/dist/enums/column-status.d.ts +9 -0
- package/dist/enums/column-status.js +14 -0
- package/dist/enums/column-status.js.map +1 -0
- package/dist/enums/column-status.mjs +13 -0
- package/dist/enums/column-status.mjs.map +1 -0
- package/dist/enums/database-type.d.mts +6 -0
- package/dist/enums/database-type.d.ts +6 -0
- package/dist/enums/database-type.js +11 -0
- package/dist/enums/database-type.js.map +1 -0
- package/dist/enums/database-type.mjs +10 -0
- package/dist/enums/database-type.mjs.map +1 -0
- package/dist/enums/deployment-status.d.mts +9 -0
- package/dist/enums/deployment-status.d.ts +9 -0
- package/dist/enums/deployment-status.js +14 -0
- package/dist/enums/deployment-status.js.map +1 -0
- package/dist/enums/deployment-status.mjs +13 -0
- package/dist/enums/deployment-status.mjs.map +1 -0
- package/dist/enums/execution-status.d.mts +8 -0
- package/dist/enums/execution-status.d.ts +8 -0
- package/dist/enums/execution-status.js +13 -0
- package/dist/enums/execution-status.js.map +1 -0
- package/dist/enums/execution-status.mjs +12 -0
- package/dist/enums/execution-status.mjs.map +1 -0
- package/dist/enums/execution-trigger.d.mts +7 -0
- package/dist/enums/execution-trigger.d.ts +7 -0
- package/dist/enums/execution-trigger.js +12 -0
- package/dist/enums/execution-trigger.js.map +1 -0
- package/dist/enums/execution-trigger.mjs +11 -0
- package/dist/enums/execution-trigger.mjs.map +1 -0
- package/dist/enums/health-antivirus-status.d.mts +7 -0
- package/dist/enums/health-antivirus-status.d.ts +7 -0
- package/dist/enums/health-antivirus-status.js +12 -0
- package/dist/enums/health-antivirus-status.js.map +1 -0
- package/dist/enums/health-antivirus-status.mjs +11 -0
- package/dist/enums/health-antivirus-status.mjs.map +1 -0
- package/dist/enums/health-check-status.d.mts +6 -0
- package/dist/enums/health-check-status.d.ts +6 -0
- package/dist/enums/health-check-status.js +11 -0
- package/dist/enums/health-check-status.js.map +1 -0
- package/dist/enums/health-check-status.mjs +10 -0
- package/dist/enums/health-check-status.mjs.map +1 -0
- package/dist/enums/index-status.d.mts +9 -0
- package/dist/enums/index-status.d.ts +9 -0
- package/dist/enums/index-status.js +14 -0
- package/dist/enums/index-status.js.map +1 -0
- package/dist/enums/index-status.mjs +13 -0
- package/dist/enums/index-status.mjs.map +1 -0
- package/dist/enums/message-status.d.mts +9 -0
- package/dist/enums/message-status.d.ts +9 -0
- package/dist/enums/message-status.js +14 -0
- package/dist/enums/message-status.js.map +1 -0
- package/dist/enums/message-status.mjs +13 -0
- package/dist/enums/message-status.mjs.map +1 -0
- package/dist/index.d.mts +10 -0
- package/dist/index.d.ts +10 -0
- package/dist/index.js +50 -0
- package/dist/index.js.map +1 -1
- package/dist/index.mjs +10 -0
- package/dist/index.mjs.map +1 -1
- package/dist/models.d.mts +45 -76
- package/dist/models.d.ts +45 -76
- package/dist/services/account.d.mts +59 -0
- package/dist/services/account.d.ts +59 -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/avatars.d.mts +10 -0
- package/dist/services/avatars.d.ts +10 -0
- package/dist/services/databases.d.mts +24 -173
- package/dist/services/databases.d.ts +24 -173
- package/dist/services/databases.js +12 -239
- package/dist/services/databases.js.map +1 -1
- package/dist/services/databases.mjs +12 -239
- package/dist/services/databases.mjs.map +1 -1
- package/dist/services/functions.d.mts +12 -2
- package/dist/services/functions.d.ts +12 -2
- package/dist/services/functions.js.map +1 -1
- package/dist/services/functions.mjs.map +1 -1
- package/dist/services/graphql.d.mts +10 -0
- package/dist/services/graphql.d.ts +10 -0
- package/dist/services/health.d.mts +10 -0
- package/dist/services/health.d.ts +10 -0
- package/dist/services/locale.d.mts +10 -0
- package/dist/services/locale.d.ts +10 -0
- package/dist/services/messaging.d.mts +10 -0
- package/dist/services/messaging.d.ts +10 -0
- package/dist/services/sites.d.mts +12 -2
- package/dist/services/sites.d.ts +12 -2
- package/dist/services/sites.js.map +1 -1
- package/dist/services/sites.mjs.map +1 -1
- package/dist/services/storage.d.mts +10 -0
- package/dist/services/storage.d.ts +10 -0
- package/dist/services/tables-db.d.mts +72 -221
- package/dist/services/tables-db.d.ts +72 -221
- package/dist/services/tables-db.js +12 -239
- package/dist/services/tables-db.js.map +1 -1
- package/dist/services/tables-db.mjs +12 -239
- package/dist/services/tables-db.mjs.map +1 -1
- package/dist/services/teams.d.mts +10 -0
- package/dist/services/teams.d.ts +10 -0
- package/dist/services/tokens.d.mts +10 -0
- package/dist/services/tokens.d.ts +10 -0
- package/dist/services/users.d.mts +10 -0
- package/dist/services/users.d.ts +10 -0
- package/package.json +1 -1
|
@@ -4,6 +4,16 @@ 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
6
|
import '../query.mjs';
|
|
7
|
+
import '../enums/database-type.mjs';
|
|
8
|
+
import '../enums/attribute-status.mjs';
|
|
9
|
+
import '../enums/column-status.mjs';
|
|
10
|
+
import '../enums/index-status.mjs';
|
|
11
|
+
import '../enums/deployment-status.mjs';
|
|
12
|
+
import '../enums/execution-trigger.mjs';
|
|
13
|
+
import '../enums/execution-status.mjs';
|
|
14
|
+
import '../enums/health-antivirus-status.mjs';
|
|
15
|
+
import '../enums/health-check-status.mjs';
|
|
16
|
+
import '../enums/message-status.mjs';
|
|
7
17
|
|
|
8
18
|
declare class TablesDB {
|
|
9
19
|
client: Client;
|
|
@@ -57,129 +67,6 @@ declare class TablesDB {
|
|
|
57
67
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
58
68
|
*/
|
|
59
69
|
create(databaseId: string, name: string, enabled?: boolean): Promise<Models.Database>;
|
|
60
|
-
/**
|
|
61
|
-
* List transactions across all databases.
|
|
62
|
-
*
|
|
63
|
-
* @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).
|
|
64
|
-
* @throws {AppwriteException}
|
|
65
|
-
* @returns {Promise<Models.TransactionList>}
|
|
66
|
-
*/
|
|
67
|
-
listTransactions(params?: {
|
|
68
|
-
queries?: string[];
|
|
69
|
-
}): Promise<Models.TransactionList>;
|
|
70
|
-
/**
|
|
71
|
-
* List transactions across all databases.
|
|
72
|
-
*
|
|
73
|
-
* @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).
|
|
74
|
-
* @throws {AppwriteException}
|
|
75
|
-
* @returns {Promise<Models.TransactionList>}
|
|
76
|
-
* @deprecated Use the object parameter style method for a better developer experience.
|
|
77
|
-
*/
|
|
78
|
-
listTransactions(queries?: string[]): Promise<Models.TransactionList>;
|
|
79
|
-
/**
|
|
80
|
-
* Create a new transaction.
|
|
81
|
-
*
|
|
82
|
-
* @param {number} params.ttl - Seconds before the transaction expires.
|
|
83
|
-
* @throws {AppwriteException}
|
|
84
|
-
* @returns {Promise<Models.Transaction>}
|
|
85
|
-
*/
|
|
86
|
-
createTransaction(params?: {
|
|
87
|
-
ttl?: number;
|
|
88
|
-
}): Promise<Models.Transaction>;
|
|
89
|
-
/**
|
|
90
|
-
* Create a new transaction.
|
|
91
|
-
*
|
|
92
|
-
* @param {number} ttl - Seconds before the transaction expires.
|
|
93
|
-
* @throws {AppwriteException}
|
|
94
|
-
* @returns {Promise<Models.Transaction>}
|
|
95
|
-
* @deprecated Use the object parameter style method for a better developer experience.
|
|
96
|
-
*/
|
|
97
|
-
createTransaction(ttl?: number): Promise<Models.Transaction>;
|
|
98
|
-
/**
|
|
99
|
-
* Get a transaction by its unique ID.
|
|
100
|
-
*
|
|
101
|
-
* @param {string} params.transactionId - Transaction ID.
|
|
102
|
-
* @throws {AppwriteException}
|
|
103
|
-
* @returns {Promise<Models.Transaction>}
|
|
104
|
-
*/
|
|
105
|
-
getTransaction(params: {
|
|
106
|
-
transactionId: string;
|
|
107
|
-
}): Promise<Models.Transaction>;
|
|
108
|
-
/**
|
|
109
|
-
* Get a transaction by its unique ID.
|
|
110
|
-
*
|
|
111
|
-
* @param {string} transactionId - Transaction ID.
|
|
112
|
-
* @throws {AppwriteException}
|
|
113
|
-
* @returns {Promise<Models.Transaction>}
|
|
114
|
-
* @deprecated Use the object parameter style method for a better developer experience.
|
|
115
|
-
*/
|
|
116
|
-
getTransaction(transactionId: string): Promise<Models.Transaction>;
|
|
117
|
-
/**
|
|
118
|
-
* Update a transaction, to either commit or roll back its operations.
|
|
119
|
-
*
|
|
120
|
-
* @param {string} params.transactionId - Transaction ID.
|
|
121
|
-
* @param {boolean} params.commit - Commit transaction?
|
|
122
|
-
* @param {boolean} params.rollback - Rollback transaction?
|
|
123
|
-
* @throws {AppwriteException}
|
|
124
|
-
* @returns {Promise<Models.Transaction>}
|
|
125
|
-
*/
|
|
126
|
-
updateTransaction(params: {
|
|
127
|
-
transactionId: string;
|
|
128
|
-
commit?: boolean;
|
|
129
|
-
rollback?: boolean;
|
|
130
|
-
}): Promise<Models.Transaction>;
|
|
131
|
-
/**
|
|
132
|
-
* Update a transaction, to either commit or roll back its operations.
|
|
133
|
-
*
|
|
134
|
-
* @param {string} transactionId - Transaction ID.
|
|
135
|
-
* @param {boolean} commit - Commit transaction?
|
|
136
|
-
* @param {boolean} rollback - Rollback transaction?
|
|
137
|
-
* @throws {AppwriteException}
|
|
138
|
-
* @returns {Promise<Models.Transaction>}
|
|
139
|
-
* @deprecated Use the object parameter style method for a better developer experience.
|
|
140
|
-
*/
|
|
141
|
-
updateTransaction(transactionId: string, commit?: boolean, rollback?: boolean): Promise<Models.Transaction>;
|
|
142
|
-
/**
|
|
143
|
-
* Delete a transaction by its unique ID.
|
|
144
|
-
*
|
|
145
|
-
* @param {string} params.transactionId - Transaction ID.
|
|
146
|
-
* @throws {AppwriteException}
|
|
147
|
-
* @returns {Promise<{}>}
|
|
148
|
-
*/
|
|
149
|
-
deleteTransaction(params: {
|
|
150
|
-
transactionId: string;
|
|
151
|
-
}): Promise<{}>;
|
|
152
|
-
/**
|
|
153
|
-
* Delete a transaction by its unique ID.
|
|
154
|
-
*
|
|
155
|
-
* @param {string} transactionId - Transaction ID.
|
|
156
|
-
* @throws {AppwriteException}
|
|
157
|
-
* @returns {Promise<{}>}
|
|
158
|
-
* @deprecated Use the object parameter style method for a better developer experience.
|
|
159
|
-
*/
|
|
160
|
-
deleteTransaction(transactionId: string): Promise<{}>;
|
|
161
|
-
/**
|
|
162
|
-
* Create multiple operations in a single transaction.
|
|
163
|
-
*
|
|
164
|
-
* @param {string} params.transactionId - Transaction ID.
|
|
165
|
-
* @param {object[]} params.operations - Array of staged operations.
|
|
166
|
-
* @throws {AppwriteException}
|
|
167
|
-
* @returns {Promise<Models.Transaction>}
|
|
168
|
-
*/
|
|
169
|
-
createOperations(params: {
|
|
170
|
-
transactionId: string;
|
|
171
|
-
operations?: object[];
|
|
172
|
-
}): Promise<Models.Transaction>;
|
|
173
|
-
/**
|
|
174
|
-
* Create multiple operations in a single transaction.
|
|
175
|
-
*
|
|
176
|
-
* @param {string} transactionId - Transaction ID.
|
|
177
|
-
* @param {object[]} operations - Array of staged operations.
|
|
178
|
-
* @throws {AppwriteException}
|
|
179
|
-
* @returns {Promise<Models.Transaction>}
|
|
180
|
-
* @deprecated Use the object parameter style method for a better developer experience.
|
|
181
|
-
*/
|
|
182
|
-
createOperations(transactionId: string, operations?: object[]): Promise<Models.Transaction>;
|
|
183
70
|
/**
|
|
184
71
|
* Get a database by its unique ID. This endpoint response returns a JSON object with the database metadata.
|
|
185
72
|
*
|
|
@@ -269,7 +156,7 @@ declare class TablesDB {
|
|
|
269
156
|
*/
|
|
270
157
|
listTables(databaseId: string, queries?: string[], search?: string): Promise<Models.TableList>;
|
|
271
158
|
/**
|
|
272
|
-
* 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.
|
|
273
160
|
*
|
|
274
161
|
* @param {string} params.databaseId - Database ID.
|
|
275
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.
|
|
@@ -289,7 +176,7 @@ declare class TablesDB {
|
|
|
289
176
|
enabled?: boolean;
|
|
290
177
|
}): Promise<Models.Table>;
|
|
291
178
|
/**
|
|
292
|
-
* 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.
|
|
293
180
|
*
|
|
294
181
|
* @param {string} databaseId - Database ID.
|
|
295
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.
|
|
@@ -410,7 +297,7 @@ declare class TablesDB {
|
|
|
410
297
|
*
|
|
411
298
|
*
|
|
412
299
|
* @param {string} params.databaseId - Database ID.
|
|
413
|
-
* @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).
|
|
414
301
|
* @param {string} params.key - Column Key.
|
|
415
302
|
* @param {boolean} params.required - Is column required?
|
|
416
303
|
* @param {boolean} params.xdefault - Default value for column when not provided. Cannot be set when column is required.
|
|
@@ -431,7 +318,7 @@ declare class TablesDB {
|
|
|
431
318
|
*
|
|
432
319
|
*
|
|
433
320
|
* @param {string} databaseId - Database ID.
|
|
434
|
-
* @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).
|
|
435
322
|
* @param {string} key - Column Key.
|
|
436
323
|
* @param {boolean} required - Is column required?
|
|
437
324
|
* @param {boolean} xdefault - Default value for column when not provided. Cannot be set when column is required.
|
|
@@ -445,7 +332,7 @@ declare class TablesDB {
|
|
|
445
332
|
* Update a boolean column. Changing the `default` value will not update already existing rows.
|
|
446
333
|
*
|
|
447
334
|
* @param {string} params.databaseId - Database ID.
|
|
448
|
-
* @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).
|
|
449
336
|
* @param {string} params.key - Column Key.
|
|
450
337
|
* @param {boolean} params.required - Is column required?
|
|
451
338
|
* @param {boolean} params.xdefault - Default value for column when not provided. Cannot be set when column is required.
|
|
@@ -465,7 +352,7 @@ declare class TablesDB {
|
|
|
465
352
|
* Update a boolean column. Changing the `default` value will not update already existing rows.
|
|
466
353
|
*
|
|
467
354
|
* @param {string} databaseId - Database ID.
|
|
468
|
-
* @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).
|
|
469
356
|
* @param {string} key - Column Key.
|
|
470
357
|
* @param {boolean} required - Is column required?
|
|
471
358
|
* @param {boolean} xdefault - Default value for column when not provided. Cannot be set when column is required.
|
|
@@ -935,7 +822,7 @@ declare class TablesDB {
|
|
|
935
822
|
* Create a geometric line column.
|
|
936
823
|
*
|
|
937
824
|
* @param {string} params.databaseId - Database ID.
|
|
938
|
-
* @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).
|
|
939
826
|
* @param {string} params.key - Column Key.
|
|
940
827
|
* @param {boolean} params.required - Is column required?
|
|
941
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.
|
|
@@ -953,7 +840,7 @@ declare class TablesDB {
|
|
|
953
840
|
* Create a geometric line column.
|
|
954
841
|
*
|
|
955
842
|
* @param {string} databaseId - Database ID.
|
|
956
|
-
* @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).
|
|
957
844
|
* @param {string} key - Column Key.
|
|
958
845
|
* @param {boolean} required - Is column required?
|
|
959
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.
|
|
@@ -966,7 +853,7 @@ declare class TablesDB {
|
|
|
966
853
|
* Update a line column. Changing the `default` value will not update already existing rows.
|
|
967
854
|
*
|
|
968
855
|
* @param {string} params.databaseId - Database ID.
|
|
969
|
-
* @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).
|
|
970
857
|
* @param {string} params.key - Column Key.
|
|
971
858
|
* @param {boolean} params.required - Is column required?
|
|
972
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.
|
|
@@ -986,7 +873,7 @@ declare class TablesDB {
|
|
|
986
873
|
* Update a line column. Changing the `default` value will not update already existing rows.
|
|
987
874
|
*
|
|
988
875
|
* @param {string} databaseId - Database ID.
|
|
989
|
-
* @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).
|
|
990
877
|
* @param {string} key - Column Key.
|
|
991
878
|
* @param {boolean} required - Is column required?
|
|
992
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.
|
|
@@ -1000,7 +887,7 @@ declare class TablesDB {
|
|
|
1000
887
|
* Create a geometric point column.
|
|
1001
888
|
*
|
|
1002
889
|
* @param {string} params.databaseId - Database ID.
|
|
1003
|
-
* @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).
|
|
1004
891
|
* @param {string} params.key - Column Key.
|
|
1005
892
|
* @param {boolean} params.required - Is column required?
|
|
1006
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.
|
|
@@ -1018,7 +905,7 @@ declare class TablesDB {
|
|
|
1018
905
|
* Create a geometric point column.
|
|
1019
906
|
*
|
|
1020
907
|
* @param {string} databaseId - Database ID.
|
|
1021
|
-
* @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).
|
|
1022
909
|
* @param {string} key - Column Key.
|
|
1023
910
|
* @param {boolean} required - Is column required?
|
|
1024
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.
|
|
@@ -1031,7 +918,7 @@ declare class TablesDB {
|
|
|
1031
918
|
* Update a point column. Changing the `default` value will not update already existing rows.
|
|
1032
919
|
*
|
|
1033
920
|
* @param {string} params.databaseId - Database ID.
|
|
1034
|
-
* @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).
|
|
1035
922
|
* @param {string} params.key - Column Key.
|
|
1036
923
|
* @param {boolean} params.required - Is column required?
|
|
1037
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.
|
|
@@ -1051,7 +938,7 @@ declare class TablesDB {
|
|
|
1051
938
|
* Update a point column. Changing the `default` value will not update already existing rows.
|
|
1052
939
|
*
|
|
1053
940
|
* @param {string} databaseId - Database ID.
|
|
1054
|
-
* @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).
|
|
1055
942
|
* @param {string} key - Column Key.
|
|
1056
943
|
* @param {boolean} required - Is column required?
|
|
1057
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.
|
|
@@ -1065,7 +952,7 @@ declare class TablesDB {
|
|
|
1065
952
|
* Create a geometric polygon column.
|
|
1066
953
|
*
|
|
1067
954
|
* @param {string} params.databaseId - Database ID.
|
|
1068
|
-
* @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).
|
|
1069
956
|
* @param {string} params.key - Column Key.
|
|
1070
957
|
* @param {boolean} params.required - Is column required?
|
|
1071
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.
|
|
@@ -1083,7 +970,7 @@ declare class TablesDB {
|
|
|
1083
970
|
* Create a geometric polygon column.
|
|
1084
971
|
*
|
|
1085
972
|
* @param {string} databaseId - Database ID.
|
|
1086
|
-
* @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).
|
|
1087
974
|
* @param {string} key - Column Key.
|
|
1088
975
|
* @param {boolean} required - Is column required?
|
|
1089
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.
|
|
@@ -1096,7 +983,7 @@ declare class TablesDB {
|
|
|
1096
983
|
* Update a polygon column. Changing the `default` value will not update already existing rows.
|
|
1097
984
|
*
|
|
1098
985
|
* @param {string} params.databaseId - Database ID.
|
|
1099
|
-
* @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).
|
|
1100
987
|
* @param {string} params.key - Column Key.
|
|
1101
988
|
* @param {boolean} params.required - Is column required?
|
|
1102
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.
|
|
@@ -1116,7 +1003,7 @@ declare class TablesDB {
|
|
|
1116
1003
|
* Update a polygon column. Changing the `default` value will not update already existing rows.
|
|
1117
1004
|
*
|
|
1118
1005
|
* @param {string} databaseId - Database ID.
|
|
1119
|
-
* @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).
|
|
1120
1007
|
* @param {string} key - Column Key.
|
|
1121
1008
|
* @param {boolean} required - Is column required?
|
|
1122
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.
|
|
@@ -1173,7 +1060,7 @@ declare class TablesDB {
|
|
|
1173
1060
|
*
|
|
1174
1061
|
*
|
|
1175
1062
|
* @param {string} params.databaseId - Database ID.
|
|
1176
|
-
* @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).
|
|
1177
1064
|
* @param {string} params.key - Column Key.
|
|
1178
1065
|
* @param {number} params.size - Column size for text columns, in number of characters.
|
|
1179
1066
|
* @param {boolean} params.required - Is column required?
|
|
@@ -1198,7 +1085,7 @@ declare class TablesDB {
|
|
|
1198
1085
|
*
|
|
1199
1086
|
*
|
|
1200
1087
|
* @param {string} databaseId - Database ID.
|
|
1201
|
-
* @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).
|
|
1202
1089
|
* @param {string} key - Column Key.
|
|
1203
1090
|
* @param {number} size - Column size for text columns, in number of characters.
|
|
1204
1091
|
* @param {boolean} required - Is column required?
|
|
@@ -1215,7 +1102,7 @@ declare class TablesDB {
|
|
|
1215
1102
|
*
|
|
1216
1103
|
*
|
|
1217
1104
|
* @param {string} params.databaseId - Database ID.
|
|
1218
|
-
* @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).
|
|
1219
1106
|
* @param {string} params.key - Column Key.
|
|
1220
1107
|
* @param {boolean} params.required - Is column required?
|
|
1221
1108
|
* @param {string} params.xdefault - Default value for column when not provided. Cannot be set when column is required.
|
|
@@ -1238,7 +1125,7 @@ declare class TablesDB {
|
|
|
1238
1125
|
*
|
|
1239
1126
|
*
|
|
1240
1127
|
* @param {string} databaseId - Database ID.
|
|
1241
|
-
* @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).
|
|
1242
1129
|
* @param {string} key - Column Key.
|
|
1243
1130
|
* @param {boolean} required - Is column required?
|
|
1244
1131
|
* @param {string} xdefault - Default value for column when not provided. Cannot be set when column is required.
|
|
@@ -1408,7 +1295,7 @@ declare class TablesDB {
|
|
|
1408
1295
|
* List indexes on the table.
|
|
1409
1296
|
*
|
|
1410
1297
|
* @param {string} params.databaseId - Database ID.
|
|
1411
|
-
* @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).
|
|
1412
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
|
|
1413
1300
|
* @throws {AppwriteException}
|
|
1414
1301
|
* @returns {Promise<Models.ColumnIndexList>}
|
|
@@ -1422,7 +1309,7 @@ declare class TablesDB {
|
|
|
1422
1309
|
* List indexes on the table.
|
|
1423
1310
|
*
|
|
1424
1311
|
* @param {string} databaseId - Database ID.
|
|
1425
|
-
* @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).
|
|
1426
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
|
|
1427
1314
|
* @throws {AppwriteException}
|
|
1428
1315
|
* @returns {Promise<Models.ColumnIndexList>}
|
|
@@ -1434,7 +1321,7 @@ declare class TablesDB {
|
|
|
1434
1321
|
* Type can be `key`, `fulltext`, or `unique`.
|
|
1435
1322
|
*
|
|
1436
1323
|
* @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/
|
|
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).
|
|
1438
1325
|
* @param {string} params.key - Index Key.
|
|
1439
1326
|
* @param {IndexType} params.type - Index type.
|
|
1440
1327
|
* @param {string[]} params.columns - Array of columns to index. Maximum of 100 columns are allowed, each 32 characters long.
|
|
@@ -1457,7 +1344,7 @@ declare class TablesDB {
|
|
|
1457
1344
|
* Type can be `key`, `fulltext`, or `unique`.
|
|
1458
1345
|
*
|
|
1459
1346
|
* @param {string} databaseId - Database ID.
|
|
1460
|
-
* @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).
|
|
1461
1348
|
* @param {string} key - Index Key.
|
|
1462
1349
|
* @param {IndexType} type - Index type.
|
|
1463
1350
|
* @param {string[]} columns - Array of columns to index. Maximum of 100 columns are allowed, each 32 characters long.
|
|
@@ -1472,7 +1359,7 @@ declare class TablesDB {
|
|
|
1472
1359
|
* Get index by ID.
|
|
1473
1360
|
*
|
|
1474
1361
|
* @param {string} params.databaseId - Database ID.
|
|
1475
|
-
* @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).
|
|
1476
1363
|
* @param {string} params.key - Index Key.
|
|
1477
1364
|
* @throws {AppwriteException}
|
|
1478
1365
|
* @returns {Promise<Models.ColumnIndex>}
|
|
@@ -1486,7 +1373,7 @@ declare class TablesDB {
|
|
|
1486
1373
|
* Get index by ID.
|
|
1487
1374
|
*
|
|
1488
1375
|
* @param {string} databaseId - Database ID.
|
|
1489
|
-
* @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).
|
|
1490
1377
|
* @param {string} key - Index Key.
|
|
1491
1378
|
* @throws {AppwriteException}
|
|
1492
1379
|
* @returns {Promise<Models.ColumnIndex>}
|
|
@@ -1497,7 +1384,7 @@ declare class TablesDB {
|
|
|
1497
1384
|
* Delete an index.
|
|
1498
1385
|
*
|
|
1499
1386
|
* @param {string} params.databaseId - Database ID.
|
|
1500
|
-
* @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).
|
|
1501
1388
|
* @param {string} params.key - Index Key.
|
|
1502
1389
|
* @throws {AppwriteException}
|
|
1503
1390
|
* @returns {Promise<{}>}
|
|
@@ -1511,7 +1398,7 @@ declare class TablesDB {
|
|
|
1511
1398
|
* Delete an index.
|
|
1512
1399
|
*
|
|
1513
1400
|
* @param {string} databaseId - Database ID.
|
|
1514
|
-
* @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).
|
|
1515
1402
|
* @param {string} key - Index Key.
|
|
1516
1403
|
* @throws {AppwriteException}
|
|
1517
1404
|
* @returns {Promise<{}>}
|
|
@@ -1522,9 +1409,8 @@ declare class TablesDB {
|
|
|
1522
1409
|
* Get a list of all the user's rows in a given table. You can use the query params to filter your results.
|
|
1523
1410
|
*
|
|
1524
1411
|
* @param {string} params.databaseId - Database ID.
|
|
1525
|
-
* @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).
|
|
1526
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.
|
|
1527
|
-
* @param {string} params.transactionId - Transaction ID to read uncommitted changes within the transaction.
|
|
1528
1414
|
* @throws {AppwriteException}
|
|
1529
1415
|
* @returns {Promise<Models.RowList<Row>>}
|
|
1530
1416
|
*/
|
|
@@ -1532,29 +1418,26 @@ declare class TablesDB {
|
|
|
1532
1418
|
databaseId: string;
|
|
1533
1419
|
tableId: string;
|
|
1534
1420
|
queries?: string[];
|
|
1535
|
-
transactionId?: string;
|
|
1536
1421
|
}): Promise<Models.RowList<Row>>;
|
|
1537
1422
|
/**
|
|
1538
1423
|
* Get a list of all the user's rows in a given table. You can use the query params to filter your results.
|
|
1539
1424
|
*
|
|
1540
1425
|
* @param {string} databaseId - Database ID.
|
|
1541
|
-
* @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).
|
|
1542
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.
|
|
1543
|
-
* @param {string} transactionId - Transaction ID to read uncommitted changes within the transaction.
|
|
1544
1428
|
* @throws {AppwriteException}
|
|
1545
1429
|
* @returns {Promise<Models.RowList<Row>>}
|
|
1546
1430
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1547
1431
|
*/
|
|
1548
|
-
listRows<Row extends Models.Row = Models.DefaultRow>(databaseId: string, tableId: string, queries?: string[]
|
|
1432
|
+
listRows<Row extends Models.Row = Models.DefaultRow>(databaseId: string, tableId: string, queries?: string[]): Promise<Models.RowList<Row>>;
|
|
1549
1433
|
/**
|
|
1550
|
-
* 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.
|
|
1551
1435
|
*
|
|
1552
1436
|
* @param {string} params.databaseId - Database ID.
|
|
1553
|
-
* @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.
|
|
1554
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.
|
|
1555
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.
|
|
1556
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).
|
|
1557
|
-
* @param {string} params.transactionId - Transaction ID for staging the operation.
|
|
1558
1441
|
* @throws {AppwriteException}
|
|
1559
1442
|
* @returns {Promise<Row>}
|
|
1560
1443
|
*/
|
|
@@ -1564,29 +1447,26 @@ declare class TablesDB {
|
|
|
1564
1447
|
rowId: string;
|
|
1565
1448
|
data: Row extends Models.DefaultRow ? Partial<Models.Row> & Record<string, any> : Partial<Models.Row> & Omit<Row, keyof Models.Row>;
|
|
1566
1449
|
permissions?: string[];
|
|
1567
|
-
transactionId?: string;
|
|
1568
1450
|
}): Promise<Row>;
|
|
1569
1451
|
/**
|
|
1570
|
-
* 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.
|
|
1571
1453
|
*
|
|
1572
1454
|
* @param {string} databaseId - Database ID.
|
|
1573
|
-
* @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.
|
|
1574
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.
|
|
1575
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.
|
|
1576
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).
|
|
1577
|
-
* @param {string} transactionId - Transaction ID for staging the operation.
|
|
1578
1459
|
* @throws {AppwriteException}
|
|
1579
1460
|
* @returns {Promise<Row>}
|
|
1580
1461
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1581
1462
|
*/
|
|
1582
|
-
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[]
|
|
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>;
|
|
1583
1464
|
/**
|
|
1584
|
-
* 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.
|
|
1585
1466
|
*
|
|
1586
1467
|
* @param {string} params.databaseId - Database ID.
|
|
1587
|
-
* @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.
|
|
1588
1469
|
* @param {object[]} params.rows - Array of rows data as JSON objects.
|
|
1589
|
-
* @param {string} params.transactionId - Transaction ID for staging the operation.
|
|
1590
1470
|
* @throws {AppwriteException}
|
|
1591
1471
|
* @returns {Promise<Models.RowList<Row>>}
|
|
1592
1472
|
*/
|
|
@@ -1594,28 +1474,25 @@ declare class TablesDB {
|
|
|
1594
1474
|
databaseId: string;
|
|
1595
1475
|
tableId: string;
|
|
1596
1476
|
rows: object[];
|
|
1597
|
-
transactionId?: string;
|
|
1598
1477
|
}): Promise<Models.RowList<Row>>;
|
|
1599
1478
|
/**
|
|
1600
|
-
* 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.
|
|
1601
1480
|
*
|
|
1602
1481
|
* @param {string} databaseId - Database ID.
|
|
1603
|
-
* @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.
|
|
1604
1483
|
* @param {object[]} rows - Array of rows data as JSON objects.
|
|
1605
|
-
* @param {string} transactionId - Transaction ID for staging the operation.
|
|
1606
1484
|
* @throws {AppwriteException}
|
|
1607
1485
|
* @returns {Promise<Models.RowList<Row>>}
|
|
1608
1486
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1609
1487
|
*/
|
|
1610
|
-
createRows<Row extends Models.Row = Models.DefaultRow>(databaseId: string, tableId: string, rows: object[]
|
|
1488
|
+
createRows<Row extends Models.Row = Models.DefaultRow>(databaseId: string, tableId: string, rows: object[]): Promise<Models.RowList<Row>>;
|
|
1611
1489
|
/**
|
|
1612
|
-
* 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.
|
|
1613
1491
|
*
|
|
1614
1492
|
*
|
|
1615
1493
|
* @param {string} params.databaseId - Database ID.
|
|
1616
1494
|
* @param {string} params.tableId - Table ID.
|
|
1617
1495
|
* @param {object[]} params.rows - Array of row data as JSON objects. May contain partial rows.
|
|
1618
|
-
* @param {string} params.transactionId - Transaction ID for staging the operation.
|
|
1619
1496
|
* @throws {AppwriteException}
|
|
1620
1497
|
* @returns {Promise<Models.RowList<Row>>}
|
|
1621
1498
|
*/
|
|
@@ -1623,21 +1500,19 @@ declare class TablesDB {
|
|
|
1623
1500
|
databaseId: string;
|
|
1624
1501
|
tableId: string;
|
|
1625
1502
|
rows: object[];
|
|
1626
|
-
transactionId?: string;
|
|
1627
1503
|
}): Promise<Models.RowList<Row>>;
|
|
1628
1504
|
/**
|
|
1629
|
-
* 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.
|
|
1630
1506
|
*
|
|
1631
1507
|
*
|
|
1632
1508
|
* @param {string} databaseId - Database ID.
|
|
1633
1509
|
* @param {string} tableId - Table ID.
|
|
1634
1510
|
* @param {object[]} rows - Array of row data as JSON objects. May contain partial rows.
|
|
1635
|
-
* @param {string} transactionId - Transaction ID for staging the operation.
|
|
1636
1511
|
* @throws {AppwriteException}
|
|
1637
1512
|
* @returns {Promise<Models.RowList<Row>>}
|
|
1638
1513
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1639
1514
|
*/
|
|
1640
|
-
upsertRows<Row extends Models.Row = Models.DefaultRow>(databaseId: string, tableId: string, rows: object[]
|
|
1515
|
+
upsertRows<Row extends Models.Row = Models.DefaultRow>(databaseId: string, tableId: string, rows: object[]): Promise<Models.RowList<Row>>;
|
|
1641
1516
|
/**
|
|
1642
1517
|
* Update all rows that match your queries, if no queries are submitted then all rows are updated. You can pass only specific fields to be updated.
|
|
1643
1518
|
*
|
|
@@ -1645,7 +1520,6 @@ declare class TablesDB {
|
|
|
1645
1520
|
* @param {string} params.tableId - Table ID.
|
|
1646
1521
|
* @param {object} params.data - Row data as JSON object. Include only column and value pairs to be updated.
|
|
1647
1522
|
* @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.
|
|
1648
|
-
* @param {string} params.transactionId - Transaction ID for staging the operation.
|
|
1649
1523
|
* @throws {AppwriteException}
|
|
1650
1524
|
* @returns {Promise<Models.RowList<Row>>}
|
|
1651
1525
|
*/
|
|
@@ -1654,7 +1528,6 @@ declare class TablesDB {
|
|
|
1654
1528
|
tableId: string;
|
|
1655
1529
|
data?: object;
|
|
1656
1530
|
queries?: string[];
|
|
1657
|
-
transactionId?: string;
|
|
1658
1531
|
}): Promise<Models.RowList<Row>>;
|
|
1659
1532
|
/**
|
|
1660
1533
|
* Update all rows that match your queries, if no queries are submitted then all rows are updated. You can pass only specific fields to be updated.
|
|
@@ -1663,19 +1536,17 @@ declare class TablesDB {
|
|
|
1663
1536
|
* @param {string} tableId - Table ID.
|
|
1664
1537
|
* @param {object} data - Row data as JSON object. Include only column and value pairs to be updated.
|
|
1665
1538
|
* @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.
|
|
1666
|
-
* @param {string} transactionId - Transaction ID for staging the operation.
|
|
1667
1539
|
* @throws {AppwriteException}
|
|
1668
1540
|
* @returns {Promise<Models.RowList<Row>>}
|
|
1669
1541
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1670
1542
|
*/
|
|
1671
|
-
updateRows<Row extends Models.Row = Models.DefaultRow>(databaseId: string, tableId: string, data?: object, queries?: string[]
|
|
1543
|
+
updateRows<Row extends Models.Row = Models.DefaultRow>(databaseId: string, tableId: string, data?: object, queries?: string[]): Promise<Models.RowList<Row>>;
|
|
1672
1544
|
/**
|
|
1673
1545
|
* Bulk delete rows using queries, if no queries are passed then all rows are deleted.
|
|
1674
1546
|
*
|
|
1675
1547
|
* @param {string} params.databaseId - Database ID.
|
|
1676
|
-
* @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).
|
|
1677
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.
|
|
1678
|
-
* @param {string} params.transactionId - Transaction ID for staging the operation.
|
|
1679
1550
|
* @throws {AppwriteException}
|
|
1680
1551
|
* @returns {Promise<Models.RowList<Row>>}
|
|
1681
1552
|
*/
|
|
@@ -1683,28 +1554,25 @@ declare class TablesDB {
|
|
|
1683
1554
|
databaseId: string;
|
|
1684
1555
|
tableId: string;
|
|
1685
1556
|
queries?: string[];
|
|
1686
|
-
transactionId?: string;
|
|
1687
1557
|
}): Promise<Models.RowList<Row>>;
|
|
1688
1558
|
/**
|
|
1689
1559
|
* Bulk delete rows using queries, if no queries are passed then all rows are deleted.
|
|
1690
1560
|
*
|
|
1691
1561
|
* @param {string} databaseId - Database ID.
|
|
1692
|
-
* @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).
|
|
1693
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.
|
|
1694
|
-
* @param {string} transactionId - Transaction ID for staging the operation.
|
|
1695
1564
|
* @throws {AppwriteException}
|
|
1696
1565
|
* @returns {Promise<Models.RowList<Row>>}
|
|
1697
1566
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1698
1567
|
*/
|
|
1699
|
-
deleteRows<Row extends Models.Row = Models.DefaultRow>(databaseId: string, tableId: string, queries?: string[]
|
|
1568
|
+
deleteRows<Row extends Models.Row = Models.DefaultRow>(databaseId: string, tableId: string, queries?: string[]): Promise<Models.RowList<Row>>;
|
|
1700
1569
|
/**
|
|
1701
1570
|
* Get a row by its unique ID. This endpoint response returns a JSON object with the row data.
|
|
1702
1571
|
*
|
|
1703
1572
|
* @param {string} params.databaseId - Database ID.
|
|
1704
|
-
* @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).
|
|
1705
1574
|
* @param {string} params.rowId - Row ID.
|
|
1706
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.
|
|
1707
|
-
* @param {string} params.transactionId - Transaction ID to read uncommitted changes within the transaction.
|
|
1708
1576
|
* @throws {AppwriteException}
|
|
1709
1577
|
* @returns {Promise<Row>}
|
|
1710
1578
|
*/
|
|
@@ -1713,30 +1581,27 @@ declare class TablesDB {
|
|
|
1713
1581
|
tableId: string;
|
|
1714
1582
|
rowId: string;
|
|
1715
1583
|
queries?: string[];
|
|
1716
|
-
transactionId?: string;
|
|
1717
1584
|
}): Promise<Row>;
|
|
1718
1585
|
/**
|
|
1719
1586
|
* Get a row by its unique ID. This endpoint response returns a JSON object with the row data.
|
|
1720
1587
|
*
|
|
1721
1588
|
* @param {string} databaseId - Database ID.
|
|
1722
|
-
* @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).
|
|
1723
1590
|
* @param {string} rowId - Row ID.
|
|
1724
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.
|
|
1725
|
-
* @param {string} transactionId - Transaction ID to read uncommitted changes within the transaction.
|
|
1726
1592
|
* @throws {AppwriteException}
|
|
1727
1593
|
* @returns {Promise<Row>}
|
|
1728
1594
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1729
1595
|
*/
|
|
1730
|
-
getRow<Row extends Models.Row = Models.DefaultRow>(databaseId: string, tableId: string, rowId: string, queries?: string[]
|
|
1596
|
+
getRow<Row extends Models.Row = Models.DefaultRow>(databaseId: string, tableId: string, rowId: string, queries?: string[]): Promise<Row>;
|
|
1731
1597
|
/**
|
|
1732
|
-
* 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.
|
|
1733
1599
|
*
|
|
1734
1600
|
* @param {string} params.databaseId - Database ID.
|
|
1735
1601
|
* @param {string} params.tableId - Table ID.
|
|
1736
1602
|
* @param {string} params.rowId - Row ID.
|
|
1737
1603
|
* @param {Row extends Models.DefaultRow ? Partial<Models.Row> & Record<string, any> : Partial<Models.Row> & Partial<Omit<Row, keyof Models.Row>>} params.data - Row data as JSON object. Include all required columns of the row to be created or updated.
|
|
1738
1604
|
* @param {string[]} params.permissions - An array of permissions strings. By default, the current permissions are inherited. [Learn more about permissions](https://appwrite.io/docs/permissions).
|
|
1739
|
-
* @param {string} params.transactionId - Transaction ID for staging the operation.
|
|
1740
1605
|
* @throws {AppwriteException}
|
|
1741
1606
|
* @returns {Promise<Row>}
|
|
1742
1607
|
*/
|
|
@@ -1746,22 +1611,20 @@ declare class TablesDB {
|
|
|
1746
1611
|
rowId: string;
|
|
1747
1612
|
data?: Row extends Models.DefaultRow ? Partial<Models.Row> & Record<string, any> : Partial<Models.Row> & Partial<Omit<Row, keyof Models.Row>>;
|
|
1748
1613
|
permissions?: string[];
|
|
1749
|
-
transactionId?: string;
|
|
1750
1614
|
}): Promise<Row>;
|
|
1751
1615
|
/**
|
|
1752
|
-
* 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.
|
|
1753
1617
|
*
|
|
1754
1618
|
* @param {string} databaseId - Database ID.
|
|
1755
1619
|
* @param {string} tableId - Table ID.
|
|
1756
1620
|
* @param {string} rowId - Row ID.
|
|
1757
1621
|
* @param {Row extends Models.DefaultRow ? Partial<Models.Row> & Record<string, any> : Partial<Models.Row> & Partial<Omit<Row, keyof Models.Row>>} data - Row data as JSON object. Include all required columns of the row to be created or updated.
|
|
1758
1622
|
* @param {string[]} permissions - An array of permissions strings. By default, the current permissions are inherited. [Learn more about permissions](https://appwrite.io/docs/permissions).
|
|
1759
|
-
* @param {string} transactionId - Transaction ID for staging the operation.
|
|
1760
1623
|
* @throws {AppwriteException}
|
|
1761
1624
|
* @returns {Promise<Row>}
|
|
1762
1625
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1763
1626
|
*/
|
|
1764
|
-
upsertRow<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> & Partial<Omit<Row, keyof Models.Row>>, permissions?: string[]
|
|
1627
|
+
upsertRow<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> & Partial<Omit<Row, keyof Models.Row>>, permissions?: string[]): Promise<Row>;
|
|
1765
1628
|
/**
|
|
1766
1629
|
* Update a row by its unique ID. Using the patch method you can pass only specific fields that will get updated.
|
|
1767
1630
|
*
|
|
@@ -1770,7 +1633,6 @@ declare class TablesDB {
|
|
|
1770
1633
|
* @param {string} params.rowId - Row ID.
|
|
1771
1634
|
* @param {Row extends Models.DefaultRow ? Partial<Models.Row> & Record<string, any> : Partial<Models.Row> & Partial<Omit<Row, keyof Models.Row>>} params.data - Row data as JSON object. Include only columns and value pairs to be updated.
|
|
1772
1635
|
* @param {string[]} params.permissions - An array of permissions strings. By default, the current permissions are inherited. [Learn more about permissions](https://appwrite.io/docs/permissions).
|
|
1773
|
-
* @param {string} params.transactionId - Transaction ID for staging the operation.
|
|
1774
1636
|
* @throws {AppwriteException}
|
|
1775
1637
|
* @returns {Promise<Row>}
|
|
1776
1638
|
*/
|
|
@@ -1780,7 +1642,6 @@ declare class TablesDB {
|
|
|
1780
1642
|
rowId: string;
|
|
1781
1643
|
data?: Row extends Models.DefaultRow ? Partial<Models.Row> & Record<string, any> : Partial<Models.Row> & Partial<Omit<Row, keyof Models.Row>>;
|
|
1782
1644
|
permissions?: string[];
|
|
1783
|
-
transactionId?: string;
|
|
1784
1645
|
}): Promise<Row>;
|
|
1785
1646
|
/**
|
|
1786
1647
|
* Update a row by its unique ID. Using the patch method you can pass only specific fields that will get updated.
|
|
@@ -1790,19 +1651,17 @@ declare class TablesDB {
|
|
|
1790
1651
|
* @param {string} rowId - Row ID.
|
|
1791
1652
|
* @param {Row extends Models.DefaultRow ? Partial<Models.Row> & Record<string, any> : Partial<Models.Row> & Partial<Omit<Row, keyof Models.Row>>} data - Row data as JSON object. Include only columns and value pairs to be updated.
|
|
1792
1653
|
* @param {string[]} permissions - An array of permissions strings. By default, the current permissions are inherited. [Learn more about permissions](https://appwrite.io/docs/permissions).
|
|
1793
|
-
* @param {string} transactionId - Transaction ID for staging the operation.
|
|
1794
1654
|
* @throws {AppwriteException}
|
|
1795
1655
|
* @returns {Promise<Row>}
|
|
1796
1656
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1797
1657
|
*/
|
|
1798
|
-
updateRow<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> & Partial<Omit<Row, keyof Models.Row>>, permissions?: string[]
|
|
1658
|
+
updateRow<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> & Partial<Omit<Row, keyof Models.Row>>, permissions?: string[]): Promise<Row>;
|
|
1799
1659
|
/**
|
|
1800
1660
|
* Delete a row by its unique ID.
|
|
1801
1661
|
*
|
|
1802
1662
|
* @param {string} params.databaseId - Database ID.
|
|
1803
|
-
* @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).
|
|
1804
1664
|
* @param {string} params.rowId - Row ID.
|
|
1805
|
-
* @param {string} params.transactionId - Transaction ID for staging the operation.
|
|
1806
1665
|
* @throws {AppwriteException}
|
|
1807
1666
|
* @returns {Promise<{}>}
|
|
1808
1667
|
*/
|
|
@@ -1810,20 +1669,18 @@ declare class TablesDB {
|
|
|
1810
1669
|
databaseId: string;
|
|
1811
1670
|
tableId: string;
|
|
1812
1671
|
rowId: string;
|
|
1813
|
-
transactionId?: string;
|
|
1814
1672
|
}): Promise<{}>;
|
|
1815
1673
|
/**
|
|
1816
1674
|
* Delete a row by its unique ID.
|
|
1817
1675
|
*
|
|
1818
1676
|
* @param {string} databaseId - Database ID.
|
|
1819
|
-
* @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).
|
|
1820
1678
|
* @param {string} rowId - Row ID.
|
|
1821
|
-
* @param {string} transactionId - Transaction ID for staging the operation.
|
|
1822
1679
|
* @throws {AppwriteException}
|
|
1823
1680
|
* @returns {Promise<{}>}
|
|
1824
1681
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1825
1682
|
*/
|
|
1826
|
-
deleteRow(databaseId: string, tableId: string, rowId: string
|
|
1683
|
+
deleteRow(databaseId: string, tableId: string, rowId: string): Promise<{}>;
|
|
1827
1684
|
/**
|
|
1828
1685
|
* Decrement a specific column of a row by a given value.
|
|
1829
1686
|
*
|
|
@@ -1833,7 +1690,6 @@ declare class TablesDB {
|
|
|
1833
1690
|
* @param {string} params.column - Column key.
|
|
1834
1691
|
* @param {number} params.value - Value to increment the column by. The value must be a number.
|
|
1835
1692
|
* @param {number} params.min - Minimum value for the column. If the current value is lesser than this value, an exception will be thrown.
|
|
1836
|
-
* @param {string} params.transactionId - Transaction ID for staging the operation.
|
|
1837
1693
|
* @throws {AppwriteException}
|
|
1838
1694
|
* @returns {Promise<Row>}
|
|
1839
1695
|
*/
|
|
@@ -1844,7 +1700,6 @@ declare class TablesDB {
|
|
|
1844
1700
|
column: string;
|
|
1845
1701
|
value?: number;
|
|
1846
1702
|
min?: number;
|
|
1847
|
-
transactionId?: string;
|
|
1848
1703
|
}): Promise<Row>;
|
|
1849
1704
|
/**
|
|
1850
1705
|
* Decrement a specific column of a row by a given value.
|
|
@@ -1855,12 +1710,11 @@ declare class TablesDB {
|
|
|
1855
1710
|
* @param {string} column - Column key.
|
|
1856
1711
|
* @param {number} value - Value to increment the column by. The value must be a number.
|
|
1857
1712
|
* @param {number} min - Minimum value for the column. If the current value is lesser than this value, an exception will be thrown.
|
|
1858
|
-
* @param {string} transactionId - Transaction ID for staging the operation.
|
|
1859
1713
|
* @throws {AppwriteException}
|
|
1860
1714
|
* @returns {Promise<Row>}
|
|
1861
1715
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1862
1716
|
*/
|
|
1863
|
-
decrementRowColumn<Row extends Models.Row = Models.DefaultRow>(databaseId: string, tableId: string, rowId: string, column: string, value?: number, min?: number
|
|
1717
|
+
decrementRowColumn<Row extends Models.Row = Models.DefaultRow>(databaseId: string, tableId: string, rowId: string, column: string, value?: number, min?: number): Promise<Row>;
|
|
1864
1718
|
/**
|
|
1865
1719
|
* Increment a specific column of a row by a given value.
|
|
1866
1720
|
*
|
|
@@ -1870,7 +1724,6 @@ declare class TablesDB {
|
|
|
1870
1724
|
* @param {string} params.column - Column key.
|
|
1871
1725
|
* @param {number} params.value - Value to increment the column by. The value must be a number.
|
|
1872
1726
|
* @param {number} params.max - Maximum value for the column. If the current value is greater than this value, an error will be thrown.
|
|
1873
|
-
* @param {string} params.transactionId - Transaction ID for staging the operation.
|
|
1874
1727
|
* @throws {AppwriteException}
|
|
1875
1728
|
* @returns {Promise<Row>}
|
|
1876
1729
|
*/
|
|
@@ -1881,7 +1734,6 @@ declare class TablesDB {
|
|
|
1881
1734
|
column: string;
|
|
1882
1735
|
value?: number;
|
|
1883
1736
|
max?: number;
|
|
1884
|
-
transactionId?: string;
|
|
1885
1737
|
}): Promise<Row>;
|
|
1886
1738
|
/**
|
|
1887
1739
|
* Increment a specific column of a row by a given value.
|
|
@@ -1892,12 +1744,11 @@ declare class TablesDB {
|
|
|
1892
1744
|
* @param {string} column - Column key.
|
|
1893
1745
|
* @param {number} value - Value to increment the column by. The value must be a number.
|
|
1894
1746
|
* @param {number} max - Maximum value for the column. If the current value is greater than this value, an error will be thrown.
|
|
1895
|
-
* @param {string} transactionId - Transaction ID for staging the operation.
|
|
1896
1747
|
* @throws {AppwriteException}
|
|
1897
1748
|
* @returns {Promise<Row>}
|
|
1898
1749
|
* @deprecated Use the object parameter style method for a better developer experience.
|
|
1899
1750
|
*/
|
|
1900
|
-
incrementRowColumn<Row extends Models.Row = Models.DefaultRow>(databaseId: string, tableId: string, rowId: string, column: string, value?: number, max?: number
|
|
1751
|
+
incrementRowColumn<Row extends Models.Row = Models.DefaultRow>(databaseId: string, tableId: string, rowId: string, column: string, value?: number, max?: number): Promise<Row>;
|
|
1901
1752
|
}
|
|
1902
1753
|
|
|
1903
1754
|
export { TablesDB };
|