Method: Appwrite::Databases#create_document

Defined in:

lib/appwrite/services/databases.rb

#create_document(database_id:, collection_id:, document_id:, data:, permissions: nil) ⇒ Document

Create a new Document. Before using this route, you should create a new collection resource using either a [server integration](appwrite.io/docs/server/databases#databasesCreateCollection) API or directly from your database console.

Parameters:

• database_id (String) —

  Database ID.

• collection_id (String) —

  Collection ID. You can create a new collection using the Database service [server integration](appwrite.io/docs/server/databases#databasesCreateCollection). Make sure to define attributes before creating documents.

• document_id (String) —

  Document ID. Choose a custom ID or generate a random ID with ‘ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can’t start with a special char. Max length is 36 chars.

• data (Hash) —

  Document data as JSON object.

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

  An array of permissions strings. By default, only the current user is granted all permissions. [Learn more about permissions](appwrite.io/docs/permissions).

Returns:

• (Document)

# File 'lib/appwrite/services/databases.rb', line 1688

def create_document(database_id:, collection_id:, document_id:, data:, permissions: nil)
    api_path = '/databases/{databaseId}/collections/{collectionId}/documents'
        .gsub('{databaseId}', database_id)
        .gsub('{collectionId}', collection_id)

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

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

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

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

    api_params = {
        documentId: document_id,
        data: data,
        permissions: permissions,
    }
    
    api_headers = {
        "content-type": 'application/json',
    }

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