@antelopejs/postgres 0.2.3 → 0.2.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +22 -10
  2. package/package.json +5 -3
package/README.md CHANGED
@@ -3,12 +3,14 @@
3
3
  <div align="center">
4
4
  <a href="https://www.npmjs.com/package/@antelopejs/postgres"><img alt="npm" src="https://img.shields.io/npm/v/@antelopejs/postgres?style=for-the-badge&labelColor=000000&color=000000"></a>
5
5
  <a href="./LICENSE"><img alt="License" src="https://img.shields.io/npm/l/@antelopejs/postgres?style=for-the-badge&labelColor=000000&color=000000"></a>
6
- <a href="https://discord.gg/sjK28QHrA7"><img src="https://img.shields.io/badge/Discord-18181B?logo=discord&style=for-the-badge&color=000000" alt="Discord"></a>
6
+ <a href="https://discord.gg/g4pFt6eXqu"><img src="https://img.shields.io/badge/Discord-18181B?logo=discord&style=for-the-badge&color=000000" alt="Discord"></a>
7
7
  <a href="https://interfaces.antelopejs.com/docs/database"><img src="https://img.shields.io/badge/Docs-18181B?style=for-the-badge&color=000000" alt="Documentation"></a>
8
8
  </div>
9
9
 
10
10
  The PostgreSQL backend of AntelopeJS: it runs the database interface's queries on PostgreSQL with the [`pg`](https://github.com/brianc/node-postgres) driver, mapping schema definitions onto real relational tables with native column types and indexes. It can also serve tables that already exist in a database it does not own.
11
11
 
12
+ Part of [AntelopeJS](https://github.com/AntelopeJS/antelopejs). Used by [AntelopeJS DMS](https://github.com/AntelopeJS/dms), the open-source back office for your PostgreSQL, MongoDB or RethinkDB database.
13
+
12
14
  ## Interfaces
13
15
 
14
16
  | Interface | Documentation |
@@ -81,7 +83,7 @@ Then follow the [database interface guide](https://framework.antelopejs.com/docs
81
83
  Unlike the document-store backends, this module treats schema field declarations as real
82
84
  DDL: each AntelopeJS schema becomes a PostgreSQL schema, each table a real table, and each
83
85
  declared scalar field a natively typed, natively indexable column. Queries compile to a single
84
- SQL statement — filters become `WHERE` clauses, joins become `JOIN`s, and a `filter` or `orderBy`
86
+ SQL statement. Filters become `WHERE` clauses, joins become `JOIN`s, and a `filter` or `orderBy`
85
87
  over a declared field reaches its btree index.
86
88
 
87
89
  - One PostgreSQL schema per AntelopeJS schema id
@@ -101,17 +103,27 @@ the only construct used above PostgreSQL 9.5.
101
103
 
102
104
  This repository documents what is specific to the PostgreSQL backend:
103
105
 
104
- | | |
105
- | ---------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- |
106
- | [Storage and schema](./docs/storage.md) | What a registered schema becomes in the database, the field-type table, what reaches an index, and how registration converges |
107
- | [Configuration](./docs/configuration.md) | Every option `construct` accepts |
108
- | [External mode](./docs/external-mode.md) | Reading tables the module did not create, in a database it does not own |
109
- | [Change feeds](./docs/change-feeds.md) | `changes()`, its ordering guarantee, its retention contract and its blind spots |
110
- | [Errors and refusals](./docs/errors.md) | Everything the module refuses, with the message it refuses by |
111
- | [Behaviour worth knowing](./docs/behaviour.md) | Things that answer rather than throw, where the answer may surprise you — including where this backend differs from the MongoDB and RethinkDB ones |
106
+ | | |
107
+ | ---------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- |
108
+ | [Storage and schema](./docs/storage.md) | What a registered schema becomes in the database, the field-type table, what reaches an index, and how registration converges |
109
+ | [Configuration](./docs/configuration.md) | Every option `construct` accepts |
110
+ | [External mode](./docs/external-mode.md) | Reading tables the module did not create, in a database it does not own |
111
+ | [Change feeds](./docs/change-feeds.md) | `changes()`, its ordering guarantee, its retention contract and its blind spots |
112
+ | [Errors and refusals](./docs/errors.md) | Everything the module refuses, with the message it refuses by |
113
+ | [Behaviour worth knowing](./docs/behaviour.md) | Things that answer rather than throw, where the answer may surprise you, including where this backend differs from the MongoDB and RethinkDB ones |
112
114
 
113
115
  ## Compatibility
114
116
 
117
+ <!-- antelopejs-docs-compat:start -->
118
+
119
+ | Package | Supported | Tested with |
120
+ | ---------------------------------------- | ---------------- | ----------- |
121
+ | `@antelopejs/interface-core` | `>=0.1.1 <1.0.0` | `0.2.0` |
122
+ | `@antelopejs/interface-database` | `>=0.2.0 <0.3.0` | `0.2.0` |
123
+ | `@antelopejs/interface-database-catalog` | `>=0.0.3 <0.1.0` | `0.0.3` |
124
+
125
+ <!-- antelopejs-docs-compat:end -->
126
+
115
127
  | Package | Supported range |
116
128
  | ---------------------------------------- | ---------------- |
117
129
  | `@antelopejs/interface-database` | `>=0.2.0 <0.3.0` |
package/package.json CHANGED
@@ -1,10 +1,12 @@
1
1
  {
2
2
  "name": "@antelopejs/postgres",
3
- "version": "0.2.3",
4
- "description": "PostgreSQL backend for AntelopeJS, implementing the Database interface on relational tables with native column types and indexes",
3
+ "version": "0.2.4",
4
+ "description": "PostgreSQL backend for AntelopeJS, implementing the Database interface on relational tables, with an external mode for existing databases.",
5
5
  "keywords": [
6
6
  "antelopejs",
7
7
  "database",
8
+ "existing-database",
9
+ "pg",
8
10
  "postgres",
9
11
  "postgresql",
10
12
  "sql"
@@ -58,7 +60,7 @@
58
60
  },
59
61
  "devDependencies": {
60
62
  "@antelopejs/core": "^1.14.0",
61
- "@antelopejs/tooling-configs": "^0.2.11",
63
+ "@antelopejs/tooling-configs": "^0.2.17",
62
64
  "@testcontainers/postgresql": "^12.0.4",
63
65
  "@types/chai": "^4.3.20",
64
66
  "@types/mocha": "^10.0.10",