Method: Appwrite::Databases#update_integer_attribute

Defined in:
lib/appwrite/services/databases.rb

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

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

Parameters:

  • database_id (String) —

    Database ID.

  • collection_id (String) —

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

  • key (String) —

    Attribute Key.

  • [] —

    required Is attribute required?

  • min (Integer) —

    Minimum value to enforce on new documents

  • max (Integer) —

    Maximum value to enforce on new documents

  • default (Integer) —

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

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

    New attribute key.

Returns:

  • (AttributeInteger) 


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

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

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

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

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

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