SqlSugar ORM 项目教程

SqlSugar ORM 项目教程

SqlSugar 项目地址: https://gitcode.com/gh_mirrors/sq/SqlSugar

1. 项目的目录结构及介绍

SqlSugar ORM 项目的目录结构如下：

SqlSugar/
├── src/
│   ├── SqlSugar.Core/
│   ├── SqlSugar.Extensions/
│   ├── SqlSugar.Tests/
│   └── ...
├── .gitattributes
├── .gitignore
├── LICENSE
├── README.md
└── ...

目录结构介绍

• src/: 包含 SqlSugar ORM 的核心代码和扩展代码。
  • SqlSugar.Core/: 核心库，包含 ORM 的主要功能实现。
  • SqlSugar.Extensions/: 扩展库，提供额外的功能和插件。
  • SqlSugar.Tests/: 单元测试代码，用于测试 ORM 的功能。
• .gitattributes: Git 属性配置文件，用于指定文件的属性。
• .gitignore: Git 忽略文件配置，指定哪些文件或目录不需要被 Git 管理。
• LICENSE: 项目许可证文件，通常为 MIT 许可证。
• README.md: 项目说明文件，包含项目的基本介绍、使用方法和贡献指南。

2. 项目的启动文件介绍

SqlSugar ORM 项目没有传统意义上的“启动文件”，因为它是一个库项目，主要用于在其他应用程序中作为依赖项使用。不过，如果你要在自己的项目中使用 SqlSugar，通常会在你的应用程序的入口点（如 Program.cs 或 Startup.cs）中进行初始化。

示例初始化代码

using SqlSugar;

public class Program
{
    public static void Main(string[] args)
    {
        // 初始化 SqlSugarClient
        SqlSugarClient db = new SqlSugarClient(new ConnectionConfig()
        {
            ConnectionString = "your_connection_string",
            DbType = DbType.SqlServer,
            IsAutoCloseConnection = true
        });

        // 使用 db 进行数据库操作
        var result = db.Queryable<YourEntity>().ToList();
    }
}

3. 项目的配置文件介绍

SqlSugar ORM 项目本身没有独立的配置文件，配置主要通过代码进行。通常在初始化 SqlSugarClient 时，通过 ConnectionConfig 对象来配置数据库连接信息。

配置示例

var config = new ConnectionConfig()
{
    ConnectionString = "your_connection_string",
    DbType = DbType.SqlServer,
    IsAutoCloseConnection = true,
    InitKeyType = InitKeyType.Attribute // 指定实体类的初始化方式
};

SqlSugarClient db = new SqlSugarClient(config);

配置项说明

• ConnectionString: 数据库连接字符串，指定数据库的连接信息。
• DbType: 数据库类型，如 DbType.SqlServer、DbType.MySql 等。
• IsAutoCloseConnection: 是否自动关闭连接，设置为 true 时，每次操作后自动关闭连接。
• InitKeyType: 实体类的初始化方式，如 Attribute 或 SystemTable。

通过以上配置，你可以灵活地使用 SqlSugar ORM 进行数据库操作。

SqlSugar 项目地址: https://gitcode.com/gh_mirrors/sq/SqlSugar