Hood ORM 使用与技术文档

Hood 是一个为 Go 语言开发的数据库无关的 ORM 工具，它提供了链式 API、事务支持、迁移和模式生成、模型验证、模型事件钩子、数据库方言接口等功能。下面是关于如何安装、使用 Hood 的详细指南以及项目 API 的使用文档。

1. 安装指南

要使用 Hood，首先需要安装它。可以使用以下命令：

go get github.com/eaigner/hood

然后，进入 Hood 的目录并运行安装脚本：

cd $GOPATH/src/github.com/eaigner/hood
./install.sh

确保 $GOPATH/bin 目录在系统的 PATH 中，这样就可以全局调用 hood 命令。

2. 项目的使用说明

打开数据库

使用 Hood 前，需要打开一个数据库连接。可以使用以下两种方式之一：

// 使用已注册的方言打开数据库
hd, err := hood.Open("postgres", "user=<username> dbname=<database>")

或者，传递一个现有的数据库连接和方言实例：

hd := hood.New(db, NewPostgres())

定义模式

定义模式（schemas）时，可以通过结构体标签指定字段属性。例如：

type Person struct {
    Id          hood.Id
    FirstName   string `sql:"pk" validate:"presence"`
    LastName    string `sql:"size(128),notnull"`
    Tag         string `sql:"size(255),default('customer')"`
    CombinedTags string `sql:"size(128),default('orange')"`
    // 其他字段...
}

迁移

使用迁移时，需要先创建一个迁移配置文件：

hood create:config

然后创建迁移：

hood create:migration CreateUserTable
hood create:migration AddUserNameIndex

编辑生成的迁移文件，实现迁移的 Up 和 Down 方法。运行迁移：

hood db:migrate

回滚迁移：

hood db:rollback

验证和钩子

可以在模型中定义验证规则和钩子方法。例如：

func (u *User) ValidateUsername() error {
    // 自定义验证逻辑
}

func (u *User) BeforeUpdate() error {
    u.Updated = time.Now()
    return nil
}

3. 项目API使用文档

Hood 提供了丰富的 API，以下是一些基本的示例用法：

• 创建表：

err = hd.CreateTable(&Fruit{})

• 保存数据：

ids, err := tx.SaveAll(&fruits)

• 查询数据：

err = hd.Where("color", "=", "green").OrderBy("name").Limit(1).Find(&results)

• 删除数据：

ids, err = hd.DeleteAll(&results)

• 删除表：

hd.DropTable(&Fruit{})

4. 项目安装方式

Hood 的安装方式如上述安装指南中所述。确保正确安装后，可以通过 hood 命令行工具进行操作，包括创建迁移、运行迁移等。

通过以上指南和文档，用户可以详细了解并有效地使用 Hood ORM 来管理数据库交互。