Skip to content

Commit cdeb5cc

Browse files
committed
feat: embed screenshots and add parameterized query example
- Add 8 screenshots from ToolJet docs to the tutorial directory - Embed screenshots at appropriate steps: connection config, operations dropdown, SQL++ query, Get/Create/Update/Delete Document, FTS Search - Screenshots are co-located with the markdown file per repo convention
1 parent 14700d3 commit cdeb5cc

9 files changed

Lines changed: 18 additions & 1 deletion

File tree

56 KB
Loading
62.1 KB
Loading
43.1 KB
Loading
54 KB
Loading
36 KB
Loading
33.6 KB
Loading
59 KB
Loading

tutorial/markdown/connectors/tooljet/tooljet-couchbase-airline-dashboard.md

Lines changed: 18 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -200,6 +200,8 @@ Now connect ToolJet to your Couchbase cluster:
200200
5. Click **Test Connection** — you should see a green "Connection successful" message
201201
6. Click **Save**
202202

203+
![Couchbase data source connection configuration in ToolJet](connection-v2.png)
204+
203205
## Step 3: Create a SQL++ Query to List Airlines
204206

205207
Let's fetch airline data from the `travel-sample` dataset.
@@ -208,7 +210,10 @@ Let's fetch airline data from the `travel-sample` dataset.
208210
2. In the bottom panel, click **+ Add****Query** → select your **Couchbase** data source
209211
3. Name the query `listAirlines`
210212
4. Configure the query:
211-
- **Operation**: Select **Query** from the dropdown
213+
- **Operation**: Select **Query** from the dropdown (see all available operations below)
214+
215+
![Available Couchbase operations in ToolJet](listops.png)
216+
212217
- **SQL++ Query**: Enter the following:
213218

214219
```sql
@@ -220,6 +225,8 @@ LIMIT 50
220225

221226
5. Click **Run** to test the query
222227

228+
![SQL++ Query operation configured in ToolJet](query-v2.png)
229+
223230
You should see results in the preview panel — a list of airlines with their names, countries, and callsigns.
224231

225232
> **How it works**: This SQL++ query runs against the `airline` collection inside the `inventory` scope of the `travel-sample` bucket. `META().id` gives us the document ID, which we'll need for CRUD operations later.
@@ -280,6 +287,8 @@ Let's add the ability to view a single airline's full document when a user click
280287
- **Collection**: `airline`
281288
- **Document ID**: `{{components.table1.selectedRow.doc_id}}`
282289

290+
![Get Document operation configured in ToolJet](get-doc.png)
291+
283292
2. Drag a **Modal** component onto the canvas and add **Text** components inside it to display:
284293
- `{{queries.getAirline.data.name}}` — Airline name
285294
- `{{queries.getAirline.data.country}}` — Country
@@ -324,6 +333,8 @@ Now when you click any airline row, it fetches the full document and displays it
324333
}
325334
```
326335

336+
![Create Document operation configured in ToolJet](create-doc.png)
337+
327338
4. Wire it up:
328339
- "Add Airline" button → **Show modal** (the creation form modal)
329340
- "Create" button inside modal → **Run query** `createAirline`, then **Run query** `listAirlines` (to refresh the table), then **Hide modal**
@@ -358,6 +369,8 @@ Test it: Click "Add Airline", fill in the form, click "Create". The new airline
358369
}
359370
```
360371

372+
![Update Document operation configured in ToolJet](update-doc.png)
373+
361374
4. Wire the "Save" button to: **Run query** `updateAirline`**Run query** `listAirlines`**Hide modal**
362375

363376
> **Important**: The Update operation performs a **full document replacement** (HTTP PUT), not a partial update. Make sure your document JSON includes all fields, not just the ones you changed.
@@ -373,6 +386,8 @@ Test it: Click "Add Airline", fill in the form, click "Create". The new airline
373386
- **Collection**: `airline`
374387
- **Document ID**: `{{components.table1.selectedRow.doc_id}}`
375388

389+
![Delete Document operation configured in ToolJet](delete-doc.png)
390+
376391
3. Wire the "Delete" button to show a **confirmation dialog**, then:
377392
- **Run query** `deleteAirline`**Run query** `listAirlines` (to refresh the table)
378393

@@ -404,6 +419,8 @@ Now let's add a search bar that uses Couchbase's Full-Text Search to find airlin
404419
}
405420
```
406421

422+
![FTS Search operation configured in ToolJet](fts-search-v2.png)
423+
407424
3. Add an event handler on the search input: **On change****Run query** `searchAirlines`
408425

409426
4. Update the **Table's Data** to conditionally show search results or all airlines:
68.3 KB
Loading

0 commit comments

Comments
 (0)