Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/demopark/sequelize-docs-Zh-CN

Sequelize 文档的中文版本: v7.0.0-alpha.18 | v6.32.0
https://github.com/demopark/sequelize-docs-Zh-CN

mysql orm postgresql sequelize transaction

Last synced: 2 months ago
JSON representation

Sequelize 文档的中文版本: v7.0.0-alpha.18 | v6.32.0

Host: GitHub
URL: https://github.com/demopark/sequelize-docs-Zh-CN
Owner: demopark
License: gpl-2.0
Created: 2017-07-14T06:19:52.000Z (over 7 years ago)
Default Branch: master
Last Pushed: 2024-05-26T05:30:41.000Z (8 months ago)
Last Synced: 2024-10-29T15:03:22.154Z (3 months ago)
Topics: mysql, orm, postgresql, sequelize, transaction
Homepage: https://demopark.github.io/sequelize-docs-Zh-CN/
Size: 623 KB
Stars: 2,998
Watchers: 61
Forks: 499
Open Issues: 25
Metadata Files:
- Readme: Readme.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE

Awesome Lists containing this project

awesome-github-star - sequelize-docs-Zh-CN - alpha.18 \| v6.32.0 | demopark | 2964 | (Others)

README

        # Sequelize Docs 中文版

![](http://docs.sequelizejs.com/manual/asset/logo-small.png)

[![npm version](https://badgen.net/npm/v/@sequelize/core)](https://www.npmjs.com/package/@sequelize/core)

[![npm downloads](https://badgen.net/npm/dm/@sequelize/core)](https://www.npmjs.com/package/@sequelize/core)

[![contributors](https://img.shields.io/github/contributors/sequelize/sequelize)](https://github.com/sequelize/sequelize/graphs/contributors)

[![Open Collective](https://img.shields.io/opencollective/backers/sequelize)](https://opencollective.com/sequelize#section-contributors)

[![sponsor](https://img.shields.io/opencollective/all/sequelize?label=sponsors)](https://opencollective.com/sequelize)

[![Merged PRs](https://badgen.net/github/merged-prs/sequelize/sequelize)](https://github.com/sequelize/sequelize)

[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)

[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)

> 此项目同步自 [sequelize](https://github.com/sequelize) / [sequelize](https://github.com/sequelize/sequelize) 项目.

> 

> 更新日志请参阅: [CHANGELOG](CHANGELOG.md)

Sequelize 是一个易用且基于 promise 的 [Node.js](https://nodejs.org/en/about/) [ORM 工具](https://en.wikipedia.org/wiki/Object-relational_mapping) 适用于 [Postgres](https://en.wikipedia.org/wiki/PostgreSQL), [MySQL](https://en.wikipedia.org/wiki/MySQL), [MariaDB](https://en.wikipedia.org/wiki/MariaDB), [SQLite](https://en.wikipedia.org/wiki/SQLite), [DB2](https://en.wikipedia.org/wiki/IBM_Db2_Family), [Microsoft SQL Server](https://en.wikipedia.org/wiki/Microsoft_SQL_Server), [Snowflake](https://www.snowflake.com/), [Oracle DB](https://www.oracle.com/database/) 和 [Db2 for IBM i](https://www.ibm.com/support/pages/db2-ibm-i). 它具有强大的事务支持, 关联关系, 预读和延迟加载,读取复制等功能.

Sequelize 遵从 [语义版本控制](http://semver.org) 和 [官方 Node.js LTS 版本](https://nodejs.org/en/about/releases/). Sequelize v7 版本正式支持 Node.js `^14.17,0`, `^16.0.0`. 其他版本或可正常工作.

你目前正在查看 Sequelize 的**教程和指南**.你可能还对[API 参考](https://sequelize.org/api/v7/) (英文)感兴趣.

![赞赏支持](https://raw.githubusercontent.com/demopark/electron-api-demos-Zh_CN/master/assets/img/td.png)

## 文档版本

- [v7 中文文档](https://github.com/demopark/sequelize-docs-Zh-CN/tree/master)(开发版本)

- [v6 中文文档](https://github.com/demopark/sequelize-docs-Zh-CN/tree/v6)(保持更新)

- [v5 中文文档](https://github.com/demopark/sequelize-docs-Zh-CN/tree/v5)(停止更新)

- [v4 中文文档](https://github.com/demopark/sequelize-docs-Zh-CN/tree/v4)(停止更新)

## 主要版本变更日志

在此处可以找到主要版本的升级信息：

- [从 v5 升级到 v6](other-topics/upgrade-to-v6.md)

- [从 v6 升级到 v7](other-topics/upgrade-to-v7.md)

## 文档(v7-alpha)

**注意** 由于当前alpha阶段api调整, 文档中的API参考指向尚未确定. 可前往 [V7 API 参考](https://sequelize.org/api/v7/)自行查询.

### 核心概念

- [Getting Started - 入门](core-concepts/getting-started.md)

- [Model Basics - 模型基础](core-concepts/model-basics.md)

- [Model Instances - 模型实例](core-concepts/model-instances.md)

- [Model Querying - Basics - 模型查询(基础)](core-concepts/model-querying-basics.md)

- [Model Querying - Finders - 模型查询(查找器)](core-concepts/model-querying-finders.md)

- [Getters, Setters & Virtuals - 获取器, 设置器 & 虚拟字段](core-concepts/getters-setters-virtuals.md)

- [Validations & Constraints - 验证 & 约束](core-concepts/validations-and-constraints.md)

- [Raw Queries - 原始查询](core-concepts/raw-queries.md)

- [Associations - 关联](core-concepts/assocs.md)

- [Paranoid - 偏执表](core-concepts/paranoid.md)

### 高级关联概念

- [Eager Loading - 预先加载](advanced-association-concepts/eager-loading.md)

- [Creating with Associations - 创建关联](advanced-association-concepts/creating-with-associations.md)

- [Advanced M:N Associations - 高级 M:N 关联](advanced-association-concepts/advanced-many-to-many.md)

- [Association Scopes - 关联作用域](advanced-association-concepts/association-scopes.md)

- [Polymorphic Associations - 多态关联](advanced-association-concepts/polymorphic-associations.md)

### 其它主题

- [Dialect-Specific Things - 方言特定事项](other-topics/dialect-specific-things.md)

- [Transactions - 事务](other-topics/transactions.md)

- [Hooks - 钩子](other-topics/hooks.md)

- [Query Interface - 查询接口](other-topics/query-interface.md)

- [Naming Strategies - 命名策略](other-topics/naming-strategies.md)

- [Scopes - 作用域](other-topics/scopes.md)

- [Sub Queries - 子查询](other-topics/sub-queries.md)

- [Other Data Types - 其他数据类型](other-topics/other-data-types.md)

- [Constraints & Circularities - 约束 & 循环](other-topics/constraints-and-circularities.md)

- [Extending Data Types - 扩展数据类型](other-topics/extending-data-types.md)

- [Indexes - 索引](other-topics/indexes.md)

- [Optimistic Locking - 乐观锁定](other-topics/optimistic-locking.md)

- [Read Replication - 读取复制](other-topics/read-replication.md)

- [Connection Pool - 连接池](other-topics/connection-pool.md)

- [Working with Legacy Tables - 使用遗留表](other-topics/legacy.md)

- [Migrations - 迁移](other-topics/migrations.md)

- [TypeScript](other-topics/typescript.md)

- [Resources - 资源](other-topics/resources.md)

## 安装

```sh

# 使用 npm

npm install sequelize # 这将安装最新版本的 Sequelize

# 使用 yarn

yarn add sequelize

```

```sh

# 用于支持数据库方言的库:

# 使用 npm

npm i pg pg-hstore # PostgreSQL

npm i mysql2 # MySQL

npm i mariadb # MariaDB

npm i sqlite3 # SQLite

npm i tedious # Microsoft SQL Server

npm i ibm_db # DB2

npm i odbc # IBM i

# 使用 yarn

yarn add pg pg-hstore # PostgreSQL

yarn add mysql2 # MySQL

yarn add mariadb # MariaDB

yarn add sqlite3 # SQLite

yarn add tedious # Microsoft SQL Server

yarn add ibm_db # DB2

yarn add odbc # IBM i

```

## 简单示例

#### TypeScript

```javascript

import { Sequelize, Model, DataTypes, InferAttributes, InferCreationAttributes } from 'sequelize';

const sequelize = new Sequelize('sqlite::memory:');

class User extends Model, InferCreationAttributes> {

  declare username: string | null;

  declare birthday: Date | null;

}

User.init({

  username: DataTypes.STRING,

  birthday: DataTypes.DATE

}, { sequelize, modelName: 'user' });

(async () => {

  await sequelize.sync();

  const jane = await User.create({

    username: 'janedoe',

    birthday: new Date(1980, 6, 20),

  });

  console.log(jane.toJSON());

})();

```

#### JavaScript (CJS)

```javascript

const { Sequelize, Model, DataTypes } = require('sequelize');

const sequelize = new Sequelize('sqlite::memory:');

class User extends Model {}

User.init({

  username: DataTypes.STRING,

  birthday: DataTypes.DATE

}, { sequelize, modelName: 'user' });

(async () => {

  await sequelize.sync();

  const jane = await User.create({

    username: 'janedoe',

    birthday: new Date(1980, 6, 20)

  });

  console.log(jane.toJSON());

})();

```

请通过 [Getting started - 入门](core-concepts/getting-started.md) 来学习更多相关内容. 如果你想要学习 Sequelize API 请通过 [API 参考](https://sequelize.org/api/v7/) (英文).