Typesense icon

Typesense

Interact with the Typesense search platform

Alias → Delete

AI-generated

Overview

This node operation deletes an alias in the Typesense search platform. It is useful for managing search aliases by removing those that are no longer needed or relevant. For example, if an alias pointing to a specific collection is outdated or incorrect, this operation can delete it to maintain accurate search configurations.

Use Case Examples

  1. Deleting an alias named 'summer_collection' to remove its reference from the search system.
  2. Removing an alias that was temporarily used for a marketing campaign after the campaign ends.

Properties

Name Meaning
Alias Name The name of the alias to delete. This is a required string input that specifies which alias will be removed from the Typesense platform.

Output

JSON

  • aliasName - The name of the alias that was deleted.
  • status - The status or result of the delete operation, indicating success or failure.

Dependencies

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

Troubleshooting

  • If the alias name does not exist, the node may throw an error indicating the alias was not found. Verify the alias name is correct before retrying.
  • Network or authentication errors may occur if the API key credential is invalid or the Typesense server is unreachable. Check credentials and network connectivity.
  • If the node throws a 'resource not supported' error, ensure the resource parameter is set to 'Alias' and the operation to 'Delete'.

Links

Discussion