KingbaseES客户端编程接口指南-Nodejs.pdf

KingbaseES 客户端编程接口指南-Nodejs 金仓数据库管理系统 KingbaseES 文档版本：V9（V009R001C001B0024） 发布日期：2023 年 10 月 12 日 北京人大金仓信息技术股份有限公司 目 目 录 录 第 1 章 前言 1 1.1 适用读者 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1 1.2 相关文档 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1 1.3 术语 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1 1.4 手册约定 1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 第 2 章 Nodejs 驱动配置 3 第 3 章 Nodejs 驱动使用说明 4 3.1 连接数据库 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4 3.2 执行语句 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5 3.3 关闭连接 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 6 第 4 章 示例 7 版权声明 9 服务周期承诺 10 I 第 1 章 前言 1 第 章 前言 本文档描述了 KingbaseES 兼容 Nodejs 的驱动，及其相关的使用说明。 前言部分包含以下主题： • 适用读者 • 相关文档 • 术语 • 手册约定 1.1 适用读者 《KingbaseES Nodejs 驱动指南》面向所有使用 KingbaseES 数据库的用户，主要是使用 Nodejs 开发应用程序的 开发人员。 1.2 相关文档 暂无参考文档。 1.3 术语 无 1.4 手册约定 本文档中可能出现“注意、提示、警告、另请参阅”等标志，它们所代表的含义如下： 1 第 1 章 前言 注意: 用于突出重要/关键信息、最佳实践等。 提示: 用于突出小窍门、捷径等。 警告: 用于传递设备或环境安全警示信息，若不避免，可能会导致设备损坏、数据丢失、设备性能降低或其 它不可预知的结果。 另请参阅: 用于突出参考、参阅等。 以下程序代码书写约定适用于本文档： 符号 说明 [] 表示包含一个或多个可选项。不需要输入中括号本身。 {} 表示包含两个以上（含两个）的候选，必须在其中选取一个。不需要输入花括号本身。 | 分割中括号或者花括号中的两个或两个以上选项。不需要输入“|”本身。 ... 表示其之前的元素可以被重复。 斜体 表示占位符或者需要提供特定值的变量。 大写 表示系统提供的元素，以便与用户定义的元素相互区分。除出现在方括号中的元素外，应当按 照顺序逐字输入。当然，部分元素在系统中是大小写不敏感的，因此用户可以根据系统说明以 小写形式输入。 小写 表示由用户提供的元素。 概述 Nodejs 驱动是一些 Nodejs 模块的集合，用于与 KingbaseES 数据库交互。通过 Nodejs 驱动，应用程序可以完 成与数据库的连接、执行 SQL 语句、从数据库中获取结果、获取状态及错误信息、终止连接等操作。 本手册的内容主要是描述如何使用 Nodejs 驱动与 KingbaseES 数据库交互。 2 第 2 章 NODEJS 驱动配置 2 第 章 Nodejs 驱动配置 使用 Nodejs 驱动进行与 KingbaseES 数据库交互前，需对 KingbaseES 项目配置 Nodejs 驱动。 将 Nodejs 驱动中的 node_modules 文件夹放入项目所在目录即可。 3 第 3 章 NODEJS 驱动使用说明 3 第 章 Nodejs 驱动使用说明 • 连接数据库 • 执行语句 • 关闭连接 3.1 连接数据库 使用 Client.connect() 连接数据库。 const { Client } = require('kb') const client = new Client({ user: 'SYSTEM', host: '192.168.0.102', database: 'TEST', password: '123456', port: 54321, ssl: false, }) client.connect(err => { if (err) { console.error('connection error', err.stack) } else { console.log('connected') } }) 4 第 3 章 NODEJS 驱动使用说明 执行语句 3.2 使用 Client.query() 执行语句。 a. 执行不带参数的语句 client.query('SELECT * FROM TEST', (err, res) => { if (err) throw err console.log(res) }) b. 执行带参数的语句 方法 1: const text = 'INSERT INTO users(name, email) VALUES($1, $2) RETURNING *' const values = ['myname', 'myemail@gmail.com'] 回调函数 */ /* client.query(query, (err, res) => { if (err) { console.log(err.stack) } else { console.log(res) } }) c. 创建一个准备好的语句, 在多次执行时提高效率 const query = { name: 'fetch-user', text: 'SELECT * FROM user WHERE id = $1', 5 第 3 章 NODEJS 驱动使用说明 values: [1], } 回调函数 */ /* client.query(query, (err, res) => { if (err) { console.log(err.stack) } else { console.log(res) } }) 3.3 关闭连接 使用 Client.end() 关闭连接。 client.end(err => { console.log('client has disconnected') if (err) { console.log('error during disconnection', err.stack) } }) 6 第 4 章 示例 4 第 章 示例 您可前往 人大金仓官网 下载 Nodejs 测试用例 。 Nodejs 程序示例 const { Client } = require('kb') const client = new Client({ user: 'SYSTEM', host: '192.168.0.102', database: 'TEST', password: '123456', port: 54321, }) client.connect() client.query('CREATE TABLE CLIENTTEST (id int, name char(100), address varchar(200), salary real,' + ' date_col DATE, description TEXT)', (err, res) => { if (err) { return console.error('Error executing query', err.stack) } console.log(res) const now = new Date() const text = 'INSERT INTO CLIENTTEST VALUES($1, $2, $3, $4, $5, $6) RETURNING *' const values = [1, 'tobby', 'incubation park', '1000', now, 'long TEXT test'] client.query(text, values, (err, res) => { if (err) { return console.error('Error executing query', err.stack) } console.log(res) 7 第 4 章 示例 const query = { text: 'UPDATE CLIENTTEST SET name=$1, address=$2 WHERE id=$3 RETURNING *', values: ['lewis', 'software park', 1,], } client.query(query, (err, res) => { if (err) { return console.error('Error executing query', err.stack) } console.log(res) client.query('SELECT * FROM CLIENTTEST', (err, res) => { if (err) { return console.error('Error executing query', err.stack) } console.log(res) client.query('DELETE FROM CLIENTTEST WHERE id=1', (err, res) => { if (err) { return console.error('Error executing query', err.stack) } console.log(res) client.query('DROP TABLE CLIENTTEST', (err, res) => { if (err) { return console.error('Error executing query', err.stack) } console.log(res) client.end() }) }) }) }) }) }) 8 版权声明 版权声明 北京人大金仓信息技术股份有限公司（简称：人大金仓）版权所有，并保留对本手册及本声明的一切权利。 未得到人大金仓的书面许可，任何人不得以任何方式或形式对本手册内的任何部分进行复制、摘录、备份、修 改、传播、翻译成其他语言、将其全部或部分用于商业用途。 免责声明 本手册内容依据现有信息制作，由于产品版本升级或其他原因，其内容有可能变更。人大金仓保留在没有任何通 知或者提示的情况下对手册内容进行修改的权利。 本手册仅作为使用指导，人大金仓在编写本手册时已尽力保证其内容准确可靠，但并不确保手册内容完全没有错 误或遗漏，本手册中的所有信息也不构成任何明示或暗示的担保。 技术支持 • 人大金仓官方网站：http://www.kingbase.com.cn/ • 人大金仓文档中心：http://help.kingbase.com.cn/ • 全国服务热线：400-601-1188 • 人大金仓技术支持与反馈信箱：support@kingbase.com.cn 9 服务周期承诺 服务周期承诺 由于市场需求在不断变化，技术创新和发展的进程不断加剧，产品的版本更迭不可避免。人大金仓对于产品版本 生命周期的有效管理，有助于您提前规划项目，更好地从产品服务终止上过渡。 表 1: KingbaseES 产品生命周期里程碑 关键里程碑点 定义 产品发布日期 产品正式发布版本，即 GA（general availability）版本的发布日期。 停止销售日期 正式停止销售的日期，版本停止接受订单日。该日之后，产品将不再销售。 停止功能升级日期 在该日期之后，不再提供新特性和新硬件支持。但依旧提供错误修复、安全修复、功 能维护等服务。 停止功能维护日期 在该日期之后，不再维护功能，修复问题。但依旧提供安全修复等服务 停止安全维护日期 在该日期之后，不再发布补丁版本修复中高风险漏洞，仅提供有限的支持。 产品服务终止日期 停止提供产品服务和支持的日期。包括软件维护版本，缺陷修复，以及针对该产品的 所有服务支持（包括服务热线和远程/现场支持）。 服务周期策略 金仓数据库管理系统 KingbaseES 产品确保以下的服务周期： 1）产品自发布之日起至产品停止功能升级（包含新特性、新硬件支持）之日不少于 5 年。 2）产品停止功能升级之日起至产品停止功能维护（主要包括问题修复）之日不少于 4 年。 3）产品功能维护停止之日起至产品停止安全维护（包括中高风险漏洞修复）之日不少于 2 年。 服务终止策略 金仓数据库管理系统 KingbaseES 产品确保在销售后，至少提供 6 年的服务支持。 注意: 人大金仓将会综合各方因素来确定产品服务终止日期。并将在实际产品服务终止日期之前至少 90 天，通过公 10 服务周期承诺 开方式宣布产品服务终止日期。 11