appwrite 29.0.0 → 30.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/lib/appwrite/client.rb +3 -3
- data/lib/appwrite/models/attribute_bigint.rb +6 -1
- data/lib/appwrite/models/attribute_boolean.rb +6 -1
- data/lib/appwrite/models/attribute_datetime.rb +6 -1
- data/lib/appwrite/models/attribute_email.rb +6 -1
- data/lib/appwrite/models/attribute_enum.rb +6 -1
- data/lib/appwrite/models/attribute_float.rb +6 -1
- data/lib/appwrite/models/attribute_integer.rb +6 -1
- data/lib/appwrite/models/attribute_ip.rb +6 -1
- data/lib/appwrite/models/attribute_line.rb +6 -1
- data/lib/appwrite/models/attribute_longtext.rb +6 -1
- data/lib/appwrite/models/attribute_mediumtext.rb +6 -1
- data/lib/appwrite/models/attribute_object.rb +6 -1
- data/lib/appwrite/models/attribute_point.rb +6 -1
- data/lib/appwrite/models/attribute_polygon.rb +6 -1
- data/lib/appwrite/models/attribute_relationship.rb +6 -1
- data/lib/appwrite/models/attribute_string.rb +6 -1
- data/lib/appwrite/models/attribute_text.rb +6 -1
- data/lib/appwrite/models/attribute_url.rb +6 -1
- data/lib/appwrite/models/attribute_varchar.rb +6 -1
- data/lib/appwrite/models/attribute_vector.rb +6 -1
- data/lib/appwrite/models/billing_plan.rb +6 -1
- data/lib/appwrite/models/bucket.rb +11 -1
- data/lib/appwrite/models/collection.rb +6 -1
- data/lib/appwrite/models/column_bigint.rb +6 -1
- data/lib/appwrite/models/column_boolean.rb +6 -1
- data/lib/appwrite/models/column_datetime.rb +6 -1
- data/lib/appwrite/models/column_email.rb +6 -1
- data/lib/appwrite/models/column_enum.rb +6 -1
- data/lib/appwrite/models/column_float.rb +6 -1
- data/lib/appwrite/models/column_index.rb +6 -1
- data/lib/appwrite/models/column_integer.rb +6 -1
- data/lib/appwrite/models/column_ip.rb +6 -1
- data/lib/appwrite/models/column_line.rb +6 -1
- data/lib/appwrite/models/column_longtext.rb +6 -1
- data/lib/appwrite/models/column_mediumtext.rb +6 -1
- data/lib/appwrite/models/column_point.rb +6 -1
- data/lib/appwrite/models/column_polygon.rb +6 -1
- data/lib/appwrite/models/column_relationship.rb +6 -1
- data/lib/appwrite/models/column_string.rb +6 -1
- data/lib/appwrite/models/column_text.rb +6 -1
- data/lib/appwrite/models/column_url.rb +6 -1
- data/lib/appwrite/models/column_varchar.rb +6 -1
- data/lib/appwrite/models/database.rb +6 -1
- data/lib/appwrite/models/ephemeral_key.rb +6 -1
- data/lib/appwrite/models/function.rb +6 -1
- data/lib/appwrite/models/index.rb +6 -1
- data/lib/appwrite/models/key.rb +6 -1
- data/lib/appwrite/models/policy_password_dictionary.rb +9 -4
- data/lib/appwrite/models/policy_password_personal_data.rb +9 -4
- data/lib/appwrite/models/site.rb +6 -1
- data/lib/appwrite/models/table.rb +6 -1
- data/lib/appwrite/models/topic.rb +6 -1
- data/lib/appwrite/models/variable.rb +6 -1
- data/lib/appwrite/models/vectorsdb_collection.rb +6 -1
- data/lib/appwrite/models/webhook.rb +6 -1
- data/lib/appwrite/services/account.rb +48 -0
- data/lib/appwrite/services/activities.rb +4 -1
- data/lib/appwrite/services/backups.rb +12 -3
- data/lib/appwrite/services/databases.rb +233 -42
- data/lib/appwrite/services/documents_db.rb +74 -3
- data/lib/appwrite/services/domains.rb +8 -2
- data/lib/appwrite/services/functions.rb +15 -3
- data/lib/appwrite/services/messaging.rb +16 -4
- data/lib/appwrite/services/mongo.rb +12 -3
- data/lib/appwrite/services/mysql.rb +12 -3
- data/lib/appwrite/services/organization.rb +4 -1
- data/lib/appwrite/services/postgresql.rb +12 -3
- data/lib/appwrite/services/project.rb +38 -5
- data/lib/appwrite/services/sites.rb +16 -4
- data/lib/appwrite/services/storage.rb +15 -3
- data/lib/appwrite/services/tables_db.rb +227 -40
- data/lib/appwrite/services/vectors_db.rb +18 -3
- data/lib/appwrite/services/webhooks.rb +8 -2
- metadata +3 -3
|
@@ -47,6 +47,7 @@ module Appwrite
|
|
|
47
47
|
# @param [String] database_id 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.
|
|
48
48
|
# @param [String] name Database name. Max length: 128 chars.
|
|
49
49
|
# @param [] enabled Is the database enabled? When set to 'disabled', users cannot access the database but Server SDKs with an API key can still read and write to the database. No data is lost when this is toggled.
|
|
50
|
+
# @param [String] description Optional description for the database.
|
|
50
51
|
# @param [String] specification Database specification. Defaults to `serverless`, which creates the database on the shared pool. Any other value provisions a dedicated database on that specification.
|
|
51
52
|
# @param [Integer] replicas Number of high availability replicas (0-5) for the dedicated database backing this database. Requires a dedicated `specification`; must be 0 for a serverless database. High availability is enabled when greater than 0.
|
|
52
53
|
# @param [String] sync_mode Replication sync mode for the dedicated database backing this database. Requires a dedicated `specification`; the mode is only in force once there is at least one replica. Allowed values: async, sync, quorum.
|
|
@@ -56,6 +57,7 @@ module Appwrite
|
|
|
56
57
|
database_id:,
|
|
57
58
|
name:,
|
|
58
59
|
enabled: nil,
|
|
60
|
+
description: nil,
|
|
59
61
|
specification: nil,
|
|
60
62
|
replicas: nil,
|
|
61
63
|
sync_mode: nil
|
|
@@ -74,6 +76,7 @@ module Appwrite
|
|
|
74
76
|
databaseId: database_id,
|
|
75
77
|
name: name,
|
|
76
78
|
enabled: enabled,
|
|
79
|
+
description: description,
|
|
77
80
|
specification: specification,
|
|
78
81
|
replicas: replicas,
|
|
79
82
|
syncMode: sync_mode,
|
|
@@ -353,6 +356,7 @@ module Appwrite
|
|
|
353
356
|
# @param [String] database_id Database ID.
|
|
354
357
|
# @param [String] name Database name. Max length: 128 chars.
|
|
355
358
|
# @param [] enabled Is database enabled? When set to 'disabled', users cannot access the database but Server SDKs with an API key can still read and write to the database. No data is lost when this is toggled.
|
|
359
|
+
# @param [String] description Optional description for the database.
|
|
356
360
|
# @param [String] specification Database specification. Resizing between dedicated specifications changes cpu, memory, storage and the connection ceiling via a rolling cutover with zero downtime. Moving a `serverless` database onto a dedicated specification is a data migration, not a resize.
|
|
357
361
|
# @param [Integer] replicas Number of high availability replicas (0-5) for the dedicated database backing this database. Only valid when the database is backed by a dedicated specification. High availability is enabled when greater than 0.
|
|
358
362
|
# @param [String] sync_mode Replication sync mode for the dedicated database backing this database. Only valid when the database is backed by a dedicated specification; the mode is only in force once there is at least one replica. Allowed values: async, sync, quorum.
|
|
@@ -362,6 +366,7 @@ module Appwrite
|
|
|
362
366
|
database_id:,
|
|
363
367
|
name: nil,
|
|
364
368
|
enabled: nil,
|
|
369
|
+
description: nil,
|
|
365
370
|
specification: nil,
|
|
366
371
|
replicas: nil,
|
|
367
372
|
sync_mode: nil
|
|
@@ -376,6 +381,7 @@ module Appwrite
|
|
|
376
381
|
api_params = {
|
|
377
382
|
name: name,
|
|
378
383
|
enabled: enabled,
|
|
384
|
+
description: description,
|
|
379
385
|
specification: specification,
|
|
380
386
|
replicas: replicas,
|
|
381
387
|
syncMode: sync_mode,
|
|
@@ -842,6 +848,7 @@ module Appwrite
|
|
|
842
848
|
# @param [] enabled Is table enabled? When set to 'disabled', users cannot access the table but Server SDKs with and API key can still read and write to the table. No data is lost when this is toggled.
|
|
843
849
|
# @param [Array] columns Array of column definitions to create. Each column should contain: key (string), type (string: string, varchar, text, mediumtext, longtext, integer, bigint, double, boolean, datetime, point, linestring, polygon, email, url, ip, enum), size (integer, required for string and varchar types), required (boolean, optional), default (mixed, optional), array (boolean, optional), and type-specific options.
|
|
844
850
|
# @param [Array] indexes Array of index definitions to create. Each index should contain: key (string), type (string: key, fulltext, unique, spatial, trigram), attributes (array of column keys), orders (array of ASC/DESC, optional), and lengths (array of integers, optional).
|
|
851
|
+
# @param [String] description Optional description for the table.
|
|
845
852
|
#
|
|
846
853
|
# @return [Table]
|
|
847
854
|
def create_table(
|
|
@@ -852,7 +859,8 @@ module Appwrite
|
|
|
852
859
|
row_security: nil,
|
|
853
860
|
enabled: nil,
|
|
854
861
|
columns: nil,
|
|
855
|
-
indexes: nil
|
|
862
|
+
indexes: nil,
|
|
863
|
+
description: nil
|
|
856
864
|
)
|
|
857
865
|
if database_id.nil? || database_id == ''
|
|
858
866
|
raise Appwrite::Exception.new('Missing required parameter: "databaseId"')
|
|
@@ -877,6 +885,7 @@ module Appwrite
|
|
|
877
885
|
enabled: enabled,
|
|
878
886
|
columns: columns,
|
|
879
887
|
indexes: indexes,
|
|
888
|
+
description: description,
|
|
880
889
|
}
|
|
881
890
|
|
|
882
891
|
api_headers = {
|
|
@@ -942,6 +951,7 @@ module Appwrite
|
|
|
942
951
|
# @param [] row_security Enables configuring permissions for individual rows. A user needs one of row or table-level permissions to access a row. [Learn more about permissions](https://appwrite.io/docs/permissions).
|
|
943
952
|
# @param [] enabled Is table enabled? When set to 'disabled', users cannot access the table but Server SDKs with and API key can still read and write to the table. No data is lost when this is toggled.
|
|
944
953
|
# @param [] purge When true, purge all cached list responses for this table as part of the update. Use this to force readers to see fresh data immediately instead of waiting for the cache TTL to expire.
|
|
954
|
+
# @param [String] description Optional description for the table.
|
|
945
955
|
#
|
|
946
956
|
# @return [Table]
|
|
947
957
|
def update_table(
|
|
@@ -951,7 +961,8 @@ module Appwrite
|
|
|
951
961
|
permissions: nil,
|
|
952
962
|
row_security: nil,
|
|
953
963
|
enabled: nil,
|
|
954
|
-
purge: nil
|
|
964
|
+
purge: nil,
|
|
965
|
+
description: nil
|
|
955
966
|
)
|
|
956
967
|
if database_id.nil? || database_id == ''
|
|
957
968
|
raise Appwrite::Exception.new('Missing required parameter: "databaseId"')
|
|
@@ -971,6 +982,7 @@ module Appwrite
|
|
|
971
982
|
rowSecurity: row_security,
|
|
972
983
|
enabled: enabled,
|
|
973
984
|
purge: purge,
|
|
985
|
+
description: description,
|
|
974
986
|
}
|
|
975
987
|
|
|
976
988
|
api_headers = {
|
|
@@ -1084,6 +1096,7 @@ module Appwrite
|
|
|
1084
1096
|
# @param [Integer] max Maximum value
|
|
1085
1097
|
# @param [Integer] default Default value. Cannot be set when column is required.
|
|
1086
1098
|
# @param [] array Is column an array?
|
|
1099
|
+
# @param [String] description Optional description for the column.
|
|
1087
1100
|
#
|
|
1088
1101
|
# @return [ColumnBigint]
|
|
1089
1102
|
def create_big_int_column(
|
|
@@ -1094,7 +1107,8 @@ module Appwrite
|
|
|
1094
1107
|
min: nil,
|
|
1095
1108
|
max: nil,
|
|
1096
1109
|
default: nil,
|
|
1097
|
-
array: nil
|
|
1110
|
+
array: nil,
|
|
1111
|
+
description: nil
|
|
1098
1112
|
)
|
|
1099
1113
|
if database_id.nil? || database_id == ''
|
|
1100
1114
|
raise Appwrite::Exception.new('Missing required parameter: "databaseId"')
|
|
@@ -1123,6 +1137,7 @@ module Appwrite
|
|
|
1123
1137
|
max: max,
|
|
1124
1138
|
default: default,
|
|
1125
1139
|
array: array,
|
|
1140
|
+
description: description,
|
|
1126
1141
|
}
|
|
1127
1142
|
|
|
1128
1143
|
api_headers = {
|
|
@@ -1152,6 +1167,7 @@ module Appwrite
|
|
|
1152
1167
|
# @param [Integer] min Minimum value
|
|
1153
1168
|
# @param [Integer] max Maximum value
|
|
1154
1169
|
# @param [String] new_key New Column Key.
|
|
1170
|
+
# @param [String] description Optional description for the column.
|
|
1155
1171
|
#
|
|
1156
1172
|
# @return [ColumnBigint]
|
|
1157
1173
|
def update_big_int_column(
|
|
@@ -1162,7 +1178,8 @@ module Appwrite
|
|
|
1162
1178
|
default:,
|
|
1163
1179
|
min: nil,
|
|
1164
1180
|
max: nil,
|
|
1165
|
-
new_key: nil
|
|
1181
|
+
new_key: nil,
|
|
1182
|
+
description: nil
|
|
1166
1183
|
)
|
|
1167
1184
|
if database_id.nil? || database_id == ''
|
|
1168
1185
|
raise Appwrite::Exception.new('Missing required parameter: "databaseId"')
|
|
@@ -1195,6 +1212,7 @@ module Appwrite
|
|
|
1195
1212
|
max: max,
|
|
1196
1213
|
default: default,
|
|
1197
1214
|
newKey: new_key,
|
|
1215
|
+
description: description,
|
|
1198
1216
|
}
|
|
1199
1217
|
|
|
1200
1218
|
api_headers = {
|
|
@@ -1221,6 +1239,7 @@ module Appwrite
|
|
|
1221
1239
|
# @param [] required Is column required?
|
|
1222
1240
|
# @param [] default Default value for column when not provided. Cannot be set when column is required.
|
|
1223
1241
|
# @param [] array Is column an array?
|
|
1242
|
+
# @param [String] description Optional description for the column.
|
|
1224
1243
|
#
|
|
1225
1244
|
# @return [ColumnBoolean]
|
|
1226
1245
|
def create_boolean_column(
|
|
@@ -1229,7 +1248,8 @@ module Appwrite
|
|
|
1229
1248
|
key:,
|
|
1230
1249
|
required:,
|
|
1231
1250
|
default: nil,
|
|
1232
|
-
array: nil
|
|
1251
|
+
array: nil,
|
|
1252
|
+
description: nil
|
|
1233
1253
|
)
|
|
1234
1254
|
if database_id.nil? || database_id == ''
|
|
1235
1255
|
raise Appwrite::Exception.new('Missing required parameter: "databaseId"')
|
|
@@ -1256,6 +1276,7 @@ module Appwrite
|
|
|
1256
1276
|
required: required,
|
|
1257
1277
|
default: default,
|
|
1258
1278
|
array: array,
|
|
1279
|
+
description: description,
|
|
1259
1280
|
}
|
|
1260
1281
|
|
|
1261
1282
|
api_headers = {
|
|
@@ -1282,6 +1303,7 @@ module Appwrite
|
|
|
1282
1303
|
# @param [] required Is column required?
|
|
1283
1304
|
# @param [] default Default value for column when not provided. Cannot be set when column is required.
|
|
1284
1305
|
# @param [String] new_key New Column Key.
|
|
1306
|
+
# @param [String] description Optional description for the column.
|
|
1285
1307
|
#
|
|
1286
1308
|
# @return [ColumnBoolean]
|
|
1287
1309
|
def update_boolean_column(
|
|
@@ -1290,7 +1312,8 @@ module Appwrite
|
|
|
1290
1312
|
key:,
|
|
1291
1313
|
required:,
|
|
1292
1314
|
default:,
|
|
1293
|
-
new_key: nil
|
|
1315
|
+
new_key: nil,
|
|
1316
|
+
description: nil
|
|
1294
1317
|
)
|
|
1295
1318
|
if database_id.nil? || database_id == ''
|
|
1296
1319
|
raise Appwrite::Exception.new('Missing required parameter: "databaseId"')
|
|
@@ -1321,6 +1344,7 @@ module Appwrite
|
|
|
1321
1344
|
required: required,
|
|
1322
1345
|
default: default,
|
|
1323
1346
|
newKey: new_key,
|
|
1347
|
+
description: description,
|
|
1324
1348
|
}
|
|
1325
1349
|
|
|
1326
1350
|
api_headers = {
|
|
@@ -1346,6 +1370,7 @@ module Appwrite
|
|
|
1346
1370
|
# @param [] required Is column required?
|
|
1347
1371
|
# @param [String] default Default value for the column in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Cannot be set when column is required.
|
|
1348
1372
|
# @param [] array Is column an array?
|
|
1373
|
+
# @param [String] description Optional description for the column.
|
|
1349
1374
|
#
|
|
1350
1375
|
# @return [ColumnDatetime]
|
|
1351
1376
|
def create_datetime_column(
|
|
@@ -1354,7 +1379,8 @@ module Appwrite
|
|
|
1354
1379
|
key:,
|
|
1355
1380
|
required:,
|
|
1356
1381
|
default: nil,
|
|
1357
|
-
array: nil
|
|
1382
|
+
array: nil,
|
|
1383
|
+
description: nil
|
|
1358
1384
|
)
|
|
1359
1385
|
if database_id.nil? || database_id == ''
|
|
1360
1386
|
raise Appwrite::Exception.new('Missing required parameter: "databaseId"')
|
|
@@ -1381,6 +1407,7 @@ module Appwrite
|
|
|
1381
1407
|
required: required,
|
|
1382
1408
|
default: default,
|
|
1383
1409
|
array: array,
|
|
1410
|
+
description: description,
|
|
1384
1411
|
}
|
|
1385
1412
|
|
|
1386
1413
|
api_headers = {
|
|
@@ -1407,6 +1434,7 @@ module Appwrite
|
|
|
1407
1434
|
# @param [] required Is column required?
|
|
1408
1435
|
# @param [String] default Default value for column when not provided. Cannot be set when column is required.
|
|
1409
1436
|
# @param [String] new_key New Column Key.
|
|
1437
|
+
# @param [String] description Optional description for the column.
|
|
1410
1438
|
#
|
|
1411
1439
|
# @return [ColumnDatetime]
|
|
1412
1440
|
def update_datetime_column(
|
|
@@ -1415,7 +1443,8 @@ module Appwrite
|
|
|
1415
1443
|
key:,
|
|
1416
1444
|
required:,
|
|
1417
1445
|
default:,
|
|
1418
|
-
new_key: nil
|
|
1446
|
+
new_key: nil,
|
|
1447
|
+
description: nil
|
|
1419
1448
|
)
|
|
1420
1449
|
if database_id.nil? || database_id == ''
|
|
1421
1450
|
raise Appwrite::Exception.new('Missing required parameter: "databaseId"')
|
|
@@ -1446,6 +1475,7 @@ module Appwrite
|
|
|
1446
1475
|
required: required,
|
|
1447
1476
|
default: default,
|
|
1448
1477
|
newKey: new_key,
|
|
1478
|
+
description: description,
|
|
1449
1479
|
}
|
|
1450
1480
|
|
|
1451
1481
|
api_headers = {
|
|
@@ -1472,6 +1502,7 @@ module Appwrite
|
|
|
1472
1502
|
# @param [] required Is column required?
|
|
1473
1503
|
# @param [String] default Default value for column when not provided. Cannot be set when column is required.
|
|
1474
1504
|
# @param [] array Is column an array?
|
|
1505
|
+
# @param [String] description Optional description for the column.
|
|
1475
1506
|
#
|
|
1476
1507
|
# @return [ColumnEmail]
|
|
1477
1508
|
def create_email_column(
|
|
@@ -1480,7 +1511,8 @@ module Appwrite
|
|
|
1480
1511
|
key:,
|
|
1481
1512
|
required:,
|
|
1482
1513
|
default: nil,
|
|
1483
|
-
array: nil
|
|
1514
|
+
array: nil,
|
|
1515
|
+
description: nil
|
|
1484
1516
|
)
|
|
1485
1517
|
if database_id.nil? || database_id == ''
|
|
1486
1518
|
raise Appwrite::Exception.new('Missing required parameter: "databaseId"')
|
|
@@ -1507,6 +1539,7 @@ module Appwrite
|
|
|
1507
1539
|
required: required,
|
|
1508
1540
|
default: default,
|
|
1509
1541
|
array: array,
|
|
1542
|
+
description: description,
|
|
1510
1543
|
}
|
|
1511
1544
|
|
|
1512
1545
|
api_headers = {
|
|
@@ -1534,6 +1567,7 @@ module Appwrite
|
|
|
1534
1567
|
# @param [] required Is column required?
|
|
1535
1568
|
# @param [String] default Default value for column when not provided. Cannot be set when column is required.
|
|
1536
1569
|
# @param [String] new_key New Column Key.
|
|
1570
|
+
# @param [String] description Optional description for the column.
|
|
1537
1571
|
#
|
|
1538
1572
|
# @return [ColumnEmail]
|
|
1539
1573
|
def update_email_column(
|
|
@@ -1542,7 +1576,8 @@ module Appwrite
|
|
|
1542
1576
|
key:,
|
|
1543
1577
|
required:,
|
|
1544
1578
|
default:,
|
|
1545
|
-
new_key: nil
|
|
1579
|
+
new_key: nil,
|
|
1580
|
+
description: nil
|
|
1546
1581
|
)
|
|
1547
1582
|
if database_id.nil? || database_id == ''
|
|
1548
1583
|
raise Appwrite::Exception.new('Missing required parameter: "databaseId"')
|
|
@@ -1573,6 +1608,7 @@ module Appwrite
|
|
|
1573
1608
|
required: required,
|
|
1574
1609
|
default: default,
|
|
1575
1610
|
newKey: new_key,
|
|
1611
|
+
description: description,
|
|
1576
1612
|
}
|
|
1577
1613
|
|
|
1578
1614
|
api_headers = {
|
|
@@ -1600,6 +1636,7 @@ module Appwrite
|
|
|
1600
1636
|
# @param [] required Is column required?
|
|
1601
1637
|
# @param [String] default Default value for column when not provided. Cannot be set when column is required.
|
|
1602
1638
|
# @param [] array Is column an array?
|
|
1639
|
+
# @param [String] description Optional description for the column.
|
|
1603
1640
|
#
|
|
1604
1641
|
# @return [ColumnEnum]
|
|
1605
1642
|
def create_enum_column(
|
|
@@ -1609,7 +1646,8 @@ module Appwrite
|
|
|
1609
1646
|
elements:,
|
|
1610
1647
|
required:,
|
|
1611
1648
|
default: nil,
|
|
1612
|
-
array: nil
|
|
1649
|
+
array: nil,
|
|
1650
|
+
description: nil
|
|
1613
1651
|
)
|
|
1614
1652
|
if database_id.nil? || database_id == ''
|
|
1615
1653
|
raise Appwrite::Exception.new('Missing required parameter: "databaseId"')
|
|
@@ -1641,6 +1679,7 @@ module Appwrite
|
|
|
1641
1679
|
required: required,
|
|
1642
1680
|
default: default,
|
|
1643
1681
|
array: array,
|
|
1682
|
+
description: description,
|
|
1644
1683
|
}
|
|
1645
1684
|
|
|
1646
1685
|
api_headers = {
|
|
@@ -1669,6 +1708,7 @@ module Appwrite
|
|
|
1669
1708
|
# @param [] required Is column required?
|
|
1670
1709
|
# @param [String] default Default value for column when not provided. Cannot be set when column is required.
|
|
1671
1710
|
# @param [String] new_key New Column Key.
|
|
1711
|
+
# @param [String] description Optional description for the column.
|
|
1672
1712
|
#
|
|
1673
1713
|
# @return [ColumnEnum]
|
|
1674
1714
|
def update_enum_column(
|
|
@@ -1678,7 +1718,8 @@ module Appwrite
|
|
|
1678
1718
|
elements:,
|
|
1679
1719
|
required:,
|
|
1680
1720
|
default:,
|
|
1681
|
-
new_key: nil
|
|
1721
|
+
new_key: nil,
|
|
1722
|
+
description: nil
|
|
1682
1723
|
)
|
|
1683
1724
|
if database_id.nil? || database_id == ''
|
|
1684
1725
|
raise Appwrite::Exception.new('Missing required parameter: "databaseId"')
|
|
@@ -1714,6 +1755,7 @@ module Appwrite
|
|
|
1714
1755
|
required: required,
|
|
1715
1756
|
default: default,
|
|
1716
1757
|
newKey: new_key,
|
|
1758
|
+
description: description,
|
|
1717
1759
|
}
|
|
1718
1760
|
|
|
1719
1761
|
api_headers = {
|
|
@@ -1743,6 +1785,7 @@ module Appwrite
|
|
|
1743
1785
|
# @param [Float] max Maximum value
|
|
1744
1786
|
# @param [Float] default Default value. Cannot be set when required.
|
|
1745
1787
|
# @param [] array Is column an array?
|
|
1788
|
+
# @param [String] description Optional description for the column.
|
|
1746
1789
|
#
|
|
1747
1790
|
# @return [ColumnFloat]
|
|
1748
1791
|
def create_float_column(
|
|
@@ -1753,7 +1796,8 @@ module Appwrite
|
|
|
1753
1796
|
min: nil,
|
|
1754
1797
|
max: nil,
|
|
1755
1798
|
default: nil,
|
|
1756
|
-
array: nil
|
|
1799
|
+
array: nil,
|
|
1800
|
+
description: nil
|
|
1757
1801
|
)
|
|
1758
1802
|
if database_id.nil? || database_id == ''
|
|
1759
1803
|
raise Appwrite::Exception.new('Missing required parameter: "databaseId"')
|
|
@@ -1782,6 +1826,7 @@ module Appwrite
|
|
|
1782
1826
|
max: max,
|
|
1783
1827
|
default: default,
|
|
1784
1828
|
array: array,
|
|
1829
|
+
description: description,
|
|
1785
1830
|
}
|
|
1786
1831
|
|
|
1787
1832
|
api_headers = {
|
|
@@ -1811,6 +1856,7 @@ module Appwrite
|
|
|
1811
1856
|
# @param [Float] min Minimum value
|
|
1812
1857
|
# @param [Float] max Maximum value
|
|
1813
1858
|
# @param [String] new_key New Column Key.
|
|
1859
|
+
# @param [String] description Optional description for the column.
|
|
1814
1860
|
#
|
|
1815
1861
|
# @return [ColumnFloat]
|
|
1816
1862
|
def update_float_column(
|
|
@@ -1821,7 +1867,8 @@ module Appwrite
|
|
|
1821
1867
|
default:,
|
|
1822
1868
|
min: nil,
|
|
1823
1869
|
max: nil,
|
|
1824
|
-
new_key: nil
|
|
1870
|
+
new_key: nil,
|
|
1871
|
+
description: nil
|
|
1825
1872
|
)
|
|
1826
1873
|
if database_id.nil? || database_id == ''
|
|
1827
1874
|
raise Appwrite::Exception.new('Missing required parameter: "databaseId"')
|
|
@@ -1854,6 +1901,7 @@ module Appwrite
|
|
|
1854
1901
|
max: max,
|
|
1855
1902
|
default: default,
|
|
1856
1903
|
newKey: new_key,
|
|
1904
|
+
description: description,
|
|
1857
1905
|
}
|
|
1858
1906
|
|
|
1859
1907
|
api_headers = {
|
|
@@ -1883,6 +1931,7 @@ module Appwrite
|
|
|
1883
1931
|
# @param [Integer] max Maximum value
|
|
1884
1932
|
# @param [Integer] default Default value. Cannot be set when column is required.
|
|
1885
1933
|
# @param [] array Is column an array?
|
|
1934
|
+
# @param [String] description Optional description for the column.
|
|
1886
1935
|
#
|
|
1887
1936
|
# @return [ColumnInteger]
|
|
1888
1937
|
def create_integer_column(
|
|
@@ -1893,7 +1942,8 @@ module Appwrite
|
|
|
1893
1942
|
min: nil,
|
|
1894
1943
|
max: nil,
|
|
1895
1944
|
default: nil,
|
|
1896
|
-
array: nil
|
|
1945
|
+
array: nil,
|
|
1946
|
+
description: nil
|
|
1897
1947
|
)
|
|
1898
1948
|
if database_id.nil? || database_id == ''
|
|
1899
1949
|
raise Appwrite::Exception.new('Missing required parameter: "databaseId"')
|
|
@@ -1922,6 +1972,7 @@ module Appwrite
|
|
|
1922
1972
|
max: max,
|
|
1923
1973
|
default: default,
|
|
1924
1974
|
array: array,
|
|
1975
|
+
description: description,
|
|
1925
1976
|
}
|
|
1926
1977
|
|
|
1927
1978
|
api_headers = {
|
|
@@ -1951,6 +2002,7 @@ module Appwrite
|
|
|
1951
2002
|
# @param [Integer] min Minimum value
|
|
1952
2003
|
# @param [Integer] max Maximum value
|
|
1953
2004
|
# @param [String] new_key New Column Key.
|
|
2005
|
+
# @param [String] description Optional description for the column.
|
|
1954
2006
|
#
|
|
1955
2007
|
# @return [ColumnInteger]
|
|
1956
2008
|
def update_integer_column(
|
|
@@ -1961,7 +2013,8 @@ module Appwrite
|
|
|
1961
2013
|
default:,
|
|
1962
2014
|
min: nil,
|
|
1963
2015
|
max: nil,
|
|
1964
|
-
new_key: nil
|
|
2016
|
+
new_key: nil,
|
|
2017
|
+
description: nil
|
|
1965
2018
|
)
|
|
1966
2019
|
if database_id.nil? || database_id == ''
|
|
1967
2020
|
raise Appwrite::Exception.new('Missing required parameter: "databaseId"')
|
|
@@ -1994,6 +2047,7 @@ module Appwrite
|
|
|
1994
2047
|
max: max,
|
|
1995
2048
|
default: default,
|
|
1996
2049
|
newKey: new_key,
|
|
2050
|
+
description: description,
|
|
1997
2051
|
}
|
|
1998
2052
|
|
|
1999
2053
|
api_headers = {
|
|
@@ -2020,6 +2074,7 @@ module Appwrite
|
|
|
2020
2074
|
# @param [] required Is column required?
|
|
2021
2075
|
# @param [String] default Default value. Cannot be set when column is required.
|
|
2022
2076
|
# @param [] array Is column an array?
|
|
2077
|
+
# @param [String] description Optional description for the column.
|
|
2023
2078
|
#
|
|
2024
2079
|
# @return [ColumnIp]
|
|
2025
2080
|
def create_ip_column(
|
|
@@ -2028,7 +2083,8 @@ module Appwrite
|
|
|
2028
2083
|
key:,
|
|
2029
2084
|
required:,
|
|
2030
2085
|
default: nil,
|
|
2031
|
-
array: nil
|
|
2086
|
+
array: nil,
|
|
2087
|
+
description: nil
|
|
2032
2088
|
)
|
|
2033
2089
|
if database_id.nil? || database_id == ''
|
|
2034
2090
|
raise Appwrite::Exception.new('Missing required parameter: "databaseId"')
|
|
@@ -2055,6 +2111,7 @@ module Appwrite
|
|
|
2055
2111
|
required: required,
|
|
2056
2112
|
default: default,
|
|
2057
2113
|
array: array,
|
|
2114
|
+
description: description,
|
|
2058
2115
|
}
|
|
2059
2116
|
|
|
2060
2117
|
api_headers = {
|
|
@@ -2082,6 +2139,7 @@ module Appwrite
|
|
|
2082
2139
|
# @param [] required Is column required?
|
|
2083
2140
|
# @param [String] default Default value. Cannot be set when column is required.
|
|
2084
2141
|
# @param [String] new_key New Column Key.
|
|
2142
|
+
# @param [String] description Optional description for the column.
|
|
2085
2143
|
#
|
|
2086
2144
|
# @return [ColumnIp]
|
|
2087
2145
|
def update_ip_column(
|
|
@@ -2090,7 +2148,8 @@ module Appwrite
|
|
|
2090
2148
|
key:,
|
|
2091
2149
|
required:,
|
|
2092
2150
|
default:,
|
|
2093
|
-
new_key: nil
|
|
2151
|
+
new_key: nil,
|
|
2152
|
+
description: nil
|
|
2094
2153
|
)
|
|
2095
2154
|
if database_id.nil? || database_id == ''
|
|
2096
2155
|
raise Appwrite::Exception.new('Missing required parameter: "databaseId"')
|
|
@@ -2121,6 +2180,7 @@ module Appwrite
|
|
|
2121
2180
|
required: required,
|
|
2122
2181
|
default: default,
|
|
2123
2182
|
newKey: new_key,
|
|
2183
|
+
description: description,
|
|
2124
2184
|
}
|
|
2125
2185
|
|
|
2126
2186
|
api_headers = {
|
|
@@ -2145,6 +2205,7 @@ module Appwrite
|
|
|
2145
2205
|
# @param [String] key Column Key.
|
|
2146
2206
|
# @param [] required Is column required?
|
|
2147
2207
|
# @param [Array] default 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.
|
|
2208
|
+
# @param [String] description Optional description for the column.
|
|
2148
2209
|
#
|
|
2149
2210
|
# @return [ColumnLine]
|
|
2150
2211
|
def create_line_column(
|
|
@@ -2152,7 +2213,8 @@ module Appwrite
|
|
|
2152
2213
|
table_id:,
|
|
2153
2214
|
key:,
|
|
2154
2215
|
required:,
|
|
2155
|
-
default: nil
|
|
2216
|
+
default: nil,
|
|
2217
|
+
description: nil
|
|
2156
2218
|
)
|
|
2157
2219
|
if database_id.nil? || database_id == ''
|
|
2158
2220
|
raise Appwrite::Exception.new('Missing required parameter: "databaseId"')
|
|
@@ -2178,6 +2240,7 @@ module Appwrite
|
|
|
2178
2240
|
key: key,
|
|
2179
2241
|
required: required,
|
|
2180
2242
|
default: default,
|
|
2243
|
+
description: description,
|
|
2181
2244
|
}
|
|
2182
2245
|
|
|
2183
2246
|
api_headers = {
|
|
@@ -2204,6 +2267,7 @@ module Appwrite
|
|
|
2204
2267
|
# @param [] required Is column required?
|
|
2205
2268
|
# @param [Array] default 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.
|
|
2206
2269
|
# @param [String] new_key New Column Key.
|
|
2270
|
+
# @param [String] description Optional description for the column.
|
|
2207
2271
|
#
|
|
2208
2272
|
# @return [ColumnLine]
|
|
2209
2273
|
def update_line_column(
|
|
@@ -2212,7 +2276,8 @@ module Appwrite
|
|
|
2212
2276
|
key:,
|
|
2213
2277
|
required:,
|
|
2214
2278
|
default: nil,
|
|
2215
|
-
new_key: nil
|
|
2279
|
+
new_key: nil,
|
|
2280
|
+
description: nil
|
|
2216
2281
|
)
|
|
2217
2282
|
if database_id.nil? || database_id == ''
|
|
2218
2283
|
raise Appwrite::Exception.new('Missing required parameter: "databaseId"')
|
|
@@ -2239,6 +2304,7 @@ module Appwrite
|
|
|
2239
2304
|
required: required,
|
|
2240
2305
|
default: default,
|
|
2241
2306
|
newKey: new_key,
|
|
2307
|
+
description: description,
|
|
2242
2308
|
}
|
|
2243
2309
|
|
|
2244
2310
|
api_headers = {
|
|
@@ -2266,6 +2332,7 @@ module Appwrite
|
|
|
2266
2332
|
# @param [String] default Default value for column when not provided. Cannot be set when column is required.
|
|
2267
2333
|
# @param [] array Is column an array?
|
|
2268
2334
|
# @param [] encrypt Toggle encryption for the column. Encryption enhances security by not storing any plain text values in the database. However, encrypted columns cannot be queried.
|
|
2335
|
+
# @param [String] description Optional description for the column.
|
|
2269
2336
|
#
|
|
2270
2337
|
# @return [ColumnLongtext]
|
|
2271
2338
|
def create_longtext_column(
|
|
@@ -2275,7 +2342,8 @@ module Appwrite
|
|
|
2275
2342
|
required:,
|
|
2276
2343
|
default: nil,
|
|
2277
2344
|
array: nil,
|
|
2278
|
-
encrypt: nil
|
|
2345
|
+
encrypt: nil,
|
|
2346
|
+
description: nil
|
|
2279
2347
|
)
|
|
2280
2348
|
if database_id.nil? || database_id == ''
|
|
2281
2349
|
raise Appwrite::Exception.new('Missing required parameter: "databaseId"')
|
|
@@ -2303,6 +2371,7 @@ module Appwrite
|
|
|
2303
2371
|
default: default,
|
|
2304
2372
|
array: array,
|
|
2305
2373
|
encrypt: encrypt,
|
|
2374
|
+
description: description,
|
|
2306
2375
|
}
|
|
2307
2376
|
|
|
2308
2377
|
api_headers = {
|
|
@@ -2330,6 +2399,7 @@ module Appwrite
|
|
|
2330
2399
|
# @param [] required Is column required?
|
|
2331
2400
|
# @param [String] default Default value for column when not provided. Cannot be set when column is required.
|
|
2332
2401
|
# @param [String] new_key New Column Key.
|
|
2402
|
+
# @param [String] description Optional description for the column.
|
|
2333
2403
|
#
|
|
2334
2404
|
# @return [ColumnLongtext]
|
|
2335
2405
|
def update_longtext_column(
|
|
@@ -2338,7 +2408,8 @@ module Appwrite
|
|
|
2338
2408
|
key:,
|
|
2339
2409
|
required:,
|
|
2340
2410
|
default:,
|
|
2341
|
-
new_key: nil
|
|
2411
|
+
new_key: nil,
|
|
2412
|
+
description: nil
|
|
2342
2413
|
)
|
|
2343
2414
|
if database_id.nil? || database_id == ''
|
|
2344
2415
|
raise Appwrite::Exception.new('Missing required parameter: "databaseId"')
|
|
@@ -2369,6 +2440,7 @@ module Appwrite
|
|
|
2369
2440
|
required: required,
|
|
2370
2441
|
default: default,
|
|
2371
2442
|
newKey: new_key,
|
|
2443
|
+
description: description,
|
|
2372
2444
|
}
|
|
2373
2445
|
|
|
2374
2446
|
api_headers = {
|
|
@@ -2396,6 +2468,7 @@ module Appwrite
|
|
|
2396
2468
|
# @param [String] default Default value for column when not provided. Cannot be set when column is required.
|
|
2397
2469
|
# @param [] array Is column an array?
|
|
2398
2470
|
# @param [] encrypt Toggle encryption for the column. Encryption enhances security by not storing any plain text values in the database. However, encrypted columns cannot be queried.
|
|
2471
|
+
# @param [String] description Optional description for the column.
|
|
2399
2472
|
#
|
|
2400
2473
|
# @return [ColumnMediumtext]
|
|
2401
2474
|
def create_mediumtext_column(
|
|
@@ -2405,7 +2478,8 @@ module Appwrite
|
|
|
2405
2478
|
required:,
|
|
2406
2479
|
default: nil,
|
|
2407
2480
|
array: nil,
|
|
2408
|
-
encrypt: nil
|
|
2481
|
+
encrypt: nil,
|
|
2482
|
+
description: nil
|
|
2409
2483
|
)
|
|
2410
2484
|
if database_id.nil? || database_id == ''
|
|
2411
2485
|
raise Appwrite::Exception.new('Missing required parameter: "databaseId"')
|
|
@@ -2433,6 +2507,7 @@ module Appwrite
|
|
|
2433
2507
|
default: default,
|
|
2434
2508
|
array: array,
|
|
2435
2509
|
encrypt: encrypt,
|
|
2510
|
+
description: description,
|
|
2436
2511
|
}
|
|
2437
2512
|
|
|
2438
2513
|
api_headers = {
|
|
@@ -2460,6 +2535,7 @@ module Appwrite
|
|
|
2460
2535
|
# @param [] required Is column required?
|
|
2461
2536
|
# @param [String] default Default value for column when not provided. Cannot be set when column is required.
|
|
2462
2537
|
# @param [String] new_key New Column Key.
|
|
2538
|
+
# @param [String] description Optional description for the column.
|
|
2463
2539
|
#
|
|
2464
2540
|
# @return [ColumnMediumtext]
|
|
2465
2541
|
def update_mediumtext_column(
|
|
@@ -2468,7 +2544,8 @@ module Appwrite
|
|
|
2468
2544
|
key:,
|
|
2469
2545
|
required:,
|
|
2470
2546
|
default:,
|
|
2471
|
-
new_key: nil
|
|
2547
|
+
new_key: nil,
|
|
2548
|
+
description: nil
|
|
2472
2549
|
)
|
|
2473
2550
|
if database_id.nil? || database_id == ''
|
|
2474
2551
|
raise Appwrite::Exception.new('Missing required parameter: "databaseId"')
|
|
@@ -2499,6 +2576,7 @@ module Appwrite
|
|
|
2499
2576
|
required: required,
|
|
2500
2577
|
default: default,
|
|
2501
2578
|
newKey: new_key,
|
|
2579
|
+
description: description,
|
|
2502
2580
|
}
|
|
2503
2581
|
|
|
2504
2582
|
api_headers = {
|
|
@@ -2523,6 +2601,7 @@ module Appwrite
|
|
|
2523
2601
|
# @param [String] key Column Key.
|
|
2524
2602
|
# @param [] required Is column required?
|
|
2525
2603
|
# @param [Array] default Default value for column when not provided, array of two numbers [longitude, latitude], representing a single coordinate. Cannot be set when column is required.
|
|
2604
|
+
# @param [String] description Optional description for the column.
|
|
2526
2605
|
#
|
|
2527
2606
|
# @return [ColumnPoint]
|
|
2528
2607
|
def create_point_column(
|
|
@@ -2530,7 +2609,8 @@ module Appwrite
|
|
|
2530
2609
|
table_id:,
|
|
2531
2610
|
key:,
|
|
2532
2611
|
required:,
|
|
2533
|
-
default: nil
|
|
2612
|
+
default: nil,
|
|
2613
|
+
description: nil
|
|
2534
2614
|
)
|
|
2535
2615
|
if database_id.nil? || database_id == ''
|
|
2536
2616
|
raise Appwrite::Exception.new('Missing required parameter: "databaseId"')
|
|
@@ -2556,6 +2636,7 @@ module Appwrite
|
|
|
2556
2636
|
key: key,
|
|
2557
2637
|
required: required,
|
|
2558
2638
|
default: default,
|
|
2639
|
+
description: description,
|
|
2559
2640
|
}
|
|
2560
2641
|
|
|
2561
2642
|
api_headers = {
|
|
@@ -2582,6 +2663,7 @@ module Appwrite
|
|
|
2582
2663
|
# @param [] required Is column required?
|
|
2583
2664
|
# @param [Array] default Default value for column when not provided, array of two numbers [longitude, latitude], representing a single coordinate. Cannot be set when column is required.
|
|
2584
2665
|
# @param [String] new_key New Column Key.
|
|
2666
|
+
# @param [String] description Optional description for the column.
|
|
2585
2667
|
#
|
|
2586
2668
|
# @return [ColumnPoint]
|
|
2587
2669
|
def update_point_column(
|
|
@@ -2590,7 +2672,8 @@ module Appwrite
|
|
|
2590
2672
|
key:,
|
|
2591
2673
|
required:,
|
|
2592
2674
|
default: nil,
|
|
2593
|
-
new_key: nil
|
|
2675
|
+
new_key: nil,
|
|
2676
|
+
description: nil
|
|
2594
2677
|
)
|
|
2595
2678
|
if database_id.nil? || database_id == ''
|
|
2596
2679
|
raise Appwrite::Exception.new('Missing required parameter: "databaseId"')
|
|
@@ -2617,6 +2700,7 @@ module Appwrite
|
|
|
2617
2700
|
required: required,
|
|
2618
2701
|
default: default,
|
|
2619
2702
|
newKey: new_key,
|
|
2703
|
+
description: description,
|
|
2620
2704
|
}
|
|
2621
2705
|
|
|
2622
2706
|
api_headers = {
|
|
@@ -2641,6 +2725,7 @@ module Appwrite
|
|
|
2641
2725
|
# @param [String] key Column Key.
|
|
2642
2726
|
# @param [] required Is column required?
|
|
2643
2727
|
# @param [Array] default 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.
|
|
2728
|
+
# @param [String] description Optional description for the column.
|
|
2644
2729
|
#
|
|
2645
2730
|
# @return [ColumnPolygon]
|
|
2646
2731
|
def create_polygon_column(
|
|
@@ -2648,7 +2733,8 @@ module Appwrite
|
|
|
2648
2733
|
table_id:,
|
|
2649
2734
|
key:,
|
|
2650
2735
|
required:,
|
|
2651
|
-
default: nil
|
|
2736
|
+
default: nil,
|
|
2737
|
+
description: nil
|
|
2652
2738
|
)
|
|
2653
2739
|
if database_id.nil? || database_id == ''
|
|
2654
2740
|
raise Appwrite::Exception.new('Missing required parameter: "databaseId"')
|
|
@@ -2674,6 +2760,7 @@ module Appwrite
|
|
|
2674
2760
|
key: key,
|
|
2675
2761
|
required: required,
|
|
2676
2762
|
default: default,
|
|
2763
|
+
description: description,
|
|
2677
2764
|
}
|
|
2678
2765
|
|
|
2679
2766
|
api_headers = {
|
|
@@ -2700,6 +2787,7 @@ module Appwrite
|
|
|
2700
2787
|
# @param [] required Is column required?
|
|
2701
2788
|
# @param [Array] default 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.
|
|
2702
2789
|
# @param [String] new_key New Column Key.
|
|
2790
|
+
# @param [String] description Optional description for the column.
|
|
2703
2791
|
#
|
|
2704
2792
|
# @return [ColumnPolygon]
|
|
2705
2793
|
def update_polygon_column(
|
|
@@ -2708,7 +2796,8 @@ module Appwrite
|
|
|
2708
2796
|
key:,
|
|
2709
2797
|
required:,
|
|
2710
2798
|
default: nil,
|
|
2711
|
-
new_key: nil
|
|
2799
|
+
new_key: nil,
|
|
2800
|
+
description: nil
|
|
2712
2801
|
)
|
|
2713
2802
|
if database_id.nil? || database_id == ''
|
|
2714
2803
|
raise Appwrite::Exception.new('Missing required parameter: "databaseId"')
|
|
@@ -2735,6 +2824,7 @@ module Appwrite
|
|
|
2735
2824
|
required: required,
|
|
2736
2825
|
default: default,
|
|
2737
2826
|
newKey: new_key,
|
|
2827
|
+
description: description,
|
|
2738
2828
|
}
|
|
2739
2829
|
|
|
2740
2830
|
api_headers = {
|
|
@@ -2764,6 +2854,7 @@ module Appwrite
|
|
|
2764
2854
|
# @param [String] key Column Key.
|
|
2765
2855
|
# @param [String] two_way_key Two Way Column Key.
|
|
2766
2856
|
# @param [RelationMutate] on_delete Delete constraint. Possible values are: cascade, restrict, setNull.
|
|
2857
|
+
# @param [String] description Optional description for the column.
|
|
2767
2858
|
#
|
|
2768
2859
|
# @return [ColumnRelationship]
|
|
2769
2860
|
def create_relationship_column(
|
|
@@ -2774,7 +2865,8 @@ module Appwrite
|
|
|
2774
2865
|
two_way: nil,
|
|
2775
2866
|
key: nil,
|
|
2776
2867
|
two_way_key: nil,
|
|
2777
|
-
on_delete: nil
|
|
2868
|
+
on_delete: nil,
|
|
2869
|
+
description: nil
|
|
2778
2870
|
)
|
|
2779
2871
|
if database_id.nil? || database_id == ''
|
|
2780
2872
|
raise Appwrite::Exception.new('Missing required parameter: "databaseId"')
|
|
@@ -2803,6 +2895,7 @@ module Appwrite
|
|
|
2803
2895
|
key: key,
|
|
2804
2896
|
twoWayKey: two_way_key,
|
|
2805
2897
|
onDelete: on_delete,
|
|
2898
|
+
description: description,
|
|
2806
2899
|
}
|
|
2807
2900
|
|
|
2808
2901
|
api_headers = {
|
|
@@ -2829,6 +2922,7 @@ module Appwrite
|
|
|
2829
2922
|
# @param [String] key Column Key.
|
|
2830
2923
|
# @param [RelationMutate] on_delete Delete constraint. Possible values are: cascade, restrict, setNull.
|
|
2831
2924
|
# @param [String] new_key New Column Key.
|
|
2925
|
+
# @param [String] description Optional description for the column.
|
|
2832
2926
|
#
|
|
2833
2927
|
# @return [ColumnRelationship]
|
|
2834
2928
|
def update_relationship_column(
|
|
@@ -2836,7 +2930,8 @@ module Appwrite
|
|
|
2836
2930
|
table_id:,
|
|
2837
2931
|
key:,
|
|
2838
2932
|
on_delete: nil,
|
|
2839
|
-
new_key: nil
|
|
2933
|
+
new_key: nil,
|
|
2934
|
+
description: nil
|
|
2840
2935
|
)
|
|
2841
2936
|
if database_id.nil? || database_id == ''
|
|
2842
2937
|
raise Appwrite::Exception.new('Missing required parameter: "databaseId"')
|
|
@@ -2858,6 +2953,7 @@ module Appwrite
|
|
|
2858
2953
|
api_params = {
|
|
2859
2954
|
onDelete: on_delete,
|
|
2860
2955
|
newKey: new_key,
|
|
2956
|
+
description: description,
|
|
2861
2957
|
}
|
|
2862
2958
|
|
|
2863
2959
|
api_headers = {
|
|
@@ -2889,6 +2985,7 @@ module Appwrite
|
|
|
2889
2985
|
# @param [String] default Default value for column when not provided. Cannot be set when column is required.
|
|
2890
2986
|
# @param [] array Is column an array?
|
|
2891
2987
|
# @param [] encrypt Toggle encryption for the column. Encryption enhances security by not storing any plain text values in the database. However, encrypted columns cannot be queried.
|
|
2988
|
+
# @param [String] description Optional description for the column.
|
|
2892
2989
|
#
|
|
2893
2990
|
# @return [ColumnString]
|
|
2894
2991
|
def create_string_column(
|
|
@@ -2899,7 +2996,8 @@ module Appwrite
|
|
|
2899
2996
|
required:,
|
|
2900
2997
|
default: nil,
|
|
2901
2998
|
array: nil,
|
|
2902
|
-
encrypt: nil
|
|
2999
|
+
encrypt: nil,
|
|
3000
|
+
description: nil
|
|
2903
3001
|
)
|
|
2904
3002
|
if database_id.nil? || database_id == ''
|
|
2905
3003
|
raise Appwrite::Exception.new('Missing required parameter: "databaseId"')
|
|
@@ -2932,6 +3030,7 @@ module Appwrite
|
|
|
2932
3030
|
default: default,
|
|
2933
3031
|
array: array,
|
|
2934
3032
|
encrypt: encrypt,
|
|
3033
|
+
description: description,
|
|
2935
3034
|
}
|
|
2936
3035
|
|
|
2937
3036
|
api_headers = {
|
|
@@ -2963,6 +3062,7 @@ module Appwrite
|
|
|
2963
3062
|
# @param [String] default Default value for column when not provided. Cannot be set when column is required.
|
|
2964
3063
|
# @param [Integer] size Maximum size of the string column.
|
|
2965
3064
|
# @param [String] new_key New Column Key.
|
|
3065
|
+
# @param [String] description Optional description for the column.
|
|
2966
3066
|
#
|
|
2967
3067
|
# @return [ColumnString]
|
|
2968
3068
|
def update_string_column(
|
|
@@ -2972,7 +3072,8 @@ module Appwrite
|
|
|
2972
3072
|
required:,
|
|
2973
3073
|
default:,
|
|
2974
3074
|
size: nil,
|
|
2975
|
-
new_key: nil
|
|
3075
|
+
new_key: nil,
|
|
3076
|
+
description: nil
|
|
2976
3077
|
)
|
|
2977
3078
|
if database_id.nil? || database_id == ''
|
|
2978
3079
|
raise Appwrite::Exception.new('Missing required parameter: "databaseId"')
|
|
@@ -3004,6 +3105,7 @@ module Appwrite
|
|
|
3004
3105
|
default: default,
|
|
3005
3106
|
size: size,
|
|
3006
3107
|
newKey: new_key,
|
|
3108
|
+
description: description,
|
|
3007
3109
|
}
|
|
3008
3110
|
|
|
3009
3111
|
api_headers = {
|
|
@@ -3031,6 +3133,7 @@ module Appwrite
|
|
|
3031
3133
|
# @param [String] default Default value for column when not provided. Cannot be set when column is required.
|
|
3032
3134
|
# @param [] array Is column an array?
|
|
3033
3135
|
# @param [] encrypt Toggle encryption for the column. Encryption enhances security by not storing any plain text values in the database. However, encrypted columns cannot be queried.
|
|
3136
|
+
# @param [String] description Optional description for the column.
|
|
3034
3137
|
#
|
|
3035
3138
|
# @return [ColumnText]
|
|
3036
3139
|
def create_text_column(
|
|
@@ -3040,7 +3143,8 @@ module Appwrite
|
|
|
3040
3143
|
required:,
|
|
3041
3144
|
default: nil,
|
|
3042
3145
|
array: nil,
|
|
3043
|
-
encrypt: nil
|
|
3146
|
+
encrypt: nil,
|
|
3147
|
+
description: nil
|
|
3044
3148
|
)
|
|
3045
3149
|
if database_id.nil? || database_id == ''
|
|
3046
3150
|
raise Appwrite::Exception.new('Missing required parameter: "databaseId"')
|
|
@@ -3068,6 +3172,7 @@ module Appwrite
|
|
|
3068
3172
|
default: default,
|
|
3069
3173
|
array: array,
|
|
3070
3174
|
encrypt: encrypt,
|
|
3175
|
+
description: description,
|
|
3071
3176
|
}
|
|
3072
3177
|
|
|
3073
3178
|
api_headers = {
|
|
@@ -3095,6 +3200,7 @@ module Appwrite
|
|
|
3095
3200
|
# @param [] required Is column required?
|
|
3096
3201
|
# @param [String] default Default value for column when not provided. Cannot be set when column is required.
|
|
3097
3202
|
# @param [String] new_key New Column Key.
|
|
3203
|
+
# @param [String] description Optional description for the column.
|
|
3098
3204
|
#
|
|
3099
3205
|
# @return [ColumnText]
|
|
3100
3206
|
def update_text_column(
|
|
@@ -3103,7 +3209,8 @@ module Appwrite
|
|
|
3103
3209
|
key:,
|
|
3104
3210
|
required:,
|
|
3105
3211
|
default:,
|
|
3106
|
-
new_key: nil
|
|
3212
|
+
new_key: nil,
|
|
3213
|
+
description: nil
|
|
3107
3214
|
)
|
|
3108
3215
|
if database_id.nil? || database_id == ''
|
|
3109
3216
|
raise Appwrite::Exception.new('Missing required parameter: "databaseId"')
|
|
@@ -3134,6 +3241,7 @@ module Appwrite
|
|
|
3134
3241
|
required: required,
|
|
3135
3242
|
default: default,
|
|
3136
3243
|
newKey: new_key,
|
|
3244
|
+
description: description,
|
|
3137
3245
|
}
|
|
3138
3246
|
|
|
3139
3247
|
api_headers = {
|
|
@@ -3160,6 +3268,7 @@ module Appwrite
|
|
|
3160
3268
|
# @param [] required Is column required?
|
|
3161
3269
|
# @param [String] default Default value for column when not provided. Cannot be set when column is required.
|
|
3162
3270
|
# @param [] array Is column an array?
|
|
3271
|
+
# @param [String] description Optional description for the column.
|
|
3163
3272
|
#
|
|
3164
3273
|
# @return [ColumnUrl]
|
|
3165
3274
|
def create_url_column(
|
|
@@ -3168,7 +3277,8 @@ module Appwrite
|
|
|
3168
3277
|
key:,
|
|
3169
3278
|
required:,
|
|
3170
3279
|
default: nil,
|
|
3171
|
-
array: nil
|
|
3280
|
+
array: nil,
|
|
3281
|
+
description: nil
|
|
3172
3282
|
)
|
|
3173
3283
|
if database_id.nil? || database_id == ''
|
|
3174
3284
|
raise Appwrite::Exception.new('Missing required parameter: "databaseId"')
|
|
@@ -3195,6 +3305,7 @@ module Appwrite
|
|
|
3195
3305
|
required: required,
|
|
3196
3306
|
default: default,
|
|
3197
3307
|
array: array,
|
|
3308
|
+
description: description,
|
|
3198
3309
|
}
|
|
3199
3310
|
|
|
3200
3311
|
api_headers = {
|
|
@@ -3222,6 +3333,7 @@ module Appwrite
|
|
|
3222
3333
|
# @param [] required Is column required?
|
|
3223
3334
|
# @param [String] default Default value for column when not provided. Cannot be set when column is required.
|
|
3224
3335
|
# @param [String] new_key New Column Key.
|
|
3336
|
+
# @param [String] description Optional description for the column.
|
|
3225
3337
|
#
|
|
3226
3338
|
# @return [ColumnUrl]
|
|
3227
3339
|
def update_url_column(
|
|
@@ -3230,7 +3342,8 @@ module Appwrite
|
|
|
3230
3342
|
key:,
|
|
3231
3343
|
required:,
|
|
3232
3344
|
default:,
|
|
3233
|
-
new_key: nil
|
|
3345
|
+
new_key: nil,
|
|
3346
|
+
description: nil
|
|
3234
3347
|
)
|
|
3235
3348
|
if database_id.nil? || database_id == ''
|
|
3236
3349
|
raise Appwrite::Exception.new('Missing required parameter: "databaseId"')
|
|
@@ -3261,6 +3374,7 @@ module Appwrite
|
|
|
3261
3374
|
required: required,
|
|
3262
3375
|
default: default,
|
|
3263
3376
|
newKey: new_key,
|
|
3377
|
+
description: description,
|
|
3264
3378
|
}
|
|
3265
3379
|
|
|
3266
3380
|
api_headers = {
|
|
@@ -3289,6 +3403,7 @@ module Appwrite
|
|
|
3289
3403
|
# @param [String] default Default value for column when not provided. Cannot be set when column is required.
|
|
3290
3404
|
# @param [] array Is column an array?
|
|
3291
3405
|
# @param [] encrypt Toggle encryption for the column. Encryption enhances security by not storing any plain text values in the database. However, encrypted columns cannot be queried.
|
|
3406
|
+
# @param [String] description Optional description for the column.
|
|
3292
3407
|
#
|
|
3293
3408
|
# @return [ColumnVarchar]
|
|
3294
3409
|
def create_varchar_column(
|
|
@@ -3299,7 +3414,8 @@ module Appwrite
|
|
|
3299
3414
|
required:,
|
|
3300
3415
|
default: nil,
|
|
3301
3416
|
array: nil,
|
|
3302
|
-
encrypt: nil
|
|
3417
|
+
encrypt: nil,
|
|
3418
|
+
description: nil
|
|
3303
3419
|
)
|
|
3304
3420
|
if database_id.nil? || database_id == ''
|
|
3305
3421
|
raise Appwrite::Exception.new('Missing required parameter: "databaseId"')
|
|
@@ -3332,6 +3448,7 @@ module Appwrite
|
|
|
3332
3448
|
default: default,
|
|
3333
3449
|
array: array,
|
|
3334
3450
|
encrypt: encrypt,
|
|
3451
|
+
description: description,
|
|
3335
3452
|
}
|
|
3336
3453
|
|
|
3337
3454
|
api_headers = {
|
|
@@ -3360,6 +3477,7 @@ module Appwrite
|
|
|
3360
3477
|
# @param [String] default Default value for column when not provided. Cannot be set when column is required.
|
|
3361
3478
|
# @param [Integer] size Maximum size of the varchar column.
|
|
3362
3479
|
# @param [String] new_key New Column Key.
|
|
3480
|
+
# @param [String] description Optional description for the column.
|
|
3363
3481
|
#
|
|
3364
3482
|
# @return [ColumnVarchar]
|
|
3365
3483
|
def update_varchar_column(
|
|
@@ -3369,7 +3487,8 @@ module Appwrite
|
|
|
3369
3487
|
required:,
|
|
3370
3488
|
default:,
|
|
3371
3489
|
size: nil,
|
|
3372
|
-
new_key: nil
|
|
3490
|
+
new_key: nil,
|
|
3491
|
+
description: nil
|
|
3373
3492
|
)
|
|
3374
3493
|
if database_id.nil? || database_id == ''
|
|
3375
3494
|
raise Appwrite::Exception.new('Missing required parameter: "databaseId"')
|
|
@@ -3401,6 +3520,7 @@ module Appwrite
|
|
|
3401
3520
|
default: default,
|
|
3402
3521
|
size: size,
|
|
3403
3522
|
newKey: new_key,
|
|
3523
|
+
description: description,
|
|
3404
3524
|
}
|
|
3405
3525
|
|
|
3406
3526
|
api_headers = {
|
|
@@ -3661,6 +3781,7 @@ module Appwrite
|
|
|
3661
3781
|
# @param [Array] columns Array of columns to index. Maximum of 100 columns are allowed, each 32 characters long.
|
|
3662
3782
|
# @param [Array] orders Array of index orders. Maximum of 100 orders are allowed.
|
|
3663
3783
|
# @param [Array] lengths Length of index. Maximum of 100
|
|
3784
|
+
# @param [String] description Optional description for the index.
|
|
3664
3785
|
#
|
|
3665
3786
|
# @return [ColumnIndex]
|
|
3666
3787
|
def create_index(
|
|
@@ -3670,7 +3791,8 @@ module Appwrite
|
|
|
3670
3791
|
type:,
|
|
3671
3792
|
columns:,
|
|
3672
3793
|
orders: nil,
|
|
3673
|
-
lengths: nil
|
|
3794
|
+
lengths: nil,
|
|
3795
|
+
description: nil
|
|
3674
3796
|
)
|
|
3675
3797
|
if database_id.nil? || database_id == ''
|
|
3676
3798
|
raise Appwrite::Exception.new('Missing required parameter: "databaseId"')
|
|
@@ -3702,6 +3824,7 @@ module Appwrite
|
|
|
3702
3824
|
columns: columns,
|
|
3703
3825
|
orders: orders,
|
|
3704
3826
|
lengths: lengths,
|
|
3827
|
+
description: description,
|
|
3705
3828
|
}
|
|
3706
3829
|
|
|
3707
3830
|
api_headers = {
|
|
@@ -3812,12 +3935,20 @@ module Appwrite
|
|
|
3812
3935
|
# Get a list of all the user's rows in a given table. You can use the query
|
|
3813
3936
|
# params to filter your results.
|
|
3814
3937
|
#
|
|
3938
|
+
# Rows returned by aggregate, groupBy or distinct queries hold only the
|
|
3939
|
+
# columns they select, group or aggregate, typed as a row types them, with a
|
|
3940
|
+
# joined column named by its join alias (`alias.column`). The response omits
|
|
3941
|
+
# their `$id`, `$sequence`, `$createdAt`, `$updatedAt`, `$permissions`,
|
|
3942
|
+
# `$databaseId` and `$tableId` unless they select or group it, and those of a
|
|
3943
|
+
# right or full join row that no row of this table matched. SDK row models
|
|
3944
|
+
# fill omitted system columns with empty values.
|
|
3945
|
+
#
|
|
3815
3946
|
# @param [String] database_id Database ID.
|
|
3816
3947
|
# @param [String] table_id Table ID. You can create a new table using the TablesDB service [server integration](https://appwrite.io/docs/products/databases/tables#create-table).
|
|
3817
3948
|
# @param [Array] 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.
|
|
3818
3949
|
# @param [String] transaction_id Transaction ID to read uncommitted changes within the transaction.
|
|
3819
3950
|
# @param [] total When set to false, the total count returned will be 0 and will not be calculated.
|
|
3820
|
-
# @param [Integer] ttl TTL (seconds) for caching list responses. Responses are stored in an in-memory key-value cache, keyed per project, table, schema version (columns and indexes), caller authorization roles, and the exact query — so users with different permissions never share cached entries. Schema changes invalidate cached entries automatically; row writes do not, so choose a TTL you are comfortable serving as stale data. Set to 0 to disable caching. Must be between 0 and 86400 (24 hours).
|
|
3951
|
+
# @param [Integer] ttl TTL (seconds) for caching list responses. Responses are stored in an in-memory key-value cache, keyed per project, table, schema version (columns and indexes), caller authorization roles, and the exact query — so users with different permissions never share cached entries. Schema changes invalidate cached entries automatically; row writes do not, so choose a TTL you are comfortable serving as stale data. Set to 0 to disable caching. Lists with join queries are not cached. Must be between 0 and 86400 (24 hours).
|
|
3821
3952
|
#
|
|
3822
3953
|
# @return [RowList]
|
|
3823
3954
|
def list_rows(
|
|
@@ -4128,6 +4259,62 @@ module Appwrite
|
|
|
4128
4259
|
)
|
|
4129
4260
|
end
|
|
4130
4261
|
|
|
4262
|
+
# Get a list of all the user's rows in a given table using a POST request.
|
|
4263
|
+
# This behaves identically to the list rows endpoint but accepts the queries
|
|
4264
|
+
# in the request body, allowing much larger `queries` arrays than can fit in
|
|
4265
|
+
# a URL query string.
|
|
4266
|
+
#
|
|
4267
|
+
#
|
|
4268
|
+
# @param [String] database_id Database ID.
|
|
4269
|
+
# @param [String] table_id Table ID. You can create a new table using the TablesDB service [server integration](https://appwrite.io/docs/products/databases/tables#create-table).
|
|
4270
|
+
# @param [Array] 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.
|
|
4271
|
+
# @param [String] transaction_id Transaction ID to read uncommitted changes within the transaction.
|
|
4272
|
+
# @param [] total When set to false, the total count returned will be 0 and will not be calculated.
|
|
4273
|
+
# @param [Integer] ttl TTL (seconds) for caching list responses. Responses are stored in an in-memory key-value cache, keyed per project, table, schema version (columns and indexes), caller authorization roles, and the exact query — so users with different permissions never share cached entries. Schema changes invalidate cached entries automatically; row writes do not, so choose a TTL you are comfortable serving as stale data. Set to 0 to disable caching. Lists with join queries are not cached. Must be between 0 and 86400 (24 hours).
|
|
4274
|
+
#
|
|
4275
|
+
# @return [RowList]
|
|
4276
|
+
def create_query(
|
|
4277
|
+
database_id:,
|
|
4278
|
+
table_id:,
|
|
4279
|
+
queries: nil,
|
|
4280
|
+
transaction_id: nil,
|
|
4281
|
+
total: nil,
|
|
4282
|
+
ttl: nil
|
|
4283
|
+
)
|
|
4284
|
+
if database_id.nil? || database_id == ''
|
|
4285
|
+
raise Appwrite::Exception.new('Missing required parameter: "databaseId"')
|
|
4286
|
+
end
|
|
4287
|
+
|
|
4288
|
+
if table_id.nil? || table_id == ''
|
|
4289
|
+
raise Appwrite::Exception.new('Missing required parameter: "tableId"')
|
|
4290
|
+
end
|
|
4291
|
+
|
|
4292
|
+
api_path = '/tablesdb/{databaseId}/tables/{tableId}/rows/query'
|
|
4293
|
+
.gsub('{databaseId}', database_id)
|
|
4294
|
+
.gsub('{tableId}', table_id)
|
|
4295
|
+
|
|
4296
|
+
api_params = {
|
|
4297
|
+
queries: queries,
|
|
4298
|
+
transactionId: transaction_id,
|
|
4299
|
+
total: total,
|
|
4300
|
+
ttl: ttl,
|
|
4301
|
+
}
|
|
4302
|
+
|
|
4303
|
+
api_headers = {
|
|
4304
|
+
"X-Appwrite-Project": @client.get_config('project'),
|
|
4305
|
+
"content-type": 'application/json',
|
|
4306
|
+
"accept": 'application/json',
|
|
4307
|
+
}
|
|
4308
|
+
|
|
4309
|
+
@client.call(
|
|
4310
|
+
method: 'POST',
|
|
4311
|
+
path: api_path,
|
|
4312
|
+
headers: api_headers,
|
|
4313
|
+
params: api_params,
|
|
4314
|
+
response_type: Models::RowList
|
|
4315
|
+
)
|
|
4316
|
+
end
|
|
4317
|
+
|
|
4131
4318
|
# Get a row by its unique ID. This endpoint response returns a JSON object
|
|
4132
4319
|
# with the row data.
|
|
4133
4320
|
#
|