Databases

The Databases service allows you to create structured collections of documents, query and filter lists of documents, and manage an advanced set of read and write access permissions.

All data returned by the Databases service are represented as structured JSON documents.

The Databases service can contain multiple databases, each database can contain multiple collections. A collection is a group of similarly structured documents. The accepted structure of documents is defined by collection attributes. The collection attributes help you ensure all your user-submitted data is validated and stored according to the collection structure.

Using Appwrite permissions architecture, you can assign read or write access to each collection or document in your project for either a specific user, team, user role, or even grant it with public access (any). You can learn more about how Appwrite handles permissions and access control.

• Request

  • databaseId string

    required

    Database ID.

  • collectionId string

    required

    Collection ID. You can create a new collection using the Database service server integration.

  • queries array

    Array of query strings generated using the Query class provided by the SDK. Learn more about queries. Maximum of 100 queries are allowed, each 4096 characters long.

• Response

  • 200 application/json

    • Documents List

• Request

  • databaseId string

    required

    Database ID.

  • collectionId string

    required

    Collection ID. You can create a new collection using the Database service server integration. Make sure to define attributes before creating documents.

  • documentId string

    required

    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 object

    required

    Document data as JSON object.

  • permissions array

    An array of permissions strings. By default, only the current user is granted all permissions. Learn more about permissions.

• Response

  • 201 application/json

    • Document
• Rate limits

  This endpoint is rate limited. You can only make a limited number of request to his endpoint within a specific time frame.

  The limit is applied for each unique limit key.

  Time frame	Attempts	Key
  1 minutes	120 requests	IP + METHOD + URL + USER ID

  Learn more about rate limits

• Request

  • databaseId string

    required

    Database ID.

  • collectionId string

    required

    Collection ID. You can create a new collection using the Database service server integration.

  • documentId string

    required

    Document ID.

  • queries array

    Array of query strings generated using the Query class provided by the SDK. Learn more about queries. Only method allowed is select.

• Response

  • 200 application/json

    • Document

• Request

  • databaseId string

    required

    Database ID.

  • collectionId string

    required

    Collection ID.

  • documentId string

    required

    Document ID.

  • data object

    Document data as JSON object. Include only attribute and value pairs to be updated.

  • permissions array

    An array of permissions strings. By default, the current permissions are inherited. Learn more about permissions.

• Response

  • 200 application/json

    • Document
• Rate limits

  This endpoint is rate limited. You can only make a limited number of request to his endpoint within a specific time frame.

  The limit is applied for each unique limit key.

  Time frame	Attempts	Key
  1 minutes	120 requests	IP + METHOD + URL + USER ID

  Learn more about rate limits

• Request

  • databaseId string

    required

    Database ID.

  • collectionId string

    required

    Collection ID. You can create a new collection using the Database service server integration.

  • documentId string

    required

    Document ID.

• Response

  • 204 application/json
• Rate limits

  This endpoint is rate limited. You can only make a limited number of request to his endpoint within a specific time frame.

  The limit is applied for each unique limit key.

  Time frame	Attempts	Key
  1 minutes	60 requests	IP + METHOD + URL + USER ID

  Learn more about rate limits