mirror of
https://github.com/ToolJet/ToolJet
synced 2026-04-22 22:17:55 +00:00
9423e890c8
* create new version * revert changes in versions.json * add system requirements in version 2.39
198 lines
No EOL
7.3 KiB
Markdown
198 lines
No EOL
7.3 KiB
Markdown
---
|
|
id: appwrite
|
|
title: Appwrite
|
|
---
|
|
|
|
<div style={{paddingBottom:'24px'}}>
|
|
|
|
ToolJet can connect to appwrite database to read/write data.
|
|
|
|
</div>
|
|
|
|
<div style={{paddingTop:'24px', paddingBottom:'24px'}}>
|
|
|
|
## Connection
|
|
|
|
ToolJet connects to your Appwrite app using :
|
|
- **Host (API endpoint)**
|
|
- **Project ID**
|
|
- **Secret Key**
|
|
|
|
You'll find the Secret Key and other credentials on your Appwrite's project settings page. You may need to create a new key if you don't have one already.
|
|
|
|
:::info
|
|
You should also set the scope for access to a particular resource. Learn more about the **API keys and scopes** [here](https://appwrite.io/docs/keys).
|
|
:::
|
|
|
|
To establish a connection with the Appwrite data source, you can either click on the **+Add new Data source** button located on the query panel or navigate to the **[Data Sources](https://docs.tooljet.com/docs/data-sources/overview)** page from the ToolJet dashboard.
|
|
|
|
<div style={{textAlign: 'center'}}>
|
|
|
|
<img style={{ border:'0', marginBottom:'15px' }} className="screenshot-full" src="/img/datasource-reference/appwrite/connect-v3.png" alt="Appwrite intro"/>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
|
|
<div style={{paddingTop:'24px', paddingBottom:'24px'}}>
|
|
|
|
## Querying Appwrite
|
|
|
|
- After setting up the Appwrite data source, navigate to the query panel and select the Appwrite data source that you added in the previous step.
|
|
|
|
- After selecting Appwrite data source, select the operations that you want to perform on the Appwrite database and click **Save** to save the query.
|
|
|
|
<div style={{textAlign: 'center'}}>
|
|
|
|
<img style={{ border:'0', marginBottom:'15px' }} className="screenshot-full" src="/img/datasource-reference/appwrite/querying-v3.png" alt="Appwrite intro"/>
|
|
|
|
</div>
|
|
|
|
:::tip
|
|
Query results can be transformed using Transformations. Read our **Transformation documentation** [here](/docs/tutorial/transformations)
|
|
:::
|
|
|
|
</div>
|
|
|
|
<div style={{paddingTop:'24px', paddingBottom:'24px'}}>
|
|
|
|
## Supported operations
|
|
|
|
- **[List Documents](#list-documents)**
|
|
- **[Get Document](#get-document)**
|
|
- **[Add Document to Collection](#add-document-to-collection)**
|
|
- **[Update Document](#update-document)**
|
|
- **[Bulk update using document id](#bulk-update-using-document-id)**
|
|
- **[Delete Document](#delete-document)**
|
|
|
|
</div>
|
|
|
|
<div style={{paddingTop:'24px', paddingBottom:'24px'}}>
|
|
|
|
### List Documents
|
|
|
|
This operation is used to get a list of all the user documents.
|
|
|
|
#### Required parameters:
|
|
|
|
- **Collection ID:** You can create a new collection using the Database service **[server integration](https://appwrite.io/docs/server/database#createCollection)** or appwrite console. The value for collection ID field should be of `String` type.
|
|
|
|
#### Optional parameters:
|
|
|
|
- **Limit:** Maximum number of documents to return in the response. By default, it will return a maximum of 25 results. A maximum of 100 results is allowed per request. The Limit value should be of `integer` type.
|
|
- **Order fields:** Array of attributes used to sort results. The order field value should be an `array`.
|
|
- **Order types:** Array of order directions for sorting attributes. Possible values are DESC for descending order or ASC for ascending order. The order field value should be an `array`.
|
|
- **Field, Operator, and Value:** For filtering the results, you can enter a field(attribute) name, use the appropriate operator from the dropdown, and set a value.
|
|
|
|
<div style={{textAlign: 'center'}}>
|
|
|
|
<img style={{ border:'0', marginBottom:'15px' }} className="screenshot-full" src="/img/datasource-reference/appwrite/list-v3.png" alt="Appwrite List" />
|
|
|
|
</div>
|
|
|
|
</div>
|
|
|
|
<div style={{paddingTop:'24px', paddingBottom:'24px'}}>
|
|
|
|
### Get Document
|
|
|
|
Use this operation to get a document from a collection by its unique ID.
|
|
|
|
#### Required parameters:
|
|
|
|
- **Collection ID:** You can create a new collection using the Database service **[server integration](https://appwrite.io/docs/server/database#createCollection)** or appwrite console. The value for collection ID should be of `String` type.
|
|
|
|
- **Document ID:** Enter the document ID of the document that you want to get. The document ID should be of `String` type.
|
|
|
|
<div style={{textAlign: 'center'}}>
|
|
|
|
<img style={{ border:'0', marginBottom:'15px' }} className="screenshot-full" src="/img/datasource-reference/appwrite/get-v3.png" alt="Appwrite get" />
|
|
|
|
</div>
|
|
|
|
</div>
|
|
|
|
<div style={{paddingTop:'24px', paddingBottom:'24px'}}>
|
|
|
|
### Add Document to Collection
|
|
|
|
Use this operation to create a new document in a collection.
|
|
|
|
#### Required parameters:
|
|
|
|
- **Collection ID:** You can create a new collection using the Database service **[server integration](https://appwrite.io/docs/server/database#createCollection)** or appwrite console. The collection ID should be of `String` type.
|
|
|
|
- **Body:** Enter the document data as a JSON object.
|
|
|
|
<div style={{textAlign: 'center'}}>
|
|
|
|
<img style={{ border:'0', marginBottom:'15px' }} className="screenshot-full" src="/img/datasource-reference/appwrite/add-v3.png" alt="Appwrite add" />
|
|
|
|
</div>
|
|
|
|
</div>
|
|
|
|
<div style={{paddingTop:'24px', paddingBottom:'24px'}}>
|
|
|
|
### Update Document
|
|
|
|
Use this operation to update a document.
|
|
|
|
#### Required parameters:
|
|
|
|
- **Collection ID:** You can create a new collection using the Database service **[server integration](https://appwrite.io/docs/server/database#createCollection)** or appwrite console. The value for collection ID should be of `String` type.
|
|
|
|
- **Document ID:** Enter the document ID of the document that you want to get. The document ID should be of `String` type.
|
|
|
|
- **Body:** Enter the document data as a JSON object.
|
|
|
|
<div style={{textAlign: 'center'}}>
|
|
|
|
<img style={{ border:'0', marginBottom:'15px' }} className="screenshot-full" src="/img/datasource-reference/appwrite/upd-v3.png" alt="Appwrite update" />
|
|
|
|
</div>
|
|
|
|
</div>
|
|
|
|
<div style={{paddingTop:'24px', paddingBottom:'24px'}}>
|
|
|
|
### Bulk update using document id
|
|
|
|
Use this operation for bulk updating a document in a collection.
|
|
|
|
#### Required parameters:
|
|
|
|
- **Collection ID:** You can create a new collection using the Database service **[server integration](https://appwrite.io/docs/server/database#createCollection)** or appwrite console. The value for collection ID should be of `String` type.
|
|
|
|
- **Key for document Id:** Enter the key or attribute name that can be used to identify each record.
|
|
|
|
- **Records:** The array of objects that will contain the data for updating each record in the database
|
|
and these objects must contain a key-value pair to point unique record in the database (key for document)
|
|
|
|
<div style={{textAlign: 'center'}}>
|
|
|
|
<img style={{ border:'0', marginBottom:'15px' }} className="screenshot-full" src="/img/datasource-reference/appwrite/bulk-v3.png" alt="Appwrite bulk update" />
|
|
|
|
</div>
|
|
|
|
</div>
|
|
|
|
<div style={{paddingTop:'24px', paddingBottom:'24px'}}>
|
|
|
|
### Delete Document
|
|
|
|
Use this operation for deleting a document in the collection.
|
|
|
|
#### Required parameters:
|
|
|
|
- **Collection ID:** You can create a new collection using the Database service **[server integration](https://appwrite.io/docs/server/database#createCollection)** or appwrite console. The value for collection ID should be of `String` type.
|
|
|
|
- **Document ID:** Enter the document ID of the document that you want to get. The document ID should be of `String` type.
|
|
|
|
<div style={{textAlign: 'center'}}>
|
|
|
|
<img style={{ border:'0', marginBottom:'15px' }} className="screenshot-full" src="/img/datasource-reference/appwrite/del-v3.png" alt="Appwrite delete"/>
|
|
|
|
</div>
|
|
|
|
</div> |