https://github.com/jandenma/pg-connector
An ORM library for Postgresql on NodeJS
https://github.com/jandenma/pg-connector
node nodejs orm orm-framework postgres postgresql
Last synced: about 2 months ago
JSON representation
An ORM library for Postgresql on NodeJS
- Host: GitHub
- URL: https://github.com/jandenma/pg-connector
- Owner: JandenMa
- License: mit
- Created: 2020-02-24T06:59:13.000Z (over 6 years ago)
- Default Branch: dev
- Last Pushed: 2021-06-05T05:39:50.000Z (about 5 years ago)
- Last Synced: 2025-03-30T15:36:07.975Z (over 1 year ago)
- Topics: node, nodejs, orm, orm-framework, postgres, postgresql
- Language: TypeScript
- Homepage: https://jandenma.github.io/pg-connector/
- Size: 95.7 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Pg-Connector
> Lib Version：0.1.6
>
> Document Version：0.1.6
>
> Author：Janden Ma
>
> LICENCE: MIT
## Version Change Logs
- **v0.1.1 (Build20200514):** Correct `orderBy` option for build querying sql
- **v0.1.2 (Build20200514):** Update README
- **v0.1.3 (Build20200515):** Optimizations
- **v0.1.4 (Build20200621):** Resolve bugs
- **v0.1.5 (Build20200729):** Bug fixes
- **v0.1.6 (Build20201010):** Support PostgreSQL 13
## What is Pg-Connector?
Pg-Connector is an ORM library for Postgresql on NodeJS.
## Installation
- npm
```bash
npm i pg-connector --save
```
- yarn
``` bash
yarn add pg-connector --save
```
## Quick Example
- Instance (_core/pg.js_)
``` js
// core/pg.js
import PgConnector from 'pg-connector'
const Pg = new PgConnector({
host: 'http://192.168.1.100',
port: 5432,
userName: 'root',
password: '123456',
database: 'test',
connectionTimeoutMillis: 0,
idleTimeoutMillis: 60000,
ssl: true
})
export default Pg
```
- Model (_models/users.js_)
```js
import Pg from '../core/pg.js';
class User extends Pg.Model{
constructor(){
super({
autoCreate: true,
tables: [
{
index: 0,
name: 'users',
primaryKeys: ['id'],
fields: [
{
name: 'id',
type: Pg.DataType.SERIAL
},
{
name: 'name',
type: Pg.DataType.VARCHAR,
length: 100
},
{
name: 'age',
type: Pg.DataType.INT
}
]
}
]
});
// other functions you want to override or customize
}
}
User.init(); // will create data table if not exists
export default User
```
## Usage
- import
```js
import PgConnector from 'pg-connector'
// or
const PgConnector = require('pg-connector')
```
- Instantiate
```js
const Pg = new PgConnector({
host: 'http://192.168.1.100',
port: 5432,
userName: 'root',
password: '123456',
database: 'test',
connectionTimeoutMillis: 0,
idleTimeoutMillis: 60000,
ssl: true
})
```
| Key | Type | Introduction | Default value |
| ----------------------- | --------- | ------------------------------------------------------------ | ------------- |
| host | `string` | Postgresql server host | "localhost" |
| port | `number` | Postgresql server port | 5432 |
| userName | `string` | Postgresql server user name | "postgres" |
| password | `string` | Postgresql server password | ""_(empty)_ |
| database | `string` | Postgresql database name | "postgres" |
| connectionMax | `number` | Postgresql database max connection | 10 |
| connectionTimeoutMillis | `number` | Number of milliseconds to wait before timing out when connecting a new client, by default this is 0 which means no timeout | 0 |
| idleTimeoutMillis | `number` | Number of milliseconds a client must sit idle in the pool and not be checked out, before it is disconnected from the backend and discarded, default is 10000 (10 seconds) - set to 0 to disable auto-disconnection of idle clients | 10000 |
| ssl | `boolean` | To connect to pg using ssl | false |
## Modules
- [LibDataAccess](https://github.com/JandenMa/pg-connector/blob/master/LibDataAccess.md)
- [LibSQLBuilder](https://github.com/JandenMa/pg-connector/blob/master/LibSQLBuilder.md)
- [LibModel](https://github.com/JandenMa/pg-connector/blob/master/LibModel.md)
- DataTypes
- SERIAL: Serial Id
- BIT
- BOOLEAN
- CHAR
- VARCHAR
- INT: Int 4
- BIGINT: Int 8
- SMALLINT: Int 2
- FLOAT
- DOUBLE
- DECIMAL
- NUMERIC
- JSON
- DATE
- TIMESTAMP
- TIMESTAMPTZ: Timestamp with time zone
- TEXT