SqlHydra 项目使用教程

SqlHydra 项目使用教程

SqlHydra SqlHydra is a suite of NuGet packages for working with databases in F# including code generation tools and query expressions. 项目地址: https://gitcode.com/gh_mirrors/sq/SqlHydra

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

SqlHydra 项目的目录结构如下：

SqlHydra/
├── src/
│   ├── gitattributes
│   ├── gitignore
│   ├── LICENSE
│   ├── README.md
│   └── ...
├── .github/
│   └── ...
├── .gitignore
├── .gitattributes
├── LICENSE
├── README.md
└── ...

目录结构介绍

• src/: 包含项目的主要源代码文件。

  • gitattributes: 用于定义 Git 属性。
  • gitignore: 用于指定 Git 忽略的文件和目录。
  • LICENSE: 项目的许可证文件。
  • README.md: 项目的说明文档。

• .github/: 包含 GitHub 相关的配置文件，如 CI/CD 配置等。

• .gitignore: 全局 Git 忽略文件。

• .gitattributes: 全局 Git 属性文件。

• LICENSE: 项目的许可证文件。

• README.md: 项目的说明文档。

2. 项目的启动文件介绍

SqlHydra 项目的主要启动文件是 SqlHydra.Cli，它是一个 dotnet 工具，用于生成 F# 类型的代码和数据读取器。

启动文件介绍

• SqlHydra.Cli: 这是一个 dotnet 工具，可以通过命令行运行。它用于生成 F# 类型的代码和数据读取器。

启动命令

dotnet sqlhydra mssql

该命令会根据配置文件生成相应的 F# 类型代码。如果没有检测到配置文件，工具会启动一个配置向导，帮助用户创建新的配置文件。

3. 项目的配置文件介绍

SqlHydra 项目的主要配置文件是 sqlhydra-[provider].toml，其中 [provider] 可以是 mssql、npgsql、sqlite 等数据库提供者。

配置文件介绍

• sqlhydra-[provider].toml: 该文件包含了生成代码所需的配置信息，如数据库连接字符串、输出文件名、命名空间等。

配置文件示例

[database]
connection_string = "your_connection_string_here"
output_filename = "AdventureWorks.fs"
namespace = "MyApp.AdventureWorks"
use_case = "SqlHydra.Query integration"

配置文件字段说明

• connection_string: 数据库连接字符串。
• output_filename: 生成的 F# 类型代码的输出文件名。
• namespace: 生成的 F# 类型代码的命名空间。
• use_case: 使用场景，可以是 SqlHydra.Query integration、Other data library 或 Standalone。

通过以上配置文件，SqlHydra 可以根据用户的需求生成相应的 F# 类型代码和数据读取器。

SqlHydra SqlHydra is a suite of NuGet packages for working with databases in F# including code generation tools and query expressions. 项目地址: https://gitcode.com/gh_mirrors/sq/SqlHydra