使用 Node.js 连接到 Databend
Databend 允许你使用 Databend Driver Node.js Binding 开发与 Databend 交互的 Node.js 程序。该驱动程序提供了一个接口，用于连接到 Databend 并执行操作，如执行 SQL 查询和检索结果。通过 Databend 驱动程序，你可以利用 Databend 强大的分布式计算能力，构建可扩展的数据处理应用程序。访问 https://www.npmjs.com/package/databend-driver 了解更多关于该驱动的信息。
要安装适用于 Node.js 的 Databend 驱动程序：
npm install --save databend-driver
在安装驱动程序之前，请确保满足以下先决条件：
- 必须在你要安装驱动程序的环境中已经安装了 Node.js。
- 确保你可以运行
node和npm命令。 - 根据你的环境，你可能需要 sudo 权限来安装驱动程序。
数据类型映射
下表展示了 Databend 通用数据类型与其对应的 Node.js 数据类型的对应关系：
| Databend | Node.js |
|---|---|
| BOOLEAN | Boolean |
| TINYINT | Number |
| SMALLINT | Number |
| INT | Number |
| BIGINT | Number |
| FLOAT | Number |
| DOUBLE | Number |
| DECIMAL | String |
| DATE | Date |
| TIMESTAMP | Date |
| VARCHAR | String |
| BINARY | Buffer |
下表展示了 Databend 半结构化数据类型与其对应的 Node.js 数据类型的对应关系：
| Databend | Node.js |
|---|---|
| ARRAY | Array |
| TUPLE | Array |
| MAP | Object |
| VARIANT | String |
| BITMAP | String |
| GEOMETRY | String |
Databend Node.js 驱动程序行为总结
Node.js 驱动程序提供了与 Rust 驱动程序绑定相似的功能，具有相同名称的函数具有相同的逻辑和能力。
下表总结了 Node.js 驱动程序的主要行为和功能及其用途：
| 函数名称 | 描述 |
|---|---|
info | 返回客户端的连接信息。 |
version | 返回执行 SELECT VERSION() 语句的结果。 |
exec | 执行 SQL 语句并返回受影响的行数。 |
query_iter | 执行 SQL 查询并返回一个迭代器，用于逐行处理结果。 |
query_iter_ext | 执行 SQL 查询并返回一个包含结果统计信息的迭代器。 |
query_row | 执行 SQL 查询并返回单行结果。 |
stream_load | 将数据上传到内置 Stage 并执行带有 stage attachment 的 insert/replace 操作。 |
教程 -1：使用 Node.js 集成 Databend
在开始之前，请确保你已成功安装本地 Databend。详细步骤请参阅 本地和 Docker 部署。
步骤 1. 准备一个 SQL 用户账户
要让你的程序连接到 Databend 并执行 SQL 操作，你必须在代码中提供一个具有适当权限的 SQL 用户账户。如果需要，请在 Databend 中创建一个，并确保该 SQL 用户仅具有必要的权限以确保安全。
本教程使用名为 'user1' 且密码为 'abc123' 的 SQL 用户作为示例。由于程序将向 Databend 写入数据，该用户需要 ALL 权限。有关如何管理 SQL 用户及其权限的详细信息，请参阅 用户与角色。
CREATE USER user1 IDENTIFIED BY 'abc123';
GRANT ALL on *.* TO user1;
步骤 2. 编写一个 Node.js 程序
将以下代码复制并粘贴到一个名为 databend.js 的文件中：
const { Client } = require("databend-driver");
// 以连接到本地 Databend 并使用名为 'user1' 和密码 'abc123' 的 SQL 用户为例。
// 请随意使用你自己的值，同时保持相同的格式。
const dsn = process.env.DATABEND_DSN
? process.env.DATABEND_DSN
: "databend://user1:abc123@localhost:8000/default?sslmode=disable";
async function create_conn() {
this.client = new Client(dsn);
this.conn = await this.client.getConn();
console.log("Connected to Databend Server!");
}
async function select_books() {
var sql = "CREATE DATABASE IF NOT EXISTS book_db";
await this.conn.exec(sql);
console.log("Database created");
var sql = "USE book_db";
await this.conn.exec(sql);
console.log("Database used");
var sql =
"CREATE TABLE IF NOT EXISTS books(title VARCHAR, author VARCHAR, date VARCHAR)";
await this.conn.exec(sql);
console.log("Table created");
var sql =
"INSERT INTO books VALUES('Readings in Database Systems', 'Michael Stonebraker', '2004')";
await this.conn.exec(sql);
console.log("1 record inserted");
var sql = "SELECT * FROM books";
const rows = await this.conn.queryIter(sql);
const ret = [];
let row = await rows.next();
while (row) {
ret.push(row.values());
row = await rows.next();
}
console.log(ret);
}
create_conn().then((conn) => {
select_books();
});
运行 node databend.js
Connected to Databend Server!
Database created
Database used
Table created
1 record inserted
[ [ 'Readings in Database Systems', 'Michael Stonebraker', '2004' ] ]
教程 -2：使用 Node.js 集成 Databend Cloud
在开始之前，请确保你已成功创建了一个计算集群并获取了连接信息。具体步骤请参阅 连接到计算集群。
步骤 1. 创建一个 Node.js 包
$ mkdir databend-sample
$ cd databend-sample
$ npm init -y
步骤 2. 添加依赖项
安装适用于 Node.js 的 Databend 驱动程序：
$ npm install --save databend-driver
在 package.json 中添加一个新的 NPM 脚本：
"scripts": {
+ "run-example": "node index.js",
"test": "echo \"Error: no test specified\" && exit 1"
},
步骤 3. 使用 databend-driver 连接
创建一个名为 index.js 的文件，并添加以下代码：
const { Client } = require("databend-driver");
const dsn = process.env.DATABEND_DSN
? process.env.DATABEND_DSN
: "databend://{USER}:{PASSWORD}@${HOST}:443/{DATABASE}?&warehouse={WAREHOUSE_NAME}";
async function create_conn() {
this.client = new Client(dsn);
this.conn = await this.client.getConn();
console.log("Connected to Databend Server!");
}
async function select_data() {
let sql_table_create = `CREATE TABLE IF NOT EXISTS data (
i64 Int64,
u64 UInt64,
f64 Float64,
s String,
s2 String,
d Date,
t DateTime)`;
await this.conn.exec(sql_table_create);
let sql_insert =
"INSERT INTO data VALUES ('1234', '2345', '3.1415', 'test', 'test2', '2021-01-01', '2021-01-01 00:00:00');";
await this.conn.exec(sql_insert);
let sql_select = "SELECT * FROM data";
const rows = await this.conn.queryIter(sql_select);
const ret = [];
let row = await rows.next();
while (row) {
ret.push(row.values());
row = await rows.next();
}
console.log(ret);
}
create_conn().then((conn) => {
select_data();
});
将代码中的 {USER}, {PASSWORD}, {HOST}, {WAREHOUSE_NAME} 和 {DATABASE} 替换为你的连接信息。如何获取连接信息的详细步骤，请参阅 连接到计算集群。
步骤 4. 使用 NPM 运行示例
$ npm run run-example
