Couchbase

ToolJet integrates with Couchbase to utilize its NoSQL database capabilities and advanced vector search features. This integration enables ToolJet to perform document operations such as creating, reading, updating, and deleting documents, as well as executing SQL++ queries, Full-Text Search (FTS) operations in Couchbase databases. With Couchbase's vector store capabilities, ToolJet can leverage semantic search, hybrid search combining traditional and AI-powered queries, and build intelligent applications.

:::note Before following this guide, it is assumed that you have already completed the process of Using Marketplace plugins. :::

Connection

For connecting to Couchbase, the following credentials are required:

• Data API Endpoint: Your Couchbase Data API endpoint URL
• Username: Your Couchbase username
• Password: Your Couchbase password

Supported Operations

• Get Document
• Create Document
• Update Document
• Delete Document
• Query
• FTS Search

Get Document

This operation retrieves a specific document by its ID from a Couchbase collection.

Required Parameters

• Bucket: The name of the bucket containing the document
• Document ID: The unique identifier of the document to retrieve
• Scope: The scope name
• Collection: The collection name

{
  "id": "user::123",
  "name": "John Doe",
  "email": "[email protected]",
  "age": 30,
  "created_at": "2023-01-15T10:30:00Z"
}

Create Document

This operation creates a new document in a Couchbase collection.

Required Parameters

• Bucket: The name of the bucket to create the document in
• Scope: The scope name
• Collection: The collection name
• Document ID: The unique identifier for the new document
• Document: The document data as a JSON object

Created successfully

Update Document

This operation updates an existing document in a Couchbase collection.

Required Parameters

• Bucket: The name of the bucket containing the document
• Scope: The scope name
• Collection: The collection name
• Document ID: The unique identifier of the document to update
• Document: The updated document data as a JSON object

Updated successfully

Note: Update operation replaces the original document with the updated value of the document passed.

Delete Document

This operation deletes a document from a Couchbase collection.

Required Parameters

• Bucket: The name of the bucket containing the document
• Scope: The scope name
• Collection: The collection name
• Document ID: The unique identifier of the document to delete

Deleted successfully

Query

This operation executes SQL++ queries against your Couchbase database.

Required Parameters

• SQL++ Query: The SQL++ statement to execute (use $parameter placeholders for named parameters)

Optional Parameters

• Arguments (Key-Value): Key-value object for named parameters that replace $parameter placeholders in the query
• Query Options: JSON object containing additional query options like readonly, timeout, etc.

SELECT * FROM `travel-sample`.`inventory`.`airline` WHERE country = $country LIMIT 10

Arguments (Key-Value): { "$country": "France" }

Query Options: { "readonly": true, "query_context": "travel-sample.inventory" }

Refer to the request paramters for supported query options.

{
  "results": [
    {
      "airline": {
        "id": 137,
        "type": "airline",
        "name": "Air France",
        "iata": "AF",
        "icao": "AFR",
        "callsign": "AIRFRANS",
        "country": "France"
      }
    }
  ],
  "status": "success",
  "metrics": {
    "elapsedTime": "15.2ms",
    "executionTime": "14.8ms",
    "resultCount": 1,
    "resultSize": 234
  }
}

FTS Search

This operation performs Full-Text Search queries against a Couchbase FTS index.

Required Parameters

• Bucket: The name of the bucket to search in
• Scope: The scope name
• Index Name: The name of the FTS index to search against
• Search Query: The FTS search query as a JSON object

{
  "query": {
    "match": "hotel",
    "field": "name"
  }
}

{
  "status": {
    "total": 1,
    "failed": 0,
    "successful": 1
  },
  "request": {
    "query": {
      "match": "hotel",
      "field": "name"
    }
  },
  "hits": [
    {
      "index": "hotel-index",
      "id": "hotel_123",
      "score": 0.8567,
      "fields": {
        "name": "Grand Hotel",
        "city": "Paris",
        "country": "France"
      }
    }
  ],
  "total_hits": 1,
  "max_score": 0.8567,
  "took": 12
}