# egg-sequelize-extends

> egg sequelize plugin extends

Latest version **1.0.7** (published 2019-08-12) · MIT license · 0 weekly downloads

## Install

```sh
npm install egg-sequelize-extends
pnpm add egg-sequelize-extends
yarn add egg-sequelize-extends
bun add egg-sequelize-extends
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; large bundle.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.7 |
| Published | 2019-08-12 |
| First published | 2018-10-16 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=8.0.0 |
| Dependencies | 5 |
| Unpacked size | 11.6 MB |
| Known vulnerabilities | 0 (+7 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 3 |
| Author | zhangmingfeng |
| Maintainers | zhangmingfeng |
| Keywords | egg, sequelize, extends, egg-plugin, eggPlugin |

## Links

- npm: https://www.npmjs.com/package/egg-sequelize-extends
- Repository: https://github.com/zhangmingfeng/egg-sequelize-extends
- Homepage: https://github.com/zhangmingfeng/egg-sequelize-extends#readme
- Issues: https://github.com/zhangmingfeng/egg-sequelize-extends/issues
- npm.io page: https://npm.io/package/egg-sequelize-extends

## Dependencies (5)

- [lodash](https://npm.io/package/lodash.md) ^4.17.11
- [moment](https://npm.io/package/moment.md) ^2.24.0
- [mysql2](https://npm.io/package/mysql2.md) ^1.6.1
- [egg-logger](https://npm.io/package/egg-logger.md) ^2.0.1
- [egg-sequelize](https://npm.io/package/egg-sequelize.md) ^4.1.0

## Recent versions

- 1.0.7 (latest) — 2019-08-12
- 1.0.6 — 2019-08-12
- 1.0.5 — 2019-01-16
- 1.0.4 — 2019-01-16
- 1.0.3 — 2019-01-16
- 1.0.2 — 2018-10-16
- 1.0.1 — 2018-10-16
- 1.0.0 — 2018-10-16

## README

# egg-sequelize-extends
sequelize plugin for Egg.js.

> NOTE: This plugin just for extends egg-sequelize, more documentation please visit https://github.com/eggjs/egg-sequelize.

# Install

```bash
$ npm i --save egg-sequelize-extends
```

## Usage & configuration

- `config.default.js`
配置文件和egg-sequelize一致，只是在它的基础上增加了日志的配置，可以自定义日志打印的级别和文件（egg-sequelize插件的默认打印的日志是info，而且不能调整，不能指定打印到其他文件里，只能关闭），默认打印的位置是appBaseDir/logs/sequelize-sql.log, 另外增加了comment参数支持（原egg-sequelize不支持）

```js
exports.sequelize = {
    logger: {
        level: 'DEBUG',
        dir: '/path/to/sql'
    },
};
```
or
```js
exports.sequelize = {
    logger: {
        level: 'DEBUG',
        file: '/path/to/sql.log'
    },
};
```

- `config/plugin.js`

``` js
exports.sequelize = {
  enable: true,
  package: 'egg-sequelize-extends'
}
```

- 支持在model目录里按模块目录定义model，如下例子：

- `app/model/user/account.js`

``` js
module.exports = (app) => {
    return app.model.define('account', {...}, {
        tableName: 'account'
    });
}

```

- `controller or service`

```js
await this.ctx.model.Account.findById(100);
```

for examples, please visit https://github.com/eggjs/egg-sequelize.

---
_Source: https://npm.io/package/egg-sequelize-extends · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._