Skip to content

Add ToolJet + Couchbase integration tutorial#96

Open
teetangh wants to merge 2 commits intomainfrom
tutorial/tooljet-couchbase-airline-dashboard
Open

Add ToolJet + Couchbase integration tutorial#96
teetangh wants to merge 2 commits intomainfrom
tutorial/tooljet-couchbase-airline-dashboard

Conversation

@teetangh
Copy link
Copy Markdown
Contributor

Summary

  • Adds a new tutorial under tutorial/markdown/connectors/tooljet/ for building an Airline Dashboard using ToolJet and Couchbase
  • Covers all 6 Couchbase plugin operations: Get Document, Create Document, Update Document, Delete Document, SQL++ Query, and Full-Text Search
  • Uses the travel-sample dataset with setup paths for both Capella and self-managed clusters (collapsible toggle sections)
  • Follows existing tutorial conventions (frontmatter schema, connectors directory, ~30 min length)

Context

Couchbase was added as a marketplace plugin to ToolJet via ToolJet PR #14518 (merged Feb 2026). This tutorial provides the hands-on guide for Couchbase users to get started with the integration.

Tutorial Outline

  1. Prerequisites (Couchbase cluster + ToolJet instance setup)
  2. Install the Couchbase plugin from ToolJet Marketplace
  3. Configure the data source (Data API URL, credentials)
  4. SQL++ query to list airlines
  5. Display results in a Table component
  6. View airline details (Get Document)
  7. Create new airline (Create Document)
  8. Edit airline (Update Document)
  9. Delete airline (Delete Document)
  10. Full-Text Search with FTS index

Test plan

  • Verify frontmatter passes npm run test:frontmatter validation
  • Verify all SQL++ queries are valid against travel-sample schema
  • Verify tutorial renders correctly on the Developer Portal
  • Test both Capella and self-managed setup paths end-to-end

Step-by-step tutorial covering all 6 Couchbase operations in ToolJet
(CRUD, SQL++, FTS) using the travel-sample dataset. Includes setup
paths for both Capella and self-managed clusters.
@teetangh teetangh requested a review from a team as a code owner March 24, 2026 10:21
@gemini-code-assist
Copy link
Copy Markdown
Contributor

Summary of Changes

Hello, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request introduces a new, detailed tutorial designed to guide users through building a functional Airline Dashboard application using ToolJet's low-code platform and Couchbase. The tutorial provides a hands-on experience, showcasing how to leverage the Couchbase marketplace plugin to perform various database operations, from basic CRUD to advanced SQL++ queries and Full-Text Search, with clear setup paths for both cloud and self-managed Couchbase environments. The primary goal is to empower users to quickly get started with the ToolJet-Couchbase integration and build internal tools without writing extensive backend or frontend code.

Highlights

  • New Tutorial Content: Added a comprehensive tutorial demonstrating the integration of ToolJet with Couchbase to build an Airline Dashboard.
  • Couchbase Operations Covered: The tutorial covers all six Couchbase plugin operations: Get Document, Create Document, Update Document, Delete Document, SQL++ Query, and Full-Text Search.
  • Flexible Setup Options: Included detailed setup instructions for both Couchbase Capella (cloud) and self-managed clusters, utilizing the travel-sample dataset.
  • Adherence to Standards: Ensured the new tutorial follows existing documentation conventions, including frontmatter schema and placement within the connectors directory.

🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for GitHub and other Google products, sign up here.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

Copy link
Copy Markdown
Contributor

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request adds a new, comprehensive tutorial for building an airline dashboard with ToolJet and Couchbase. The tutorial is well-structured and covers a wide range of operations. I've provided a few suggestions to enhance security, ensure the tutorial's long-term stability by version-pinning Docker images, and align the content with its stated learning objectives. Addressing the invalid frontmatter tags is also necessary to pass the validation checks.

@teetangh teetangh self-assigned this Mar 24, 2026
- Fix frontmatter tags to use allowed values (Data API, Connector,
  SQL++ (N1QL), FTS, REST API) and stay within the 6-tag limit
- Remove 0.0.0.0/0 suggestion from Capella setup, add security note
  guiding users to find their actual IP instead
- Add parameterized query example ($country) in Step 3 demonstrating
  safe SQL++ parameter binding via the args field
- Remove parameterized queries from "Next Steps" since now covered
- Pin Docker images to specific versions (couchbase:7.6.2,
  tooljet/tooljet-ce:v3.16.0-LTS) for tutorial reproducibility
@teetangh teetangh requested a review from prajwal-pai77 March 24, 2026 10:47
- nodejs
length: 30 Mins
---

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pls Add an overview tab


To follow this tutorial, you will need:

- A **Couchbase cluster** with the `travel-sample` bucket loaded (see setup instructions below)
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Link to the section and rename to see Couchbase Cluster Setup

To follow this tutorial, you will need:

- A **Couchbase cluster** with the `travel-sample` bucket loaded (see setup instructions below)
- A **ToolJet instance** — either [ToolJet Cloud](https://www.tooljet.com) (free tier available) or self-hosted via Docker
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Link to the relevant section

<details>
<summary><b>Option A: Couchbase Capella (Cloud) — Recommended</b></summary>

Couchbase Capella is the easiest way to get started. It has a free tier and the Data API is available out of the box.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pls point to the relevant docs link for the user to navigate, like for example you can say:
Loading Travel Sample Bucket If travel-sample is not loaded in your Capella cluster, you can load it by following the instructions for your Capella Cluster:

Load travel-sample bucket in Couchbase Capella
Similarly pls add relevant links to the docs

- Go to **Allowed IP Addresses**
- Add the IP address of your ToolJet instance (visit [whatismyip.com](https://whatismyip.com) to find your public IP if self-hosting)
> **Security Note**: Never allow `0.0.0.0/0` (all IPs). Always restrict access to specific IP addresses, even in development.
5. **Find your Data API endpoint**:
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same as above, pls add relevant doc link

couchbase:7.6.2
```

2. **Initialize the cluster**:
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this correct for self managed? I guess it doesnt have to always be localhost


4. **Your Data API endpoint** is:
```
http://localhost:8091
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same as above

<details>
<summary><b>Option B: Self-Hosted ToolJet (Docker)</b></summary>

```shell
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I believe it is also good to rephrase/add a link to the repo/docs of tooljet where they show how to setup self hosted

1. In ToolJet, click the **gear icon** (bottom-left) to open **Workspace Settings**
2. Navigate to **Marketplace** → **Plugins**
3. Search for **"Couchbase"**
4. Click **Install**
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pls add relevant screenshots

2. Click **+ Add new data source**
3. Search for **"Couchbase"** and select it
4. Fill in the connection details:

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same as above, pls add screenshot

3. Search for **"Couchbase"** and select it
4. Fill in the connection details:

| Field | Value |
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I dont think this table is needed, u can just rephrase to something like "Fill in the Data API Endpoint, Username and Password"
Feel free to rephrase better

| **Password** | Your Couchbase database password |

<details>
<summary><b>Capella Users</b></summary>
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The 2 sub sections Capella Users and Self managed should not be needed as they should be covered in the setup section

4. Configure the query:
- **Operation**: Select **Query** from the dropdown
- **SQL++ Query**: Enter the following:

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Add relevant screenshot

2. Configure it:
- **Operation**: **Query**
- **SQL++ Query**:

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same as above


1. Drag a **Button** component above the table, label it "Add Airline"

2. Drag a **Modal** component for the creation form. Inside it, add:
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is not clear, maybe adding a screenshot or rephrasing it will help better

Before you can search, you need to create an FTS index on the airline collection.

<details>
<summary><b>Capella Users</b></summary>
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The 2 sections should not be here, it should be in the pre requisites or setup.

Copy link
Copy Markdown
Contributor

@prajwal-pai77 prajwal-pai77 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Needs some changes wrt the following:

  • Add links to the documentation wherever needed and point to the right docs links
  • Add screenshot/photos wherever needed to show user the dashboard

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants