Class: Appwrite::Databases

Inherits:
Service
  • Object
show all
Defined in:
lib/appwrite/services/databases.rb

Instance Method Summary collapse

Constructor Details

#initialize(client) ⇒ Databases

Returns a new instance of Databases.



6
7
8
 
# File 'lib/appwrite/services/databases.rb', line 6

def initialize(client)
    @client = client
end

Instance Method Details

#create(database_id:, name:, enabled: nil) ⇒ Database

Deprecated.

This API has been deprecated since 1.8.0. Please use ‘TablesDB.create` instead.

Create a new Database.

Parameters:

  • database_id (String) —

    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.

  • name (String) —

    Database name. Max length: 128 chars.

  • [] —

    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.

Returns:

  • (Database) 


53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
 
# File 'lib/appwrite/services/databases.rb', line 53

def create(database_id:, name:, enabled: nil)
    api_path = '/databases'

    if database_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "databaseId"')
    end

    if name.nil?
      raise Appwrite::Exception.new('Missing required parameter: "name"')
    end

    api_params = {
        databaseId: database_id,
        name: name,
        enabled: enabled,
    }
    
    api_headers = {
        "content-type": 'application/json',
    }

    @client.call(
        method: 'POST',
        path: api_path,
        headers: api_headers,
        params: api_params,
        response_type: Models::Database
    )
end

#create_boolean_attribute(database_id:, collection_id:, key:, required:, default: nil, array: nil) ⇒ AttributeBoolean

Deprecated.

This API has been deprecated since 1.8.0. Please use ‘TablesDB.createBooleanColumn` instead.

Create a boolean attribute.

Parameters:

  • database_id (String) —

    Database ID.

  • collection_id (String) —

    Collection ID. You can create a new table using the Database service [server integration](appwrite.io/docs/server/databases#databasesCreateCollection).

  • key (String) —

    Attribute Key.

  • [] —

    required Is attribute required?

  • [] —

    default Default value for attribute when not provided. Cannot be set when attribute is required.

  • [] —

    array Is attribute an array?

Returns:

  • (AttributeBoolean) 


628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
 
# File 'lib/appwrite/services/databases.rb', line 628

def create_boolean_attribute(database_id:, collection_id:, key:, required:, default: nil, array: nil)
    api_path = '/databases/{databaseId}/collections/{collectionId}/attributes/boolean'
        .gsub('{databaseId}', database_id)
        .gsub('{collectionId}', collection_id)

    if database_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "databaseId"')
    end

    if collection_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "collectionId"')
    end

    if key.nil?
      raise Appwrite::Exception.new('Missing required parameter: "key"')
    end

    if required.nil?
      raise Appwrite::Exception.new('Missing required parameter: "required"')
    end

    api_params = {
        key: key,
        required: required,
        default: default,
        array: array,
    }
    
    api_headers = {
        "content-type": 'application/json',
    }

    @client.call(
        method: 'POST',
        path: api_path,
        headers: api_headers,
        params: api_params,
        response_type: Models::AttributeBoolean
    )
end

#create_collection(database_id:, collection_id:, name:, permissions: nil, document_security: nil, enabled: nil) ⇒ Collection

Deprecated.

This API has been deprecated since 1.8.0. Please use ‘TablesDB.createTable` instead.

Create a new Collection. Before using this route, you should create a new database resource using either a [server integration](appwrite.io/docs/server/databases#databasesCreateCollection) API or directly from your database console.

Parameters:

  • database_id (String) —

    Database ID.

  • collection_id (String) —

    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.

  • name (String) —

    Collection name. Max length: 128 chars.

  • permissions (Array) (defaults to: nil) —

    An array of permissions strings. By default, no user is granted with any permissions. [Learn more about permissions](appwrite.io/docs/permissions).

  • [] —

    document_security Enables configuring permissions for individual documents. A user needs one of document or collection level permissions to access a document. [Learn more about permissions](appwrite.io/docs/permissions).

  • [] —

    enabled Is collection enabled? When set to ‘disabled’, users cannot access the collection but Server SDKs with and API key can still read and write to the collection. No data is lost when this is toggled.

Returns:

  • (Collection) 


410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
 
# File 'lib/appwrite/services/databases.rb', line 410

def create_collection(database_id:, collection_id:, name:, permissions: nil, document_security: nil, enabled: nil)
    api_path = '/databases/{databaseId}/collections'
        .gsub('{databaseId}', database_id)

    if database_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "databaseId"')
    end

    if collection_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "collectionId"')
    end

    if name.nil?
      raise Appwrite::Exception.new('Missing required parameter: "name"')
    end

    api_params = {
        collectionId: collection_id,
        name: name,
        permissions: permissions,
        documentSecurity: document_security,
        enabled: enabled,
    }
    
    api_headers = {
        "content-type": 'application/json',
    }

    @client.call(
        method: 'POST',
        path: api_path,
        headers: api_headers,
        params: api_params,
        response_type: Models::Collection
    )
end

#create_datetime_attribute(database_id:, collection_id:, key:, required:, default: nil, array: nil) ⇒ AttributeDatetime

Deprecated.

This API has been deprecated since 1.8.0. Please use ‘TablesDB.createDatetimeColumn` instead.

Create a date time attribute according to the ISO 8601 standard.

Parameters:

  • database_id (String) —

    Database ID.

  • collection_id (String) —

    Collection ID. You can create a new collection using the Database service [server integration](appwrite.io/docs/server/databases#createCollection).

  • key (String) —

    Attribute Key.

  • [] —

    required Is attribute required?

  • default (String) (defaults to: nil) —

    Default value for the attribute in [ISO 8601](www.iso.org/iso-8601-date-and-time-format.html) format. Cannot be set when attribute is required.

  • [] —

    array Is attribute an array?

Returns:

  • (AttributeDatetime) 


741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
 
# File 'lib/appwrite/services/databases.rb', line 741

def create_datetime_attribute(database_id:, collection_id:, key:, required:, default: nil, array: nil)
    api_path = '/databases/{databaseId}/collections/{collectionId}/attributes/datetime'
        .gsub('{databaseId}', database_id)
        .gsub('{collectionId}', collection_id)

    if database_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "databaseId"')
    end

    if collection_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "collectionId"')
    end

    if key.nil?
      raise Appwrite::Exception.new('Missing required parameter: "key"')
    end

    if required.nil?
      raise Appwrite::Exception.new('Missing required parameter: "required"')
    end

    api_params = {
        key: key,
        required: required,
        default: default,
        array: array,
    }
    
    api_headers = {
        "content-type": 'application/json',
    }

    @client.call(
        method: 'POST',
        path: api_path,
        headers: api_headers,
        params: api_params,
        response_type: Models::AttributeDatetime
    )
end

#create_document(database_id:, collection_id:, document_id:, data:, permissions: nil, transaction_id: nil) ⇒ Document

Deprecated.

This API has been deprecated since 1.8.0. Please use ‘TablesDB.createRow` instead.

Create a new Document. Before using this route, you should create a new collection resource using either a [server integration](appwrite.io/docs/server/databases#databasesCreateCollection) API or directly from your database console.

Parameters:

  • database_id (String) —

    Database ID.

  • collection_id (String) —

    Collection ID. You can create a new collection using the Database service [server integration](appwrite.io/docs/server/databases#databasesCreateCollection). Make sure to define attributes before creating documents.

  • document_id (String) —

    Document 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.

  • data (Hash) —

    Document data as JSON object.

  • permissions (Array) (defaults to: nil) —

    An array of permissions strings. By default, only the current user is granted all permissions. [Learn more about permissions](appwrite.io/docs/permissions).

  • transaction_id (String) (defaults to: nil) —

    Transaction ID for staging the operation.

Returns:

  • (Document) 


2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
 
# File 'lib/appwrite/services/databases.rb', line 2263

def create_document(database_id:, collection_id:, document_id:, data:, permissions: nil, transaction_id: nil)
    api_path = '/databases/{databaseId}/collections/{collectionId}/documents'
        .gsub('{databaseId}', database_id)
        .gsub('{collectionId}', collection_id)

    if database_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "databaseId"')
    end

    if collection_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "collectionId"')
    end

    if document_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "documentId"')
    end

    if data.nil?
      raise Appwrite::Exception.new('Missing required parameter: "data"')
    end

    api_params = {
        documentId: document_id,
        data: data,
        permissions: permissions,
        transactionId: transaction_id,
    }
    
    api_headers = {
        "content-type": 'application/json',
    }

    @client.call(
        method: 'POST',
        path: api_path,
        headers: api_headers,
        params: api_params,
        response_type: Models::Document
    )
end

#create_documents(database_id:, collection_id:, documents:, transaction_id: nil) ⇒ DocumentList

Deprecated.

This API has been deprecated since 1.8.0. Please use ‘TablesDB.createRows` instead.

Create new Documents. Before using this route, you should create a new collection resource using either a [server integration](appwrite.io/docs/server/databases#databasesCreateCollection) API or directly from your database console.

Parameters:

  • database_id (String) —

    Database ID.

  • collection_id (String) —

    Collection ID. You can create a new collection using the Database service [server integration](appwrite.io/docs/server/databases#databasesCreateCollection). Make sure to define attributes before creating documents.

  • documents (Array) —

    Array of documents data as JSON objects.

  • transaction_id (String) (defaults to: nil) —

    Transaction ID for staging the operation.

Returns:

  • (DocumentList) 


2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
 
# File 'lib/appwrite/services/databases.rb', line 2318

def create_documents(database_id:, collection_id:, documents:, transaction_id: nil)
    api_path = '/databases/{databaseId}/collections/{collectionId}/documents'
        .gsub('{databaseId}', database_id)
        .gsub('{collectionId}', collection_id)

    if database_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "databaseId"')
    end

    if collection_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "collectionId"')
    end

    if documents.nil?
      raise Appwrite::Exception.new('Missing required parameter: "documents"')
    end

    api_params = {
        documents: documents,
        transactionId: transaction_id,
    }
    
    api_headers = {
        "content-type": 'application/json',
    }

    @client.call(
        method: 'POST',
        path: api_path,
        headers: api_headers,
        params: api_params,
        response_type: Models::DocumentList
    )
end

#create_email_attribute(database_id:, collection_id:, key:, required:, default: nil, array: nil) ⇒ AttributeEmail

Deprecated.

This API has been deprecated since 1.8.0. Please use ‘TablesDB.createEmailColumn` instead.

Create an email attribute.

Parameters:

  • database_id (String) —

    Database ID.

  • collection_id (String) —

    Collection ID.

  • key (String) —

    Attribute Key.

  • [] —

    required Is attribute required?

  • default (String) (defaults to: nil) —

    Default value for attribute when not provided. Cannot be set when attribute is required.

  • [] —

    array Is attribute an array?

Returns:

  • (AttributeEmail) 


855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
 
# File 'lib/appwrite/services/databases.rb', line 855

def create_email_attribute(database_id:, collection_id:, key:, required:, default: nil, array: nil)
    api_path = '/databases/{databaseId}/collections/{collectionId}/attributes/email'
        .gsub('{databaseId}', database_id)
        .gsub('{collectionId}', collection_id)

    if database_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "databaseId"')
    end

    if collection_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "collectionId"')
    end

    if key.nil?
      raise Appwrite::Exception.new('Missing required parameter: "key"')
    end

    if required.nil?
      raise Appwrite::Exception.new('Missing required parameter: "required"')
    end

    api_params = {
        key: key,
        required: required,
        default: default,
        array: array,
    }
    
    api_headers = {
        "content-type": 'application/json',
    }

    @client.call(
        method: 'POST',
        path: api_path,
        headers: api_headers,
        params: api_params,
        response_type: Models::AttributeEmail
    )
end

#create_enum_attribute(database_id:, collection_id:, key:, elements:, required:, default: nil, array: nil) ⇒ AttributeEnum

Deprecated.

This API has been deprecated since 1.8.0. Please use ‘TablesDB.createEnumColumn` instead.

Create an enum attribute. The ‘elements` param acts as a white-list of accepted values for this attribute.

Parameters:

  • database_id (String) —

    Database ID.

  • collection_id (String) —

    Collection ID.

  • key (String) —

    Attribute Key.

  • elements (Array) —

    Array of enum values.

  • [] —

    required Is attribute required?

  • default (String) (defaults to: nil) —

    Default value for attribute when not provided. Cannot be set when attribute is required.

  • [] —

    array Is attribute an array?

Returns:

  • (AttributeEnum) 


972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
 
# File 'lib/appwrite/services/databases.rb', line 972

def create_enum_attribute(database_id:, collection_id:, key:, elements:, required:, default: nil, array: nil)
    api_path = '/databases/{databaseId}/collections/{collectionId}/attributes/enum'
        .gsub('{databaseId}', database_id)
        .gsub('{collectionId}', collection_id)

    if database_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "databaseId"')
    end

    if collection_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "collectionId"')
    end

    if key.nil?
      raise Appwrite::Exception.new('Missing required parameter: "key"')
    end

    if elements.nil?
      raise Appwrite::Exception.new('Missing required parameter: "elements"')
    end

    if required.nil?
      raise Appwrite::Exception.new('Missing required parameter: "required"')
    end

    api_params = {
        key: key,
        elements: elements,
        required: required,
        default: default,
        array: array,
    }
    
    api_headers = {
        "content-type": 'application/json',
    }

    @client.call(
        method: 'POST',
        path: api_path,
        headers: api_headers,
        params: api_params,
        response_type: Models::AttributeEnum
    )
end

#create_float_attribute(database_id:, collection_id:, key:, required:, min: nil, max: nil, default: nil, array: nil) ⇒ AttributeFloat

Deprecated.

This API has been deprecated since 1.8.0. Please use ‘TablesDB.createFloatColumn` instead.

Create a float attribute. Optionally, minimum and maximum values can be provided.

Parameters:

  • database_id (String) —

    Database ID.

  • collection_id (String) —

    Collection ID.

  • key (String) —

    Attribute Key.

  • [] —

    required Is attribute required?

  • min (Float) (defaults to: nil) —

    Minimum value.

  • max (Float) (defaults to: nil) —

    Maximum value.

  • default (Float) (defaults to: nil) —

    Default value. Cannot be set when required.

  • [] —

    array Is attribute an array?

Returns:

  • (AttributeFloat) 


1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
 
# File 'lib/appwrite/services/databases.rb', line 1101

def create_float_attribute(database_id:, collection_id:, key:, required:, min: nil, max: nil, default: nil, array: nil)
    api_path = '/databases/{databaseId}/collections/{collectionId}/attributes/float'
        .gsub('{databaseId}', database_id)
        .gsub('{collectionId}', collection_id)

    if database_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "databaseId"')
    end

    if collection_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "collectionId"')
    end

    if key.nil?
      raise Appwrite::Exception.new('Missing required parameter: "key"')
    end

    if required.nil?
      raise Appwrite::Exception.new('Missing required parameter: "required"')
    end

    api_params = {
        key: key,
        required: required,
        min: min,
        max: max,
        default: default,
        array: array,
    }
    
    api_headers = {
        "content-type": 'application/json',
    }

    @client.call(
        method: 'POST',
        path: api_path,
        headers: api_headers,
        params: api_params,
        response_type: Models::AttributeFloat
    )
end

#create_index(database_id:, collection_id:, key:, type:, attributes:, orders: nil, lengths: nil) ⇒ Index

Deprecated.

This API has been deprecated since 1.8.0. Please use ‘TablesDB.createIndex` instead.

Creates an index on the attributes listed. Your index should include all the attributes you will query in a single request. Attributes can be ‘key`, `fulltext`, and `unique`.

Parameters:

  • database_id (String) —

    Database ID.

  • collection_id (String) —

    Collection ID. You can create a new collection using the Database service [server integration](appwrite.io/docs/server/databases#databasesCreateCollection).

  • key (String) —

    Index Key.

  • type (IndexType) —

    Index type.

  • attributes (Array) —

    Array of attributes to index. Maximum of 100 attributes are allowed, each 32 characters long.

  • orders (Array) (defaults to: nil) —

    Array of index orders. Maximum of 100 orders are allowed.

  • lengths (Array) (defaults to: nil) —

    Length of index. Maximum of 100

Returns:

  • (Index) 


2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
 
# File 'lib/appwrite/services/databases.rb', line 2862

def create_index(database_id:, collection_id:, key:, type:, attributes:, orders: nil, lengths: nil)
    api_path = '/databases/{databaseId}/collections/{collectionId}/indexes'
        .gsub('{databaseId}', database_id)
        .gsub('{collectionId}', collection_id)

    if database_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "databaseId"')
    end

    if collection_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "collectionId"')
    end

    if key.nil?
      raise Appwrite::Exception.new('Missing required parameter: "key"')
    end

    if type.nil?
      raise Appwrite::Exception.new('Missing required parameter: "type"')
    end

    if attributes.nil?
      raise Appwrite::Exception.new('Missing required parameter: "attributes"')
    end

    api_params = {
        key: key,
        type: type,
        attributes: attributes,
        orders: orders,
        lengths: lengths,
    }
    
    api_headers = {
        "content-type": 'application/json',
    }

    @client.call(
        method: 'POST',
        path: api_path,
        headers: api_headers,
        params: api_params,
        response_type: Models::Index
    )
end

#create_integer_attribute(database_id:, collection_id:, key:, required:, min: nil, max: nil, default: nil, array: nil) ⇒ AttributeInteger

Deprecated.

This API has been deprecated since 1.8.0. Please use ‘TablesDB.createIntegerColumn` instead.

Create an integer attribute. Optionally, minimum and maximum values can be provided.

Parameters:

  • database_id (String) —

    Database ID.

  • collection_id (String) —

    Collection ID.

  • key (String) —

    Attribute Key.

  • [] —

    required Is attribute required?

  • min (Integer) (defaults to: nil) —

    Minimum value

  • max (Integer) (defaults to: nil) —

    Maximum value

  • default (Integer) (defaults to: nil) —

    Default value. Cannot be set when attribute is required.

  • [] —

    array Is attribute an array?

Returns:

  • (AttributeInteger) 


1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
 
# File 'lib/appwrite/services/databases.rb', line 1225

def create_integer_attribute(database_id:, collection_id:, key:, required:, min: nil, max: nil, default: nil, array: nil)
    api_path = '/databases/{databaseId}/collections/{collectionId}/attributes/integer'
        .gsub('{databaseId}', database_id)
        .gsub('{collectionId}', collection_id)

    if database_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "databaseId"')
    end

    if collection_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "collectionId"')
    end

    if key.nil?
      raise Appwrite::Exception.new('Missing required parameter: "key"')
    end

    if required.nil?
      raise Appwrite::Exception.new('Missing required parameter: "required"')
    end

    api_params = {
        key: key,
        required: required,
        min: min,
        max: max,
        default: default,
        array: array,
    }
    
    api_headers = {
        "content-type": 'application/json',
    }

    @client.call(
        method: 'POST',
        path: api_path,
        headers: api_headers,
        params: api_params,
        response_type: Models::AttributeInteger
    )
end

#create_ip_attribute(database_id:, collection_id:, key:, required:, default: nil, array: nil) ⇒ AttributeIp

Deprecated.

This API has been deprecated since 1.8.0. Please use ‘TablesDB.createIpColumn` instead.

Create IP address attribute.

Parameters:

  • database_id (String) —

    Database ID.

  • collection_id (String) —

    Collection ID.

  • key (String) —

    Attribute Key.

  • [] —

    required Is attribute required?

  • default (String) (defaults to: nil) —

    Default value. Cannot be set when attribute is required.

  • [] —

    array Is attribute an array?

Returns:

  • (AttributeIp) 


1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
 
# File 'lib/appwrite/services/databases.rb', line 1346

def create_ip_attribute(database_id:, collection_id:, key:, required:, default: nil, array: nil)
    api_path = '/databases/{databaseId}/collections/{collectionId}/attributes/ip'
        .gsub('{databaseId}', database_id)
        .gsub('{collectionId}', collection_id)

    if database_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "databaseId"')
    end

    if collection_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "collectionId"')
    end

    if key.nil?
      raise Appwrite::Exception.new('Missing required parameter: "key"')
    end

    if required.nil?
      raise Appwrite::Exception.new('Missing required parameter: "required"')
    end

    api_params = {
        key: key,
        required: required,
        default: default,
        array: array,
    }
    
    api_headers = {
        "content-type": 'application/json',
    }

    @client.call(
        method: 'POST',
        path: api_path,
        headers: api_headers,
        params: api_params,
        response_type: Models::AttributeIp
    )
end

#create_line_attribute(database_id:, collection_id:, key:, required:, default: nil) ⇒ AttributeLine

Deprecated.

This API has been deprecated since 1.8.0. Please use ‘TablesDB.createLineColumn` instead.

Create a geometric line attribute.

Parameters:

  • database_id (String) —

    Database ID.

  • collection_id (String) —

    Collection ID. You can create a new collection using the Database service [server integration](appwrite.io/docs/server/databases#databasesCreateCollection).

  • key (String) —

    Attribute Key.

  • [] —

    required Is attribute required?

  • default (Array) (defaults to: nil) —

    Default value for attribute 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 attribute is required.

Returns:

  • (AttributeLine) 


1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
 
# File 'lib/appwrite/services/databases.rb', line 1459

def create_line_attribute(database_id:, collection_id:, key:, required:, default: nil)
    api_path = '/databases/{databaseId}/collections/{collectionId}/attributes/line'
        .gsub('{databaseId}', database_id)
        .gsub('{collectionId}', collection_id)

    if database_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "databaseId"')
    end

    if collection_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "collectionId"')
    end

    if key.nil?
      raise Appwrite::Exception.new('Missing required parameter: "key"')
    end

    if required.nil?
      raise Appwrite::Exception.new('Missing required parameter: "required"')
    end

    api_params = {
        key: key,
        required: required,
        default: default,
    }
    
    api_headers = {
        "content-type": 'application/json',
    }

    @client.call(
        method: 'POST',
        path: api_path,
        headers: api_headers,
        params: api_params,
        response_type: Models::AttributeLine
    )
end

#create_operations(transaction_id:, operations: nil) ⇒ Transaction

Create multiple operations in a single transaction.

Parameters:

  • transaction_id (String) —

    Transaction ID.

  • operations (Array) (defaults to: nil) —

    Array of staged operations.

Returns:

  • (Transaction) 


227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
 
# File 'lib/appwrite/services/databases.rb', line 227

def create_operations(transaction_id:, operations: nil)
    api_path = '/databases/transactions/{transactionId}/operations'
        .gsub('{transactionId}', transaction_id)

    if transaction_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "transactionId"')
    end

    api_params = {
        operations: operations,
    }
    
    api_headers = {
        "content-type": 'application/json',
    }

    @client.call(
        method: 'POST',
        path: api_path,
        headers: api_headers,
        params: api_params,
        response_type: Models::Transaction
    )
end

#create_point_attribute(database_id:, collection_id:, key:, required:, default: nil) ⇒ AttributePoint

Deprecated.

This API has been deprecated since 1.8.0. Please use ‘TablesDB.createPointColumn` instead.

Create a geometric point attribute.

Parameters:

  • database_id (String) —

    Database ID.

  • collection_id (String) —

    Collection ID. You can create a new collection using the Database service [server integration](appwrite.io/docs/server/databases#databasesCreateCollection).

  • key (String) —

    Attribute Key.

  • [] —

    required Is attribute required?

  • default (Array) (defaults to: nil) —

    Default value for attribute when not provided, array of two numbers [longitude, latitude], representing a single coordinate. Cannot be set when attribute is required.

Returns:

  • (AttributePoint) 


1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
 
# File 'lib/appwrite/services/databases.rb', line 1566

def create_point_attribute(database_id:, collection_id:, key:, required:, default: nil)
    api_path = '/databases/{databaseId}/collections/{collectionId}/attributes/point'
        .gsub('{databaseId}', database_id)
        .gsub('{collectionId}', collection_id)

    if database_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "databaseId"')
    end

    if collection_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "collectionId"')
    end

    if key.nil?
      raise Appwrite::Exception.new('Missing required parameter: "key"')
    end

    if required.nil?
      raise Appwrite::Exception.new('Missing required parameter: "required"')
    end

    api_params = {
        key: key,
        required: required,
        default: default,
    }
    
    api_headers = {
        "content-type": 'application/json',
    }

    @client.call(
        method: 'POST',
        path: api_path,
        headers: api_headers,
        params: api_params,
        response_type: Models::AttributePoint
    )
end

#create_polygon_attribute(database_id:, collection_id:, key:, required:, default: nil) ⇒ AttributePolygon

Deprecated.

This API has been deprecated since 1.8.0. Please use ‘TablesDB.createPolygonColumn` instead.

Create a geometric polygon attribute.

Parameters:

  • database_id (String) —

    Database ID.

  • collection_id (String) —

    Collection ID. You can create a new collection using the Database service [server integration](appwrite.io/docs/server/databases#databasesCreateCollection).

  • key (String) —

    Attribute Key.

  • [] —

    required Is attribute required?

  • default (Array) (defaults to: nil) —

    Default value for attribute 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 attribute is required.

Returns:

  • (AttributePolygon) 


1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
 
# File 'lib/appwrite/services/databases.rb', line 1673

def create_polygon_attribute(database_id:, collection_id:, key:, required:, default: nil)
    api_path = '/databases/{databaseId}/collections/{collectionId}/attributes/polygon'
        .gsub('{databaseId}', database_id)
        .gsub('{collectionId}', collection_id)

    if database_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "databaseId"')
    end

    if collection_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "collectionId"')
    end

    if key.nil?
      raise Appwrite::Exception.new('Missing required parameter: "key"')
    end

    if required.nil?
      raise Appwrite::Exception.new('Missing required parameter: "required"')
    end

    api_params = {
        key: key,
        required: required,
        default: default,
    }
    
    api_headers = {
        "content-type": 'application/json',
    }

    @client.call(
        method: 'POST',
        path: api_path,
        headers: api_headers,
        params: api_params,
        response_type: Models::AttributePolygon
    )
end

#create_relationship_attribute(database_id:, collection_id:, related_collection_id:, type:, two_way: nil, key: nil, two_way_key: nil, on_delete: nil) ⇒ AttributeRelationship

Deprecated.

This API has been deprecated since 1.8.0. Please use ‘TablesDB.createRelationshipColumn` instead.

Create relationship attribute. [Learn more about relationship attributes](appwrite.io/docs/databases-relationships#relationship-attributes).

Parameters:

  • database_id (String) —

    Database ID.

  • collection_id (String) —

    Collection ID.

  • related_collection_id (String) —

    Related Collection ID.

  • type (RelationshipType) —

    Relation type

  • [] —

    two_way Is Two Way?

  • key (String) (defaults to: nil) —

    Attribute Key.

  • two_way_key (String) (defaults to: nil) —

    Two Way Attribute Key.

  • on_delete (RelationMutate) (defaults to: nil) —

    Constraints option

Returns:

  • (AttributeRelationship) 


1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
 
# File 'lib/appwrite/services/databases.rb', line 1785

def create_relationship_attribute(database_id:, collection_id:, related_collection_id:, type:, two_way: nil, key: nil, two_way_key: nil, on_delete: nil)
    api_path = '/databases/{databaseId}/collections/{collectionId}/attributes/relationship'
        .gsub('{databaseId}', database_id)
        .gsub('{collectionId}', collection_id)

    if database_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "databaseId"')
    end

    if collection_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "collectionId"')
    end

    if related_collection_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "relatedCollectionId"')
    end

    if type.nil?
      raise Appwrite::Exception.new('Missing required parameter: "type"')
    end

    api_params = {
        relatedCollectionId: related_collection_id,
        type: type,
        twoWay: two_way,
        key: key,
        twoWayKey: two_way_key,
        onDelete: on_delete,
    }
    
    api_headers = {
        "content-type": 'application/json',
    }

    @client.call(
        method: 'POST',
        path: api_path,
        headers: api_headers,
        params: api_params,
        response_type: Models::AttributeRelationship
    )
end

#create_string_attribute(database_id:, collection_id:, key:, size:, required:, default: nil, array: nil, encrypt: nil) ⇒ AttributeString

Deprecated.

This API has been deprecated since 1.8.0. Please use ‘TablesDB.createStringColumn` instead.

Create a string attribute.

Parameters:

  • database_id (String) —

    Database ID.

  • collection_id (String) —

    Collection ID. You can create a new table using the Database service [server integration](appwrite.io/docs/server/databases#databasesCreateCollection).

  • key (String) —

    Attribute Key.

  • size (Integer) —

    Attribute size for text attributes, in number of characters.

  • [] —

    required Is attribute required?

  • default (String) (defaults to: nil) —

    Default value for attribute when not provided. Cannot be set when attribute is required.

  • [] —

    array Is attribute an array?

  • [] —

    encrypt Toggle encryption for the attribute. Encryption enhances security by not storing any plain text values in the database. However, encrypted attributes cannot be queried.

Returns:

  • (AttributeString) 


1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
 
# File 'lib/appwrite/services/databases.rb', line 1844

def create_string_attribute(database_id:, collection_id:, key:, size:, required:, default: nil, array: nil, encrypt: nil)
    api_path = '/databases/{databaseId}/collections/{collectionId}/attributes/string'
        .gsub('{databaseId}', database_id)
        .gsub('{collectionId}', collection_id)

    if database_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "databaseId"')
    end

    if collection_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "collectionId"')
    end

    if key.nil?
      raise Appwrite::Exception.new('Missing required parameter: "key"')
    end

    if size.nil?
      raise Appwrite::Exception.new('Missing required parameter: "size"')
    end

    if required.nil?
      raise Appwrite::Exception.new('Missing required parameter: "required"')
    end

    api_params = {
        key: key,
        size: size,
        required: required,
        default: default,
        array: array,
        encrypt: encrypt,
    }
    
    api_headers = {
        "content-type": 'application/json',
    }

    @client.call(
        method: 'POST',
        path: api_path,
        headers: api_headers,
        params: api_params,
        response_type: Models::AttributeString
    )
end

#create_transaction(ttl: nil) ⇒ Transaction

Create a new transaction.

Parameters:

  • ttl (Integer) (defaults to: nil) —

    Seconds before the transaction expires.

Returns:

  • (Transaction) 


112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
 
# File 'lib/appwrite/services/databases.rb', line 112

def create_transaction(ttl: nil)
    api_path = '/databases/transactions'

    api_params = {
        ttl: ttl,
    }
    
    api_headers = {
        "content-type": 'application/json',
    }

    @client.call(
        method: 'POST',
        path: api_path,
        headers: api_headers,
        params: api_params,
        response_type: Models::Transaction
    )
end

#create_url_attribute(database_id:, collection_id:, key:, required:, default: nil, array: nil) ⇒ AttributeUrl

Deprecated.

This API has been deprecated since 1.8.0. Please use ‘TablesDB.createUrlColumn` instead.

Create a URL attribute.

Parameters:

  • database_id (String) —

    Database ID.

  • collection_id (String) —

    Collection ID.

  • key (String) —

    Attribute Key.

  • [] —

    required Is attribute required?

  • default (String) (defaults to: nil) —

    Default value for attribute when not provided. Cannot be set when attribute is required.

  • [] —

    array Is attribute an array?

Returns:

  • (AttributeUrl) 


1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
 
# File 'lib/appwrite/services/databases.rb', line 1967

def create_url_attribute(database_id:, collection_id:, key:, required:, default: nil, array: nil)
    api_path = '/databases/{databaseId}/collections/{collectionId}/attributes/url'
        .gsub('{databaseId}', database_id)
        .gsub('{collectionId}', collection_id)

    if database_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "databaseId"')
    end

    if collection_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "collectionId"')
    end

    if key.nil?
      raise Appwrite::Exception.new('Missing required parameter: "key"')
    end

    if required.nil?
      raise Appwrite::Exception.new('Missing required parameter: "required"')
    end

    api_params = {
        key: key,
        required: required,
        default: default,
        array: array,
    }
    
    api_headers = {
        "content-type": 'application/json',
    }

    @client.call(
        method: 'POST',
        path: api_path,
        headers: api_headers,
        params: api_params,
        response_type: Models::AttributeUrl
    )
end

#decrement_document_attribute(database_id:, collection_id:, document_id:, attribute:, value: nil, min: nil, transaction_id: nil) ⇒ Document

Deprecated.

This API has been deprecated since 1.8.0. Please use ‘TablesDB.decrementRowColumn` instead.

Decrement a specific attribute of a document by a given value.

Parameters:

  • database_id (String) —

    Database ID.

  • collection_id (String) —

    Collection ID.

  • document_id (String) —

    Document ID.

  • attribute (String) —

    Attribute key.

  • value (Float) (defaults to: nil) —

    Value to increment the attribute by. The value must be a number.

  • min (Float) (defaults to: nil) —

    Minimum value for the attribute. If the current value is lesser than this value, an exception will be thrown.

  • transaction_id (String) (defaults to: nil) —

    Transaction ID for staging the operation.

Returns:

  • (Document) 


2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
 
# File 'lib/appwrite/services/databases.rb', line 2707

def decrement_document_attribute(database_id:, collection_id:, document_id:, attribute:, value: nil, min: nil, transaction_id: nil)
    api_path = '/databases/{databaseId}/collections/{collectionId}/documents/{documentId}/{attribute}/decrement'
        .gsub('{databaseId}', database_id)
        .gsub('{collectionId}', collection_id)
        .gsub('{documentId}', document_id)
        .gsub('{attribute}', attribute)

    if database_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "databaseId"')
    end

    if collection_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "collectionId"')
    end

    if document_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "documentId"')
    end

    if attribute.nil?
      raise Appwrite::Exception.new('Missing required parameter: "attribute"')
    end

    api_params = {
        value: value,
        min: min,
        transactionId: transaction_id,
    }
    
    api_headers = {
        "content-type": 'application/json',
    }

    @client.call(
        method: 'PATCH',
        path: api_path,
        headers: api_headers,
        params: api_params,
        response_type: Models::Document
    )
end

#delete(database_id:) ⇒ Object

Deprecated.

This API has been deprecated since 1.8.0. Please use ‘TablesDB.delete` instead.

Delete a database by its unique ID. Only API keys with with databases.write scope can delete a database.

Parameters:

  • database_id (String) —

    Database ID.

Returns:



333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
 
# File 'lib/appwrite/services/databases.rb', line 333

def delete(database_id:)
    api_path = '/databases/{databaseId}'
        .gsub('{databaseId}', database_id)

    if database_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "databaseId"')
    end

    api_params = {
    }
    
    api_headers = {
        "content-type": 'application/json',
    }

    @client.call(
        method: 'DELETE',
        path: api_path,
        headers: api_headers,
        params: api_params,
    )
end

#delete_attribute(database_id:, collection_id:, key:) ⇒ Object

Deprecated.

This API has been deprecated since 1.8.0. Please use ‘TablesDB.deleteColumn` instead.

Deletes an attribute.

Parameters:

  • database_id (String) —

    Database ID.

  • collection_id (String) —

    Collection ID.

  • key (String) —

    Attribute Key.

Returns:



2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
 
# File 'lib/appwrite/services/databases.rb', line 2120

def delete_attribute(database_id:, collection_id:, key:)
    api_path = '/databases/{databaseId}/collections/{collectionId}/attributes/{key}'
        .gsub('{databaseId}', database_id)
        .gsub('{collectionId}', collection_id)
        .gsub('{key}', key)

    if database_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "databaseId"')
    end

    if collection_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "collectionId"')
    end

    if key.nil?
      raise Appwrite::Exception.new('Missing required parameter: "key"')
    end

    api_params = {
    }
    
    api_headers = {
        "content-type": 'application/json',
    }

    @client.call(
        method: 'DELETE',
        path: api_path,
        headers: api_headers,
        params: api_params,
    )
end

#delete_collection(database_id:, collection_id:) ⇒ Object

Deprecated.

This API has been deprecated since 1.8.0. Please use ‘TablesDB.deleteTable` instead.

Delete a collection by its unique ID. Only users with write permissions have access to delete this resource.

Parameters:

  • database_id (String) —

    Database ID.

  • collection_id (String) —

    Collection ID.

Returns:



545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
 
# File 'lib/appwrite/services/databases.rb', line 545

def delete_collection(database_id:, collection_id:)
    api_path = '/databases/{databaseId}/collections/{collectionId}'
        .gsub('{databaseId}', database_id)
        .gsub('{collectionId}', collection_id)

    if database_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "databaseId"')
    end

    if collection_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "collectionId"')
    end

    api_params = {
    }
    
    api_headers = {
        "content-type": 'application/json',
    }

    @client.call(
        method: 'DELETE',
        path: api_path,
        headers: api_headers,
        params: api_params,
    )
end

#delete_document(database_id:, collection_id:, document_id:, transaction_id: nil) ⇒ Object

Deprecated.

This API has been deprecated since 1.8.0. Please use ‘TablesDB.deleteRow` instead.

Delete a document by its unique ID.

Parameters:

  • database_id (String) —

    Database ID.

  • collection_id (String) —

    Collection ID. You can create a new collection using the Database service [server integration](appwrite.io/docs/server/databases#databasesCreateCollection).

  • document_id (String) —

    Document ID.

  • transaction_id (String) (defaults to: nil) —

    Transaction ID for staging the operation.

Returns:



2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
 
# File 'lib/appwrite/services/databases.rb', line 2659

def delete_document(database_id:, collection_id:, document_id:, transaction_id: nil)
    api_path = '/databases/{databaseId}/collections/{collectionId}/documents/{documentId}'
        .gsub('{databaseId}', database_id)
        .gsub('{collectionId}', collection_id)
        .gsub('{documentId}', document_id)

    if database_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "databaseId"')
    end

    if collection_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "collectionId"')
    end

    if document_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "documentId"')
    end

    api_params = {
        transactionId: transaction_id,
    }
    
    api_headers = {
        "content-type": 'application/json',
    }

    @client.call(
        method: 'DELETE',
        path: api_path,
        headers: api_headers,
        params: api_params,
    )
end

#delete_documents(database_id:, collection_id:, queries: nil, transaction_id: nil) ⇒ DocumentList

Deprecated.

This API has been deprecated since 1.8.0. Please use ‘TablesDB.deleteRows` instead.

Bulk delete documents using queries, if no queries are passed then all documents are deleted.

Parameters:

  • database_id (String) —

    Database ID.

  • collection_id (String) —

    Collection ID. You can create a new collection using the Database service [server integration](appwrite.io/docs/server/databases#databasesCreateCollection).

  • queries (Array) (defaults to: nil) —

    Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](appwrite.io/docs/queries). Maximum of 100 queries are allowed, each 4096 characters long.

  • transaction_id (String) (defaults to: nil) —

    Transaction ID for staging the operation.

Returns:

  • (DocumentList) 


2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
 
# File 'lib/appwrite/services/databases.rb', line 2461

def delete_documents(database_id:, collection_id:, queries: nil, transaction_id: nil)
    api_path = '/databases/{databaseId}/collections/{collectionId}/documents'
        .gsub('{databaseId}', database_id)
        .gsub('{collectionId}', collection_id)

    if database_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "databaseId"')
    end

    if collection_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "collectionId"')
    end

    api_params = {
        queries: queries,
        transactionId: transaction_id,
    }
    
    api_headers = {
        "content-type": 'application/json',
    }

    @client.call(
        method: 'DELETE',
        path: api_path,
        headers: api_headers,
        params: api_params,
        response_type: Models::DocumentList
    )
end

#delete_index(database_id:, collection_id:, key:) ⇒ Object

Deprecated.

This API has been deprecated since 1.8.0. Please use ‘TablesDB.deleteIndex` instead.

Delete an index.

Parameters:

Returns:



2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
 
# File 'lib/appwrite/services/databases.rb', line 2961

def delete_index(database_id:, collection_id:, key:)
    api_path = '/databases/{databaseId}/collections/{collectionId}/indexes/{key}'
        .gsub('{databaseId}', database_id)
        .gsub('{collectionId}', collection_id)
        .gsub('{key}', key)

    if database_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "databaseId"')
    end

    if collection_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "collectionId"')
    end

    if key.nil?
      raise Appwrite::Exception.new('Missing required parameter: "key"')
    end

    api_params = {
    }
    
    api_headers = {
        "content-type": 'application/json',
    }

    @client.call(
        method: 'DELETE',
        path: api_path,
        headers: api_headers,
        params: api_params,
    )
end

#delete_transaction(transaction_id:) ⇒ Object

Delete a transaction by its unique ID.

Parameters:

  • transaction_id (String) —

    Transaction ID.

Returns:



198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
 
# File 'lib/appwrite/services/databases.rb', line 198

def delete_transaction(transaction_id:)
    api_path = '/databases/transactions/{transactionId}'
        .gsub('{transactionId}', transaction_id)

    if transaction_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "transactionId"')
    end

    api_params = {
    }
    
    api_headers = {
        "content-type": 'application/json',
    }

    @client.call(
        method: 'DELETE',
        path: api_path,
        headers: api_headers,
        params: api_params,
    )
end

#get(database_id:) ⇒ Database

Deprecated.

This API has been deprecated since 1.8.0. Please use ‘TablesDB.get` instead.

Get a database by its unique ID. This endpoint response returns a JSON object with the database metadata.

Parameters:

  • database_id (String) —

    Database ID.

Returns:

  • (Database) 


261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
 
# File 'lib/appwrite/services/databases.rb', line 261

def get(database_id:)
    api_path = '/databases/{databaseId}'
        .gsub('{databaseId}', database_id)

    if database_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "databaseId"')
    end

    api_params = {
    }
    
    api_headers = {
    }

    @client.call(
        method: 'GET',
        path: api_path,
        headers: api_headers,
        params: api_params,
        response_type: Models::Database
    )
end

#get_attribute(database_id:, collection_id:, key:) ⇒ Object

Deprecated.

This API has been deprecated since 1.8.0. Please use ‘TablesDB.getColumn` instead.

Get attribute by ID.

Parameters:

  • database_id (String) —

    Database ID.

  • collection_id (String) —

    Collection ID.

  • key (String) —

    Attribute Key.

Returns:



2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
 
# File 'lib/appwrite/services/databases.rb', line 2078

def get_attribute(database_id:, collection_id:, key:)
    api_path = '/databases/{databaseId}/collections/{collectionId}/attributes/{key}'
        .gsub('{databaseId}', database_id)
        .gsub('{collectionId}', collection_id)
        .gsub('{key}', key)

    if database_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "databaseId"')
    end

    if collection_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "collectionId"')
    end

    if key.nil?
      raise Appwrite::Exception.new('Missing required parameter: "key"')
    end

    api_params = {
    }
    
    api_headers = {
    }

    @client.call(
        method: 'GET',
        path: api_path,
        headers: api_headers,
        params: api_params,
    )
end

#get_collection(database_id:, collection_id:) ⇒ Collection

Deprecated.

This API has been deprecated since 1.8.0. Please use ‘TablesDB.getTable` instead.

Get a collection by its unique ID. This endpoint response returns a JSON object with the collection metadata.

Parameters:

  • database_id (String) —

    Database ID.

  • collection_id (String) —

    Collection ID.

Returns:

  • (Collection) 


457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
 
# File 'lib/appwrite/services/databases.rb', line 457

def get_collection(database_id:, collection_id:)
    api_path = '/databases/{databaseId}/collections/{collectionId}'
        .gsub('{databaseId}', database_id)
        .gsub('{collectionId}', collection_id)

    if database_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "databaseId"')
    end

    if collection_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "collectionId"')
    end

    api_params = {
    }
    
    api_headers = {
    }

    @client.call(
        method: 'GET',
        path: api_path,
        headers: api_headers,
        params: api_params,
        response_type: Models::Collection
    )
end

#get_document(database_id:, collection_id:, document_id:, queries: nil, transaction_id: nil) ⇒ Document

Deprecated.

This API has been deprecated since 1.8.0. Please use ‘TablesDB.getRow` instead.

Get a document by its unique ID. This endpoint response returns a JSON object with the document data.

Parameters:

  • database_id (String) —

    Database ID.

  • collection_id (String) —

    Collection ID. You can create a new collection using the Database service [server integration](appwrite.io/docs/server/databases#databasesCreateCollection).

  • document_id (String) —

    Document ID.

  • queries (Array) (defaults to: nil) —

    Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](appwrite.io/docs/queries). Maximum of 100 queries are allowed, each 4096 characters long.

  • transaction_id (String) (defaults to: nil) —

    Transaction ID to read uncommitted changes within the transaction.

Returns:

  • (Document) 


2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
 
# File 'lib/appwrite/services/databases.rb', line 2505

def get_document(database_id:, collection_id:, document_id:, queries: nil, transaction_id: nil)
    api_path = '/databases/{databaseId}/collections/{collectionId}/documents/{documentId}'
        .gsub('{databaseId}', database_id)
        .gsub('{collectionId}', collection_id)
        .gsub('{documentId}', document_id)

    if database_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "databaseId"')
    end

    if collection_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "collectionId"')
    end

    if document_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "documentId"')
    end

    api_params = {
        queries: queries,
        transactionId: transaction_id,
    }
    
    api_headers = {
    }

    @client.call(
        method: 'GET',
        path: api_path,
        headers: api_headers,
        params: api_params,
        response_type: Models::Document
    )
end

#get_index(database_id:, collection_id:, key:) ⇒ Index

Deprecated.

This API has been deprecated since 1.8.0. Please use ‘TablesDB.getIndex` instead.

Get an index by its unique ID.

Parameters:

Returns:

  • (Index) 


2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
 
# File 'lib/appwrite/services/databases.rb', line 2918

def get_index(database_id:, collection_id:, key:)
    api_path = '/databases/{databaseId}/collections/{collectionId}/indexes/{key}'
        .gsub('{databaseId}', database_id)
        .gsub('{collectionId}', collection_id)
        .gsub('{key}', key)

    if database_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "databaseId"')
    end

    if collection_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "collectionId"')
    end

    if key.nil?
      raise Appwrite::Exception.new('Missing required parameter: "key"')
    end

    api_params = {
    }
    
    api_headers = {
    }

    @client.call(
        method: 'GET',
        path: api_path,
        headers: api_headers,
        params: api_params,
        response_type: Models::Index
    )
end

#get_transaction(transaction_id:) ⇒ Transaction

Get a transaction by its unique ID.

Parameters:

  • transaction_id (String) —

    Transaction ID.

Returns:

  • (Transaction) 


137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
 
# File 'lib/appwrite/services/databases.rb', line 137

def get_transaction(transaction_id:)
    api_path = '/databases/transactions/{transactionId}'
        .gsub('{transactionId}', transaction_id)

    if transaction_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "transactionId"')
    end

    api_params = {
    }
    
    api_headers = {
    }

    @client.call(
        method: 'GET',
        path: api_path,
        headers: api_headers,
        params: api_params,
        response_type: Models::Transaction
    )
end

#increment_document_attribute(database_id:, collection_id:, document_id:, attribute:, value: nil, max: nil, transaction_id: nil) ⇒ Document

Deprecated.

This API has been deprecated since 1.8.0. Please use ‘TablesDB.incrementRowColumn` instead.

Increment a specific attribute of a document by a given value.

Parameters:

  • database_id (String) —

    Database ID.

  • collection_id (String) —

    Collection ID.

  • document_id (String) —

    Document ID.

  • attribute (String) —

    Attribute key.

  • value (Float) (defaults to: nil) —

    Value to increment the attribute by. The value must be a number.

  • max (Float) (defaults to: nil) —

    Maximum value for the attribute. If the current value is greater than this value, an error will be thrown.

  • transaction_id (String) (defaults to: nil) —

    Transaction ID for staging the operation.

Returns:

  • (Document) 


2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
 
# File 'lib/appwrite/services/databases.rb', line 2763

def increment_document_attribute(database_id:, collection_id:, document_id:, attribute:, value: nil, max: nil, transaction_id: nil)
    api_path = '/databases/{databaseId}/collections/{collectionId}/documents/{documentId}/{attribute}/increment'
        .gsub('{databaseId}', database_id)
        .gsub('{collectionId}', collection_id)
        .gsub('{documentId}', document_id)
        .gsub('{attribute}', attribute)

    if database_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "databaseId"')
    end

    if collection_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "collectionId"')
    end

    if document_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "documentId"')
    end

    if attribute.nil?
      raise Appwrite::Exception.new('Missing required parameter: "attribute"')
    end

    api_params = {
        value: value,
        max: max,
        transactionId: transaction_id,
    }
    
    api_headers = {
        "content-type": 'application/json',
    }

    @client.call(
        method: 'PATCH',
        path: api_path,
        headers: api_headers,
        params: api_params,
        response_type: Models::Document
    )
end

#list(queries: nil, search: nil, total: nil) ⇒ DatabaseList

Deprecated.

This API has been deprecated since 1.8.0. Please use ‘TablesDB.list` instead.

Get a list of all databases from the current Appwrite project. You can use the search parameter to filter your results.

Parameters:

  • queries (Array) (defaults to: nil) —

    Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](appwrite.io/docs/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: name

  • search (String) (defaults to: nil) —

    Search term to filter your list results. Max length: 256 chars.

  • [] —

    total When set to false, the total count returned will be 0 and will not be calculated.

Returns:

  • (DatabaseList) 


21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
 
# File 'lib/appwrite/services/databases.rb', line 21

def list(queries: nil, search: nil, total: nil)
    api_path = '/databases'

    api_params = {
        queries: queries,
        search: search,
        total: total,
    }
    
    api_headers = {
    }

    @client.call(
        method: 'GET',
        path: api_path,
        headers: api_headers,
        params: api_params,
        response_type: Models::DatabaseList
    )
end

#list_attributes(database_id:, collection_id:, queries: nil, total: nil) ⇒ AttributeList

Deprecated.

This API has been deprecated since 1.8.0. Please use ‘TablesDB.listColumns` instead.

List attributes in the collection.

Parameters:

  • database_id (String) —

    Database ID.

  • collection_id (String) —

    Collection ID.

  • queries (Array) (defaults to: nil) —

    Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](appwrite.io/docs/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: key, type, size, required, array, status, error

  • [] —

    total When set to false, the total count returned will be 0 and will not be calculated.

Returns:

  • (AttributeList) 


584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
 
# File 'lib/appwrite/services/databases.rb', line 584

def list_attributes(database_id:, collection_id:, queries: nil, total: nil)
    api_path = '/databases/{databaseId}/collections/{collectionId}/attributes'
        .gsub('{databaseId}', database_id)
        .gsub('{collectionId}', collection_id)

    if database_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "databaseId"')
    end

    if collection_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "collectionId"')
    end

    api_params = {
        queries: queries,
        total: total,
    }
    
    api_headers = {
    }

    @client.call(
        method: 'GET',
        path: api_path,
        headers: api_headers,
        params: api_params,
        response_type: Models::AttributeList
    )
end

#list_collections(database_id:, queries: nil, search: nil, total: nil) ⇒ CollectionList

Deprecated.

This API has been deprecated since 1.8.0. Please use ‘TablesDB.listTables` instead.

Get a list of all collections that belong to the provided databaseId. You can use the search parameter to filter your results.

Parameters:

  • database_id (String) —

    Database ID.

  • queries (Array) (defaults to: nil) —

    Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](appwrite.io/docs/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: name, enabled, documentSecurity

  • search (String) (defaults to: nil) —

    Search term to filter your list results. Max length: 256 chars.

  • [] —

    total When set to false, the total count returned will be 0 and will not be calculated.

Returns:

  • (CollectionList) 


368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
 
# File 'lib/appwrite/services/databases.rb', line 368

def list_collections(database_id:, queries: nil, search: nil, total: nil)
    api_path = '/databases/{databaseId}/collections'
        .gsub('{databaseId}', database_id)

    if database_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "databaseId"')
    end

    api_params = {
        queries: queries,
        search: search,
        total: total,
    }
    
    api_headers = {
    }

    @client.call(
        method: 'GET',
        path: api_path,
        headers: api_headers,
        params: api_params,
        response_type: Models::CollectionList
    )
end

#list_documents(database_id:, collection_id:, queries: nil, transaction_id: nil, total: nil) ⇒ DocumentList

Deprecated.

This API has been deprecated since 1.8.0. Please use ‘TablesDB.listRows` instead.

Get a list of all the user’s documents in a given collection. You can use the query params to filter your results.

Parameters:

  • database_id (String) —

    Database ID.

  • collection_id (String) —

    Collection ID. You can create a new collection using the Database service [server integration](appwrite.io/docs/server/databases#databasesCreateCollection).

  • queries (Array) (defaults to: nil) —

    Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](appwrite.io/docs/queries). Maximum of 100 queries are allowed, each 4096 characters long.

  • transaction_id (String) (defaults to: nil) —

    Transaction ID to read uncommitted changes within the transaction.

  • [] —

    total When set to false, the total count returned will be 0 and will not be calculated.

Returns:

  • (DocumentList) 


2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
 
# File 'lib/appwrite/services/databases.rb', line 2216

def list_documents(database_id:, collection_id:, queries: nil, transaction_id: nil, total: nil)
    api_path = '/databases/{databaseId}/collections/{collectionId}/documents'
        .gsub('{databaseId}', database_id)
        .gsub('{collectionId}', collection_id)

    if database_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "databaseId"')
    end

    if collection_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "collectionId"')
    end

    api_params = {
        queries: queries,
        transactionId: transaction_id,
        total: total,
    }
    
    api_headers = {
    }

    @client.call(
        method: 'GET',
        path: api_path,
        headers: api_headers,
        params: api_params,
        response_type: Models::DocumentList
    )
end

#list_indexes(database_id:, collection_id:, queries: nil, total: nil) ⇒ IndexList

Deprecated.

This API has been deprecated since 1.8.0. Please use ‘TablesDB.listIndexes` instead.

List indexes in the collection.

Parameters:

  • database_id (String) —

    Database ID.

  • collection_id (String) —

    Collection ID. You can create a new collection using the Database service [server integration](appwrite.io/docs/server/databases#databasesCreateCollection).

  • queries (Array) (defaults to: nil) —

    Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](appwrite.io/docs/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: key, type, status, attributes, error

  • [] —

    total When set to false, the total count returned will be 0 and will not be calculated.

Returns:

  • (IndexList) 


2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
 
# File 'lib/appwrite/services/databases.rb', line 2816

def list_indexes(database_id:, collection_id:, queries: nil, total: nil)
    api_path = '/databases/{databaseId}/collections/{collectionId}/indexes'
        .gsub('{databaseId}', database_id)
        .gsub('{collectionId}', collection_id)

    if database_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "databaseId"')
    end

    if collection_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "collectionId"')
    end

    api_params = {
        queries: queries,
        total: total,
    }
    
    api_headers = {
    }

    @client.call(
        method: 'GET',
        path: api_path,
        headers: api_headers,
        params: api_params,
        response_type: Models::IndexList
    )
end

#list_transactions(queries: nil) ⇒ TransactionList

List transactions across all databases.

Parameters:

  • queries (Array) (defaults to: nil) —

    Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](appwrite.io/docs/queries).

Returns:

  • (TransactionList) 


88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'lib/appwrite/services/databases.rb', line 88

def list_transactions(queries: nil)
    api_path = '/databases/transactions'

    api_params = {
        queries: queries,
    }
    
    api_headers = {
    }

    @client.call(
        method: 'GET',
        path: api_path,
        headers: api_headers,
        params: api_params,
        response_type: Models::TransactionList
    )
end

#update(database_id:, name:, enabled: nil) ⇒ Database

Deprecated.

This API has been deprecated since 1.8.0. Please use ‘TablesDB.update` instead.

Update a database by its unique ID.

Parameters:

  • database_id (String) —

    Database ID.

  • name (String) —

    Database name. Max length: 128 chars.

  • [] —

    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.

Returns:

  • (Database) 


294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
 
# File 'lib/appwrite/services/databases.rb', line 294

def update(database_id:, name:, enabled: nil)
    api_path = '/databases/{databaseId}'
        .gsub('{databaseId}', database_id)

    if database_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "databaseId"')
    end

    if name.nil?
      raise Appwrite::Exception.new('Missing required parameter: "name"')
    end

    api_params = {
        name: name,
        enabled: enabled,
    }
    
    api_headers = {
        "content-type": 'application/json',
    }

    @client.call(
        method: 'PUT',
        path: api_path,
        headers: api_headers,
        params: api_params,
        response_type: Models::Database
    )
end

#update_boolean_attribute(database_id:, collection_id:, key:, required:, default:, new_key: nil) ⇒ AttributeBoolean

Deprecated.

This API has been deprecated since 1.8.0. Please use ‘TablesDB.updateBooleanColumn` instead.

Update a boolean attribute. Changing the ‘default` value will not update already existing documents.

Parameters:

  • database_id (String) —

    Database ID.

  • collection_id (String) —

    Collection ID. You can create a new collection using the Database service [server integration](appwrite.io/docs/server/databases#createCollection).

  • key (String) —

    Attribute Key.

  • [] —

    required Is attribute required?

  • [] —

    default Default value for attribute when not provided. Cannot be set when attribute is required.

  • new_key (String) (defaults to: nil) —

    New attribute key.

Returns:

  • (AttributeBoolean) 


683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
 
# File 'lib/appwrite/services/databases.rb', line 683

def update_boolean_attribute(database_id:, collection_id:, key:, required:, default:, new_key: nil)
    api_path = '/databases/{databaseId}/collections/{collectionId}/attributes/boolean/{key}'
        .gsub('{databaseId}', database_id)
        .gsub('{collectionId}', collection_id)
        .gsub('{key}', key)

    if database_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "databaseId"')
    end

    if collection_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "collectionId"')
    end

    if key.nil?
      raise Appwrite::Exception.new('Missing required parameter: "key"')
    end

    if required.nil?
      raise Appwrite::Exception.new('Missing required parameter: "required"')
    end

    if default.nil?
      raise Appwrite::Exception.new('Missing required parameter: "default"')
    end

    api_params = {
        required: required,
        default: default,
        newKey: new_key,
    }
    
    api_headers = {
        "content-type": 'application/json',
    }

    @client.call(
        method: 'PATCH',
        path: api_path,
        headers: api_headers,
        params: api_params,
        response_type: Models::AttributeBoolean
    )
end

#update_collection(database_id:, collection_id:, name:, permissions: nil, document_security: nil, enabled: nil) ⇒ Collection

Deprecated.

This API has been deprecated since 1.8.0. Please use ‘TablesDB.updateTable` instead.

Update a collection by its unique ID.

Parameters:

  • database_id (String) —

    Database ID.

  • collection_id (String) —

    Collection ID.

  • name (String) —

    Collection name. Max length: 128 chars.

  • permissions (Array) (defaults to: nil) —

    An array of permission strings. By default, the current permissions are inherited. [Learn more about permissions](appwrite.io/docs/permissions).

  • [] —

    document_security Enables configuring permissions for individual documents. A user needs one of document or collection level permissions to access a document. [Learn more about permissions](appwrite.io/docs/permissions).

  • [] —

    enabled Is collection enabled? When set to ‘disabled’, users cannot access the collection but Server SDKs with and API key can still read and write to the collection. No data is lost when this is toggled.

Returns:

  • (Collection) 


498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
 
# File 'lib/appwrite/services/databases.rb', line 498

def update_collection(database_id:, collection_id:, name:, permissions: nil, document_security: nil, enabled: nil)
    api_path = '/databases/{databaseId}/collections/{collectionId}'
        .gsub('{databaseId}', database_id)
        .gsub('{collectionId}', collection_id)

    if database_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "databaseId"')
    end

    if collection_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "collectionId"')
    end

    if name.nil?
      raise Appwrite::Exception.new('Missing required parameter: "name"')
    end

    api_params = {
        name: name,
        permissions: permissions,
        documentSecurity: document_security,
        enabled: enabled,
    }
    
    api_headers = {
        "content-type": 'application/json',
    }

    @client.call(
        method: 'PUT',
        path: api_path,
        headers: api_headers,
        params: api_params,
        response_type: Models::Collection
    )
end

#update_datetime_attribute(database_id:, collection_id:, key:, required:, default:, new_key: nil) ⇒ AttributeDatetime

Deprecated.

This API has been deprecated since 1.8.0. Please use ‘TablesDB.updateDatetimeColumn` instead.

Update a date time attribute. Changing the ‘default` value will not update already existing documents.

Parameters:

  • database_id (String) —

    Database ID.

  • collection_id (String) —

    Collection ID.

  • key (String) —

    Attribute Key.

  • [] —

    required Is attribute required?

  • default (String) —

    Default value for attribute when not provided. Cannot be set when attribute is required.

  • new_key (String) (defaults to: nil) —

    New attribute key.

Returns:

  • (AttributeDatetime) 


796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
 
# File 'lib/appwrite/services/databases.rb', line 796

def update_datetime_attribute(database_id:, collection_id:, key:, required:, default:, new_key: nil)
    api_path = '/databases/{databaseId}/collections/{collectionId}/attributes/datetime/{key}'
        .gsub('{databaseId}', database_id)
        .gsub('{collectionId}', collection_id)
        .gsub('{key}', key)

    if database_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "databaseId"')
    end

    if collection_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "collectionId"')
    end

    if key.nil?
      raise Appwrite::Exception.new('Missing required parameter: "key"')
    end

    if required.nil?
      raise Appwrite::Exception.new('Missing required parameter: "required"')
    end

    if default.nil?
      raise Appwrite::Exception.new('Missing required parameter: "default"')
    end

    api_params = {
        required: required,
        default: default,
        newKey: new_key,
    }
    
    api_headers = {
        "content-type": 'application/json',
    }

    @client.call(
        method: 'PATCH',
        path: api_path,
        headers: api_headers,
        params: api_params,
        response_type: Models::AttributeDatetime
    )
end

#update_document(database_id:, collection_id:, document_id:, data: nil, permissions: nil, transaction_id: nil) ⇒ Document

Deprecated.

This API has been deprecated since 1.8.0. Please use ‘TablesDB.updateRow` instead.

Update a document by its unique ID. Using the patch method you can pass only specific fields that will get updated.

Parameters:

  • database_id (String) —

    Database ID.

  • collection_id (String) —

    Collection ID.

  • document_id (String) —

    Document ID.

  • data (Hash) (defaults to: nil) —

    Document data as JSON object. Include only attribute and value pairs to be updated.

  • permissions (Array) (defaults to: nil) —

    An array of permissions strings. By default, the current permissions are inherited. [Learn more about permissions](appwrite.io/docs/permissions).

  • transaction_id (String) (defaults to: nil) —

    Transaction ID for staging the operation.

Returns:

  • (Document) 


2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
 
# File 'lib/appwrite/services/databases.rb', line 2611

def update_document(database_id:, collection_id:, document_id:, data: nil, permissions: nil, transaction_id: nil)
    api_path = '/databases/{databaseId}/collections/{collectionId}/documents/{documentId}'
        .gsub('{databaseId}', database_id)
        .gsub('{collectionId}', collection_id)
        .gsub('{documentId}', document_id)

    if database_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "databaseId"')
    end

    if collection_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "collectionId"')
    end

    if document_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "documentId"')
    end

    api_params = {
        data: data,
        permissions: permissions,
        transactionId: transaction_id,
    }
    
    api_headers = {
        "content-type": 'application/json',
    }

    @client.call(
        method: 'PATCH',
        path: api_path,
        headers: api_headers,
        params: api_params,
        response_type: Models::Document
    )
end

#update_documents(database_id:, collection_id:, data: nil, queries: nil, transaction_id: nil) ⇒ DocumentList

Deprecated.

This API has been deprecated since 1.8.0. Please use ‘TablesDB.updateRows` instead.

Update all documents that match your queries, if no queries are submitted then all documents are updated. You can pass only specific fields to be updated.

Parameters:

  • database_id (String) —

    Database ID.

  • collection_id (String) —

    Collection ID.

  • data (Hash) (defaults to: nil) —

    Document data as JSON object. Include only attribute and value pairs to be updated.

  • queries (Array) (defaults to: nil) —

    Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](appwrite.io/docs/queries). Maximum of 100 queries are allowed, each 4096 characters long.

  • transaction_id (String) (defaults to: nil) —

    Transaction ID for staging the operation.

Returns:

  • (DocumentList) 


2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
 
# File 'lib/appwrite/services/databases.rb', line 2417

def update_documents(database_id:, collection_id:, data: nil, queries: nil, transaction_id: nil)
    api_path = '/databases/{databaseId}/collections/{collectionId}/documents'
        .gsub('{databaseId}', database_id)
        .gsub('{collectionId}', collection_id)

    if database_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "databaseId"')
    end

    if collection_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "collectionId"')
    end

    api_params = {
        data: data,
        queries: queries,
        transactionId: transaction_id,
    }
    
    api_headers = {
        "content-type": 'application/json',
    }

    @client.call(
        method: 'PATCH',
        path: api_path,
        headers: api_headers,
        params: api_params,
        response_type: Models::DocumentList
    )
end

#update_email_attribute(database_id:, collection_id:, key:, required:, default:, new_key: nil) ⇒ AttributeEmail

Deprecated.

This API has been deprecated since 1.8.0. Please use ‘TablesDB.updateEmailColumn` instead.

Update an email attribute. Changing the ‘default` value will not update already existing documents.

Parameters:

  • database_id (String) —

    Database ID.

  • collection_id (String) —

    Collection ID.

  • key (String) —

    Attribute Key.

  • [] —

    required Is attribute required?

  • default (String) —

    Default value for attribute when not provided. Cannot be set when attribute is required.

  • new_key (String) (defaults to: nil) —

    New Attribute Key.

Returns:

  • (AttributeEmail) 


911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
 
# File 'lib/appwrite/services/databases.rb', line 911

def update_email_attribute(database_id:, collection_id:, key:, required:, default:, new_key: nil)
    api_path = '/databases/{databaseId}/collections/{collectionId}/attributes/email/{key}'
        .gsub('{databaseId}', database_id)
        .gsub('{collectionId}', collection_id)
        .gsub('{key}', key)

    if database_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "databaseId"')
    end

    if collection_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "collectionId"')
    end

    if key.nil?
      raise Appwrite::Exception.new('Missing required parameter: "key"')
    end

    if required.nil?
      raise Appwrite::Exception.new('Missing required parameter: "required"')
    end

    if default.nil?
      raise Appwrite::Exception.new('Missing required parameter: "default"')
    end

    api_params = {
        required: required,
        default: default,
        newKey: new_key,
    }
    
    api_headers = {
        "content-type": 'application/json',
    }

    @client.call(
        method: 'PATCH',
        path: api_path,
        headers: api_headers,
        params: api_params,
        response_type: Models::AttributeEmail
    )
end

#update_enum_attribute(database_id:, collection_id:, key:, elements:, required:, default:, new_key: nil) ⇒ AttributeEnum

Deprecated.

This API has been deprecated since 1.8.0. Please use ‘TablesDB.updateEnumColumn` instead.

Update an enum attribute. Changing the ‘default` value will not update already existing documents.

Parameters:

  • database_id (String) —

    Database ID.

  • collection_id (String) —

    Collection ID.

  • key (String) —

    Attribute Key.

  • elements (Array) —

    Updated list of enum values.

  • [] —

    required Is attribute required?

  • default (String) —

    Default value for attribute when not provided. Cannot be set when attribute is required.

  • new_key (String) (defaults to: nil) —

    New Attribute Key.

Returns:

  • (AttributeEnum) 


1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
 
# File 'lib/appwrite/services/databases.rb', line 1034

def update_enum_attribute(database_id:, collection_id:, key:, elements:, required:, default:, new_key: nil)
    api_path = '/databases/{databaseId}/collections/{collectionId}/attributes/enum/{key}'
        .gsub('{databaseId}', database_id)
        .gsub('{collectionId}', collection_id)
        .gsub('{key}', key)

    if database_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "databaseId"')
    end

    if collection_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "collectionId"')
    end

    if key.nil?
      raise Appwrite::Exception.new('Missing required parameter: "key"')
    end

    if elements.nil?
      raise Appwrite::Exception.new('Missing required parameter: "elements"')
    end

    if required.nil?
      raise Appwrite::Exception.new('Missing required parameter: "required"')
    end

    if default.nil?
      raise Appwrite::Exception.new('Missing required parameter: "default"')
    end

    api_params = {
        elements: elements,
        required: required,
        default: default,
        newKey: new_key,
    }
    
    api_headers = {
        "content-type": 'application/json',
    }

    @client.call(
        method: 'PATCH',
        path: api_path,
        headers: api_headers,
        params: api_params,
        response_type: Models::AttributeEnum
    )
end

#update_float_attribute(database_id:, collection_id:, key:, required:, default:, min: nil, max: nil, new_key: nil) ⇒ AttributeFloat

Deprecated.

This API has been deprecated since 1.8.0. Please use ‘TablesDB.updateFloatColumn` instead.

Update a float attribute. Changing the ‘default` value will not update already existing documents.

Parameters:

  • database_id (String) —

    Database ID.

  • collection_id (String) —

    Collection ID.

  • key (String) —

    Attribute Key.

  • [] —

    required Is attribute required?

  • default (Float) —

    Default value. Cannot be set when required.

  • min (Float) (defaults to: nil) —

    Minimum value.

  • max (Float) (defaults to: nil) —

    Maximum value.

  • new_key (String) (defaults to: nil) —

    New Attribute Key.

Returns:

  • (AttributeFloat) 


1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
 
# File 'lib/appwrite/services/databases.rb', line 1161

def update_float_attribute(database_id:, collection_id:, key:, required:, default:, min: nil, max: nil, new_key: nil)
    api_path = '/databases/{databaseId}/collections/{collectionId}/attributes/float/{key}'
        .gsub('{databaseId}', database_id)
        .gsub('{collectionId}', collection_id)
        .gsub('{key}', key)

    if database_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "databaseId"')
    end

    if collection_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "collectionId"')
    end

    if key.nil?
      raise Appwrite::Exception.new('Missing required parameter: "key"')
    end

    if required.nil?
      raise Appwrite::Exception.new('Missing required parameter: "required"')
    end

    if default.nil?
      raise Appwrite::Exception.new('Missing required parameter: "default"')
    end

    api_params = {
        required: required,
        min: min,
        max: max,
        default: default,
        newKey: new_key,
    }
    
    api_headers = {
        "content-type": 'application/json',
    }

    @client.call(
        method: 'PATCH',
        path: api_path,
        headers: api_headers,
        params: api_params,
        response_type: Models::AttributeFloat
    )
end

#update_integer_attribute(database_id:, collection_id:, key:, required:, default:, min: nil, max: nil, new_key: nil) ⇒ AttributeInteger

Deprecated.

This API has been deprecated since 1.8.0. Please use ‘TablesDB.updateIntegerColumn` instead.

Update an integer attribute. Changing the ‘default` value will not update already existing documents.

Parameters:

  • database_id (String) —

    Database ID.

  • collection_id (String) —

    Collection ID.

  • key (String) —

    Attribute Key.

  • [] —

    required Is attribute required?

  • default (Integer) —

    Default value. Cannot be set when attribute is required.

  • min (Integer) (defaults to: nil) —

    Minimum value

  • max (Integer) (defaults to: nil) —

    Maximum value

  • new_key (String) (defaults to: nil) —

    New Attribute Key.

Returns:

  • (AttributeInteger) 


1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
 
# File 'lib/appwrite/services/databases.rb', line 1285

def update_integer_attribute(database_id:, collection_id:, key:, required:, default:, min: nil, max: nil, new_key: nil)
    api_path = '/databases/{databaseId}/collections/{collectionId}/attributes/integer/{key}'
        .gsub('{databaseId}', database_id)
        .gsub('{collectionId}', collection_id)
        .gsub('{key}', key)

    if database_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "databaseId"')
    end

    if collection_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "collectionId"')
    end

    if key.nil?
      raise Appwrite::Exception.new('Missing required parameter: "key"')
    end

    if required.nil?
      raise Appwrite::Exception.new('Missing required parameter: "required"')
    end

    if default.nil?
      raise Appwrite::Exception.new('Missing required parameter: "default"')
    end

    api_params = {
        required: required,
        min: min,
        max: max,
        default: default,
        newKey: new_key,
    }
    
    api_headers = {
        "content-type": 'application/json',
    }

    @client.call(
        method: 'PATCH',
        path: api_path,
        headers: api_headers,
        params: api_params,
        response_type: Models::AttributeInteger
    )
end

#update_ip_attribute(database_id:, collection_id:, key:, required:, default:, new_key: nil) ⇒ AttributeIp

Deprecated.

This API has been deprecated since 1.8.0. Please use ‘TablesDB.updateIpColumn` instead.

Update an ip attribute. Changing the ‘default` value will not update already existing documents.

Parameters:

  • database_id (String) —

    Database ID.

  • collection_id (String) —

    Collection ID.

  • key (String) —

    Attribute Key.

  • [] —

    required Is attribute required?

  • default (String) —

    Default value. Cannot be set when attribute is required.

  • new_key (String) (defaults to: nil) —

    New Attribute Key.

Returns:

  • (AttributeIp) 


1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
 
# File 'lib/appwrite/services/databases.rb', line 1402

def update_ip_attribute(database_id:, collection_id:, key:, required:, default:, new_key: nil)
    api_path = '/databases/{databaseId}/collections/{collectionId}/attributes/ip/{key}'
        .gsub('{databaseId}', database_id)
        .gsub('{collectionId}', collection_id)
        .gsub('{key}', key)

    if database_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "databaseId"')
    end

    if collection_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "collectionId"')
    end

    if key.nil?
      raise Appwrite::Exception.new('Missing required parameter: "key"')
    end

    if required.nil?
      raise Appwrite::Exception.new('Missing required parameter: "required"')
    end

    if default.nil?
      raise Appwrite::Exception.new('Missing required parameter: "default"')
    end

    api_params = {
        required: required,
        default: default,
        newKey: new_key,
    }
    
    api_headers = {
        "content-type": 'application/json',
    }

    @client.call(
        method: 'PATCH',
        path: api_path,
        headers: api_headers,
        params: api_params,
        response_type: Models::AttributeIp
    )
end

#update_line_attribute(database_id:, collection_id:, key:, required:, default: nil, new_key: nil) ⇒ AttributeLine

Deprecated.

This API has been deprecated since 1.8.0. Please use ‘TablesDB.updateLineColumn` instead.

Update a line attribute. Changing the ‘default` value will not update already existing documents.

Parameters:

  • database_id (String) —

    Database ID.

  • collection_id (String) —

    Collection ID. You can create a new collection using the Database service [server integration](appwrite.io/docs/server/databases#createCollection).

  • key (String) —

    Attribute Key.

  • [] —

    required Is attribute required?

  • default (Array) (defaults to: nil) —

    Default value for attribute 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 attribute is required.

  • new_key (String) (defaults to: nil) —

    New attribute key.

Returns:

  • (AttributeLine) 


1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
 
# File 'lib/appwrite/services/databases.rb', line 1513

def update_line_attribute(database_id:, collection_id:, key:, required:, default: nil, new_key: nil)
    api_path = '/databases/{databaseId}/collections/{collectionId}/attributes/line/{key}'
        .gsub('{databaseId}', database_id)
        .gsub('{collectionId}', collection_id)
        .gsub('{key}', key)

    if database_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "databaseId"')
    end

    if collection_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "collectionId"')
    end

    if key.nil?
      raise Appwrite::Exception.new('Missing required parameter: "key"')
    end

    if required.nil?
      raise Appwrite::Exception.new('Missing required parameter: "required"')
    end

    api_params = {
        required: required,
        default: default,
        newKey: new_key,
    }
    
    api_headers = {
        "content-type": 'application/json',
    }

    @client.call(
        method: 'PATCH',
        path: api_path,
        headers: api_headers,
        params: api_params,
        response_type: Models::AttributeLine
    )
end

#update_point_attribute(database_id:, collection_id:, key:, required:, default: nil, new_key: nil) ⇒ AttributePoint

Deprecated.

This API has been deprecated since 1.8.0. Please use ‘TablesDB.updatePointColumn` instead.

Update a point attribute. Changing the ‘default` value will not update already existing documents.

Parameters:

  • database_id (String) —

    Database ID.

  • collection_id (String) —

    Collection ID. You can create a new collection using the Database service [server integration](appwrite.io/docs/server/databases#createCollection).

  • key (String) —

    Attribute Key.

  • [] —

    required Is attribute required?

  • default (Array) (defaults to: nil) —

    Default value for attribute when not provided, array of two numbers [longitude, latitude], representing a single coordinate. Cannot be set when attribute is required.

  • new_key (String) (defaults to: nil) —

    New attribute key.

Returns:

  • (AttributePoint) 


1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
 
# File 'lib/appwrite/services/databases.rb', line 1620

def update_point_attribute(database_id:, collection_id:, key:, required:, default: nil, new_key: nil)
    api_path = '/databases/{databaseId}/collections/{collectionId}/attributes/point/{key}'
        .gsub('{databaseId}', database_id)
        .gsub('{collectionId}', collection_id)
        .gsub('{key}', key)

    if database_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "databaseId"')
    end

    if collection_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "collectionId"')
    end

    if key.nil?
      raise Appwrite::Exception.new('Missing required parameter: "key"')
    end

    if required.nil?
      raise Appwrite::Exception.new('Missing required parameter: "required"')
    end

    api_params = {
        required: required,
        default: default,
        newKey: new_key,
    }
    
    api_headers = {
        "content-type": 'application/json',
    }

    @client.call(
        method: 'PATCH',
        path: api_path,
        headers: api_headers,
        params: api_params,
        response_type: Models::AttributePoint
    )
end

#update_polygon_attribute(database_id:, collection_id:, key:, required:, default: nil, new_key: nil) ⇒ AttributePolygon

Deprecated.

This API has been deprecated since 1.8.0. Please use ‘TablesDB.updatePolygonColumn` instead.

Update a polygon attribute. Changing the ‘default` value will not update already existing documents.

Parameters:

  • database_id (String) —

    Database ID.

  • collection_id (String) —

    Collection ID. You can create a new collection using the Database service [server integration](appwrite.io/docs/server/databases#createCollection).

  • key (String) —

    Attribute Key.

  • [] —

    required Is attribute required?

  • default (Array) (defaults to: nil) —

    Default value for attribute 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 attribute is required.

  • new_key (String) (defaults to: nil) —

    New attribute key.

Returns:

  • (AttributePolygon) 


1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
 
# File 'lib/appwrite/services/databases.rb', line 1727

def update_polygon_attribute(database_id:, collection_id:, key:, required:, default: nil, new_key: nil)
    api_path = '/databases/{databaseId}/collections/{collectionId}/attributes/polygon/{key}'
        .gsub('{databaseId}', database_id)
        .gsub('{collectionId}', collection_id)
        .gsub('{key}', key)

    if database_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "databaseId"')
    end

    if collection_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "collectionId"')
    end

    if key.nil?
      raise Appwrite::Exception.new('Missing required parameter: "key"')
    end

    if required.nil?
      raise Appwrite::Exception.new('Missing required parameter: "required"')
    end

    api_params = {
        required: required,
        default: default,
        newKey: new_key,
    }
    
    api_headers = {
        "content-type": 'application/json',
    }

    @client.call(
        method: 'PATCH',
        path: api_path,
        headers: api_headers,
        params: api_params,
        response_type: Models::AttributePolygon
    )
end

#update_relationship_attribute(database_id:, collection_id:, key:, on_delete: nil, new_key: nil) ⇒ AttributeRelationship

Deprecated.

This API has been deprecated since 1.8.0. Please use ‘TablesDB.updateRelationshipColumn` instead.

Update relationship attribute. [Learn more about relationship attributes](appwrite.io/docs/databases-relationships#relationship-attributes).

Parameters:

  • database_id (String) —

    Database ID.

  • collection_id (String) —

    Collection ID.

  • key (String) —

    Attribute Key.

  • on_delete (RelationMutate) (defaults to: nil) —

    Constraints option

  • new_key (String) (defaults to: nil) —

    New Attribute Key.

Returns:

  • (AttributeRelationship) 


2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
 
# File 'lib/appwrite/services/databases.rb', line 2167

def update_relationship_attribute(database_id:, collection_id:, key:, on_delete: nil, new_key: nil)
    api_path = '/databases/{databaseId}/collections/{collectionId}/attributes/{key}/relationship'
        .gsub('{databaseId}', database_id)
        .gsub('{collectionId}', collection_id)
        .gsub('{key}', key)

    if database_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "databaseId"')
    end

    if collection_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "collectionId"')
    end

    if key.nil?
      raise Appwrite::Exception.new('Missing required parameter: "key"')
    end

    api_params = {
        onDelete: on_delete,
        newKey: new_key,
    }
    
    api_headers = {
        "content-type": 'application/json',
    }

    @client.call(
        method: 'PATCH',
        path: api_path,
        headers: api_headers,
        params: api_params,
        response_type: Models::AttributeRelationship
    )
end

#update_string_attribute(database_id:, collection_id:, key:, required:, default:, size: nil, new_key: nil) ⇒ AttributeString

Deprecated.

This API has been deprecated since 1.8.0. Please use ‘TablesDB.updateStringColumn` instead.

Update a string attribute. Changing the ‘default` value will not update already existing documents.

Parameters:

  • database_id (String) —

    Database ID.

  • collection_id (String) —

    Collection ID. You can create a new table using the Database service [server integration](appwrite.io/docs/server/databases#databasesCreateCollection).

  • key (String) —

    Attribute Key.

  • [] —

    required Is attribute required?

  • default (String) —

    Default value for attribute when not provided. Cannot be set when attribute is required.

  • size (Integer) (defaults to: nil) —

    Maximum size of the string attribute.

  • new_key (String) (defaults to: nil) —

    New Attribute Key.

Returns:

  • (AttributeString) 


1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
 
# File 'lib/appwrite/services/databases.rb', line 1907

def update_string_attribute(database_id:, collection_id:, key:, required:, default:, size: nil, new_key: nil)
    api_path = '/databases/{databaseId}/collections/{collectionId}/attributes/string/{key}'
        .gsub('{databaseId}', database_id)
        .gsub('{collectionId}', collection_id)
        .gsub('{key}', key)

    if database_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "databaseId"')
    end

    if collection_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "collectionId"')
    end

    if key.nil?
      raise Appwrite::Exception.new('Missing required parameter: "key"')
    end

    if required.nil?
      raise Appwrite::Exception.new('Missing required parameter: "required"')
    end

    if default.nil?
      raise Appwrite::Exception.new('Missing required parameter: "default"')
    end

    api_params = {
        required: required,
        default: default,
        size: size,
        newKey: new_key,
    }
    
    api_headers = {
        "content-type": 'application/json',
    }

    @client.call(
        method: 'PATCH',
        path: api_path,
        headers: api_headers,
        params: api_params,
        response_type: Models::AttributeString
    )
end

#update_transaction(transaction_id:, commit: nil, rollback: nil) ⇒ Transaction

Update a transaction, to either commit or roll back its operations.

Parameters:

  • transaction_id (String) —

    Transaction ID.

  • [] —

    commit Commit transaction?

  • [] —

    rollback Rollback transaction?

Returns:

  • (Transaction) 


167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
 
# File 'lib/appwrite/services/databases.rb', line 167

def update_transaction(transaction_id:, commit: nil, rollback: nil)
    api_path = '/databases/transactions/{transactionId}'
        .gsub('{transactionId}', transaction_id)

    if transaction_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "transactionId"')
    end

    api_params = {
        commit: commit,
        rollback: rollback,
    }
    
    api_headers = {
        "content-type": 'application/json',
    }

    @client.call(
        method: 'PATCH',
        path: api_path,
        headers: api_headers,
        params: api_params,
        response_type: Models::Transaction
    )
end

#update_url_attribute(database_id:, collection_id:, key:, required:, default:, new_key: nil) ⇒ AttributeUrl

Deprecated.

This API has been deprecated since 1.8.0. Please use ‘TablesDB.updateUrlColumn` instead.

Update an url attribute. Changing the ‘default` value will not update already existing documents.

Parameters:

  • database_id (String) —

    Database ID.

  • collection_id (String) —

    Collection ID.

  • key (String) —

    Attribute Key.

  • [] —

    required Is attribute required?

  • default (String) —

    Default value for attribute when not provided. Cannot be set when attribute is required.

  • new_key (String) (defaults to: nil) —

    New Attribute Key.

Returns:

  • (AttributeUrl) 


2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
 
# File 'lib/appwrite/services/databases.rb', line 2023

def update_url_attribute(database_id:, collection_id:, key:, required:, default:, new_key: nil)
    api_path = '/databases/{databaseId}/collections/{collectionId}/attributes/url/{key}'
        .gsub('{databaseId}', database_id)
        .gsub('{collectionId}', collection_id)
        .gsub('{key}', key)

    if database_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "databaseId"')
    end

    if collection_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "collectionId"')
    end

    if key.nil?
      raise Appwrite::Exception.new('Missing required parameter: "key"')
    end

    if required.nil?
      raise Appwrite::Exception.new('Missing required parameter: "required"')
    end

    if default.nil?
      raise Appwrite::Exception.new('Missing required parameter: "default"')
    end

    api_params = {
        required: required,
        default: default,
        newKey: new_key,
    }
    
    api_headers = {
        "content-type": 'application/json',
    }

    @client.call(
        method: 'PATCH',
        path: api_path,
        headers: api_headers,
        params: api_params,
        response_type: Models::AttributeUrl
    )
end

#upsert_document(database_id:, collection_id:, document_id:, data:, permissions: nil, transaction_id: nil) ⇒ Document

Deprecated.

This API has been deprecated since 1.8.0. Please use ‘TablesDB.upsertRow` instead.

Create or update a Document. Before using this route, you should create a new collection resource using either a [server integration](appwrite.io/docs/server/databases#databasesCreateCollection) API or directly from your database console.

Parameters:

  • database_id (String) —

    Database ID.

  • collection_id (String) —

    Collection ID.

  • document_id (String) —

    Document ID.

  • data (Hash) —

    Document data as JSON object. Include all required attributes of the document to be created or updated.

  • permissions (Array) (defaults to: nil) —

    An array of permissions strings. By default, the current permissions are inherited. [Learn more about permissions](appwrite.io/docs/permissions).

  • transaction_id (String) (defaults to: nil) —

    Transaction ID for staging the operation.

Returns:

  • (Document) 


2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
 
# File 'lib/appwrite/services/databases.rb', line 2556

def upsert_document(database_id:, collection_id:, document_id:, data:, permissions: nil, transaction_id: nil)
    api_path = '/databases/{databaseId}/collections/{collectionId}/documents/{documentId}'
        .gsub('{databaseId}', database_id)
        .gsub('{collectionId}', collection_id)
        .gsub('{documentId}', document_id)

    if database_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "databaseId"')
    end

    if collection_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "collectionId"')
    end

    if document_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "documentId"')
    end

    if data.nil?
      raise Appwrite::Exception.new('Missing required parameter: "data"')
    end

    api_params = {
        data: data,
        permissions: permissions,
        transactionId: transaction_id,
    }
    
    api_headers = {
        "content-type": 'application/json',
    }

    @client.call(
        method: 'PUT',
        path: api_path,
        headers: api_headers,
        params: api_params,
        response_type: Models::Document
    )
end

#upsert_documents(database_id:, collection_id:, documents:, transaction_id: nil) ⇒ DocumentList

Deprecated.

This API has been deprecated since 1.8.0. Please use ‘TablesDB.upsertRows` instead.

Create or update Documents. Before using this route, you should create a new collection resource using either a [server integration](appwrite.io/docs/server/databases#databasesCreateCollection) API or directly from your database console.

Parameters:

  • database_id (String) —

    Database ID.

  • collection_id (String) —

    Collection ID.

  • documents (Array) —

    Array of document data as JSON objects. May contain partial documents.

  • transaction_id (String) (defaults to: nil) —

    Transaction ID for staging the operation.

Returns:

  • (DocumentList) 


2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
 
# File 'lib/appwrite/services/databases.rb', line 2368

def upsert_documents(database_id:, collection_id:, documents:, transaction_id: nil)
    api_path = '/databases/{databaseId}/collections/{collectionId}/documents'
        .gsub('{databaseId}', database_id)
        .gsub('{collectionId}', collection_id)

    if database_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "databaseId"')
    end

    if collection_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "collectionId"')
    end

    if documents.nil?
      raise Appwrite::Exception.new('Missing required parameter: "documents"')
    end

    api_params = {
        documents: documents,
        transactionId: transaction_id,
    }
    
    api_headers = {
        "content-type": 'application/json',
    }

    @client.call(
        method: 'PUT',
        path: api_path,
        headers: api_headers,
        params: api_params,
        response_type: Models::DocumentList
    )
end