Method: Appwrite::TablesDB#create_datetime_column

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

#create_datetime_column(database_id:, table_id:, key:, required:, default: nil, array: nil) ⇒ ColumnDatetime

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

Parameters:

  • database_id (String)

    Database ID.

  • table_id (String)

    Table ID.

  • key (String)

    Column Key.

  • []

    required Is column required?

  • default (String) (defaults to: nil)

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

  • []

    array Is column an array?

Returns:

  • (ColumnDatetime)


695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
# File 'lib/appwrite/services/tables_db.rb', line 695

def create_datetime_column(database_id:, table_id:, key:, required:, default: nil, array: nil)
    api_path = '/tablesdb/{databaseId}/tables/{tableId}/columns/datetime'
        .gsub('{databaseId}', database_id)
        .gsub('{tableId}', table_id)

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

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

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

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

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

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