Typesense icon

Typesense

Interact with the Typesense search platform

Actions50

Document → Get Many

AI-generated

Overview

This node interacts with the Typesense search platform to retrieve multiple documents from a specified collection. It supports filtering, sorting, and field selection to customize the documents returned. This is useful for scenarios where you need to fetch a batch of documents from a Typesense collection, such as displaying search results, exporting data, or processing multiple records at once.

Use Case Examples

  1. Retrieve all documents from a 'products' collection to display in an e-commerce app.
  2. Fetch documents filtered by a condition, e.g., employees with more than 100 years of experience.
  3. Sort documents by a specific field, such as 'price:desc', to show the most expensive items first.
  4. Limit the number of documents returned to optimize performance or pagination.

Properties

Name Meaning
Collection Name Select a collection from your Typesense instance to retrieve documents from.
Filter By Filter expression to narrow down the documents returned, e.g., num_employees:>100.
Sort By Field to sort the documents by, with optional ascending or descending order (e.g., num_employees:desc).
Return All Boolean to decide whether to return all documents or limit the number of documents retrieved.
Limit Maximum number of documents to retrieve when 'Return All' is false.
Include Fields Specify which fields to include in the results. Leave empty to include all fields.
Exclude Fields Specify which fields to exclude from the results.
Filter Columns Comma-separated list of column names to include in the output. Leave empty to return all columns.

Output

JSON

  • document
    • `` - Array of documents retrieved from the specified collection, each document containing the requested fields.

Dependencies

  • Typesense API key credential for authentication

Troubleshooting

  • Ensure the collection name is correctly specified and exists in your Typesense instance to avoid errors.
  • Filter expressions must be valid according to Typesense syntax; invalid filters may cause the node to fail.
  • Sorting fields must exist in the selected collection; otherwise, sorting will not work as expected.
  • If 'Return All' is false, ensure the 'Limit' value is within the allowed range (1-200).
  • Network or authentication issues with the Typesense API key credential can cause failures; verify credentials and connectivity.

Links

  • Typesense Documentation - Official documentation for the Typesense search platform, useful for understanding filtering, sorting, and collection management.

Discussion