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 是一个用于在 F# 中处理数据库的 NuGet 包集合。它提供了代码生成工具和查询表达式，旨在提高类型安全性和便利性。SqlHydra 支持多种数据库，包括 SQL Server、PostgreSQL、Oracle、SQLite 和 MySQL。

2. 项目快速启动

安装 SqlHydra CLI

首先，确保你已经安装了 .NET SDK。然后，在你的项目目录中运行以下命令来安装 SqlHydra CLI：

dotnet new tool-manifest
dotnet tool install SqlHydra.Cli

生成数据库类型

安装完成后，你可以使用 SqlHydra CLI 生成数据库类型。以下是一个示例命令，用于生成 SQL Server 数据库的类型：

dotnet sqlhydra mssql

如果没有检测到 toml 配置文件，SqlHydra 会启动一个配置向导，询问你一些问题来创建一个新的 toml 配置文件，并使用该配置生成代码。

配置文件示例

以下是一个简单的 toml 配置文件示例：

[Database]
ConnectionString = "Server=myServerAddress;Database=myDataBase;User Id=myUsername;Password=myPassword;"
OutputFilename = "AdventureWorks.fs"
Namespace = "MyApp.AdventureWorks"
UseCase = "SqlHydra.Query integration"

生成代码

运行以下命令来生成代码：

dotnet sqlhydra mssql

生成的 .fs 文件将自动添加到你的 .fsproj 文件中。

3. 应用案例和最佳实践

使用 SqlHydra 进行查询

SqlHydra 生成的类型可以与 SqlHydra.Query 包一起使用，以进行强类型的 Linq 查询。以下是一个简单的查询示例：

open MyApp.AdventureWorks

let ctx = new MyDbContext()

let query = 
    select {
        for a in Person.Address do
        where (a.City |=| [ "Seattle"; "Denver" ])
    }

let results = ctx.GetReaderAsync(query) |> Async.RunSynchronously

for result in results do
    printfn "%A" result

最佳实践

1. 类型安全：使用 SqlHydra 生成的类型可以确保你的查询是类型安全的，减少运行时错误。
2. 代码生成：定期生成代码以确保与数据库模式的同步。
3. 配置管理：使用 toml 配置文件来管理数据库连接字符串和其他设置。

4. 典型生态项目

SqlHydra.Query

SqlHydra.Query 是 SqlHydra 的一个核心组件，提供了强类型的 Linq 查询功能。它与 SqlHydra 生成的类型紧密集成，使得查询更加直观和安全。

Dapper.FSharp

如果你不想使用生成的类型，可以考虑使用 Dapper.FSharp，这是一个轻量级的 ORM，支持 F# 的类型安全和语法特性。

Npgsql.FSharp

如果你主要使用 PostgreSQL，Npgsql.FSharp 是一个不错的选择，它提供了对 PostgreSQL 的强类型支持，并且与 F# 的语法完美结合。

通过这些工具和库，你可以构建出高效、类型安全的 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