Skip to content

Commit

Permalink
Updated dependencies and documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
@erayhanoglu
erayhanoglu committed May 8, 2022
1 parent ff3dbef commit f7f93d6
Show file tree
Hide file tree
Showing 4 changed files with 2,890 additions and 2,831 deletions.
100 changes: 53 additions & 47 deletions DOCUMENTATION.md
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# [postgresql-client](https://github.com/panates/postgresql-client)

---

# Contents

- 1\. [Usage](#1-usage)
Expand Down Expand Up @@ -37,7 +39,9 @@
- 2.2.8 [StatementPrepareOptions](#228-statementprepareoptions)
- 2.2.9 [QueryOptions](#229-queryoptions)
- 2.2.10 [QueryResult](#2210-queryresult)


---

# 1. Usage

## 1.1. Connecting
Expand Down Expand Up @@ -294,52 +298,54 @@ You can also check transaction status with `connection.inTransaction` getter.

The table below lists builtin data type mappings.

| Posgtres type | JS type | Receive | Send |
|-----------------|:--------------------| ------------|----------|
| bool | boolean | text,binary | binary |
| int2 | number | text,binary | binary |
| int4 | number | text,binary | binary |
| int8 | BigInt | text,binary | binary |
| float4 | number | text,binary | binary |
| float8 | number | text,binary | binary |
| char | string | text,binary | binary |
| bpchar | string | text,binary | binary |
| varchar | string | text,binary | binary |
| date | Date | text,binary | binary |
| time | Date | text,binary | binary |
| timestamp | Date | text,binary | binary |
| timestamptz | Date | text,binary | binary |
| oid | number | text,binary | binary |
| bytea | Buffer | text,binary | binary |
| uuid | string | text,binary | binary |
| json | string | text,binary | binary |
| xml | string | text,binary | binary |
| point | Point | text,binary | binary |
| circle | Circle | text,binary | binary |
| lseg | Rectangle | text,binary | binary |
| box | Rectangle | text,binary | binary |
| _bool | boolean[] | text,binary | binary |
| _int2 | number[] | text,binary | binary |
| _int4 | number[] | text,binary | binary |
| _int8 | BigInt[] | text,binary | binary |
| _float4 | number[] | text,binary | binary |
| _float8 | number[] | text,binary | binary |
| _char | string[] | text,binary | binary |
| _bpchar | string[] | text,binary | binary |
| _varchar | string[] | text,binary | binary |
| _date | Date[] | text,binary | binary |
| _time | Date[] | text,binary | binary |
| _timestamp | Date[] | text,binary | binary |
| _timestamptz | Date[] | text,binary | binary |
| _uuid | string[] | text,binary | binary |
| _oid | number[] | text,binary | binary |
| _bytea | Buffer[] | text,binary | binary |
| _json | string[] | text,binary | binary |
| _xml | string[] | text,binary | binary |
| _point | Point[] | text,binary | binary |
| _circle | Circle[] | text,binary | binary |
| _lseg | Rectangle[] | text,binary | binary |
| _box | Rectangle[] | text,binary | binary |
| Posgtres type | JS type | Receive | Send |
|---------------|:------------| ------------|----------|
| bool | boolean | text,binary | binary |
| int2 | number | text,binary | binary |
| int4 | number | text,binary | binary |
| int8 | BigInt | text,binary | binary |
| float4 | number | text,binary | binary |
| float8 | number | text,binary | binary |
| char | string | text,binary | binary |
| bpchar | string | text,binary | binary |
| varchar | string | text,binary | binary |
| date | Date | text,binary | binary |
| time | Date | text,binary | binary |
| timestamp | Date | text,binary | binary |
| timestamptz | Date | text,binary | binary |
| oid | number | text,binary | binary |
| bytea | Buffer | text,binary | binary |
| uuid | string | text,binary | binary |
| json | object | text,binary | binary |
| jsonb | object | text,binary | binary |
| xml | string | text,binary | binary |
| point | Point | text,binary | binary |
| circle | Circle | text,binary | binary |
| lseg | Rectangle | text,binary | binary |
| box | Rectangle | text,binary | binary |
| _bool | boolean[] | text,binary | binary |
| _int2 | number[] | text,binary | binary |
| _int4 | number[] | text,binary | binary |
| _int8 | BigInt[] | text,binary | binary |
| _float4 | number[] | text,binary | binary |
| _float8 | number[] | text,binary | binary |
| _char | string[] | text,binary | binary |
| _bpchar | string[] | text,binary | binary |
| _varchar | string[] | text,binary | binary |
| _date | Date[] | text,binary | binary |
| _time | Date[] | text,binary | binary |
| _timestamp | Date[] | text,binary | binary |
| _timestamptz | Date[] | text,binary | binary |
| _uuid | string[] | text,binary | binary |
| _oid | number[] | text,binary | binary |
| _bytea | Buffer[] | text,binary | binary |
| _json | object[] | text,binary | binary |
| _jsonb | object[] | text,binary | binary |
| _xml | string[] | text,binary | binary |
| _point | Point[] | text,binary | binary |
| _circle | Circle[] | text,binary | binary |
| _lseg | Rectangle[] | text,binary | binary |
| _box | Rectangle[] | text,binary | binary |

### 1.5.2 Data transfer formats
PostgreSQL wire protocol offers `text` and `binary` data transfer formats.
Expand Down
6 changes: 2 additions & 4 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,6 @@ Professional PostgreSQL client written in TypeScript.

- Pure JavaScript library completely written in TypeScript
- Both single connection and advanced pooling support
- Both CommonJS and ESM modules
- Named Prepared Statements
- Extended cursor support with fast double-link cache
- Extensible data-types and type mapping
Expand All @@ -24,6 +23,7 @@ Professional PostgreSQL client written in TypeScript.
- Can return both array and object rows
- Asynchronous Promise based api
- Strictly typed
- Supports both CommonJS and ESM module systems

## Installation

Expand Down Expand Up @@ -75,10 +75,8 @@ await db.close(); // Disconnect all connections and shutdown pool
You can report bugs and discuss features on the [GitHub issues](https://github.com/panates/postgresql-client/issues) page
When you open an issue please provide version of NodeJS and PostgreSQL server.


## Node Compatibility

- node >= 10.x
- node >= 14.x


### License
Expand Down

0 comments on commit f7f93d6

Please sign in to comment.