Skip to content
This repository was archived by the owner on Sep 4, 2024. It is now read-only.

Commit 025a217

Browse files
committed
docs(readme): update limitations
1 parent c99bb59 commit 025a217

File tree

1 file changed

+6
-7
lines changed

1 file changed

+6
-7
lines changed

README.md

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
[![LoopBack](<https://github.com/loopbackio/loopback-next/raw/master/docs/site/imgs/branding/Powered-by-LoopBack-Badge-(blue)-@2x.png>)](http://loopback.io/)
44

5-
This is a loopback4 extension that provides Sequelize's query builder at repository level in any loopback 4 application. It has zero learning curve as it follows the same interface as `DefaultCrudRepository`. For relational databases, Sequelize is a popular ORM of choice.
5+
This is a loopback4 extension that provides Sequelize's query builder at repository level in any loopback 4 application. It has zero learning curve as it follows similar interface as `DefaultCrudRepository`. For relational databases, Sequelize is a popular ORM of choice.
66

77
For pending features, refer to the [Limitations](#limitations) section below.
88

@@ -36,13 +36,13 @@ export class PgDataSource
3636

3737
### Step 2: Configure Repository
3838

39-
Change the parent class from `DefaultCrudRepository` to `SequelizeRepository` like below.
39+
Change the parent class from `DefaultCrudRepository` to `SequelizeCrudRepository` like below.
4040

4141
```ts
4242
// ...
43-
import {SequelizeRepository} from 'loopback4-sequelize';
43+
import {SequelizeCrudRepository} from 'loopback4-sequelize';
4444

45-
export class YourRepository extends SequelizeRepository<
45+
export class YourRepository extends SequelizeCrudRepository<
4646
YourModel,
4747
typeof YourModel.prototype.id,
4848
YourModelRelations
@@ -55,9 +55,8 @@ export class YourRepository extends SequelizeRepository<
5555

5656
Please note, the current implementation does not support the following:
5757

58-
1. Relational Query Support (currently only basic CRUD is supported with loopback style filters).
59-
2. SQL Transactions.
60-
3. Sequelize Powered Migrations.
58+
1. SQL Transactions.
59+
2. Sequelize Powered Migrations.
6160

6261
Community contribution is welcome.
6362

0 commit comments

Comments
 (0)