Typesense icon

Typesense

Interact with the Typesense search platform

Actions50

Document → Export

AI-generated

Overview

This node interacts with the Typesense search platform to export documents from a specified collection. It allows users to filter documents, and specify which fields to include or exclude in the export. This is useful for extracting subsets of data from a Typesense collection for analysis, backup, or migration purposes.

Use Case Examples

  1. Export all documents from a 'products' collection where the number of employees is greater than 100.
  2. Export only specific fields like 'name' and 'price' from a 'products' collection.
  3. Export documents excluding sensitive fields such as 'social_security_number' from a 'users' collection.

Properties

Name Meaning
Collection Name Selects the collection from which documents will be exported. This is a required field and the collection options are dynamically loaded from the Typesense instance.
Export Parameters A collection of optional parameters to refine the export operation, including filtering documents by a condition, including specific fields, or excluding certain fields from the export.

Output

JSON

  • exportedDocuments - Array of documents exported from the specified collection, filtered and field-selected according to the input parameters.

Dependencies

  • Requires an API key credential to authenticate with the Typesense instance.

Troubleshooting

  • Error loading collections or fields may occur if the Typesense instance is unreachable or credentials are invalid. Verify API key and network connectivity.
  • If no documents are exported, check the filter expression syntax and ensure the collection contains matching documents.
  • Including and excluding fields simultaneously may cause conflicts; use one or the other to avoid unexpected results.

Links

Discussion