Overview

This node interacts with the Typesense search platform, specifically to retrieve information about collections. The 'Get' operation under the 'Collection' resource allows users to fetch details of a selected collection from their Typesense instance. This is useful for scenarios where you need to access metadata or configuration details of a collection, such as its fields or schema, to integrate or manage search data effectively.

Use Case Examples

1. Retrieve details of a specific collection to understand its schema before performing search queries.
2. Fetch collection metadata to display in a dashboard or for auditing purposes.

Properties

Output

JSON

• collectionId - The identifier of the selected collection.
• fields - Details about the fields/columns in the collection, including their names and types.
• otherCollectionMetadata - Additional metadata related to the collection retrieved from Typesense.

Dependencies

• Requires an API key credential for authenticating with the Typesense instance.

Troubleshooting

• If the selected collection does not exist or is misspelled, the node will throw an error indicating the collection is not found. Verify the collection name is correct.
• Errors loading collections or fields may occur if the Typesense instance is unreachable or the API key is invalid. Check network connectivity and credential validity.
• If the 'Filter Columns' property is used incorrectly (e.g., invalid column names), the output may not filter as expected. Ensure column names are correct and comma-separated.

Links

• Typesense Documentation - Official documentation for the Typesense search platform, useful for understanding collections and their management.