Databases

CLIENT

Platform

Version

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.

Base URL

https://<REGION>.cloud.appwrite.io/v1

Create document

Create a new Document. Before using this route, you should create a new collection resource using either a server integration API or directly from your database console.

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

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

Endpoint

POST /databases/{databaseId}/collections/{collectionId}/documents

Web

import { Client, Databases } from "appwrite";

const client = new Client()
    .setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
    .setProject('<YOUR_PROJECT_ID>'); // Your project ID

const databases = new Databases(client);

const result = await databases.createDocument(
    '<DATABASE_ID>', // databaseId
    '<COLLECTION_ID>', // collectionId
    '<DOCUMENT_ID>', // documentId
    {}, // data
    ["read("any")"] // permissions (optional)
);

console.log(result);

Get document

Get a document by its unique ID. This endpoint response returns a JSON object with the document data.

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. Maximum of 100 queries are allowed, each 4096 characters long.
Response
- 200 application/json
  
  Document

Endpoint

GET /databases/{databaseId}/collections/{collectionId}/documents/{documentId}

Web

import { Client, Databases } from "appwrite";

const client = new Client()
    .setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
    .setProject('<YOUR_PROJECT_ID>'); // Your project ID

const databases = new Databases(client);

const result = await databases.getDocument(
    '<DATABASE_ID>', // databaseId
    '<COLLECTION_ID>', // collectionId
    '<DOCUMENT_ID>', // documentId
    [] // queries (optional)
);

console.log(result);

List documents

Get a list of all the user's documents in a given collection. You can use the query params to filter your results.

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

Endpoint

GET /databases/{databaseId}/collections/{collectionId}/documents

Web

import { Client, Databases } from "appwrite";

const client = new Client()
    .setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
    .setProject('<YOUR_PROJECT_ID>'); // Your project ID

const databases = new Databases(client);

const result = await databases.listDocuments(
    '<DATABASE_ID>', // databaseId
    '<COLLECTION_ID>', // collectionId
    [] // queries (optional)
);

console.log(result);

Update document

Update a document by its unique ID. Using the patch method you can pass only specific fields that will get updated.

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

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

Endpoint

PATCH /databases/{databaseId}/collections/{collectionId}/documents/{documentId}

Web

import { Client, Databases } from "appwrite";

const client = new Client()
    .setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
    .setProject('<YOUR_PROJECT_ID>'); // Your project ID

const databases = new Databases(client);

const result = await databases.updateDocument(
    '<DATABASE_ID>', // databaseId
    '<COLLECTION_ID>', // collectionId
    '<DOCUMENT_ID>', // documentId
    {}, // data (optional)
    ["read("any")"] // permissions (optional)
);

console.log(result);

Delete document

Delete a document by its unique ID.

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

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

Endpoint

DELETE /databases/{databaseId}/collections/{collectionId}/documents/{documentId}

Web

import { Client, Databases } from "appwrite";

const client = new Client()
    .setEndpoint('https://<REGION>.cloud.appwrite.io/v1') // Your API Endpoint
    .setProject('<YOUR_PROJECT_ID>'); // Your project ID

const databases = new Databases(client);

const result = await databases.deleteDocument(
    '<DATABASE_ID>', // databaseId
    '<COLLECTION_ID>', // collectionId
    '<DOCUMENT_ID>' // documentId
);

console.log(result);

Recommended