Typesense icon

Typesense

Interact with the Typesense search platform

Actions50

Collection → Get Many

AI-generated

Overview

This node interacts with the Typesense search platform to retrieve multiple collections based on user-defined parameters. It is useful for scenarios where you need to fetch a list of collections with options to control pagination, limit the number of results, and customize the fields included or excluded in the response. For example, you can use it to get all collections or a limited subset, exclude certain fields from the output, or filter the columns returned for each collection.

Use Case Examples

  1. Retrieve all collections without limit.
  2. Retrieve up to 50 collections starting from an offset of 10.
  3. Retrieve collections excluding specific fields like 'created_at' or 'updated_at'.
  4. Retrieve collections including only specified columns such as 'name' and 'num_documents'.

Properties

Name Meaning
Return All Whether to return all collections or limit the number of collections retrieved.
Limit Maximum number of collections to retrieve when 'Return All' is false.
Exclude Fields Comma-separated list of fields to exclude from the response.
Filter Columns Comma-separated list of column names to include in the output. Leave empty to return all columns.
Offset Starting point for pagination when retrieving collections.

Output

JSON

  • collections - Array of collection objects retrieved from Typesense, each containing the requested fields and columns.

Dependencies

  • Requires an API key credential for Typesense to authenticate requests.

Troubleshooting

  • If the node throws an error about unsupported resources, ensure the 'Resource' parameter is set to 'Collection'.
  • Errors related to API connectivity or authentication usually indicate issues with the Typesense API key credential; verify the credential is correctly configured.
  • If no collections are returned, check the 'Limit' and 'Offset' parameters to ensure they are set correctly and that collections exist in the Typesense instance.
  • Errors about invalid fields in 'Exclude Fields' or 'Filter Columns' indicate that the specified field names do not exist in the collections; verify field names are correct.

Links

Discussion