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) 


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

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 = {
        "X-Appwrite-Project": @client.get_config('project'),
        "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) 


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
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
 
# File 'lib/appwrite/services/databases.rb', line 663

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 = {
        "X-Appwrite-Project": @client.get_config('project'),
        "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) 


788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
 
# File 'lib/appwrite/services/databases.rb', line 788

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 = {
        "X-Appwrite-Project": @client.get_config('project'),
        "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) 


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
459
460
461
462
463
464
465
466
467
468
469
470
471
 
# File 'lib/appwrite/services/databases.rb', line 432

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 = {
        "X-Appwrite-Project": @client.get_config('project'),
        "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) 


905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
 
# File 'lib/appwrite/services/databases.rb', line 905

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 = {
        "X-Appwrite-Project": @client.get_config('project'),
        "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) 


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
3042
3043
3044
3045
3046
3047
3048
 
# File 'lib/appwrite/services/databases.rb', line 3007

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 = {
        "X-Appwrite-Project": @client.get_config('project'),
        "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) 


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
3093
3094
3095
3096
3097
3098
3099
 
# File 'lib/appwrite/services/databases.rb', line 3064

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 = {
        "X-Appwrite-Project": @client.get_config('project'),
        "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) 


1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
 
# File 'lib/appwrite/services/databases.rb', line 1023

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 = {
        "X-Appwrite-Project": @client.get_config('project'),
        "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) 


1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
 
# File 'lib/appwrite/services/databases.rb', line 1144

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 = {
        "X-Appwrite-Project": @client.get_config('project'),
        "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) 


1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
 
# File 'lib/appwrite/services/databases.rb', line 1277

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 = {
        "X-Appwrite-Project": @client.get_config('project'),
        "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) 


3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
3665
3666
3667
3668
3669
3670
3671
3672
 
# File 'lib/appwrite/services/databases.rb', line 3626

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 = {
        "X-Appwrite-Project": @client.get_config('project'),
        "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) 


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

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 = {
        "X-Appwrite-Project": @client.get_config('project'),
        "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) 


1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
 
# File 'lib/appwrite/services/databases.rb', line 1530

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 = {
        "X-Appwrite-Project": @client.get_config('project'),
        "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) 


1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
 
# File 'lib/appwrite/services/databases.rb', line 1647

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 = {
        "X-Appwrite-Project": @client.get_config('project'),
        "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) 


1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
 
# File 'lib/appwrite/services/databases.rb', line 1758

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 = {
        "X-Appwrite-Project": @client.get_config('project'),
        "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) 


1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
 
# File 'lib/appwrite/services/databases.rb', line 1873

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 = {
        "X-Appwrite-Project": @client.get_config('project'),
        "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) 


241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
 
# File 'lib/appwrite/services/databases.rb', line 241

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 = {
        "X-Appwrite-Project": @client.get_config('project'),
        "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) 


1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
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
 
# File 'lib/appwrite/services/databases.rb', line 1988

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 = {
        "X-Appwrite-Project": @client.get_config('project'),
        "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) 


2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
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
 
# File 'lib/appwrite/services/databases.rb', line 2099

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 = {
        "X-Appwrite-Project": @client.get_config('project'),
        "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) 


2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
 
# File 'lib/appwrite/services/databases.rb', line 2215

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 = {
        "X-Appwrite-Project": @client.get_config('project'),
        "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) 


2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
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
 
# File 'lib/appwrite/services/databases.rb', line 2328

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 = {
        "X-Appwrite-Project": @client.get_config('project'),
        "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) 


2453
2454
2455
2456
2457
2458
2459
2460
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
 
# File 'lib/appwrite/services/databases.rb', line 2453

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 = {
        "X-Appwrite-Project": @client.get_config('project'),
        "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) 


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

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

    api_params = {
        ttl: ttl,
    }
    
    api_headers = {
        "X-Appwrite-Project": @client.get_config('project'),
        "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) 


2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
 
# File 'lib/appwrite/services/databases.rb', line 2570

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 = {
        "X-Appwrite-Project": @client.get_config('project'),
        "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) 


2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
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
 
# File 'lib/appwrite/services/databases.rb', line 2688

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 = {
        "X-Appwrite-Project": @client.get_config('project'),
        "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) 


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
3499
3500
3501
3502
3503
3504
3505
3506
3507
 
# File 'lib/appwrite/services/databases.rb', line 3465

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 = {
        "X-Appwrite-Project": @client.get_config('project'),
        "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:



349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
 
# File 'lib/appwrite/services/databases.rb', line 349

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 = {
        "X-Appwrite-Project": @client.get_config('project'),
        "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:



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
2934
2935
2936
2937
2938
2939
2940
2941
 
# File 'lib/appwrite/services/databases.rb', line 2908

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 = {
        "X-Appwrite-Project": @client.get_config('project'),
        "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:



573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
 
# File 'lib/appwrite/services/databases.rb', line 573

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 = {
        "X-Appwrite-Project": @client.get_config('project'),
        "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:



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
3442
3443
3444
3445
3446
3447
3448
3449
 
# File 'lib/appwrite/services/databases.rb', line 3415

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 = {
        "X-Appwrite-Project": @client.get_config('project'),
        "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) 


3213
3214
3215
3216
3217
3218
3219
3220
3221
3222
3223
3224
3225
3226
3227
3228
3229
3230
3231
3232
3233
3234
3235
3236
3237
3238
3239
3240
3241
3242
3243
3244
 
# File 'lib/appwrite/services/databases.rb', line 3213

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 = {
        "X-Appwrite-Project": @client.get_config('project'),
        "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:



3729
3730
3731
3732
3733
3734
3735
3736
3737
3738
3739
3740
3741
3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
3755
3756
3757
3758
3759
3760
3761
3762
 
# File 'lib/appwrite/services/databases.rb', line 3729

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 = {
        "X-Appwrite-Project": @client.get_config('project'),
        "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:



210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
 
# File 'lib/appwrite/services/databases.rb', line 210

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 = {
        "X-Appwrite-Project": @client.get_config('project'),
        "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) 


277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
 
# File 'lib/appwrite/services/databases.rb', line 277

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 = {
        "X-Appwrite-Project": @client.get_config('project'),
    }

    @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:



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
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
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
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
 
# File 'lib/appwrite/services/databases.rb', line 2808

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 = {
        "X-Appwrite-Project": @client.get_config('project'),
    }

    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) 


483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
 
# File 'lib/appwrite/services/databases.rb', line 483

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 = {
        "X-Appwrite-Project": @client.get_config('project'),
    }

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


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
3287
3288
3289
3290
3291
3292
3293
3294
 
# File 'lib/appwrite/services/databases.rb', line 3259

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 = {
        "X-Appwrite-Project": @client.get_config('project'),
    }

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


3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
3712
3713
3714
3715
3716
3717
 
# File 'lib/appwrite/services/databases.rb', line 3684

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 = {
        "X-Appwrite-Project": @client.get_config('project'),
    }

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


145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
 
# File 'lib/appwrite/services/databases.rb', line 145

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 = {
        "X-Appwrite-Project": @client.get_config('project'),
    }

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


3523
3524
3525
3526
3527
3528
3529
3530
3531
3532
3533
3534
3535
3536
3537
3538
3539
3540
3541
3542
3543
3544
3545
3546
3547
3548
3549
3550
3551
3552
3553
3554
3555
3556
3557
3558
3559
3560
3561
3562
3563
3564
3565
 
# File 'lib/appwrite/services/databases.rb', line 3523

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 = {
        "X-Appwrite-Project": @client.get_config('project'),
        "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
42
 
# 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 = {
        "X-Appwrite-Project": @client.get_config('project'),
    }

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


614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
 
# File 'lib/appwrite/services/databases.rb', line 614

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 = {
        "X-Appwrite-Project": @client.get_config('project'),
    }

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


386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
 
# File 'lib/appwrite/services/databases.rb', line 386

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 = {
        "X-Appwrite-Project": @client.get_config('project'),
    }

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


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

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 = {
        "X-Appwrite-Project": @client.get_config('project'),
    }

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


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
3604
3605
3606
3607
3608
 
# File 'lib/appwrite/services/databases.rb', line 3578

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 = {
        "X-Appwrite-Project": @client.get_config('project'),
    }

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


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

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

    api_params = {
        queries: queries,
    }
    
    api_headers = {
        "X-Appwrite-Project": @client.get_config('project'),
    }

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


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

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 = {
        "X-Appwrite-Project": @client.get_config('project'),
        "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) 


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
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
 
# File 'lib/appwrite/services/databases.rb', line 725

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 = {
        "X-Appwrite-Project": @client.get_config('project'),
        "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) 


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
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
 
# File 'lib/appwrite/services/databases.rb', line 845

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 = {
        "X-Appwrite-Project": @client.get_config('project'),
        "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) 


527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
 
# File 'lib/appwrite/services/databases.rb', line 527

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 = {
        "X-Appwrite-Project": @client.get_config('project'),
        "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) 


962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
 
# File 'lib/appwrite/services/databases.rb', line 962

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 = {
        "X-Appwrite-Project": @client.get_config('project'),
        "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) 


3365
3366
3367
3368
3369
3370
3371
3372
3373
3374
3375
3376
3377
3378
3379
3380
3381
3382
3383
3384
3385
3386
3387
3388
3389
3390
3391
3392
3393
3394
3395
3396
3397
3398
3399
3400
3401
3402
 
# File 'lib/appwrite/services/databases.rb', line 3365

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 = {
        "X-Appwrite-Project": @client.get_config('project'),
        "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) 


3167
3168
3169
3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
3185
3186
3187
3188
3189
3190
3191
3192
3193
3194
3195
3196
3197
3198
3199
 
# File 'lib/appwrite/services/databases.rb', line 3167

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 = {
        "X-Appwrite-Project": @client.get_config('project'),
        "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) 


1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
 
# File 'lib/appwrite/services/databases.rb', line 1081

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 = {
        "X-Appwrite-Project": @client.get_config('project'),
        "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) 


1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
 
# File 'lib/appwrite/services/databases.rb', line 1208

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 = {
        "X-Appwrite-Project": @client.get_config('project'),
        "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) 


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

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 = {
        "X-Appwrite-Project": @client.get_config('project'),
        "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) 


1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
 
# File 'lib/appwrite/services/databases.rb', line 1467

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 = {
        "X-Appwrite-Project": @client.get_config('project'),
        "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) 


1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
 
# File 'lib/appwrite/services/databases.rb', line 1588

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 = {
        "X-Appwrite-Project": @client.get_config('project'),
        "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) 


1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
 
# File 'lib/appwrite/services/databases.rb', line 1703

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 = {
        "X-Appwrite-Project": @client.get_config('project'),
        "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) 


1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
 
# File 'lib/appwrite/services/databases.rb', line 1814

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 = {
        "X-Appwrite-Project": @client.get_config('project'),
        "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) 


1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
 
# File 'lib/appwrite/services/databases.rb', line 1929

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 = {
        "X-Appwrite-Project": @client.get_config('project'),
        "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) 


2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
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
 
# File 'lib/appwrite/services/databases.rb', line 2044

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 = {
        "X-Appwrite-Project": @client.get_config('project'),
        "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) 


2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
 
# File 'lib/appwrite/services/databases.rb', line 2155

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 = {
        "X-Appwrite-Project": @client.get_config('project'),
        "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) 


2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
 
# File 'lib/appwrite/services/databases.rb', line 2274

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 = {
        "X-Appwrite-Project": @client.get_config('project'),
        "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) 


2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
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
 
# File 'lib/appwrite/services/databases.rb', line 2393

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 = {
        "X-Appwrite-Project": @client.get_config('project'),
        "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) 


2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
 
# File 'lib/appwrite/services/databases.rb', line 2509

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 = {
        "X-Appwrite-Project": @client.get_config('project'),
        "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) 


177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
 
# File 'lib/appwrite/services/databases.rb', line 177

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 = {
        "X-Appwrite-Project": @client.get_config('project'),
        "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) 


2628
2629
2630
2631
2632
2633
2634
2635
2636
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
 
# File 'lib/appwrite/services/databases.rb', line 2628

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 = {
        "X-Appwrite-Project": @client.get_config('project'),
        "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) 


2750
2751
2752
2753
2754
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
 
# File 'lib/appwrite/services/databases.rb', line 2750

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 = {
        "X-Appwrite-Project": @client.get_config('project'),
        "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) 


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
3339
3340
3341
3342
3343
3344
3345
3346
3347
3348
3349
 
# File 'lib/appwrite/services/databases.rb', line 3312

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 = {
        "X-Appwrite-Project": @client.get_config('project'),
        "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) 


3116
3117
3118
3119
3120
3121
3122
3123
3124
3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
 
# File 'lib/appwrite/services/databases.rb', line 3116

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 = {
        "X-Appwrite-Project": @client.get_config('project'),
        "content-type": 'application/json',
    }

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

end