n8n-nodes-cloudbeaver
v0.4.1
Published
n8n node for CloudBeaver — execute SQL queries via CloudBeaver API
Maintainers
Readme
n8n-nodes-cloudbeaver
This is an n8n community node for CloudBeaver - a web-based database management tool. It lets you interact with any database connected to your CloudBeaver server directly from n8n workflows.
n8n is a fair-code licensed workflow automation platform.
Installation
Follow the installation guide in the n8n community nodes documentation.
Operations
- Execute SQL Query - run any SQL query with support for limit, offset,
ORDER BY, andWHEREfilters - Select Rows - retrieve rows from a table with optional
WHERE,ORDER BY, limit, and offset - Insert Rows - insert a new row by specifying column/value pairs
- Update Rows - update rows by specifying column/value pairs and a WHERE condition
- Delete - delete rows (with optional
WHERE), truncate, or drop a table
Note: Only connections from the Shared project in CloudBeaver are supported.
Credentials
Create a CloudBeaver API credential with:
| Field | Description |
|---------------------|------------------------------------------------------------------------------------------------------------------------------|
| Server URL | Base URL of your CloudBeaver server, e.g. https://cloudbeaver.example.com |
| Authentication Type | API Token (for Enterprise or AWS Edition only) or Local access (Username/Password) |
| API Token | Token generated by Admin in CloudBeaver - how to generate |
| Username / Password | Local Access credentials - docs |
Compatibility
Requires n8n 1.0.0 or later. Designed for self-hosted CloudBeaver instances (Community, Enterprise or AWS Edition).
Usage
Finding the Connection ID
Right-click a database in CloudBeaver's Database Navigator -> Open -> copy the ID from the connection window (e.g.
postgres-jdbc-19d5ca3a223-2f46e1a321049b15).
Default Database
The Default Database field lets you specify which database or catalog to use when executing SQL. Leave it empty to use the connection's default. Useful when a single CloudBeaver connection has access to multiple databases and you want to target a specific one.
Database Type
The Database Type field (Select, Insert, Update, Delete operations) controls identifier quoting style:
| Database Type | Use for | |---------------|------------------------------------------------------------------------------| | PostgreSQL | PostgreSQL, SQLite, Oracle, Redshift, Greenplum and other ANSI SQL databases | | MySQL | MySQL, MariaDB, TiDB | | SQL Server | SQL Server, Azure SQL, Sybase |
For databases not listed, PostgreSQL is a safe default - ANSI double-quote quoting works with most SQL databases.
Execute SQL Query
The Where and Order By fields are applied on top of your SQL query:
SQL Query:
SELECT id, name, email
FROM usersWhere: status = 'active'
Order By: created_at DESC
Limit: 50
Executes as:
SELECT *
FROM (SELECT id, name, email FROM users) AS _q
WHERE status = 'active'
ORDER BY created_at DESC LIMIT 50Insert / Update value types
Insert and Update operations let you choose how each value is formatted in the generated SQL query.
| Value type | SQL output example |
|------------|--------------------|
| String | 'Alice' |
| Number | 42 |
| Boolean | TRUE |
| Null | NULL |
| Raw SQL | NOW() |
Use Raw SQL for database-specific expressions, casts, functions, or complex values, such as NOW(),
CAST('42' AS INTEGER), or '{"a":1}'::jsonb.
Warning: Use Raw SQL only with trusted values. Raw SQL is inserted into the query without escaping.
Getting Started (Local Testing)
Start CloudBeaver:
docker run -d -p 8978:8978 dbeaver/cloudbeaver:latestOr follow the full installation guide.
Configure authentication - follow the Local Access Authentication guide. Create a user (login/password) or use admin credentials.
Create a database connection - follow the Create Connection guide.
Get the Connection ID - open Database Navigator, right-click a database -> Open, and copy the connection ID from the opened window.
In n8n:
- Create CloudBeaver credentials (Local auth: login/password)
- Add the CloudBeaver node to your workflow
- Set the Connection ID
- Choose an operation and configure its fields
- Execute the node
