shiqimei / node-opengauss

A simple OpenGauss client for Node.js based on node-postgres.

node-opengauss

A simple openGauss client for Node.js based on node-postgres.

Install

npm install node-opengauss --save

Usage

import OpenGauss from 'node-opengauss'

const client = new OpenGauss()
const config = {
  host: 'localhost',
  port: 5432,
  username: 'lolimay',
  database: 'postgres',
  password: 'Enmo@123'
}

client.connect(config)
client.query('select current_date', result => {
    console.log(result) // { rows: [ { date: 2021-05-26T16:00:00.000Z } ], affectedRows: 1 }
    return client.disconnect()
})

Development

Development on MacOS/Linux is preferred :)

1. Clone the repo git clone [email protected]:lolimay/node-opengauss.git
2. Ensure you have a openGauss instance running, follow this tutorial (Chinese Only/仅中文) to set up a local instance with docker

Run the project

Navigate to examples and run following to test driver:

cd examples
node index.js

For Debugging

For more verbose logs by setting the environment variable DEBUG to true:

DEBUG=true node index.mjs

If you need to modify files inside lib/protocol, please run following commands to take effects:

cd lib/protocol
npm run build:watch

Posts

• 借助docker搭建openGauss测试环境 - Shiqi's Blog
• openGauss鉴权配置文件pg_hba.conf - Shiqi's Blog
• OpenGauss解锁Locked的账号
• openGauss用户管理
• openGauss GUC参数配置
• gsql命令行客户端工具

Check here for more posts.

Notes

• OpenGauss配置客户端接入认证方式
• OpenGauss的SHA256加密认证的协议细节和PostgresSQL不一致，具体实现请参考此GO语言实现。
• OpenGauss 的用于SHA256认证鉴权的GO语言实现 - 官方开源代码

License

Copyright (c) 2021-2021 Shiqi Mei ([email protected])

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

node-opengauss's Issues

openGauss的接口，怎么使用连接池功能？

openGauss的接口，怎么使用连接池功能？

把 lib/core 用 typescript 重写

这样可以保持 pg-protocol 和 core 同构，不需要再单独维护一个 pg-protocol 包。

封装的OpenGauss接口不支持参数化执行

请支持参数化查询语句
client.query("insert into table values($1)", ['value1'], callback)

对CLOB类型的处理

在 openGauss-connector-jdbc中，CLOB类型被映射为TEXT。

详细参考：https://gitee.com/opengauss/openGauss-connector-jdbc/commit/a8c4788c466922b7322df9398ca1b836cd8fb21a

对于OpenGauss的接口，当建立连接或者执行命令失败，是否直接抛出异常更好，由上层应用去处理异常。

我在使用 client.connect(config) 建立数据库连接时候，其实失败了，但是程序还是继续往下执行。 这种情况是否抛出异常更好，而不是只是去打印出来。

async connect(config) {
        if (this.client) throw new Error('连接已建立')
        if (config.username) config.user = config.username
        if (config.dbname) config.database = config.dbname
        this.client = new this.Client(config)
        // 建立TCP连接
        this.client.connect()
            .then(() => {})
            .catch(err => console.error(err))         ################## 直接抛出异常
        return this.client
    }
    // SQL语句执行功能
    query(sql, callback = () => {}) {
        // const timeStart = Date.now()
        this.client.query(sql, (err, res) => {
            if (err) return console.error(err)                     ################## 直接抛出异常
            const data = res
            if (data) {
                const result = {}
                if (data.rows.length) {
                    result.rows = data.rows
                }
                if (data.rowCount > 0) {
                    result.affectedRows = data.rowCount
                }
                callback(result)
            }
            // 记录 SQL 执行用时
            // console.log(`SQL \`${ sql }\` finished in ${ Date.now() - timeStart }ms`)
        })
    }

移除 `core` 下的 sasl.js 相关逻辑，sasl 对 OpenGauss 数据库没有意义。

timestamp 类型数据的处理

参考: !9 Jdbc增加支持LocalDateTime对象的读取和设置

不支持openGauss的批量插入协议

openGauss在兼容原有pg批量插入协议基础上，新增加了batchMode=ON(默认值)的协议， 该协议以'U'作为标识，请实现。

NPM 发布仅 include `lib`目录，减少包体大小。

增加对国密SM3算法的支持并添加测试

参考：

1. Issue - JDBC支持国密算法SM3认证
2. Pull Request - JDBC支持国密算法sm3认证