UNPKG

@loopback/docs

Version:

Documentation files rendered at [https://loopback.io](https://loopback.io)

313 lines (139 loc) 4.57 kB
--- lang: en title: 'API docs: sequelize.sequelizedatasource' keywords: LoopBack 4.0, LoopBack 4, Node.js, TypeScript, OpenAPI sidebar: lb4_sidebar editurl: https://github.com/loopbackio/loopback-next/tree/master/extensions/sequelize permalink: /doc/en/lb4/apidocs.sequelize.sequelizedatasource.html --- <!-- Do not edit this file. It is automatically generated by API Documenter. --> [Home](./index.md) &gt; [@loopback/sequelize](./sequelize.md) &gt; [SequelizeDataSource](./sequelize.sequelizedatasource.md) ## SequelizeDataSource class Sequelize DataSource Class **Signature:** ```typescript export declare class SequelizeDataSource implements LifeCycleObserver ``` **Implements:** [LifeCycleObserver](./core.lifecycleobserver.md) ## Constructors <table><thead><tr><th> Constructor </th><th> Modifiers </th><th> Description </th></tr></thead> <tbody><tr><td markdown="1"> [(constructor)(config)](./sequelize.sequelizedatasource._constructor_.md) </td><td markdown="1"> </td><td markdown="1"> Constructs a new instance of the `SequelizeDataSource` class </td></tr> </tbody></table> ## Properties <table><thead><tr><th> Property </th><th> Modifiers </th><th> Type </th><th> Description </th></tr></thead> <tbody><tr><td markdown="1"> [config](./sequelize.sequelizedatasource.config.md) </td><td markdown="1"> </td><td markdown="1"> [SequelizeDataSourceConfig](./sequelize.sequelizedatasourceconfig.md) </td><td markdown="1"> </td></tr> <tr><td markdown="1"> [name](./sequelize.sequelizedatasource.name.md) </td><td markdown="1"> </td><td markdown="1"> string </td><td markdown="1"> </td></tr> <tr><td markdown="1"> [parseJsonColumns](./sequelize.sequelizedatasource.parsejsoncolumns.md) </td><td markdown="1"> `readonly` </td><td markdown="1"> boolean </td><td markdown="1"> Gets the flag indicating whether to parse JSON columns. If the `parseJsonColumns` property is set in the configuration, its value will be returned. Otherwise, it returns `true` if the dialect is MySQL, `false` otherwise. </td></tr> <tr><td markdown="1"> [sequelize](./sequelize.sequelizedatasource.sequelize.md) </td><td markdown="1"> </td><td markdown="1"> Sequelize </td><td markdown="1"> </td></tr> <tr><td markdown="1"> [sequelizeConfig](./sequelize.sequelizedatasource.sequelizeconfig.md) </td><td markdown="1"> </td><td markdown="1"> SequelizeOptions </td><td markdown="1"> </td></tr> <tr><td markdown="1"> [settings](./sequelize.sequelizedatasource.settings.md) </td><td markdown="1"> </td><td markdown="1"> {} </td><td markdown="1"> </td></tr> </tbody></table> ## Methods <table><thead><tr><th> Method </th><th> Modifiers </th><th> Description </th></tr></thead> <tbody><tr><td markdown="1"> [automigrate()](./sequelize.sequelizedatasource.automigrate.md) </td><td markdown="1"> </td><td markdown="1"> </td></tr> <tr><td markdown="1"> [autoupdate()](./sequelize.sequelizedatasource.autoupdate.md) </td><td markdown="1"> </td><td markdown="1"> </td></tr> <tr><td markdown="1"> [beginTransaction(options)](./sequelize.sequelizedatasource.begintransaction.md) </td><td markdown="1"> </td><td markdown="1"> Begin a new transaction. </td></tr> <tr><td markdown="1"> [execute(command, parameters, options)](./sequelize.sequelizedatasource.execute.md) </td><td markdown="1"> </td><td markdown="1"> Execute a SQL command. \*\*WARNING:\*\* In general, it is always better to perform database actions through repository methods. Directly executing SQL may lead to unexpected results, corrupted data, security vulnerabilities and other issues. </td></tr> <tr><td markdown="1"> [getPoolOptions()](./sequelize.sequelizedatasource.getpooloptions.md) </td><td markdown="1"> </td><td markdown="1"> </td></tr> <tr><td markdown="1"> [init()](./sequelize.sequelizedatasource.init.md) </td><td markdown="1"> </td><td markdown="1"> </td></tr> <tr><td markdown="1"> [start(\_injectedArgs)](./sequelize.sequelizedatasource.start.md) </td><td markdown="1"> </td><td markdown="1"> </td></tr> <tr><td markdown="1"> [stop()](./sequelize.sequelizedatasource.stop.md) </td><td markdown="1"> </td><td markdown="1"> </td></tr> </tbody></table>