2d08d889de
* add custom resolvers info and editable row selection info (#9057) * fix system requirements icon * add auth info for webhooks and fix casing * add regex custom validation info (#9068) * [docs]: Marketplace 1.7 updates (#9085) * [docs] Amazon redshift plugin * make minor improvements * add and update docs for marketplace 1.7 * update order of plugins in overview to match sidebar * create new version --------- Co-authored-by: Shubhendra <withshubh@gmail.com> * add the latest version in the versions.json file (#9094) * [docs]: Update PDF component (#9088) * update PDF component * merged with develop and added changes to the new version * update docs favicon: (#9118) * [docs] SSO revamp (#9031) * add method to set default language * update image settings through custom css and update screenshots for getting started and tooljet concepts (#9158) * fix read documentation button * fix formatting for setup icons (#9172) * fix sidebar link for aws lambda * Update static media (#9175) * updated the screenshots * reduced the gif size * reverted the package.json file * edited the zoomed in images and replaced some gifs with screenshots * removed one gif * update static media * update file names * update toolbar * fix file names * fix: dynamodb img path * update media for org management dashboard * fix: casing and formatting * update workspace constant media * update media in workspace settings and github * update github sso * minor change to github sso docs * minor fix * update google sso * change includeCurrentVersion flag to false --------- Co-authored-by: Asjad Ahmed Khan <iitasjad2001@gmail.com> Co-authored-by: Asjad Ahmed Khan <60435499+2001asjad@users.noreply.github.com> Co-authored-by: Karan Rathod <karan.altcampus@gmail.com> * Feature: Engagespot plugin (#9012) * feat(plugins): added engagespot plugin * feat(docs): added engagespot plugin docs * chore(engagespot-plugin): revised copywritings * Feature: Databricks data source (#9174) * plugin-created * Databricks integration * icon, error handling * removed unrelated changes from marketplace and frontend package-lock.json removed runAsync and maxRows timeouts pending * timeout implementation * socket timeout and error handling * resolve comments * resolve comments2 * solved render issue test connection improvements * solved undefined error * fix TJDB not null value fail for is operation (#9055) * fix TJDB not null value fail for is operation * handling not null and null case insenstive values * Support for marketplace plugin deploy on render preview app (#9221) * Fix for marketplace error on render preview app * add marketplace build command * Adding new workflow for building marketplace plugin * removed render app creation * [:docs] Add documentation for Databricks plugin (#9224) * add docs for databricks * update databricks docs * update docs * remove ref to clusters * bump to v2.34.0 * Fixed data source cypress failure (#9227) * updated spec with required text * updated mongodb and import spec * updated import spec --------- Co-authored-by: Karan Rathod <karan.altcampus@gmail.com> Co-authored-by: Adish M <44204658+adishM98@users.noreply.github.com> Co-authored-by: Midhun G S <gsmithun4@gmail.com> Co-authored-by: Shubhendra <withshubh@gmail.com> Co-authored-by: Aman Regu <amanregu@gmail.com> Co-authored-by: Asjad Ahmed Khan <iitasjad2001@gmail.com> Co-authored-by: Asjad Ahmed Khan <60435499+2001asjad@users.noreply.github.com> Co-authored-by: Jobin Jose <129726530+jobin-logidots@users.noreply.github.com> Co-authored-by: Syed Mohammad Akhtar Rizvi <85864291+ShazanRizvi@users.noreply.github.com> Co-authored-by: blank0537 <111295371+blank0537@users.noreply.github.com> Co-authored-by: Mekhla Asopa <59684099+Mekhla-Asopa@users.noreply.github.com>
6.4 KiB
| id | title |
|---|---|
| appwrite | Appwrite |
Appwrite
ToolJet can connect to appwrite database to read/write data.
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. :::
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 page from the ToolJet dashboard.
Querying Appwrite
After setting up the Appwrite datasource, you can click on the + button of the query manager at the bottom panel of the editor and select the Appwrite data source that you added in the previous step.
After selecting Appwrite datasource, select the operation that you want to perform on the Appwrite database and click Save to save the query.
:::tip Query results can be transformed using Transformations. Read our Transformation documentation here :::
Supported operations
- List documents
- Get document
- Create document
- Update document
- Delete document
- Bulk update using document id
List documents
This operation can be 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 or appwrite console. The value for collection ID field should be of
Stringtype.
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
integertype. - 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.
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 or appwrite console. The value for collection ID should be of
Stringtype. -
Document ID: Enter the document ID of the document that you want to get. The document ID should be of
Stringtype.
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 or appwrite console. The collection ID should be of
Stringtype. -
Body: Enter the document data as a JSON object.
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 or appwrite console. The value for collection ID should be of
Stringtype. -
Document ID: Enter the document ID of the document that you want to get. The document ID should be of
Stringtype. -
Body: Enter the document data as a JSON object.
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 or appwrite console. The value for collection ID should be of
Stringtype. -
Document ID: Enter the document ID of the document that you want to get. The document ID should be of
Stringtype.
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 or appwrite console. The value for collection ID should be of
Stringtype. -
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)
