Documents_
Master document management with Appwrite Databases. Learn how to create, update, and query documents within your collections for dynamic data storage.
2 min read
Each piece of data or information in Appwrite Databases is a document. Documents have a structure defined by the parent collection.
Create documents
You must grant create permissions to users at the collection level before users can create documents. Learn more about permissions
In most use cases, you will create documents programmatically.
During testing, you might prefer to create documents in the Appwrite Console. To do so, navigate to the Documents tab of your collection and click the Add document button.
List documents
You must grant read permissions to users at the collection level before users can read documents. Learn more about permissions
Documents can be retrieved using the List Document endpoint.
Results can be filtered, sorted, and paginated using Appwrite's shared set of query methods. You can find a full guide on querying in the Queries Guide.
By default, results are limited to the first 25 items. You can change this through pagination.
Upsert documents
You must grant create and update permissions to users at the collection level before users can upsert documents. You can also grant update permissions at the document level instead. Learn more about permissions
In most use cases, you will upsert documents programmatically.
Permissions
In Appwrite, permissions can be granted at the collection level and the document level. Before a user can create a document, you need to grant create permissions to the user.
Read, update, and delete permissions can be granted at both the collection and document level. Users only need to be granted access at either the collection or document level to access documents.
Learn about configuring permissions.
Next steps
Continue learning with these related guides:
Queries
Learn how to filter, sort, and search your documents with various query operators.
Pagination
Handle large datasets by implementing pagination in your document queries.
Bulk operations
Perform create, update, and delete operations on multiple documents simultaneously.
Timestamp overrides
Set custom creation and update timestamps when migrating data or backdating records.
Was this page helpful?
Share what worked or what we should fix. Once approved, our agents automatically apply suggested updates to the docs.