@loopback/docs 6.0.5 → 7.0.0

package/site/apidocs/sequelize.sequelizecrudrepository.md

@@ -0,0 +1,87 @@
+---
+lang: en
+title: 'API docs: sequelize.sequelizecrudrepository'
+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.sequelizecrudrepository.html
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@loopback/sequelize](./sequelize.md) &gt; [SequelizeCrudRepository](./sequelize.sequelizecrudrepository.md)
+
+## SequelizeCrudRepository class
+
+Sequelize implementation of CRUD repository to be used with default loopback entities and SequelizeDataSource for SQL Databases
+
+**Signature:**
+
+```typescript
+export declare class SequelizeCrudRepository<T extends Entity, ID, Relations extends object = {}> implements EntityCrudRepository<T, ID, Relations> 
+```
+**Implements:** EntityCrudRepository&lt;T, ID, Relations&gt;
+
+## Constructors
+
+|  Constructor | Modifiers | Description |
+|  --- | --- | --- |
+|  [(constructor)(entityClass, dataSource)](./sequelize.sequelizecrudrepository._constructor_.md) |  | Constructs a new instance of the <code>SequelizeCrudRepository</code> class |
+
+## Properties
+
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [dataSource](./sequelize.sequelizecrudrepository.datasource.md) |  | [SequelizeDataSource](./sequelize.sequelizedatasource.md) |  |
+|  [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> |
+|  [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 |
+|  [defaultFnRegistry](./sequelize.sequelizecrudrepository.defaultfnregistry.md) | <code>protected</code> | Record&lt;string, unknown&gt; | <p>The alias registry for <code>defaultFn</code> option used in model property definition.</p><p>See: https://loopback.io/doc/en/lb4/Model.html\#property-decorator</p> |
+|  [entityClass](./sequelize.sequelizecrudrepository.entityclass.md) |  | typeof Entity &amp; { prototype: T; } |  |
+|  [inclusionResolvers](./sequelize.sequelizecrudrepository.inclusionresolvers.md) | <code>readonly</code> | Map&lt;string, InclusionResolver&lt;T, Entity&gt;&gt; |  |
+|  [NANO\_ID\_LENGTH](./sequelize.sequelizecrudrepository.nano_id_length.md) |  | number | Length of the <code>nanoid</code> generated for defaultFn's <code>shortid</code> and <code>nanoid</code> aliases. |
+|  [sequelizeModel](./sequelize.sequelizecrudrepository.sequelizemodel.md) |  | ModelStatic&lt;Model&lt;T&gt;&gt; | Sequelize Model Instance created from the model definition received from the <code>entityClass</code> |
+
+## Methods
+
+|  Method | Modifiers | Description |
+|  --- | --- | --- |
+|  [beginTransaction(options)](./sequelize.sequelizecrudrepository.begintransaction.md) |  |  |
+|  [buildSequelizeAttributeFilter(fields)](./sequelize.sequelizecrudrepository.buildsequelizeattributefilter.md) | <code>protected</code> | Get Sequelize <code>attributes</code> filter value from <code>fields</code> of loopback. |
+|  [buildSequelizeIncludeFilter(inclusionFilters, sourceModel)](./sequelize.sequelizecrudrepository.buildsequelizeincludefilter.md) | <code>protected</code> | Build Sequelize compatible <code>include</code> filter |
+|  [buildSequelizeOrder(order)](./sequelize.sequelizecrudrepository.buildsequelizeorder.md) | <code>protected</code> | <p>Get Sequelize Order filter value from loopback style order value.</p><p>It also supports passing associations in the order array to sort by nested models. Example: <code>[&quot;user email ASC&quot;]</code>.</p> |
+|  [buildSequelizeWhere(where)](./sequelize.sequelizecrudrepository.buildsequelizewhere.md) | <code>protected</code> | Build Sequelize compatible where condition object |
+|  [count(where, options)](./sequelize.sequelizecrudrepository.count.md) |  |  |
+|  [create(entity, options)](./sequelize.sequelizecrudrepository.create.md) |  |  |
+|  [createAll(entities, options)](./sequelize.sequelizecrudrepository.createall.md) |  |  |
+|  [createBelongsToAccessorFor(relationName, targetRepositoryGetter)](./sequelize.sequelizecrudrepository.createbelongstoaccessorfor.md) | <code>protected</code> | Function to create a belongs to accessor |
+|  [createHasManyRepositoryFactoryFor(relationName, targetRepositoryGetter)](./sequelize.sequelizecrudrepository.createhasmanyrepositoryfactoryfor.md) | <code>protected</code> | Function to create a constrained relation repository factory |
+|  [createHasManyThroughRepositoryFactoryFor(relationName, targetRepositoryGetter, throughRepositoryGetter)](./sequelize.sequelizecrudrepository.createhasmanythroughrepositoryfactoryfor.md) | <code>protected</code> | Function to create a constrained hasManyThrough relation repository factory |
+|  [createHasOneRepositoryFactoryFor(relationName, targetRepositoryGetter)](./sequelize.sequelizecrudrepository.createhasonerepositoryfactoryfor.md) | <code>protected</code> | Function to create a constrained hasOne relation repository factory |
+|  [createReferencesManyAccessorFor(relationName, targetRepoGetter)](./sequelize.sequelizecrudrepository.createreferencesmanyaccessorfor.md) | <code>protected</code> | Function to create a references many accessor |
+|  [delete(entity, options)](./sequelize.sequelizecrudrepository.delete.md) |  |  |
+|  [deleteAll(where, options)](./sequelize.sequelizecrudrepository.deleteall.md) |  |  |
+|  [deleteById(id, options)](./sequelize.sequelizecrudrepository.deletebyid.md) |  |  |
+|  [excludeHiddenProps(entity)](./sequelize.sequelizecrudrepository.excludehiddenprops.md) | <code>protected</code> | Remove hidden properties specified in model from response body. (See: https://github.com/sourcefuse/loopback4-sequelize/issues/3) |
+|  [execute(command, parameters, options)](./sequelize.sequelizecrudrepository.execute.md) |  | <p>Execute a SQL command.</p><p>\*\*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.</p> |
+|  [exists(id, \_options)](./sequelize.sequelizecrudrepository.exists.md) |  |  |
+|  [find(filter, options)](./sequelize.sequelizecrudrepository.find.md) |  |  |
+|  [findById(id, filter, options)](./sequelize.sequelizecrudrepository.findbyid.md) |  |  |
+|  [findOne(filter, options)](./sequelize.sequelizecrudrepository.findone.md) |  |  |
+|  [getDefaultFnRegistry()](./sequelize.sequelizecrudrepository.getdefaultfnregistry.md) | <code>protected</code> |  |
+|  [getSequelizeModel(entityClass)](./sequelize.sequelizecrudrepository.getsequelizemodel.md) |  | Get Sequelize Model |
+|  [getSequelizeModelAttributes(definition)](./sequelize.sequelizecrudrepository.getsequelizemodelattributes.md) | <code>protected</code> | Get Sequelize Model Attributes |
+|  [getSequelizeOperator(key)](./sequelize.sequelizecrudrepository.getsequelizeoperator.md) | <code>protected</code> | Get Sequelize Operator |
+|  [getTableName(entityClass)](./sequelize.sequelizecrudrepository.gettablename.md) |  | <p>This function retrieves the table name associated with a given entity class. Different loopback connectors have different conventions for picking up table names, unless the name is specified in the  decorator.</p><p>The function follows the following cases to determine the table name: - It checks if the name property is specified in the  decorator and uses it. (this takes precedence over all other cases) - If the dialect of the dataSource is PostgreSQL, it uses the lowercased version of the model class name. - If the dialect is MySQL or any other dialect, it uses the default model class name.</p> |
+|  [includeReferencesIfRequested(parentEntities, parentEntityClass, inclusionFilters)](./sequelize.sequelizecrudrepository.includereferencesifrequested.md) | <code>protected</code> | <p>Include related entities of <code>@referencesMany</code> relation</p><p>referencesMany relation is NOT handled by <code>sequelizeModel.findAll</code> as it doesn't have any direct alternative to it, so to include relation data of referencesMany, we're manually fetching related data requested</p> |
+|  [isInclusionAllowed(include)](./sequelize.sequelizecrudrepository.isinclusionallowed.md) | <code>protected</code> | Checks if the resolver of the inclusion relation is registered in the inclusionResolver of the current repository |
+|  [registerInclusionResolver(relationName, resolver)](./sequelize.sequelizecrudrepository.registerinclusionresolver.md) |  | Register an inclusion resolver for the related model name. |
+|  [replaceById(id, data, options)](./sequelize.sequelizecrudrepository.replacebyid.md) |  |  |
+|  [save(entity, options)](./sequelize.sequelizecrudrepository.save.md) |  |  |
+|  [syncLoadedSequelizeModels(options)](./sequelize.sequelizecrudrepository.syncloadedsequelizemodels.md) |  | Run CREATE TABLE query for the all sequelize models, Useful for quick testing |
+|  [syncSequelizeModel(options)](./sequelize.sequelizecrudrepository.syncsequelizemodel.md) |  | Run CREATE TABLE query for the target sequelize model, Useful for quick testing |
+|  [toEntities(models)](./sequelize.sequelizecrudrepository.toentities.md) | <code>protected</code> |  |
+|  [update(entity, options)](./sequelize.sequelizecrudrepository.update.md) |  |  |
+|  [updateAll(data, where, options)](./sequelize.sequelizecrudrepository.updateall.md) |  |  |
+|  [updateById(id, data, options)](./sequelize.sequelizecrudrepository.updatebyid.md) |  |  |
+
+

package/site/apidocs/sequelize.sequelizecrudrepository.nano_id_length.md

@@ -0,0 +1,23 @@
+---
+lang: en
+title: 'API docs: sequelize.sequelizecrudrepository.nano_id_length'
+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.sequelizecrudrepository.nano_id_length.html
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@loopback/sequelize](./sequelize.md) &gt; [SequelizeCrudRepository](./sequelize.sequelizecrudrepository.md) &gt; [NANO\_ID\_LENGTH](./sequelize.sequelizecrudrepository.nano_id_length.md)
+
+## SequelizeCrudRepository.NANO\_ID\_LENGTH property
+
+Length of the `nanoid` generated for defaultFn's `shortid` and `nanoid` aliases.
+
+**Signature:**
+
+```typescript
+NANO_ID_LENGTH: number;
+```
+

package/site/apidocs/sequelize.sequelizecrudrepository.registerinclusionresolver.md

@@ -0,0 +1,35 @@
+---
+lang: en
+title: 'API docs: sequelize.sequelizecrudrepository.registerinclusionresolver'
+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.sequelizecrudrepository.registerinclusionresolver.html
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@loopback/sequelize](./sequelize.md) &gt; [SequelizeCrudRepository](./sequelize.sequelizecrudrepository.md) &gt; [registerInclusionResolver](./sequelize.sequelizecrudrepository.registerinclusionresolver.md)
+
+## SequelizeCrudRepository.registerInclusionResolver() method
+
+Register an inclusion resolver for the related model name.
+
+**Signature:**
+
+```typescript
+registerInclusionResolver(relationName: string, resolver: InclusionResolver<T, Entity>): void;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  relationName | string | Name of the relation defined on the source model |
+|  resolver | InclusionResolver&lt;T, Entity&gt; | Resolver function for getting related model entities |
+
+**Returns:**
+
+void
+
+

package/site/apidocs/sequelize.sequelizecrudrepository.replacebyid.md

@@ -0,0 +1,34 @@
+---
+lang: en
+title: 'API docs: sequelize.sequelizecrudrepository.replacebyid'
+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.sequelizecrudrepository.replacebyid.html
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@loopback/sequelize](./sequelize.md) &gt; [SequelizeCrudRepository](./sequelize.sequelizecrudrepository.md) &gt; [replaceById](./sequelize.sequelizecrudrepository.replacebyid.md)
+
+## SequelizeCrudRepository.replaceById() method
+
+**Signature:**
+
+```typescript
+replaceById(id: ID, data: DataObject<T>, options?: AnyObject | undefined): Promise<void>;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  id | ID |  |
+|  data | DataObject&lt;T&gt; |  |
+|  options | AnyObject \| undefined | _(Optional)_ |
+
+**Returns:**
+
+Promise&lt;void&gt;
+
+

package/site/apidocs/sequelize.sequelizecrudrepository.save.md

@@ -0,0 +1,33 @@
+---
+lang: en
+title: 'API docs: sequelize.sequelizecrudrepository.save'
+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.sequelizecrudrepository.save.html
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@loopback/sequelize](./sequelize.md) &gt; [SequelizeCrudRepository](./sequelize.sequelizecrudrepository.md) &gt; [save](./sequelize.sequelizecrudrepository.save.md)
+
+## SequelizeCrudRepository.save() method
+
+**Signature:**
+
+```typescript
+save(entity: T, options?: AnyObject): Promise<T>;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  entity | T |  |
+|  options | AnyObject | _(Optional)_ |
+
+**Returns:**
+
+Promise&lt;T&gt;
+
+

package/site/apidocs/sequelize.sequelizecrudrepository.sequelizemodel.md

@@ -0,0 +1,23 @@
+---
+lang: en
+title: 'API docs: sequelize.sequelizecrudrepository.sequelizemodel'
+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.sequelizecrudrepository.sequelizemodel.html
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@loopback/sequelize](./sequelize.md) &gt; [SequelizeCrudRepository](./sequelize.sequelizecrudrepository.md) &gt; [sequelizeModel](./sequelize.sequelizecrudrepository.sequelizemodel.md)
+
+## SequelizeCrudRepository.sequelizeModel property
+
+Sequelize Model Instance created from the model definition received from the `entityClass`
+
+**Signature:**
+
+```typescript
+sequelizeModel: ModelStatic<Model<T>>;
+```
+

package/site/apidocs/sequelize.sequelizecrudrepository.syncloadedsequelizemodels.md

@@ -0,0 +1,34 @@
+---
+lang: en
+title: 'API docs: sequelize.sequelizecrudrepository.syncloadedsequelizemodels'
+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.sequelizecrudrepository.syncloadedsequelizemodels.html
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@loopback/sequelize](./sequelize.md) &gt; [SequelizeCrudRepository](./sequelize.sequelizecrudrepository.md) &gt; [syncLoadedSequelizeModels](./sequelize.sequelizecrudrepository.syncloadedsequelizemodels.md)
+
+## SequelizeCrudRepository.syncLoadedSequelizeModels() method
+
+Run CREATE TABLE query for the all sequelize models, Useful for quick testing
+
+**Signature:**
+
+```typescript
+syncLoadedSequelizeModels(options?: SyncOptions): Promise<void>;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  options | SyncOptions | _(Optional)_ Sequelize Sync Options |
+
+**Returns:**
+
+Promise&lt;void&gt;
+
+

package/site/apidocs/sequelize.sequelizecrudrepository.syncsequelizemodel.md

@@ -0,0 +1,34 @@
+---
+lang: en
+title: 'API docs: sequelize.sequelizecrudrepository.syncsequelizemodel'
+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.sequelizecrudrepository.syncsequelizemodel.html
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@loopback/sequelize](./sequelize.md) &gt; [SequelizeCrudRepository](./sequelize.sequelizecrudrepository.md) &gt; [syncSequelizeModel](./sequelize.sequelizecrudrepository.syncsequelizemodel.md)
+
+## SequelizeCrudRepository.syncSequelizeModel() method
+
+Run CREATE TABLE query for the target sequelize model, Useful for quick testing
+
+**Signature:**
+
+```typescript
+syncSequelizeModel(options?: SyncOptions): Promise<void>;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  options | SyncOptions | _(Optional)_ Sequelize Sync Options |
+
+**Returns:**
+
+Promise&lt;void&gt;
+
+

package/site/apidocs/sequelize.sequelizecrudrepository.toentities.md

@@ -0,0 +1,32 @@
+---
+lang: en
+title: 'API docs: sequelize.sequelizecrudrepository.toentities'
+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.sequelizecrudrepository.toentities.html
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@loopback/sequelize](./sequelize.md) &gt; [SequelizeCrudRepository](./sequelize.sequelizecrudrepository.md) &gt; [toEntities](./sequelize.sequelizecrudrepository.toentities.md)
+
+## SequelizeCrudRepository.toEntities() method
+
+**Signature:**
+
+```typescript
+protected toEntities(models: Model<T, T>[]): T[];
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  models | Model&lt;T, T&gt;\[\] |  |
+
+**Returns:**
+
+T\[\]
+
+

package/site/apidocs/sequelize.sequelizecrudrepository.update.md

@@ -0,0 +1,33 @@
+---
+lang: en
+title: 'API docs: sequelize.sequelizecrudrepository.update'
+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.sequelizecrudrepository.update.html
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@loopback/sequelize](./sequelize.md) &gt; [SequelizeCrudRepository](./sequelize.sequelizecrudrepository.md) &gt; [update](./sequelize.sequelizecrudrepository.update.md)
+
+## SequelizeCrudRepository.update() method
+
+**Signature:**
+
+```typescript
+update(entity: T, options?: AnyObject): Promise<void>;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  entity | T |  |
+|  options | AnyObject | _(Optional)_ |
+
+**Returns:**
+
+Promise&lt;void&gt;
+
+

package/site/apidocs/sequelize.sequelizecrudrepository.updateall.md

@@ -0,0 +1,34 @@
+---
+lang: en
+title: 'API docs: sequelize.sequelizecrudrepository.updateall'
+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.sequelizecrudrepository.updateall.html
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@loopback/sequelize](./sequelize.md) &gt; [SequelizeCrudRepository](./sequelize.sequelizecrudrepository.md) &gt; [updateAll](./sequelize.sequelizecrudrepository.updateall.md)
+
+## SequelizeCrudRepository.updateAll() method
+
+**Signature:**
+
+```typescript
+updateAll(data: DataObject<T>, where?: Where<T>, options?: AnyObject): Promise<Count>;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  data | DataObject&lt;T&gt; |  |
+|  where | [Where](./filter.where.md)<!-- -->&lt;T&gt; | _(Optional)_ |
+|  options | AnyObject | _(Optional)_ |
+
+**Returns:**
+
+Promise&lt;Count&gt;
+
+

package/site/apidocs/sequelize.sequelizecrudrepository.updatebyid.md

@@ -0,0 +1,34 @@
+---
+lang: en
+title: 'API docs: sequelize.sequelizecrudrepository.updatebyid'
+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.sequelizecrudrepository.updatebyid.html
+---
+
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@loopback/sequelize](./sequelize.md) &gt; [SequelizeCrudRepository](./sequelize.sequelizecrudrepository.md) &gt; [updateById](./sequelize.sequelizecrudrepository.updatebyid.md)
+
+## SequelizeCrudRepository.updateById() method
+
+**Signature:**
+
+```typescript
+updateById(id: ID, data: DataObject<T>, options?: AnyObject): Promise<void>;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  id | ID |  |
+|  data | DataObject&lt;T&gt; |  |
+|  options | AnyObject | _(Optional)_ |
+
+**Returns:**
+
+Promise&lt;void&gt;
+
+

package/site/apidocs/sequelize.sequelizedatasource._constructor_.md

@@ -0,0 +1,30 @@
+---
+lang: en
+title: 'API docs: sequelize.sequelizedatasource._constructor_'
+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._constructor_.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) &gt; [(constructor)](./sequelize.sequelizedatasource._constructor_.md)
+
+## SequelizeDataSource.(constructor)
+
+Constructs a new instance of the `SequelizeDataSource` class
+
+**Signature:**
+
+```typescript
+constructor(config: SequelizeDataSourceConfig);
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  config | [SequelizeDataSourceConfig](./sequelize.sequelizedatasourceconfig.md) |  |
+
+

package/site/apidocs/sequelize.sequelizedatasource.automigrate.md

@@ -0,0 +1,25 @@
+---
+lang: en
+title: 'API docs: sequelize.sequelizedatasource.automigrate'
+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.automigrate.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) &gt; [automigrate](./sequelize.sequelizedatasource.automigrate.md)
+
+## SequelizeDataSource.automigrate() method
+
+**Signature:**
+
+```typescript
+automigrate(): void;
+```
+**Returns:**
+
+void
+
+

package/site/apidocs/sequelize.sequelizedatasource.autoupdate.md

@@ -0,0 +1,25 @@
+---
+lang: en
+title: 'API docs: sequelize.sequelizedatasource.autoupdate'
+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.autoupdate.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) &gt; [autoupdate](./sequelize.sequelizedatasource.autoupdate.md)
+
+## SequelizeDataSource.autoupdate() method
+
+**Signature:**
+
+```typescript
+autoupdate(): void;
+```
+**Returns:**
+
+void
+
+

package/site/apidocs/sequelize.sequelizedatasource.begintransaction.md

@@ -0,0 +1,36 @@
+---
+lang: en
+title: 'API docs: sequelize.sequelizedatasource.begintransaction'
+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.begintransaction.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) &gt; [beginTransaction](./sequelize.sequelizedatasource.begintransaction.md)
+
+## SequelizeDataSource.beginTransaction() method
+
+Begin a new transaction.
+
+**Signature:**
+
+```typescript
+beginTransaction(options?: TransactionOptions | TransactionOptions['isolationLevel']): Promise<Transaction>;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  options | TransactionOptions \| TransactionOptions\['isolationLevel'\] | _(Optional)_ Options {<!-- -->isolationLevel: '...'<!-- -->} |
+
+**Returns:**
+
+Promise&lt;Transaction&gt;
+
+A promise which resolves to a Sequelize Transaction object
+
+

package/site/apidocs/sequelize.sequelizedatasource.config.md

@@ -0,0 +1,21 @@
+---
+lang: en
+title: 'API docs: sequelize.sequelizedatasource.config'
+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.config.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) &gt; [config](./sequelize.sequelizedatasource.config.md)
+
+## SequelizeDataSource.config property
+
+**Signature:**
+
+```typescript
+config: SequelizeDataSourceConfig;
+```
+

package/site/apidocs/sequelize.sequelizedatasource.execute.md

@@ -0,0 +1,57 @@
+---
+lang: en
+title: 'API docs: sequelize.sequelizedatasource.execute'
+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.execute.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) &gt; [execute](./sequelize.sequelizedatasource.execute.md)
+
+## SequelizeDataSource.execute() method
+
+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.
+
+**Signature:**
+
+```typescript
+execute(command: Command, parameters?: NamedParameters | PositionalParameters, options?: Options): Promise<AnyObject>;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  command | Command | A parameterized SQL command or query. |
+|  parameters | NamedParameters \| PositionalParameters | _(Optional)_ List of parameter values to use. |
+|  options | Options | _(Optional)_ Additional options, for example <code>transaction</code>. |
+
+**Returns:**
+
+Promise&lt;AnyObject&gt;
+
+A promise which resolves to the command output. The output type (data structure) is database specific and often depends on the command executed.
+
+## Example
+
+
+```ts
+// MySQL
+const result = await db.execute(
+  'SELECT * FROM Products WHERE size > ?',
+  [42]
+);
+
+// PostgreSQL
+const result = await db.execute(
+  'SELECT * FROM Products WHERE size > $1',
+  [42]
+);
+```
+
+