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) 


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

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_big_int_attribute(database_id:, collection_id:, key:, required:, min: nil, max: nil, default: nil, array: nil) ⇒ AttributeBigint

Deprecated.

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

Create a bigint 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:

  • (AttributeBigint) 


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

def create_big_int_attribute(database_id:, collection_id:, key:, required:, min: nil, max: nil, default: nil, array: nil)
    api_path = '/databases/{databaseId}/collections/{collectionId}/attributes/bigint'
        .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::AttributeBigint
    )

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


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
804
805
806
807
808
809
 
# File 'lib/appwrite/services/databases.rb', line 769

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, attributes: nil, indexes: 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.

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

    Array of attribute definitions to create. Each attribute should contain: key (string), type (string: string, integer, float, boolean, datetime), size (integer, required for string type), required (boolean, optional), default (mixed, optional), array (boolean, optional), and type-specific options.

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

    Array of index definitions to create. Each index should contain: key (string), type (string: key, fulltext, unique, spatial), attributes (array of attribute keys), orders (array of ASC/DESC, optional), and lengths (array of integers, optional).

Returns:

  • (Collection) 


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
446
447
448
449
450
451
452
453
454
455
456
457
458
 
# File 'lib/appwrite/services/databases.rb', line 420

def create_collection(database_id:, collection_id:, name:, permissions: nil, document_security: nil, enabled: nil, attributes: nil, indexes: 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,
        attributes: attributes,
        indexes: indexes,
    }
    
    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) 


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

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) 


2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
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
 
# File 'lib/appwrite/services/databases.rb', line 2951

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) 


3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
 
# File 'lib/appwrite/services/databases.rb', line 3007

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) 


1000
1001
1002
1003
1004
1005
1006
1007
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
 
# File 'lib/appwrite/services/databases.rb', line 1000

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) 


1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
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
 
# File 'lib/appwrite/services/databases.rb', line 1119

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) 


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
1285
1286
1287
1288
1289
1290
1291
1292
 
# File 'lib/appwrite/services/databases.rb', line 1250

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 (DatabasesIndexType) —

    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) 


3558
3559
3560
3561
3562
3563
3564
3565
3566
3567
3568
3569
3570
3571
3572
3573
3574
3575
3576
3577
3578
3579
3580
3581
3582
3583
3584
3585
3586
3587
3588
3589
3590
3591
3592
3593
3594
3595
3596
3597
3598
3599
3600
3601
3602
3603
 
# File 'lib/appwrite/services/databases.rb', line 3558

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) 


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
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
 
# File 'lib/appwrite/services/databases.rb', line 1376

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) 


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

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) 


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
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
 
# File 'lib/appwrite/services/databases.rb', line 1614

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

Create a longtext 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?

  • [] —

    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:

  • (AttributeLongtext) 


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

def create_longtext_attribute(database_id:, collection_id:, key:, required:, default: nil, array: nil, encrypt: nil)
    api_path = '/databases/{databaseId}/collections/{collectionId}/attributes/longtext'
        .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,
        encrypt: encrypt,
    }
    
    api_headers = {
        "content-type": 'application/json',
    }

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

end

#create_mediumtext_attribute(database_id:, collection_id:, key:, required:, default: nil, array: nil, encrypt: nil) ⇒ AttributeMediumtext

Create a mediumtext 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?

  • [] —

    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:

  • (AttributeMediumtext) 


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
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
 
# File 'lib/appwrite/services/databases.rb', line 1836

def create_mediumtext_attribute(database_id:, collection_id:, key:, required:, default: nil, array: nil, encrypt: nil)
    api_path = '/databases/{databaseId}/collections/{collectionId}/attributes/mediumtext'
        .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,
        encrypt: encrypt,
    }
    
    api_headers = {
        "content-type": 'application/json',
    }

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

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) 


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

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) 


1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
 
# File 'lib/appwrite/services/databases.rb', line 1949

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) 


2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
 
# File 'lib/appwrite/services/databases.rb', line 2058

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) 


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
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
 
# File 'lib/appwrite/services/databases.rb', line 2172

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) 


2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
 
# File 'lib/appwrite/services/databases.rb', line 2283

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

Create a text 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?

  • [] —

    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:

  • (AttributeText) 


2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
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 2406

def create_text_attribute(database_id:, collection_id:, key:, required:, default: nil, array: nil, encrypt: nil)
    api_path = '/databases/{databaseId}/collections/{collectionId}/attributes/text'
        .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,
        encrypt: encrypt,
    }
    
    api_headers = {
        "content-type": 'application/json',
    }

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

end

#create_transaction(ttl: nil) ⇒ Transaction

Create a new transaction.

Parameters:

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

    Seconds before the transaction expires.

Returns:

  • (Transaction) 


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

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) 


2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
 
# File 'lib/appwrite/services/databases.rb', line 2521

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

#create_varchar_attribute(database_id:, collection_id:, key:, size:, required:, default: nil, array: nil, encrypt: nil) ⇒ AttributeVarchar

Create a varchar 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 varchar attributes, in number of characters. Maximum size is 16381.

  • [] —

    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:

  • (AttributeVarchar) 


2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
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
 
# File 'lib/appwrite/services/databases.rb', line 2637

def create_varchar_attribute(database_id:, collection_id:, key:, size:, required:, default: nil, array: nil, encrypt: nil)
    api_path = '/databases/{databaseId}/collections/{collectionId}/attributes/varchar'
        .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::AttributeVarchar
    )

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) 


3400
3401
3402
3403
3404
3405
3406
3407
3408
3409
3410
3411
3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
3436
3437
3438
3439
3440
3441
 
# File 'lib/appwrite/services/databases.rb', line 3400

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:



339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
 
# File 'lib/appwrite/services/databases.rb', line 339

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:



2854
2855
2856
2857
2858
2859
2860
2861
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
 
# File 'lib/appwrite/services/databases.rb', line 2854

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:



558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
 
# File 'lib/appwrite/services/databases.rb', line 558

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:



3351
3352
3353
3354
3355
3356
3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
3367
3368
3369
3370
3371
3372
3373
3374
3375
3376
3377
3378
3379
3380
3381
3382
3383
3384
 
# File 'lib/appwrite/services/databases.rb', line 3351

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) 


3153
3154
3155
3156
3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
 
# File 'lib/appwrite/services/databases.rb', line 3153

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:



3659
3660
3661
3662
3663
3664
3665
3666
3667
3668
3669
3670
3671
3672
3673
3674
3675
3676
3677
3678
3679
3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
 
# File 'lib/appwrite/services/databases.rb', line 3659

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:



204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
 
# File 'lib/appwrite/services/databases.rb', line 204

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) 


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

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

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:

  • (AttributeBoolean, AttributeInteger, AttributeFloat, AttributeEmail, AttributeEnum, AttributeUrl, AttributeIp, AttributeDatetime, AttributeRelationship, AttributeString)

Raises:



2755
2756
2757
2758
2759
2760
2761
2762
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
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
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
 
# File 'lib/appwrite/services/databases.rb', line 2755

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 = {
    }

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

    unless response.is_a?(Hash)
        raise Exception, "Expected object response when hydrating a response model"
    end

    if response['type'] == 'string' && response['format'] == 'email'

        return Models::AttributeEmail.from(map: response)
    end

    if response['type'] == 'string' && response['format'] == 'enum'

        return Models::AttributeEnum.from(map: response)
    end

    if response['type'] == 'string' && response['format'] == 'url'

        return Models::AttributeUrl.from(map: response)
    end

    if response['type'] == 'string' && response['format'] == 'ip'

        return Models::AttributeIp.from(map: response)
    end

    if response['type'] == 'boolean'

        return Models::AttributeBoolean.from(map: response)
    end

    if response['type'] == 'integer'

        return Models::AttributeInteger.from(map: response)
    end

    if response['type'] == 'double'

        return Models::AttributeFloat.from(map: response)
    end

    if response['type'] == 'datetime'

        return Models::AttributeDatetime.from(map: response)
    end

    if response['type'] == 'relationship'

        return Models::AttributeRelationship.from(map: response)
    end

    if response['type'] == 'string'

        return Models::AttributeString.from(map: response)
    end

    raise Exception, "Unable to match response to any expected response model"

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) 


470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
 
# File 'lib/appwrite/services/databases.rb', line 470

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) 


3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
3222
3223
3224
3225
3226
3227
3228
3229
3230
3231
3232
 
# File 'lib/appwrite/services/databases.rb', line 3198

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) 


3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
 
# File 'lib/appwrite/services/databases.rb', line 3615

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) 


141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
 
# File 'lib/appwrite/services/databases.rb', line 141

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) 


3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
3494
3495
3496
3497
3498
 
# File 'lib/appwrite/services/databases.rb', line 3457

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
41
 
# 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) 


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

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) 


375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
 
# File 'lib/appwrite/services/databases.rb', line 375

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, ttl: 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.

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

    TTL (seconds) for caching list responses. Responses are stored in an in-memory key-value cache, keyed per project, collection, schema version (attributes and indexes), caller authorization roles, and the exact query — so users with different permissions never share cached entries. Schema changes invalidate cached entries automatically; document writes do not, so choose a TTL you are comfortable serving as stale data. Set to 0 to disable caching. Must be between 0 and 86400 (24 hours).

Returns:

  • (DocumentList) 


2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
 
# File 'lib/appwrite/services/databases.rb', line 2902

def list_documents(database_id:, collection_id:, queries: nil, transaction_id: nil, total: nil, ttl: 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,
        ttl: ttl,
    }
    
    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) 


3511
3512
3513
3514
3515
3516
3517
3518
3519
3520
3521
3522
3523
3524
3525
3526
3527
3528
3529
3530
3531
3532
3533
3534
3535
3536
3537
3538
3539
3540
 
# File 'lib/appwrite/services/databases.rb', line 3511

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) 


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

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: nil, 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) (defaults to: nil) —

    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) 


303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
 
# File 'lib/appwrite/services/databases.rb', line 303

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

    if database_id.nil?
      raise Appwrite::Exception.new('Missing required parameter: "databaseId"')
    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_big_int_attribute(database_id:, collection_id:, key:, required:, default:, min: nil, max: nil, new_key: nil) ⇒ AttributeBigint

Deprecated.

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

Update a bigint 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:

  • (AttributeBigint) 


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
744
745
746
747
748
749
750
751
752
753
 
# File 'lib/appwrite/services/databases.rb', line 707

def update_big_int_attribute(database_id:, collection_id:, key:, required:, default:, min: nil, max: nil, new_key: nil)
    api_path = '/databases/{databaseId}/collections/{collectionId}/attributes/bigint/{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::AttributeBigint
    )

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) 


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
866
867
868
869
 
# File 'lib/appwrite/services/databases.rb', line 825

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: nil, permissions: nil, document_security: nil, enabled: nil, purge: 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) (defaults to: nil) —

    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.

  • [] —

    purge When true, purge all cached list responses for this collection as part of the update. Use this to force readers to see fresh data immediately instead of waiting for the cache TTL to expire.

Returns:

  • (Collection) 


513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
 
# File 'lib/appwrite/services/databases.rb', line 513

def update_collection(database_id:, collection_id:, name: nil, permissions: nil, document_security: nil, enabled: nil, purge: 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

    api_params = {
        name: name,
        permissions: permissions,
        documentSecurity: document_security,
        enabled: enabled,
        purge: purge,
    }
    
    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) 


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

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) 


3302
3303
3304
3305
3306
3307
3308
3309
3310
3311
3312
3313
3314
3315
3316
3317
3318
3319
3320
3321
3322
3323
3324
3325
3326
3327
3328
3329
3330
3331
3332
3333
3334
3335
3336
3337
3338
 
# File 'lib/appwrite/services/databases.rb', line 3302

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) 


3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
3123
3124
3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
 
# File 'lib/appwrite/services/databases.rb', line 3108

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) 


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
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
 
# File 'lib/appwrite/services/databases.rb', line 1057

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) 


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
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
 
# File 'lib/appwrite/services/databases.rb', line 1182

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) 


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
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
 
# File 'lib/appwrite/services/databases.rb', line 1311

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) 


1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
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
 
# File 'lib/appwrite/services/databases.rb', line 1437

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) 


1556
1557
1558
1559
1560
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
1593
1594
1595
1596
1597
1598
1599
1600
 
# File 'lib/appwrite/services/databases.rb', line 1556

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) 


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

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_longtext_attribute(database_id:, collection_id:, key:, required:, default:, new_key: nil) ⇒ AttributeLongtext

Update a longtext 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.

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

    New Attribute Key.

Returns:

  • (AttributeLongtext) 


1778
1779
1780
1781
1782
1783
1784
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
 
# File 'lib/appwrite/services/databases.rb', line 1778

def update_longtext_attribute(database_id:, collection_id:, key:, required:, default:, new_key: nil)
    api_path = '/databases/{databaseId}/collections/{collectionId}/attributes/longtext/{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::AttributeLongtext
    )

end

#update_mediumtext_attribute(database_id:, collection_id:, key:, required:, default:, new_key: nil) ⇒ AttributeMediumtext

Update a mediumtext 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.

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

    New Attribute Key.

Returns:

  • (AttributeMediumtext) 


1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
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
 
# File 'lib/appwrite/services/databases.rb', line 1891

def update_mediumtext_attribute(database_id:, collection_id:, key:, required:, default:, new_key: nil)
    api_path = '/databases/{databaseId}/collections/{collectionId}/attributes/mediumtext/{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::AttributeMediumtext
    )

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) 


2004
2005
2006
2007
2008
2009
2010
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
2043
2044
 
# File 'lib/appwrite/services/databases.rb', line 2004

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) 


2113
2114
2115
2116
2117
2118
2119
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
2152
2153
 
# File 'lib/appwrite/services/databases.rb', line 2113

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) 


2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
 
# File 'lib/appwrite/services/databases.rb', line 2230

def update_relationship_attribute(database_id:, collection_id:, key:, on_delete: nil, new_key: nil)
    api_path = '/databases/{databaseId}/collections/{collectionId}/attributes/relationship/{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 = {
        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) 


2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
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
 
# File 'lib/appwrite/services/databases.rb', line 2347

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_text_attribute(database_id:, collection_id:, key:, required:, default:, new_key: nil) ⇒ AttributeText

Update a text 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.

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

    New Attribute Key.

Returns:

  • (AttributeText) 


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
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
 
# File 'lib/appwrite/services/databases.rb', line 2461

def update_text_attribute(database_id:, collection_id:, key:, required:, default:, new_key: nil)
    api_path = '/databases/{databaseId}/collections/{collectionId}/attributes/text/{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::AttributeText
    )

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) 


172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
 
# File 'lib/appwrite/services/databases.rb', line 172

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) 


2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
 
# File 'lib/appwrite/services/databases.rb', line 2578

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

#update_varchar_attribute(database_id:, collection_id:, key:, required:, default:, size: nil, new_key: nil) ⇒ AttributeVarchar

Update a varchar 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.

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

    Maximum size of the varchar attribute.

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

    New Attribute Key.

Returns:

  • (AttributeVarchar) 


2698
2699
2700
2701
2702
2703
2704
2705
2706
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
 
# File 'lib/appwrite/services/databases.rb', line 2698

def update_varchar_attribute(database_id:, collection_id:, key:, required:, default:, size: nil, new_key: nil)
    api_path = '/databases/{databaseId}/collections/{collectionId}/attributes/varchar/{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::AttributeVarchar
    )

end

#upsert_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.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) (defaults to: nil) —

    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) 


3250
3251
3252
3253
3254
3255
3256
3257
3258
3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
3283
3284
3285
3286
 
# File 'lib/appwrite/services/databases.rb', line 3250

def upsert_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: '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) 


3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
 
# File 'lib/appwrite/services/databases.rb', line 3058

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