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

Commit 363349d

Browse files
authored
docs(readme): add limitations section
1 parent ebc7d7f commit 363349d

File tree

1 file changed

+12
-0
lines changed

1 file changed

+12
-0
lines changed

README.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@
44

55
This is a loopback 4 extension that provides Sequelize powered repository methods which is more performant than juggler (the default ORM in Loopback) for relational databases.
66

7+
For pending features, refer to the [Limitations](#limitations) section below.
8+
79
## Installation
810

911
```sh
@@ -47,6 +49,16 @@ export class YourRepository extends SequelizeRepository<
4749
}
4850
```
4951

52+
## Limitations
53+
54+
Please note, the current implementation does not support the following:
55+
56+
1. Relational Query Support (currently only basic CRUD is supported with loopback style filters).
57+
2. SQL Transactions.
58+
3. Sequelize Powered Migrations.
59+
60+
Community contribution is welcome.
61+
5062
## Feedback
5163

5264
If you've noticed a bug or have a question or have a feature request, [search the issue tracker](https://github.com/sourcefuse/loopback4-sequelize/issues) to see if someone else in the community has already created a ticket.

0 commit comments

Comments
 (0)