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

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) 


47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
 
# File 'lib/appwrite/services/databases.rb', line 47

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

Create a boolean 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 Default value for attribute when not provided. Cannot be set when attribute is required.

  • [] —

    array Is attribute an array?

Returns:

  • (AttributeBoolean) 


433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
 
# File 'lib/appwrite/services/databases.rb', line 433

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

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) 


225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
 
# File 'lib/appwrite/services/databases.rb', line 225

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

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

Parameters:

Returns:

  • (AttributeDatetime) 


540
541
542
543
544
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
572
573
574
575
576
577
578
579
 
# File 'lib/appwrite/services/databases.rb', line 540

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) ⇒ Document

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

Returns:

  • (Document) 


1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
 
# File 'lib/appwrite/services/databases.rb', line 1692

def create_document(database_id:, collection_id:, document_id:, data:, permissions: 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,
    }
    
    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_email_attribute(database_id:, collection_id:, key:, required:, default: nil, array: nil) ⇒ AttributeEmail

Create an email 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 (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) 


648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
 
# File 'lib/appwrite/services/databases.rb', line 648

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

Create an enumeration 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. You can create a new collection using the Database service [server integration](appwrite.io/docs/server/databases#databasesCreateCollection).

  • key (String) —

    Attribute Key.

  • elements (Array) —

    Array of elements in enumerated type. Uses length of longest element to determine size. Maximum of 100 elements are allowed, each 255 characters long.

  • [] —

    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) 


759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
 
# File 'lib/appwrite/services/databases.rb', line 759

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

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

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?

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

    Minimum value to enforce on new documents

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

    Maximum value to enforce on new documents

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

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

  • [] —

    array Is attribute an array?

Returns:

  • (AttributeFloat) 


882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
 
# File 'lib/appwrite/services/databases.rb', line 882

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) ⇒ Index

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.

Returns:

  • (Index) 


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
1952
1953
1954
1955
1956
1957
1958
1959
 
# File 'lib/appwrite/services/databases.rb', line 1916

def create_index(database_id:, collection_id:, key:, type:, attributes:, orders: 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,
    }
    
    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

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

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?

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

    Minimum value to enforce on new documents

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

    Maximum value to enforce on new documents

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

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

  • [] —

    array Is attribute an array?

Returns:

  • (AttributeInteger) 


1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
 
# File 'lib/appwrite/services/databases.rb', line 1008

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

Create IP address 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 (String) (defaults to: nil) —

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

  • [] —

    array Is attribute an array?

Returns:

  • (AttributeIp) 


1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
 
# File 'lib/appwrite/services/databases.rb', line 1131

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_relationship_attribute(database_id:, collection_id:, related_collection_id:, type:, two_way: nil, key: nil, two_way_key: nil, on_delete: nil) ⇒ AttributeRelationship

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. You can create a new collection using the Database service [server integration](appwrite.io/docs/server/databases#databasesCreateCollection).

  • related_collection_id (String) —

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

  • 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) 


1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
 
# File 'lib/appwrite/services/databases.rb', line 1243

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

Create a string 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.

  • 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) 


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
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
 
# File 'lib/appwrite/services/databases.rb', line 1300

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_url_attribute(database_id:, collection_id:, key:, required:, default: nil, array: nil) ⇒ AttributeUrl

Create a URL 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 (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) 


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
1446
1447
1448
1449
1450
1451
1452
1453
1454
 
# File 'lib/appwrite/services/databases.rb', line 1415

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

#delete(database_id:) ⇒ Object

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:



153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
 
# File 'lib/appwrite/services/databases.rb', line 153

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

Deletes an attribute.

Parameters:

Returns:



1561
1562
1563
1564
1565
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
 
# File 'lib/appwrite/services/databases.rb', line 1561

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

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:



355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
 
# File 'lib/appwrite/services/databases.rb', line 355

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:) ⇒ Object

Delete a document by its unique ID.

Parameters:

Returns:



1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
 
# File 'lib/appwrite/services/databases.rb', line 1832

def delete_document(database_id:, collection_id:, document_id:)
    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 = {
    }
    
    api_headers = {
        "content-type": 'application/json',
    }

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

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

Delete an index.

Parameters:

Returns:



2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
 
# File 'lib/appwrite/services/databases.rb', line 2011

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

#get(database_id:) ⇒ Database

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) 


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

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 = {
        "content-type": 'application/json',
    }

    @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

Get attribute by ID.

Parameters:

Returns:



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
 
# File 'lib/appwrite/services/databases.rb', line 1520

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 = {
        "content-type": 'application/json',
    }

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

#get_collection(database_id:, collection_id:) ⇒ Collection

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) 


270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
 
# File 'lib/appwrite/services/databases.rb', line 270

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 = {
        "content-type": 'application/json',
    }

    @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) ⇒ Document

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.

Returns:

  • (Document) 


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
1767
1768
1769
1770
1771
1772
1773
1774
1775
 
# File 'lib/appwrite/services/databases.rb', line 1742

def get_document(database_id:, collection_id:, document_id:, queries: 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,
    }
    
    api_headers = {
        "content-type": 'application/json',
    }

    @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

Get index by ID.

Parameters:

Returns:

  • (Index) 


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
 
# File 'lib/appwrite/services/databases.rb', line 1969

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 = {
        "content-type": 'application/json',
    }

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

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

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.

Returns:

  • (DatabaseList) 


17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
 
# File 'lib/appwrite/services/databases.rb', line 17

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

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

    @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) ⇒ AttributeList

List attributes 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, size, required, array, status, error

Returns:

  • (AttributeList) 


391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
 
# File 'lib/appwrite/services/databases.rb', line 391

def list_attributes(database_id:, collection_id:, queries: 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,
    }
    
    api_headers = {
        "content-type": 'application/json',
    }

    @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) ⇒ CollectionList

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.

Returns:

  • (CollectionList) 


185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
 
# File 'lib/appwrite/services/databases.rb', line 185

def list_collections(database_id:, queries: nil, search: 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,
    }
    
    api_headers = {
        "content-type": 'application/json',
    }

    @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) ⇒ DocumentList

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.

Returns:

  • (DocumentList) 


1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
 
# File 'lib/appwrite/services/databases.rb', line 1649

def list_documents(database_id:, collection_id:, queries: 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,
    }
    
    api_headers = {
        "content-type": 'application/json',
    }

    @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) ⇒ IndexList

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

Returns:

  • (IndexList) 


1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
 
# File 'lib/appwrite/services/databases.rb', line 1873

def list_indexes(database_id:, collection_id:, queries: 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,
    }
    
    api_headers = {
        "content-type": 'application/json',
    }

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

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

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) 


116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
 
# File 'lib/appwrite/services/databases.rb', line 116

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:) ⇒ AttributeBoolean

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#databasesCreateCollection).

  • key (String) —

    Attribute Key.

  • [] —

    required Is attribute required?

  • [] —

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

Returns:

  • (AttributeBoolean) 


485
486
487
488
489
490
491
492
493
494
495
496
497
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
 
# File 'lib/appwrite/services/databases.rb', line 485

def update_boolean_attribute(database_id:, collection_id:, key:, required:, default:)
    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,
    }
    
    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

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) 


310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
 
# File 'lib/appwrite/services/databases.rb', line 310

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:) ⇒ AttributeDatetime

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. 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 (String) —

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

Returns:

  • (AttributeDatetime) 


592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
 
# File 'lib/appwrite/services/databases.rb', line 592

def update_datetime_attribute(database_id:, collection_id:, key:, required:, default:)
    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,
    }
    
    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) ⇒ Document

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

Returns:

  • (Document) 


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
 
# File 'lib/appwrite/services/databases.rb', line 1788

def update_document(database_id:, collection_id:, document_id:, data: nil, permissions: 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,
    }
    
    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_email_attribute(database_id:, collection_id:, key:, required:, default:) ⇒ AttributeEmail

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. 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 (String) —

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

Returns:

  • (AttributeEmail) 


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
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
 
# File 'lib/appwrite/services/databases.rb', line 701

def update_email_attribute(database_id:, collection_id:, key:, required:, default:)
    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,
    }
    
    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:) ⇒ AttributeEnum

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. You can create a new collection using the Database service [server integration](appwrite.io/docs/server/databases#databasesCreateCollection).

  • key (String) —

    Attribute Key.

  • elements (Array) —

    Array of elements in enumerated type. Uses length of longest element to determine size. Maximum of 100 elements are allowed, each 255 characters long.

  • [] —

    required Is attribute required?

  • default (String) —

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

Returns:

  • (AttributeEnum) 


818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
 
# File 'lib/appwrite/services/databases.rb', line 818

def update_enum_attribute(database_id:, collection_id:, key:, elements:, required:, default:)
    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,
    }
    
    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:, min:, max:, default:) ⇒ AttributeFloat

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

  • min (Float) —

    Minimum value to enforce on new documents

  • max (Float) —

    Maximum value to enforce on new documents

  • default (Float) —

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

Returns:

  • (AttributeFloat) 


939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
 
# File 'lib/appwrite/services/databases.rb', line 939

def update_float_attribute(database_id:, collection_id:, key:, required:, min:, max:, default:)
    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 min.nil?
      raise Appwrite::Exception.new('Missing required parameter: "min"')
    end

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

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

    api_params = {
        required: required,
        min: min,
        max: max,
        default: default,
    }
    
    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:, min:, max:, default:) ⇒ AttributeInteger

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

  • min (Integer) —

    Minimum value to enforce on new documents

  • max (Integer) —

    Maximum value to enforce on new documents

  • default (Integer) —

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

Returns:

  • (AttributeInteger) 


1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
 
# File 'lib/appwrite/services/databases.rb', line 1065

def update_integer_attribute(database_id:, collection_id:, key:, required:, min:, max:, default:)
    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 min.nil?
      raise Appwrite::Exception.new('Missing required parameter: "min"')
    end

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

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

    api_params = {
        required: required,
        min: min,
        max: max,
        default: default,
    }
    
    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:) ⇒ AttributeIp

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. 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 (String) —

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

Returns:

  • (AttributeIp) 


1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
 
# File 'lib/appwrite/services/databases.rb', line 1184

def update_ip_attribute(database_id:, collection_id:, key:, required:, default:)
    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,
    }
    
    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_relationship_attribute(database_id:, collection_id:, key:, on_delete: nil) ⇒ AttributeRelationship

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. You can create a new collection using the Database service [server integration](appwrite.io/docs/server/databases#databasesCreateCollection).

  • key (String) —

    Attribute Key.

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

    Constraints option

Returns:

  • (AttributeRelationship) 


1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
 
# File 'lib/appwrite/services/databases.rb', line 1605

def update_relationship_attribute(database_id:, collection_id:, key:, on_delete: 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,
    }
    
    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:) ⇒ AttributeString

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

Returns:

  • (AttributeString) 


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
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
 
# File 'lib/appwrite/services/databases.rb', line 1359

def update_string_attribute(database_id:, collection_id:, key:, required:, default:)
    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,
    }
    
    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_url_attribute(database_id:, collection_id:, key:, required:, default:) ⇒ AttributeUrl

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. 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 (String) —

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

Returns:

  • (AttributeUrl) 


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
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
 
# File 'lib/appwrite/services/databases.rb', line 1468

def update_url_attribute(database_id:, collection_id:, key:, required:, default:)
    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,
    }
    
    api_headers = {
        "content-type": 'application/json',
    }

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