Appwrite Helper icon

Appwrite Helper

Utility node for building Appwrite queries, permissions, and schemas

Overview

The Appwrite Helper node is a utility node designed to assist in building Appwrite queries, permissions, and schemas. It supports various query templates and custom query building, enabling users to construct complex queries for filtering, searching, sorting, and paginating data in Appwrite databases. This node is beneficial for scenarios where users need to dynamically generate queries based on different criteria, such as filtering active users, retrieving recent documents, searching by name, filtering by date ranges, or paginating results.

Use Case Examples

  1. Filtering active users with status = 'active'
  2. Retrieving the most recent documents with a limit on the number of results
  3. Searching documents by a specific name field
  4. Filtering documents within a specified date range using start and end dates in ISO format

Properties

Name Meaning
Query Template Select a pre-built query template or create custom queries to build Appwrite queries.
Search Term The search term to look for in the 'name' field, used with the 'Search by Name' template.
Start Date Start date for the date range filter in ISO format, used with the 'Date Range' template.
End Date End date for the date range filter in ISO format, used with the 'Date Range' template.
Page Size Number of results per page, used with 'Paginated Results' and 'Recent Documents' templates.
Page Number Page number to retrieve (1-based), used with the 'Paginated Results' template.
Queries Custom queries built using the query builder, combined with AND logic. Supports various query types like equal, not equal, less than, greater than, search, is null, between, starts with, ends with, select, order descending/ascending, limit, and offset.

Output

JSON

  • query - The constructed Appwrite query object or query string based on the selected template or custom queries.

Dependencies

  • Appwrite API or SDK for query execution

Troubleshooting

  • Ensure that date values are in ISO format when using date range queries to avoid errors.
  • When using custom queries, verify that attribute names and values are correctly specified to prevent query failures.
  • Pagination parameters like page size and page number should be within valid ranges to avoid unexpected results.

Discussion