@loopback/docs 5.2.0 → 6.0.0
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.
- package/CHANGELOG.md +37 -0
- package/package.json +5 -5
- package/site/Application-generator.md +1 -1
- package/site/CHANGELOG.md +1 -0
- package/site/Calling-rest-apis.md +11 -0
- package/site/Discovering-models.md +5 -0
- package/site/OpenAPI-generator.md +94 -2
- package/site/apidocs/sequelize.md +1 -1
- package/site/apidocs/sequelize.sequelizecrudrepository.begintransaction.md +32 -0
- package/site/apidocs/sequelize.sequelizecrudrepository.db_specific_settings_keys.md +1 -1
- package/site/apidocs/sequelize.sequelizecrudrepository.md +2 -1
- package/site/apidocs/sequelize.sequelizedatasource.begintransaction.md +36 -0
- package/site/apidocs/sequelize.sequelizedatasource.getpooloptions.md +25 -0
- package/site/apidocs/sequelize.sequelizedatasource.md +4 -0
- package/site/apidocs/sequelize.sequelizedatasource.stop.md +2 -2
- package/site/apidocs/typeorm.md +0 -1
- package/site/changelogs/bodyparsers/rest-msgpack/CHANGELOG.md +19 -0
- package/site/changelogs/examples/access-control-migration/CHANGELOG.md +19 -0
- package/site/changelogs/examples/binding-resolution/CHANGELOG.md +19 -0
- package/site/changelogs/examples/context/CHANGELOG.md +19 -0
- package/site/changelogs/examples/express-composition/CHANGELOG.md +19 -0
- package/site/changelogs/examples/file-transfer/CHANGELOG.md +19 -0
- package/site/changelogs/examples/graphql/CHANGELOG.md +19 -0
- package/site/changelogs/examples/greeter-extension/CHANGELOG.md +19 -0
- package/site/changelogs/examples/greeting-app/CHANGELOG.md +19 -0
- package/site/changelogs/examples/hello-world/CHANGELOG.md +19 -0
- package/site/changelogs/examples/lb3-application/CHANGELOG.md +19 -0
- package/site/changelogs/examples/log-extension/CHANGELOG.md +19 -0
- package/site/changelogs/examples/metrics-prometheus/CHANGELOG.md +19 -0
- package/site/changelogs/examples/multi-tenancy/CHANGELOG.md +19 -0
- package/site/changelogs/examples/passport-login/CHANGELOG.md +19 -0
- package/site/changelogs/examples/references-many/CHANGELOG.md +19 -0
- package/site/changelogs/examples/rest-crud/CHANGELOG.md +19 -0
- package/site/changelogs/examples/rpc-server/CHANGELOG.md +19 -0
- package/site/changelogs/examples/soap-calculator/CHANGELOG.md +19 -0
- package/site/changelogs/examples/socketio/CHANGELOG.md +19 -0
- package/site/changelogs/examples/todo/CHANGELOG.md +19 -0
- package/site/changelogs/examples/todo-jwt/CHANGELOG.md +19 -0
- package/site/changelogs/examples/todo-list/CHANGELOG.md +19 -0
- package/site/changelogs/examples/validation-app/CHANGELOG.md +19 -0
- package/site/changelogs/examples/webpack/CHANGELOG.md +19 -0
- package/site/changelogs/extensions/apiconnect/CHANGELOG.md +19 -0
- package/site/changelogs/extensions/authentication-jwt/CHANGELOG.md +19 -0
- package/site/changelogs/extensions/authentication-passport/CHANGELOG.md +19 -0
- package/site/changelogs/extensions/context-explorer/CHANGELOG.md +19 -0
- package/site/changelogs/extensions/cron/CHANGELOG.md +19 -0
- package/site/changelogs/extensions/graphql/CHANGELOG.md +19 -0
- package/site/changelogs/extensions/health/CHANGELOG.md +19 -0
- package/site/changelogs/extensions/logging/CHANGELOG.md +19 -0
- package/site/changelogs/extensions/metrics/CHANGELOG.md +19 -0
- package/site/changelogs/extensions/pooling/CHANGELOG.md +19 -0
- package/site/changelogs/extensions/sequelize/CHANGELOG.md +39 -0
- package/site/changelogs/extensions/socketio/CHANGELOG.md +19 -0
- package/site/changelogs/extensions/typeorm/CHANGELOG.md +19 -0
- package/site/changelogs/fixtures/mock-oauth2-provider/CHANGELOG.md +19 -0
- package/site/changelogs/packages/authentication/CHANGELOG.md +19 -0
- package/site/changelogs/packages/authorization/CHANGELOG.md +19 -0
- package/site/changelogs/packages/boot/CHANGELOG.md +20 -0
- package/site/changelogs/packages/booter-lb3app/CHANGELOG.md +19 -0
- package/site/changelogs/packages/build/CHANGELOG.md +34 -0
- package/site/changelogs/packages/cli/CHANGELOG.md +35 -0
- package/site/changelogs/packages/context/CHANGELOG.md +19 -0
- package/site/changelogs/packages/core/CHANGELOG.md +19 -0
- package/site/changelogs/packages/eslint-config/CHANGELOG.md +31 -0
- package/site/changelogs/packages/express/CHANGELOG.md +19 -0
- package/site/changelogs/packages/filter/CHANGELOG.md +11 -0
- package/site/changelogs/packages/http-caching-proxy/CHANGELOG.md +32 -0
- package/site/changelogs/packages/http-server/CHANGELOG.md +19 -0
- package/site/changelogs/packages/metadata/CHANGELOG.md +11 -0
- package/site/changelogs/packages/model-api-builder/CHANGELOG.md +19 -0
- package/site/changelogs/packages/monorepo/CHANGELOG.md +31 -0
- package/site/changelogs/packages/openapi-spec-builder/CHANGELOG.md +11 -0
- package/site/changelogs/packages/openapi-v3/CHANGELOG.md +19 -0
- package/site/changelogs/packages/repository/CHANGELOG.md +25 -0
- package/site/changelogs/packages/repository-json-schema/CHANGELOG.md +19 -0
- package/site/changelogs/packages/repository-tests/CHANGELOG.md +19 -0
- package/site/changelogs/packages/rest/CHANGELOG.md +19 -0
- package/site/changelogs/packages/rest-crud/CHANGELOG.md +19 -0
- package/site/changelogs/packages/rest-explorer/CHANGELOG.md +19 -0
- package/site/changelogs/packages/security/CHANGELOG.md +19 -0
- package/site/changelogs/packages/service-proxy/CHANGELOG.md +19 -0
- package/site/changelogs/packages/testlab/CHANGELOG.md +31 -0
- package/site/changelogs/packages/tsdocs/CHANGELOG.md +19 -0
- package/site/readmes/loopback-next/extensions/sequelize/README.md +79 -3
- package/site/apidocs/typeorm.propertytype.md +0 -23
package/CHANGELOG.md
CHANGED
|
@@ -3,6 +3,43 @@
|
|
|
3
3
|
All notable changes to this project will be documented in this file.
|
|
4
4
|
See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
|
|
5
5
|
|
|
6
|
+
# [6.0.0](https://github.com/loopbackio/loopback-next/compare/@loopback/docs@5.2.1...@loopback/docs@6.0.0) (2023-05-15)
|
|
7
|
+
|
|
8
|
+
|
|
9
|
+
### Bug Fixes
|
|
10
|
+
|
|
11
|
+
* **cli:** openapi generator implementation for controllers ([611a533](https://github.com/loopbackio/loopback-next/commit/611a533a4f773fc4dc6d42b78ae05e78f03c2e22))
|
|
12
|
+
|
|
13
|
+
|
|
14
|
+
### Features
|
|
15
|
+
|
|
16
|
+
* add support for node v20 ([e23cefa](https://github.com/loopbackio/loopback-next/commit/e23cefaf5cce3fb990cb09f4c94239d1979615b1))
|
|
17
|
+
* remove support for node v14 ([5425762](https://github.com/loopbackio/loopback-next/commit/5425762f1353869994acf081bcda4816e6a9c3b0))
|
|
18
|
+
* remove support for node v19 ([e26a2ac](https://github.com/loopbackio/loopback-next/commit/e26a2ac2e43245d09dfc9721ccfa41d830daccb8))
|
|
19
|
+
|
|
20
|
+
|
|
21
|
+
### BREAKING CHANGES
|
|
22
|
+
|
|
23
|
+
* End of life of Node v14
|
|
24
|
+
|
|
25
|
+
Signed-off-by: Francisco Buceta <frbuceta@gmail.com>
|
|
26
|
+
|
|
27
|
+
|
|
28
|
+
|
|
29
|
+
|
|
30
|
+
|
|
31
|
+
## [5.2.1](https://github.com/loopbackio/loopback-next/compare/@loopback/docs@5.2.0...@loopback/docs@5.2.1) (2023-04-13)
|
|
32
|
+
|
|
33
|
+
|
|
34
|
+
### Bug Fixes
|
|
35
|
+
|
|
36
|
+
* **cli:** pass flags to mysql-connector while lb4 discover ([357d0c3](https://github.com/loopbackio/loopback-next/commit/357d0c3c1b0dae27b1b2fafa4a04c9e170d4cff2))
|
|
37
|
+
* refresh package lock files ([9979eb1](https://github.com/loopbackio/loopback-next/commit/9979eb183b6c6cd5775da7478cdede8a92ce0d5e)), closes [#9351](https://github.com/loopbackio/loopback-next/issues/9351)
|
|
38
|
+
|
|
39
|
+
|
|
40
|
+
|
|
41
|
+
|
|
42
|
+
|
|
6
43
|
# [5.2.0](https://github.com/loopbackio/loopback-next/compare/@loopback/docs@5.1.7...@loopback/docs@5.2.0) (2023-03-09)
|
|
7
44
|
|
|
8
45
|
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@loopback/docs",
|
|
3
3
|
"description": "Documentation files rendered at [https://loopback.io](https://loopback.io)",
|
|
4
|
-
"version": "
|
|
4
|
+
"version": "6.0.0",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"LoopBack",
|
|
7
7
|
"docs"
|
|
@@ -16,7 +16,7 @@
|
|
|
16
16
|
"directory": "docs"
|
|
17
17
|
},
|
|
18
18
|
"engines": {
|
|
19
|
-
"node": "
|
|
19
|
+
"node": "16 || 18 || 20"
|
|
20
20
|
},
|
|
21
21
|
"scripts": {
|
|
22
22
|
"version": "node ./bin/copy-readmes.js && node ./bin/copy-changelogs.js && cd .. && npm run tsdocs",
|
|
@@ -32,12 +32,12 @@
|
|
|
32
32
|
"site/"
|
|
33
33
|
],
|
|
34
34
|
"dependencies": {
|
|
35
|
-
"fs-extra": "^
|
|
35
|
+
"fs-extra": "^11.1.1",
|
|
36
36
|
"tslib": "^2.5.0"
|
|
37
37
|
},
|
|
38
38
|
"devDependencies": {
|
|
39
39
|
"@lerna/project": "^6.4.1",
|
|
40
|
-
"@loopback/build": "^
|
|
40
|
+
"@loopback/build": "^10.0.0"
|
|
41
41
|
},
|
|
42
|
-
"gitHead": "
|
|
42
|
+
"gitHead": "97a26bd5973830a1d5f28aa2f58040f953995c17"
|
|
43
43
|
}
|
|
@@ -20,7 +20,7 @@ lb4 [app] [options] [<name>]
|
|
|
20
20
|
|
|
21
21
|
`--description` : Description of the application.
|
|
22
22
|
|
|
23
|
-
`--
|
|
23
|
+
`--outdir` : Project root directory for the application.
|
|
24
24
|
|
|
25
25
|
`--eslint` : Add ESLint to LoopBack4 application project.
|
|
26
26
|
|
package/site/CHANGELOG.md
CHANGED
|
@@ -55,6 +55,7 @@ permalink: /doc/en/lb4/changelog.index.html
|
|
|
55
55
|
- [@loopback/logging](changelogs/extensions/logging/CHANGELOG.md)
|
|
56
56
|
- [@loopback/metrics](changelogs/extensions/metrics/CHANGELOG.md)
|
|
57
57
|
- [@loopback/pooling](changelogs/extensions/pooling/CHANGELOG.md)
|
|
58
|
+
- [@loopback/sequelize](changelogs/extensions/sequelize/CHANGELOG.md)
|
|
58
59
|
- [@loopback/socketio](changelogs/extensions/socketio/CHANGELOG.md)
|
|
59
60
|
- [@loopback/typeorm](changelogs/extensions/typeorm/CHANGELOG.md)
|
|
60
61
|
|
|
@@ -154,6 +154,17 @@ Service interface.
|
|
|
154
154
|
}
|
|
155
155
|
```
|
|
156
156
|
|
|
157
|
+
```ts
|
|
158
|
+
@post('/people')
|
|
159
|
+
async getPeople(
|
|
160
|
+
@param.query.string('name') name: string,
|
|
161
|
+
): Promise<object> {
|
|
162
|
+
//Preconditions
|
|
163
|
+
|
|
164
|
+
return this.peopleService.getPeople(name);
|
|
165
|
+
}
|
|
166
|
+
```
|
|
167
|
+
|
|
157
168
|
For calling Services with OpenAPI DataSource,
|
|
158
169
|
|
|
159
170
|
- the parameters need to be wrapped in a JSON object
|
|
@@ -55,6 +55,11 @@ discover
|
|
|
55
55
|
|
|
56
56
|
not required
|
|
57
57
|
|
|
58
|
+
`--connectorDiscoveryOptions`: Pass the options to the connectors. For example:
|
|
59
|
+
Passing `--connectorDiscoveryOptions = '{"treatTINYINT1AsTinyInt":false}'` to
|
|
60
|
+
`loopback-mysql-connector` would make the connector treat `tinyint `as a
|
|
61
|
+
`boolean`.
|
|
62
|
+
|
|
58
63
|
### Interactive Prompts
|
|
59
64
|
|
|
60
65
|
Based on the option, the tool may prompt you for:
|
|
@@ -31,8 +31,8 @@ lb4 openapi [<url>] [options]
|
|
|
31
31
|
- `--validate`: Validate the OpenAPI spec. Default: `false`.
|
|
32
32
|
- `--promote-anonymous-schemas`: Promote anonymous schemas as models classes.
|
|
33
33
|
Default: `false`.
|
|
34
|
-
- `--client`: Generate client-side service proxies
|
|
35
|
-
`false`.
|
|
34
|
+
- `--client`: Generate client-side service proxies and controllers with
|
|
35
|
+
implementation for the OpenAPI spec Default: `false`.
|
|
36
36
|
- `--datasource`: A valid datasource name
|
|
37
37
|
- `--positional`: A flag to control if service methods use positional parameters
|
|
38
38
|
or an object with named properties. Default: `true`.
|
|
@@ -520,6 +520,98 @@ export class CustomerServiceProvider implements Provider<CustomerService> {
|
|
|
520
520
|
}
|
|
521
521
|
````
|
|
522
522
|
|
|
523
|
+
Along with service interface and proxy, controller implementation for each tag
|
|
524
|
+
is generated by consuming the generated services.
|
|
525
|
+
|
|
526
|
+
{% include code-caption.html content="src/services/customer.controller.ts"
|
|
527
|
+
%}
|
|
528
|
+
|
|
529
|
+
```
|
|
530
|
+
import {operation, param} from '@loopback/rest';
|
|
531
|
+
import {DateTime} from '../models/date-time.model';
|
|
532
|
+
import {inject} from '@loopback/core';
|
|
533
|
+
import {CustomerService} from '../services';'
|
|
534
|
+
/**
|
|
535
|
+
* The controller class is generated from OpenAPI spec with operations tagged
|
|
536
|
+
* by account
|
|
537
|
+
*
|
|
538
|
+
*/
|
|
539
|
+
export class AccountController {
|
|
540
|
+
constructor(@inject('services.CustomerServic')
|
|
541
|
+
protected customerService: CustomerService) {}
|
|
542
|
+
|
|
543
|
+
/**
|
|
544
|
+
* Get list of carts.
|
|
545
|
+
*/
|
|
546
|
+
@operation('get', '/account.cart.list.json')
|
|
547
|
+
async accountCartList(
|
|
548
|
+
@param({name: 'params', in: 'query'}) params: string,
|
|
549
|
+
@param({name: 'exclude', in: 'query'}) exclude: string,
|
|
550
|
+
@param({name: 'request_from_date', in: 'query'}) request_from_date: string,
|
|
551
|
+
@param({name: 'request_to_date', in: 'query'}) request_to_date: string,
|
|
552
|
+
): Promise<{
|
|
553
|
+
result?: {
|
|
554
|
+
carts?: {
|
|
555
|
+
cart_id?: string;
|
|
556
|
+
id?: string;
|
|
557
|
+
store_key?: string;
|
|
558
|
+
total_calls?: string;
|
|
559
|
+
url?: string;
|
|
560
|
+
}[];
|
|
561
|
+
carts_count?: number;
|
|
562
|
+
};
|
|
563
|
+
return_code?: number;
|
|
564
|
+
return_message?: string;
|
|
565
|
+
}> {
|
|
566
|
+
return this.customerService.accountCartList(params, exclude, request_from_date, request_to_date);
|
|
567
|
+
}
|
|
568
|
+
|
|
569
|
+
/**
|
|
570
|
+
* Update configs in the API2Cart database.
|
|
571
|
+
*/
|
|
572
|
+
@operation('put', '/account.config.update.json')
|
|
573
|
+
async accountConfigUpdate(
|
|
574
|
+
@param({name: 'db_tables_prefix', in: 'query'}) db_tables_prefix: string,
|
|
575
|
+
@param({name: 'client_id', in: 'query'}) client_id: string,
|
|
576
|
+
@param({name: 'bridge_url', in: 'query'}) bridge_url: string,
|
|
577
|
+
@param({name: 'store_root', in: 'query'}) store_root: string,
|
|
578
|
+
@param({name: 'shared_secret', in: 'query'}) shared_secret: string,
|
|
579
|
+
): Promise<{
|
|
580
|
+
result?: {
|
|
581
|
+
updated_items?: number;
|
|
582
|
+
};
|
|
583
|
+
return_code?: number;
|
|
584
|
+
return_message?: string;
|
|
585
|
+
}> {
|
|
586
|
+
return this.customerService.accountConfigUpdate(db_tables_prefix, client_id, bridge_url, store_roo, shared_secret);
|
|
587
|
+
}
|
|
588
|
+
|
|
589
|
+
/**
|
|
590
|
+
* List webhooks that was not delivered to the callback.
|
|
591
|
+
*/
|
|
592
|
+
@operation('get', '/account.failed_webhooks.json')
|
|
593
|
+
async accountFailedWebhooks(
|
|
594
|
+
@param({name: 'count', in: 'query'}) count: number,
|
|
595
|
+
@param({name: 'start', in: 'query'}) start: number,
|
|
596
|
+
@param({name: 'ids', in: 'query'}) ids: string,
|
|
597
|
+
): Promise<{
|
|
598
|
+
result?: {
|
|
599
|
+
all_failed_webhook?: string;
|
|
600
|
+
webhook?: {
|
|
601
|
+
entity_id?: string;
|
|
602
|
+
time?: DateTime;
|
|
603
|
+
webhook_id?: number;
|
|
604
|
+
}[];
|
|
605
|
+
};
|
|
606
|
+
return_code?: number;
|
|
607
|
+
return_message?: string;
|
|
608
|
+
}> {
|
|
609
|
+
return this.customerService.accountFailedWebhooks(count, start, ids);
|
|
610
|
+
}
|
|
611
|
+
}
|
|
612
|
+
|
|
613
|
+
```
|
|
614
|
+
|
|
523
615
|
## OpenAPI Examples
|
|
524
616
|
|
|
525
617
|
Try out the following specs or your own with `lb4 openapi`:
|
|
@@ -21,7 +21,7 @@ permalink: /doc/en/lb4/apidocs.sequelize.html
|
|
|
21
21
|
| --- | --- |
|
|
22
22
|
| [LoopbackSequelizeComponent](./sequelize.loopbacksequelizecomponent.md) | |
|
|
23
23
|
| [SequelizeCrudRepository](./sequelize.sequelizecrudrepository.md) | Sequelize implementation of CRUD repository to be used with default loopback entities and SequelizeDataSource for SQL Databases |
|
|
24
|
-
| [SequelizeDataSource](./sequelize.sequelizedatasource.md) |
|
|
24
|
+
| [SequelizeDataSource](./sequelize.sequelizedatasource.md) | Sequelize DataSource Class |
|
|
25
25
|
|
|
26
26
|
## Interfaces
|
|
27
27
|
|
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
---
|
|
2
|
+
lang: en
|
|
3
|
+
title: 'API docs: sequelize.sequelizecrudrepository.begintransaction'
|
|
4
|
+
keywords: LoopBack 4.0, LoopBack 4, Node.js, TypeScript, OpenAPI
|
|
5
|
+
sidebar: lb4_sidebar
|
|
6
|
+
editurl: https://github.com/loopbackio/loopback-next/tree/master/extensions/sequelize
|
|
7
|
+
permalink: /doc/en/lb4/apidocs.sequelize.sequelizecrudrepository.begintransaction.html
|
|
8
|
+
---
|
|
9
|
+
|
|
10
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
11
|
+
|
|
12
|
+
[Home](./index.md) > [@loopback/sequelize](./sequelize.md) > [SequelizeCrudRepository](./sequelize.sequelizecrudrepository.md) > [beginTransaction](./sequelize.sequelizecrudrepository.begintransaction.md)
|
|
13
|
+
|
|
14
|
+
## SequelizeCrudRepository.beginTransaction() method
|
|
15
|
+
|
|
16
|
+
**Signature:**
|
|
17
|
+
|
|
18
|
+
```typescript
|
|
19
|
+
beginTransaction(options?: TransactionOptions | TransactionOptions['isolationLevel']): Promise<Transaction>;
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
## Parameters
|
|
23
|
+
|
|
24
|
+
| Parameter | Type | Description |
|
|
25
|
+
| --- | --- | --- |
|
|
26
|
+
| options | TransactionOptions \| TransactionOptions\['isolationLevel'\] | _(Optional)_ |
|
|
27
|
+
|
|
28
|
+
**Returns:**
|
|
29
|
+
|
|
30
|
+
Promise<Transaction>
|
|
31
|
+
|
|
32
|
+
|
|
@@ -13,7 +13,7 @@ permalink: /doc/en/lb4/apidocs.sequelize.sequelizecrudrepository.db_specific_set
|
|
|
13
13
|
|
|
14
14
|
## SequelizeCrudRepository.DB\_SPECIFIC\_SETTINGS\_KEYS property
|
|
15
15
|
|
|
16
|
-
Object keys used in models for set database specific settings. Example: In model property definition one can use postgresql dataType as float { type: 'number', postgresql: { dataType: 'float', precision: 20, scale: 4, }
|
|
16
|
+
Object keys used in models for set database specific settings. Example: In model property definition one can use postgresql dataType as float `{ type: 'number', postgresql: { dataType: 'float', precision: 20, scale: 4, }, }`
|
|
17
17
|
|
|
18
18
|
This array of keys is used while building model definition for sequelize.
|
|
19
19
|
|
|
@@ -33,7 +33,7 @@ export declare class SequelizeCrudRepository<T extends Entity, ID, Relations ext
|
|
|
33
33
|
| Property | Modifiers | Type | Description |
|
|
34
34
|
| --- | --- | --- | --- |
|
|
35
35
|
| [dataSource](./sequelize.sequelizecrudrepository.datasource.md) | | [SequelizeDataSource](./sequelize.sequelizedatasource.md) | |
|
|
36
|
-
| [DB\_SPECIFIC\_SETTINGS\_KEYS](./sequelize.sequelizecrudrepository.db_specific_settings_keys.md) | <code>readonly</code> | readonly \["postgresql", "mysql", "sqlite3"\] | <p>Object keys used in models for set database specific settings. Example: In model property definition one can use postgresql dataType as float { type: 'number', postgresql: { dataType: 'float', precision: 20, scale: 4, }
|
|
36
|
+
| [DB\_SPECIFIC\_SETTINGS\_KEYS](./sequelize.sequelizecrudrepository.db_specific_settings_keys.md) | <code>readonly</code> | readonly \["postgresql", "mysql", "sqlite3"\] | <p>Object keys used in models for set database specific settings. Example: In model property definition one can use postgresql dataType as float <code>{ type: 'number', postgresql: { dataType: 'float', precision: 20, scale: 4, }, }</code></p><p>This array of keys is used while building model definition for sequelize.</p> |
|
|
37
37
|
| [DEFAULT\_ORDER\_STYLE](./sequelize.sequelizecrudrepository.default_order_style.md) | <code>readonly</code> | (not declared) | Default <code>order</code> filter style if only column name is specified |
|
|
38
38
|
| [entityClass](./sequelize.sequelizecrudrepository.entityclass.md) | | typeof [Entity](./repository.entity.md) & { prototype: T; } | |
|
|
39
39
|
| [inclusionResolvers](./sequelize.sequelizecrudrepository.inclusionresolvers.md) | <code>readonly</code> | Map<string, [InclusionResolver](./repository.inclusionresolver.md)<!-- --><T, [Entity](./repository.entity.md)<!-- -->>> | |
|
|
@@ -43,6 +43,7 @@ export declare class SequelizeCrudRepository<T extends Entity, ID, Relations ext
|
|
|
43
43
|
|
|
44
44
|
| Method | Modifiers | Description |
|
|
45
45
|
| --- | --- | --- |
|
|
46
|
+
| [beginTransaction(options)](./sequelize.sequelizecrudrepository.begintransaction.md) | | |
|
|
46
47
|
| [buildSequelizeAttributeFilter(fields)](./sequelize.sequelizecrudrepository.buildsequelizeattributefilter.md) | <code>protected</code> | Get Sequelize <code>attributes</code> filter value from <code>fields</code> of loopback. |
|
|
47
48
|
| [buildSequelizeIncludeFilter(inclusionFilters, sourceModel)](./sequelize.sequelizecrudrepository.buildsequelizeincludefilter.md) | <code>protected</code> | Build Sequelize compatible <code>include</code> filter |
|
|
48
49
|
| [buildSequelizeOrder(order)](./sequelize.sequelizecrudrepository.buildsequelizeorder.md) | <code>protected</code> | Get Sequelize Order filter value from loopback style order value |
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
---
|
|
2
|
+
lang: en
|
|
3
|
+
title: 'API docs: sequelize.sequelizedatasource.begintransaction'
|
|
4
|
+
keywords: LoopBack 4.0, LoopBack 4, Node.js, TypeScript, OpenAPI
|
|
5
|
+
sidebar: lb4_sidebar
|
|
6
|
+
editurl: https://github.com/loopbackio/loopback-next/tree/master/extensions/sequelize
|
|
7
|
+
permalink: /doc/en/lb4/apidocs.sequelize.sequelizedatasource.begintransaction.html
|
|
8
|
+
---
|
|
9
|
+
|
|
10
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
11
|
+
|
|
12
|
+
[Home](./index.md) > [@loopback/sequelize](./sequelize.md) > [SequelizeDataSource](./sequelize.sequelizedatasource.md) > [beginTransaction](./sequelize.sequelizedatasource.begintransaction.md)
|
|
13
|
+
|
|
14
|
+
## SequelizeDataSource.beginTransaction() method
|
|
15
|
+
|
|
16
|
+
Begin a new transaction.
|
|
17
|
+
|
|
18
|
+
**Signature:**
|
|
19
|
+
|
|
20
|
+
```typescript
|
|
21
|
+
beginTransaction(options?: TransactionOptions | TransactionOptions['isolationLevel']): Promise<Transaction>;
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
## Parameters
|
|
25
|
+
|
|
26
|
+
| Parameter | Type | Description |
|
|
27
|
+
| --- | --- | --- |
|
|
28
|
+
| options | TransactionOptions \| TransactionOptions\['isolationLevel'\] | _(Optional)_ Options {<!-- -->isolationLevel: '...'<!-- -->} |
|
|
29
|
+
|
|
30
|
+
**Returns:**
|
|
31
|
+
|
|
32
|
+
Promise<Transaction>
|
|
33
|
+
|
|
34
|
+
A promise which resolves to a Sequelize Transaction object
|
|
35
|
+
|
|
36
|
+
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
---
|
|
2
|
+
lang: en
|
|
3
|
+
title: 'API docs: sequelize.sequelizedatasource.getpooloptions'
|
|
4
|
+
keywords: LoopBack 4.0, LoopBack 4, Node.js, TypeScript, OpenAPI
|
|
5
|
+
sidebar: lb4_sidebar
|
|
6
|
+
editurl: https://github.com/loopbackio/loopback-next/tree/master/extensions/sequelize
|
|
7
|
+
permalink: /doc/en/lb4/apidocs.sequelize.sequelizedatasource.getpooloptions.html
|
|
8
|
+
---
|
|
9
|
+
|
|
10
|
+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
|
|
11
|
+
|
|
12
|
+
[Home](./index.md) > [@loopback/sequelize](./sequelize.md) > [SequelizeDataSource](./sequelize.sequelizedatasource.md) > [getPoolOptions](./sequelize.sequelizedatasource.getpooloptions.md)
|
|
13
|
+
|
|
14
|
+
## SequelizeDataSource.getPoolOptions() method
|
|
15
|
+
|
|
16
|
+
**Signature:**
|
|
17
|
+
|
|
18
|
+
```typescript
|
|
19
|
+
getPoolOptions(): PoolOptions | undefined;
|
|
20
|
+
```
|
|
21
|
+
**Returns:**
|
|
22
|
+
|
|
23
|
+
PoolOptions \| undefined
|
|
24
|
+
|
|
25
|
+
|
|
@@ -13,6 +13,8 @@ permalink: /doc/en/lb4/apidocs.sequelize.sequelizedatasource.html
|
|
|
13
13
|
|
|
14
14
|
## SequelizeDataSource class
|
|
15
15
|
|
|
16
|
+
Sequelize DataSource Class
|
|
17
|
+
|
|
16
18
|
**Signature:**
|
|
17
19
|
|
|
18
20
|
```typescript
|
|
@@ -42,6 +44,8 @@ export declare class SequelizeDataSource implements LifeCycleObserver
|
|
|
42
44
|
| --- | --- | --- |
|
|
43
45
|
| [automigrate()](./sequelize.sequelizedatasource.automigrate.md) | | |
|
|
44
46
|
| [autoupdate()](./sequelize.sequelizedatasource.autoupdate.md) | | |
|
|
47
|
+
| [beginTransaction(options)](./sequelize.sequelizedatasource.begintransaction.md) | | Begin a new transaction. |
|
|
48
|
+
| [getPoolOptions()](./sequelize.sequelizedatasource.getpooloptions.md) | | |
|
|
45
49
|
| [init()](./sequelize.sequelizedatasource.init.md) | | |
|
|
46
50
|
| [start(\_injectedArgs)](./sequelize.sequelizedatasource.start.md) | | |
|
|
47
51
|
| [stop()](./sequelize.sequelizedatasource.stop.md) | | |
|
package/site/apidocs/typeorm.md
CHANGED
|
@@ -53,7 +53,6 @@ permalink: /doc/en/lb4/apidocs.typeorm.html
|
|
|
53
53
|
|
|
54
54
|
| Type Alias | Description |
|
|
55
55
|
| --- | --- |
|
|
56
|
-
| [PropertyType](./typeorm.propertytype.md) | |
|
|
57
56
|
| [StringifiedTypeOptions](./typeorm.stringifiedtypeoptions.md) | |
|
|
58
57
|
| [TypeOrmComponentOptions](./typeorm.typeormcomponentoptions.md) | |
|
|
59
58
|
|
|
@@ -13,6 +13,25 @@ permalink: /doc/en/lb4/changelog.rest-msgpack.html
|
|
|
13
13
|
All notable changes to this project will be documented in this file.
|
|
14
14
|
See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
|
|
15
15
|
|
|
16
|
+
## [0.8.10](https://github.com/loopbackio/loopback-next/compare/@loopback/rest-msgpack@0.8.9...@loopback/rest-msgpack@0.8.10) (2023-04-13)
|
|
17
|
+
|
|
18
|
+
|
|
19
|
+
### Bug Fixes
|
|
20
|
+
|
|
21
|
+
* refresh package lock files ([9979eb1](https://github.com/loopbackio/loopback-next/commit/9979eb183b6c6cd5775da7478cdede8a92ce0d5e)), closes [#9351](https://github.com/loopbackio/loopback-next/issues/9351)
|
|
22
|
+
|
|
23
|
+
|
|
24
|
+
|
|
25
|
+
|
|
26
|
+
|
|
27
|
+
## [0.8.9](https://github.com/loopbackio/loopback-next/compare/@loopback/rest-msgpack@0.8.8...@loopback/rest-msgpack@0.8.9) (2023-03-09)
|
|
28
|
+
|
|
29
|
+
**Note:** Version bump only for package @loopback/rest-msgpack
|
|
30
|
+
|
|
31
|
+
|
|
32
|
+
|
|
33
|
+
|
|
34
|
+
|
|
16
35
|
## [0.8.8](https://github.com/loopbackio/loopback-next/compare/@loopback/rest-msgpack@0.8.7...@loopback/rest-msgpack@0.8.8) (2023-02-07)
|
|
17
36
|
|
|
18
37
|
|
|
@@ -13,6 +13,25 @@ permalink: /doc/en/lb4/changelog.example-access-control-migration.html
|
|
|
13
13
|
All notable changes to this project will be documented in this file.
|
|
14
14
|
See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
|
|
15
15
|
|
|
16
|
+
## [5.0.10](https://github.com/loopbackio/loopback-next/compare/@loopback/example-access-control-migration@5.0.9...@loopback/example-access-control-migration@5.0.10) (2023-04-13)
|
|
17
|
+
|
|
18
|
+
|
|
19
|
+
### Bug Fixes
|
|
20
|
+
|
|
21
|
+
* refresh package lock files ([9979eb1](https://github.com/loopbackio/loopback-next/commit/9979eb183b6c6cd5775da7478cdede8a92ce0d5e)), closes [#9351](https://github.com/loopbackio/loopback-next/issues/9351)
|
|
22
|
+
|
|
23
|
+
|
|
24
|
+
|
|
25
|
+
|
|
26
|
+
|
|
27
|
+
## [5.0.9](https://github.com/loopbackio/loopback-next/compare/@loopback/example-access-control-migration@5.0.8...@loopback/example-access-control-migration@5.0.9) (2023-03-09)
|
|
28
|
+
|
|
29
|
+
**Note:** Version bump only for package @loopback/example-access-control-migration
|
|
30
|
+
|
|
31
|
+
|
|
32
|
+
|
|
33
|
+
|
|
34
|
+
|
|
16
35
|
## [5.0.8](https://github.com/loopbackio/loopback-next/compare/@loopback/example-access-control-migration@5.0.7...@loopback/example-access-control-migration@5.0.8) (2023-02-07)
|
|
17
36
|
|
|
18
37
|
**Note:** Version bump only for package @loopback/example-access-control-migration
|
|
@@ -13,6 +13,25 @@ permalink: /doc/en/lb4/changelog.example-binding-resolution.html
|
|
|
13
13
|
All notable changes to this project will be documented in this file.
|
|
14
14
|
See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
|
|
15
15
|
|
|
16
|
+
## [0.7.10](https://github.com/loopbackio/loopback-next/compare/@loopback/example-binding-resolution@0.7.9...@loopback/example-binding-resolution@0.7.10) (2023-04-13)
|
|
17
|
+
|
|
18
|
+
|
|
19
|
+
### Bug Fixes
|
|
20
|
+
|
|
21
|
+
* refresh package lock files ([9979eb1](https://github.com/loopbackio/loopback-next/commit/9979eb183b6c6cd5775da7478cdede8a92ce0d5e)), closes [#9351](https://github.com/loopbackio/loopback-next/issues/9351)
|
|
22
|
+
|
|
23
|
+
|
|
24
|
+
|
|
25
|
+
|
|
26
|
+
|
|
27
|
+
## [0.7.9](https://github.com/loopbackio/loopback-next/compare/@loopback/example-binding-resolution@0.7.8...@loopback/example-binding-resolution@0.7.9) (2023-03-09)
|
|
28
|
+
|
|
29
|
+
**Note:** Version bump only for package @loopback/example-binding-resolution
|
|
30
|
+
|
|
31
|
+
|
|
32
|
+
|
|
33
|
+
|
|
34
|
+
|
|
16
35
|
## [0.7.8](https://github.com/loopbackio/loopback-next/compare/@loopback/example-binding-resolution@0.7.7...@loopback/example-binding-resolution@0.7.8) (2023-02-07)
|
|
17
36
|
|
|
18
37
|
**Note:** Version bump only for package @loopback/example-binding-resolution
|
|
@@ -13,6 +13,25 @@ permalink: /doc/en/lb4/changelog.example-context.html
|
|
|
13
13
|
All notable changes to this project will be documented in this file.
|
|
14
14
|
See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
|
|
15
15
|
|
|
16
|
+
## [5.0.10](https://github.com/loopbackio/loopback-next/compare/@loopback/example-context@5.0.9...@loopback/example-context@5.0.10) (2023-04-13)
|
|
17
|
+
|
|
18
|
+
|
|
19
|
+
### Bug Fixes
|
|
20
|
+
|
|
21
|
+
* refresh package lock files ([9979eb1](https://github.com/loopbackio/loopback-next/commit/9979eb183b6c6cd5775da7478cdede8a92ce0d5e)), closes [#9351](https://github.com/loopbackio/loopback-next/issues/9351)
|
|
22
|
+
|
|
23
|
+
|
|
24
|
+
|
|
25
|
+
|
|
26
|
+
|
|
27
|
+
## [5.0.9](https://github.com/loopbackio/loopback-next/compare/@loopback/example-context@5.0.8...@loopback/example-context@5.0.9) (2023-03-09)
|
|
28
|
+
|
|
29
|
+
**Note:** Version bump only for package @loopback/example-context
|
|
30
|
+
|
|
31
|
+
|
|
32
|
+
|
|
33
|
+
|
|
34
|
+
|
|
16
35
|
## [5.0.8](https://github.com/loopbackio/loopback-next/compare/@loopback/example-context@5.0.7...@loopback/example-context@5.0.8) (2023-02-07)
|
|
17
36
|
|
|
18
37
|
**Note:** Version bump only for package @loopback/example-context
|
|
@@ -13,6 +13,25 @@ permalink: /doc/en/lb4/changelog.example-express-composition.html
|
|
|
13
13
|
All notable changes to this project will be documented in this file.
|
|
14
14
|
See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
|
|
15
15
|
|
|
16
|
+
## [5.0.10](https://github.com/loopbackio/loopback-next/compare/@loopback/example-express-composition@5.0.9...@loopback/example-express-composition@5.0.10) (2023-04-13)
|
|
17
|
+
|
|
18
|
+
|
|
19
|
+
### Bug Fixes
|
|
20
|
+
|
|
21
|
+
* refresh package lock files ([9979eb1](https://github.com/loopbackio/loopback-next/commit/9979eb183b6c6cd5775da7478cdede8a92ce0d5e)), closes [#9351](https://github.com/loopbackio/loopback-next/issues/9351)
|
|
22
|
+
|
|
23
|
+
|
|
24
|
+
|
|
25
|
+
|
|
26
|
+
|
|
27
|
+
## [5.0.9](https://github.com/loopbackio/loopback-next/compare/@loopback/example-express-composition@5.0.8...@loopback/example-express-composition@5.0.9) (2023-03-09)
|
|
28
|
+
|
|
29
|
+
**Note:** Version bump only for package @loopback/example-express-composition
|
|
30
|
+
|
|
31
|
+
|
|
32
|
+
|
|
33
|
+
|
|
34
|
+
|
|
16
35
|
## [5.0.8](https://github.com/loopbackio/loopback-next/compare/@loopback/example-express-composition@5.0.7...@loopback/example-express-composition@5.0.8) (2023-02-07)
|
|
17
36
|
|
|
18
37
|
**Note:** Version bump only for package @loopback/example-express-composition
|
|
@@ -13,6 +13,25 @@ permalink: /doc/en/lb4/changelog.example-file-transfer.html
|
|
|
13
13
|
All notable changes to this project will be documented in this file.
|
|
14
14
|
See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
|
|
15
15
|
|
|
16
|
+
## [4.0.10](https://github.com/loopbackio/loopback-next/compare/@loopback/example-file-transfer@4.0.9...@loopback/example-file-transfer@4.0.10) (2023-04-13)
|
|
17
|
+
|
|
18
|
+
|
|
19
|
+
### Bug Fixes
|
|
20
|
+
|
|
21
|
+
* refresh package lock files ([9979eb1](https://github.com/loopbackio/loopback-next/commit/9979eb183b6c6cd5775da7478cdede8a92ce0d5e)), closes [#9351](https://github.com/loopbackio/loopback-next/issues/9351)
|
|
22
|
+
|
|
23
|
+
|
|
24
|
+
|
|
25
|
+
|
|
26
|
+
|
|
27
|
+
## [4.0.9](https://github.com/loopbackio/loopback-next/compare/@loopback/example-file-transfer@4.0.8...@loopback/example-file-transfer@4.0.9) (2023-03-09)
|
|
28
|
+
|
|
29
|
+
**Note:** Version bump only for package @loopback/example-file-transfer
|
|
30
|
+
|
|
31
|
+
|
|
32
|
+
|
|
33
|
+
|
|
34
|
+
|
|
16
35
|
## [4.0.8](https://github.com/loopbackio/loopback-next/compare/@loopback/example-file-transfer@4.0.7...@loopback/example-file-transfer@4.0.8) (2023-02-07)
|
|
17
36
|
|
|
18
37
|
**Note:** Version bump only for package @loopback/example-file-transfer
|
|
@@ -13,6 +13,25 @@ permalink: /doc/en/lb4/changelog.example-graphql.html
|
|
|
13
13
|
All notable changes to this project will be documented in this file.
|
|
14
14
|
See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
|
|
15
15
|
|
|
16
|
+
## [0.7.10](https://github.com/loopbackio/loopback-next/compare/@loopback/example-graphql@0.7.9...@loopback/example-graphql@0.7.10) (2023-04-13)
|
|
17
|
+
|
|
18
|
+
|
|
19
|
+
### Bug Fixes
|
|
20
|
+
|
|
21
|
+
* refresh package lock files ([9979eb1](https://github.com/loopbackio/loopback-next/commit/9979eb183b6c6cd5775da7478cdede8a92ce0d5e)), closes [#9351](https://github.com/loopbackio/loopback-next/issues/9351)
|
|
22
|
+
|
|
23
|
+
|
|
24
|
+
|
|
25
|
+
|
|
26
|
+
|
|
27
|
+
## [0.7.9](https://github.com/loopbackio/loopback-next/compare/@loopback/example-graphql@0.7.8...@loopback/example-graphql@0.7.9) (2023-03-09)
|
|
28
|
+
|
|
29
|
+
**Note:** Version bump only for package @loopback/example-graphql
|
|
30
|
+
|
|
31
|
+
|
|
32
|
+
|
|
33
|
+
|
|
34
|
+
|
|
16
35
|
## [0.7.8](https://github.com/loopbackio/loopback-next/compare/@loopback/example-graphql@0.7.7...@loopback/example-graphql@0.7.8) (2023-02-07)
|
|
17
36
|
|
|
18
37
|
|
|
@@ -13,6 +13,25 @@ permalink: /doc/en/lb4/changelog.example-greeter-extension.html
|
|
|
13
13
|
All notable changes to this project will be documented in this file.
|
|
14
14
|
See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
|
|
15
15
|
|
|
16
|
+
## [5.0.10](https://github.com/loopbackio/loopback-next/compare/@loopback/example-greeter-extension@5.0.9...@loopback/example-greeter-extension@5.0.10) (2023-04-13)
|
|
17
|
+
|
|
18
|
+
|
|
19
|
+
### Bug Fixes
|
|
20
|
+
|
|
21
|
+
* refresh package lock files ([9979eb1](https://github.com/loopbackio/loopback-next/commit/9979eb183b6c6cd5775da7478cdede8a92ce0d5e)), closes [#9351](https://github.com/loopbackio/loopback-next/issues/9351)
|
|
22
|
+
|
|
23
|
+
|
|
24
|
+
|
|
25
|
+
|
|
26
|
+
|
|
27
|
+
## [5.0.9](https://github.com/loopbackio/loopback-next/compare/@loopback/example-greeter-extension@5.0.8...@loopback/example-greeter-extension@5.0.9) (2023-03-09)
|
|
28
|
+
|
|
29
|
+
**Note:** Version bump only for package @loopback/example-greeter-extension
|
|
30
|
+
|
|
31
|
+
|
|
32
|
+
|
|
33
|
+
|
|
34
|
+
|
|
16
35
|
## [5.0.8](https://github.com/loopbackio/loopback-next/compare/@loopback/example-greeter-extension@5.0.7...@loopback/example-greeter-extension@5.0.8) (2023-02-07)
|
|
17
36
|
|
|
18
37
|
**Note:** Version bump only for package @loopback/example-greeter-extension
|
|
@@ -13,6 +13,25 @@ permalink: /doc/en/lb4/changelog.example-greeting-app.html
|
|
|
13
13
|
All notable changes to this project will be documented in this file.
|
|
14
14
|
See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
|
|
15
15
|
|
|
16
|
+
## [5.0.10](https://github.com/loopbackio/loopback-next/compare/@loopback/example-greeting-app@5.0.9...@loopback/example-greeting-app@5.0.10) (2023-04-13)
|
|
17
|
+
|
|
18
|
+
|
|
19
|
+
### Bug Fixes
|
|
20
|
+
|
|
21
|
+
* refresh package lock files ([9979eb1](https://github.com/loopbackio/loopback-next/commit/9979eb183b6c6cd5775da7478cdede8a92ce0d5e)), closes [#9351](https://github.com/loopbackio/loopback-next/issues/9351)
|
|
22
|
+
|
|
23
|
+
|
|
24
|
+
|
|
25
|
+
|
|
26
|
+
|
|
27
|
+
## [5.0.9](https://github.com/loopbackio/loopback-next/compare/@loopback/example-greeting-app@5.0.8...@loopback/example-greeting-app@5.0.9) (2023-03-09)
|
|
28
|
+
|
|
29
|
+
**Note:** Version bump only for package @loopback/example-greeting-app
|
|
30
|
+
|
|
31
|
+
|
|
32
|
+
|
|
33
|
+
|
|
34
|
+
|
|
16
35
|
## [5.0.8](https://github.com/loopbackio/loopback-next/compare/@loopback/example-greeting-app@5.0.7...@loopback/example-greeting-app@5.0.8) (2023-02-07)
|
|
17
36
|
|
|
18
37
|
**Note:** Version bump only for package @loopback/example-greeting-app
|