Typesense icon

Typesense

Interact with the Typesense search platform

Actions50

Alias → Create

AI-generated

Overview

This node interacts with the Typesense search platform, specifically to create an alias for a collection within a Typesense instance. It is useful for managing search indices by allowing users to create aliases that point to specific collections, facilitating easier search management and updates without changing client-side configurations. For example, a user can create an alias named 'current_products' that points to a collection 'products_2024'.

Use Case Examples

  1. Create an alias named 'summer_sale' for the 'products' collection to quickly switch search context during a promotional period.
  2. Create an alias to point to a new version of a collection without changing the search queries in the application.

Properties

Name Meaning
Alias Name The name of the alias to create or operate on. It is required and used to identify the alias within the Typesense instance.
Collection Name The name of the collection in the Typesense instance to which the alias will point. This is a required field and must be selected from existing collections loaded dynamically from the Typesense instance.

Output

JSON

  • aliasName - The name of the alias that was created.
  • collectionName - The name of the collection the alias points to.
  • message - Confirmation or status message about the alias creation operation.

Dependencies

  • Requires a Typesense API key credential to authenticate and interact with the Typesense instance.

Troubleshooting

  • If the specified collection does not exist or is not accessible, the node will fail with an error indicating the collection could not be found.
  • If the alias name is missing or invalid, the node will throw an error requiring a valid alias name.
  • Errors related to network connectivity or authentication with the Typesense instance may occur; ensure the API key and endpoint are correctly configured.
  • Loading collections dynamically may fail if the Typesense instance is unreachable or credentials are incorrect, resulting in an error message in the collection dropdown.

Links

Discussion