@uql/mongo
Advanced tools
Comparing version 0.4.90 to 0.4.91
@@ -6,3 +6,3 @@ { | ||
"license": "MIT", | ||
"version": "0.4.90", | ||
"version": "0.4.91", | ||
"main": "index.js", | ||
@@ -25,3 +25,3 @@ "types": "index.d.ts", | ||
"@types/node": "^17.0.23", | ||
"@uql/core": "^0.4.90", | ||
"@uql/core": "^0.4.91", | ||
"copyfiles": "^2.4.1", | ||
@@ -28,0 +28,0 @@ "rimraf": "^3.0.2", |
@@ -5,3 +5,3 @@ # [uql](https://uql.io) · [![license](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/rogerpadilla/uql/blob/main/LICENSE) [![tests](https://github.com/rogerpadilla/uql/actions/workflows/tests.yml/badge.svg)](https://github.com/rogerpadilla/uql) [![coverage status](https://coveralls.io/repos/rogerpadilla/uql/badge.svg?branch=main)](https://coveralls.io/r/rogerpadilla/uql?branch=main) [![npm version](https://badge.fury.io/js/%40uql%2Fcore.svg)](https://badge.fury.io/js/%40uql%2Fcore) | ||
# Quick Start | ||
## Quick Start | ||
@@ -12,3 +12,3 @@ `uql` is a flexible and efficient `ORM`, with declarative `JSON` syntax and really smart type-safety. | ||
## <a name="features"></a> Features | ||
### <a name="features"></a> Features | ||
@@ -24,47 +24,47 @@ - `JSON` (serializable) syntax for all the [queries](https://uql.io/docs/querying-logical-operators). | ||
## <a name="installation"></a> Installation | ||
### <a name="installation"></a> Installation | ||
1. Install the core package: | ||
```sh | ||
npm install @uql/core --save | ||
``` | ||
```sh | ||
npm install @uql/core --save | ||
``` | ||
or | ||
or | ||
```sh | ||
yarn add @uql/core | ||
``` | ||
```sh | ||
yarn add @uql/core | ||
``` | ||
2. Install one of the specific packages according to your database: | ||
| Database | Package | | ||
| ------------ | --------------- | | ||
| `MySQL` | `@uql/mysql` | | ||
| `PostgreSQL` | `@uql/postgres` | | ||
| `MariaDB` | `@uql/maria` | | ||
| `MongoDB` | `@uql/mongo` | | ||
| `SQLite` | `@uql/sqlite` | | ||
| Database | Package | | ||
| ------------ | --------------- | | ||
| `MySQL` | `@uql/mysql` | | ||
| `PostgreSQL` | `@uql/postgres` | | ||
| `MariaDB` | `@uql/maria` | | ||
| `MongoDB` | `@uql/mongo` | | ||
| `SQLite` | `@uql/sqlite` | | ||
E.g. for `PostgreSQL` | ||
E.g. for `PostgreSQL` | ||
```sh | ||
npm install @uql/postgres --save | ||
``` | ||
```sh | ||
npm install @uql/postgres --save | ||
``` | ||
or with _yarn_ | ||
or with _yarn_ | ||
```sh | ||
yarn add @uql/postgres | ||
``` | ||
```sh | ||
yarn add @uql/postgres | ||
``` | ||
3. Additionally, your `tsconfig.json` may need the following flags: | ||
```json | ||
"target": "es2020", | ||
"experimentalDecorators": true, | ||
"emitDecoratorMetadata": true | ||
``` | ||
```json | ||
"target": "es2020", | ||
"experimentalDecorators": true, | ||
"emitDecoratorMetadata": true | ||
``` | ||
## <a name="configuration"></a> Configuration | ||
### <a name="configuration"></a> Configuration | ||
@@ -91,3 +91,3 @@ A default querier-pool can be set in any of the bootstrap files of your app (e.g. in the `server.ts`). | ||
## <a name="definition-of-entities"></a> Definition of Entities | ||
### <a name="definition-of-entities"></a> Definition of Entities | ||
@@ -158,3 +158,3 @@ Take any dump class (aka DTO) and annotate it with the decorators from `'@uql/core/entity'`. | ||
## <a name="creation-of-queries"></a> Creation of Queries | ||
### <a name="data-query"></a> Data query | ||
@@ -161,0 +161,0 @@ ```ts |
Sorry, the diff of this file is not supported yet
91064