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.