Couchbase icon

Couchbase

Couchbase node to insert, update, retrieve, and delete data from a Couchbase database using KV, Query and Search services

Actions7

Overview

This node integrates with a Couchbase database to perform various operations including document management, querying, and full-text search. Specifically, the Search - Create Index operation allows users to create or update a full-text search index in Couchbase by providing a JSON definition of the index.

This is useful when you want to enable advanced search capabilities on your Couchbase data, such as text matching, filtering, and ranking. For example, you might create an index to support searching product descriptions in an e-commerce application or to enable log analytics by indexing log message fields.

Properties

Name Meaning
Index Definition The JSON object defining the search index configuration according to Couchbase Search documentation. This includes fields, analyzers, source bucket, and other index settings.

Output

The output JSON contains a single message indicating the result of the index creation operation:

[
  {
    "message": "Index created successfully"
  }
]

No binary data is produced by this operation.

Dependencies

  • Requires a valid connection to a Couchbase cluster using credentials that include:
    • Connection string (e.g., couchbase://...)
    • Username and password for authentication
  • The node uses the official Couchbase Node.js SDK.
  • The Couchbase cluster must have the Search service enabled to create search indexes.
  • Proper permissions are required to create or update search indexes on the cluster.

Troubleshooting

  • Connection errors: If the node cannot connect to the Couchbase cluster, verify that the connection string, username, and password are correct, and that the cluster is reachable and running.
  • Invalid index definition: Providing an incorrect or malformed JSON for the index definition will cause the operation to fail. Validate the JSON against Couchbase Search index schema before use.
  • Permission issues: Ensure the user has sufficient privileges to create or modify search indexes.
  • Cluster service availability: Confirm that the Search service is enabled on the Couchbase cluster nodes.
  • Error messages: Errors thrown during execution typically include descriptive messages from the Couchbase SDK. Review these messages to identify issues such as timeouts, invalid parameters, or missing resources.

Links and References

Discussion