|
|
@@ -2,6 +2,25 @@
|
|
|
|
|
|
Абстракция для работы с базами данных для Node.js
|
|
|
|
|
|
+- [Установка](#Установка)
|
|
|
+- [Концепция](#Концепция)
|
|
|
+- [Точка входа](#Точка-входа)
|
|
|
+- [Источник данных](#Источник-данных)
|
|
|
+ - [Параметры источника](#Параметры-источника)
|
|
|
+- [Модель данных](#Модель-данных)
|
|
|
+ - [Параметры модели](#Параметры-модели)
|
|
|
+ - [Типы данных](#Типы-данных)
|
|
|
+ - [Параметры поля](#Параметры-поля)
|
|
|
+- [Репозиторий](#Репозиторий)
|
|
|
+ - [Методы](#Методы)
|
|
|
+ - [Параметры](#Параметры)
|
|
|
+ - [Фильтрация](#Фильтрация)
|
|
|
+ - [where](#where)
|
|
|
+ - [filter](#filter)
|
|
|
+ - [order](#order)
|
|
|
+ - [limit и skip](#limit-и-skip)
|
|
|
+ - [fields](#limit-и-skip)
|
|
|
+
|
|
|
## Установка
|
|
|
|
|
|
```bash
|
|
|
@@ -72,7 +91,7 @@ schema.defineDatasource({
|
|
|
});
|
|
|
```
|
|
|
|
|
|
-**Параметры источника:**
|
|
|
+#### Параметры источника
|
|
|
|
|
|
- `name: string` уникальное название
|
|
|
- `adapter: string` выбранный адаптер
|
|
|
@@ -109,7 +128,7 @@ schema.defineModel({
|
|
|
});
|
|
|
```
|
|
|
|
|
|
-**Параметры модели:**
|
|
|
+#### Параметры модели
|
|
|
|
|
|
- `name: string` уникальное название (обязательно)
|
|
|
- `datasource: string` выбранный источник данных
|
|
|
@@ -132,7 +151,7 @@ schema.defineModel({
|
|
|
});
|
|
|
```
|
|
|
|
|
|
-**Типы данных:**
|
|
|
+#### Типы данных
|
|
|
|
|
|
- `DataType.ANY`
|
|
|
- `DataType.STRING`
|
|
|
@@ -186,7 +205,7 @@ schema.defineModel({
|
|
|
});
|
|
|
```
|
|
|
|
|
|
-**Параметры поля:**
|
|
|
+#### Параметры поля
|
|
|
|
|
|
- `type: string` тип допустимого значения (обязательно)
|
|
|
- `itemType: string` тип элемента массива (для `type: 'array'`)
|
|
|
@@ -207,7 +226,7 @@ schema.defineModel({
|
|
|
const rep = schema.getRepository('place');
|
|
|
```
|
|
|
|
|
|
-**Методы:**
|
|
|
+#### Методы
|
|
|
|
|
|
- `create(data, filter = undefined)` добавить новый документ
|
|
|
- `replaceById(id, data, filter = undefined)` заменить весь документ
|
|
|
@@ -221,7 +240,7 @@ const rep = schema.getRepository('place');
|
|
|
- `exists(id)` проверить существование по идентификатору
|
|
|
- `count(where = undefined)` подсчет всех документов или по условию
|
|
|
|
|
|
-**Параметры:**
|
|
|
+#### Параметры
|
|
|
|
|
|
- `id` идентификатор (первичный ключ)
|
|
|
- `data` объект отражающий состав документа
|
e22m4u