As of 24th April 2023, loopback4-sequelize is fully deprecated. New changes are expected to land on the official replacement of this package here: @loopback/sequelize and the same is recommended for current and future users.
-@2x.png){kind=icon}
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.
For pending features, refer to the Limitations section below.
To install this extension in your Loopback 4 project, run the following command:
npm install loopback4-sequelizeYou'll also need to install the driver for your preferred database:
# One of the following:
npm install --save pg pg-hstore # Postgres
npm install --save mysql2
npm install --save mariadb
npm install --save sqlite3
npm install --save tedious # Microsoft SQL Server
npm install --save oracledb # Oracle DatabaseYou can watch a video overview of this extension by clicking here.
Both newly developed and existing projects can benefit from the extension by simply changing the parent classes in the target Data Source and Repositories.
Change the parent class from juggler.DataSource to SequelizeDataSource like below.
// ...
import {SequelizeDataSource} from 'loopback4-sequelize';
// ...
export class PgDataSource
extends SequelizeDataSource
implements LifeCycleObserver {
// ...
}SequelizeDataSource accepts commonly used config in the same way as loopback did. So in most cases you won't need to change your existing configuration. But if you want to use sequelize specific options pass them in sequelizeOptions like below:
let config = {
name: 'db',
connector: 'postgresql',
sequelizeOptions: {
username: 'postgres',
password: 'secret',
dialectOptions: {
ssl: {
rejectUnauthorized: false,
ca: fs.readFileSync('/path/to/root.crt').toString(),
},
},
},
};Note: Options provided in
sequelizeOptionswill take priority over others, For eg. if you have password specified in bothconfig.passwordandconfig.password.sequelizeOptionsthe latter one will be used.
Change the parent class from DefaultCrudRepository to SequelizeCrudRepository like below.
// ...
import {SequelizeCrudRepository} from 'loopback4-sequelize';
export class YourRepository extends SequelizeCrudRepository<
YourModel,
typeof YourModel.prototype.id,
YourModelRelations
> {
// ...
}With SequelizeCrudRepository, you can utilize following relations without any additional configuration:
The default relation configuration, generated using the lb4 relation command (i.e. inclusion resolvers in the repository and property decorators in the model), remain unchanged.
Check the demo video of using inner joins here: https://youtu.be/ZrUxIk63oRc?t=76
When using SequelizeCrudRepository, the find(), findOne(), and findById() methods accept a new option called required in the include filter. Setting this option to true will result in an inner join query that explicitly requires the specified condition for the child model. If the row does not meet this condition, it will not be fetched and returned.
An example of the filter object might look like this to fetch the books who contains "Art" in their title, which belongs to category "Programming":
{
"where": {"title": {"like": "%Art%"}},
"include": [
{
"relation": "category",
"scope": {
"where": {
"name": "Programming"
}
},
"required": true // 👈
}
]
}A Sequelize repository can perform operations in a transaction using the beginTransaction() method.
When you call beginTransaction(), you can optionally specify a transaction isolation level. It support the following isolation levels:
Transaction.ISOLATION_LEVELS.READ_UNCOMMITTED(default)Transaction.ISOLATION_LEVELS.READ_COMMITTEDTransaction.ISOLATION_LEVELS.REPEATABLE_READTransaction.ISOLATION_LEVELS.SERIALIZABLE
Following are the supported options:
{
autocommit?: boolean;
isolationLevel?: Transaction.ISOLATION_LEVELS;
type?: Transaction.TYPES;
deferrable?: string | Deferrable;
/**
* Parent transaction.
*/
transaction?: Transaction | null;
}// Get repository instances. In a typical application, instances are injected
// via dependency injection using `@repository` decorator.
const userRepo = await app.getRepository(UserRepository);
// Begin a new transaction.
// It's also possible to call `userRepo.dataSource.beginTransaction` instead.
const tx = await userRepo.beginTransaction({
isolationLevel: Transaction.ISOLATION_LEVELS.SERIALIZABLE,
});
try {
// Then, we do some calls passing this transaction as an option:
const user = await userRepo.create(
{
firstName: 'Jon',
lastName: 'Doe',
},
{transaction: tx},
);
await userRepo.updateById(
user.id,
{
firstName: 'John',
},
{transaction: tx},
);
// If the execution reaches this line, no errors were thrown.
// We commit the transaction.
await tx.commit();
} catch (error) {
// If the execution reaches this line, an error was thrown.
// We rollback the transaction.
await tx.rollback();
}Switching from loopback defaults to sequelize transaction is as simple as this commit in loopback4-sequelize-transaction-example.
There are three built-in debug strings available in this extension to aid in debugging. To learn more about how to use them, see this page.
| String | Description |
|---|---|
| Datasource | |
| loopback:sequelize:datasource | Database Connections logs |
| loopback:sequelize:queries | Logs Executed SQL Queries and Parameters |
| Repository | |
| loopback:sequelize:modelbuilder | Logs Translation of Loopback Models Into Sequelize Supported Definitions. Helpful When Debugging Datatype Issues |
Please note, the current implementation does not support the following:
- Loopback Migrations (via default
migrate.ts). Though you're good if using external packages likedb-migrate.
Community contribution is welcome.
If you've noticed a bug or have a question or have a feature request, search the issue tracker to see if someone else in the community has already created a ticket. If not, go ahead and make one! All feature requests are welcome. Implementation time may vary. Feel free to contribute the same, if you can. If you think this extension is useful, please star it. Appreciation really helps in keeping this project alive.
Please read CONTRIBUTING.md for details on the process for submitting pull requests to us.
Code of conduct guidelines here.