n8n-nodes-couchbase

This is an n8n community node. It lets you use Couchbase in your n8n workflows.

Couchbase is a distributed NoSQL cloud database that offers the robustness of a relational database with the flexibility of a JSON document database, featuring key-value operations, SQL++ querying, and powerful search capabilities.

n8n is a fair-code licensed workflow automation platform.

Installation
Operations
Credentials
Compatibility
Usage
Resources

Installation

Follow the installation guide in the n8n community nodes documentation.

Operations

The Couchbase node supports operations across two main resources:

Document & Key-Value Operations

• Create: Insert a document with a specified or auto-generated ID
• Query: Execute SQL++ queries to retrieve or manipulate documents
• Read: Retrieve a document by its ID
• Upsert: Modify an existing document identified by its ID, or create a new one if it does not exist
• Delete: Remove a document by its ID

Search Operations

• Create Index: Create a new search index
• Search & Retrieve: Perform full-text search with multiple options:
  • Basic search with query, fields, and limit
  • Advanced mode with raw JSON query capabilities

Credentials

To use the Couchbase node, you'll need to set up Couchbase credentials in n8n:

1. Prerequisites:

   • A running Couchbase cluster (using Couchbase Capella in the cloud, or Couchbase Server)
   • Database credentials with appropriate permissions for the operations you want to perform
   • Allow IP address for your n8n instance

2. Credential Parameters:

   • Connection String: The connection string to your Couchbase server (e.g., couchbase://localhost)
   • Username: Database access username
   • Password: Database access password

Compatibility

This node has been tested with n8n version 1.86.0.

Usage

Document Operations

Creating Documents

1. Select the Document & Key-Value resource
2. Choose the Create operation
3. Select your target bucket, scope, and collection
4. You can either:
   • Use a generated UUID for your document
   • Specify your own document ID
5. Enter your document content in JSON format

Reading Documents

1. Select the Document & Key-Value resource
2. Choose the Read operation
3. Select your target bucket, scope, and collection
4. Enter the document ID to retrieve
5. The node will return the document content if found

Upserting Documents

1. Select the Document & Key-Value resource
2. Choose the Upsert operation
3. Select your target bucket, scope, and collection
4. Enter the document ID
5. Provide the new JSON document content
6. The document will be created if it doesn't exist, or updated if it does

Deleting Documents

1. Select the Document & Key-Value resource
2. Choose the Delete operation
3. Select your target bucket, scope, and collection
4. Enter the document ID to delete
5. The node will remove the document from the collection

Querying Documents with SQL++

1. Select the Document & Key-Value resource
2. Choose the Query operation
3. Optionally select a bucket and scope context
4. Enter your SQL++ query

   SELECT * FROM `travel-sample`.inventory.hotel WHERE country = "United States"
   

Search Operations

Full-Text Search

1. Select the Search resource
2. Choose the Search & Retrieve operation
3. Enter the index name (format: bucket.scope.index-name)
4. Enter your search query
5. Configure optional parameters:
   • Fields to return (comma-separated)
   • Results limit
   • Include term locations option

Advanced Search

1. Enable Advanced Mode
2. Enter a raw JSON query for more complex search requirements:

   {
       "query": {
           "match": "California"
       },
       "size": 5,
       "from": 0
   }
   

Creating Search Indexes

1. Select the Search resource
2. Choose the Create Index operation
3. Enter the index definition as a JSON object

Resources

• n8n community nodes documentation
• Couchbase Documentation
• Couchbase Node.js SDK
• Couchbase Search Service