Pegasus Go 客户端使用教程

Pegasus Go 客户端使用教程

pegasus-go-clientHas been migrated to https://github.com/apache/incubator-pegasus/tree/master/go-client项目地址:https://gitcode.com/gh_mirrors/pe/pegasus-go-client

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

Pegasus Go 客户端项目的目录结构如下：

pegasus-go-client/
├── docs/
├── example/
├── generator/
├── idl/
├── integration/
│   └── failover-test/
├── pegalog/
├── pegasus/
├── rpc/
├── session/
├── .gitignore
├── .golangci.yml
├── LICENSE
├── Makefile
├── README.md
├── codecov.yml
├── go.mod
├── go.sum
└── test.sh

目录介绍

• docs/: 包含项目的文档文件。
• example/: 包含使用 Pegasus Go 客户端的示例代码。
• generator/: 包含代码生成器的相关文件。
• idl/: 包含接口定义语言（IDL）文件。
• integration/: 包含集成测试的相关文件，例如 failover-test/。
• pegalog/: 包含日志相关的文件。
• pegasus/: 包含 Pegasus 客户端的核心实现文件。
• rpc/: 包含远程过程调用（RPC）相关的文件。
• session/: 包含会话管理相关的文件。
• .gitignore: Git 忽略文件。
• .golangci.yml: GolangCI 配置文件。
• LICENSE: 项目许可证文件。
• Makefile: 用于构建和测试的 Makefile 文件。
• README.md: 项目说明文档。
• codecov.yml: Codecov 配置文件。
• go.mod: Go 模块文件。
• go.sum: Go 模块校验文件。
• test.sh: 测试脚本。

2. 项目的启动文件介绍

Pegasus Go 客户端的启动文件主要是 example/ 目录下的示例代码。以下是一个简单的启动示例：

package main

import (
    "context"
    "fmt"
    "github.com/XiaoMi/pegasus-go-client/pegasus"
)

func main() {
    cfg := pegasus.NewConfig()
    client := pegasus.NewClient(cfg)
    defer client.Close()

    tb, err := client.OpenTable(context.Background(), "temp")
    if err != nil {
        fmt.Println("Failed to open table:", err)
        return
    }

    err = tb.Set(context.Background(), []byte("h1"), []byte("s1"), []byte("v1"))
    if err != nil {
        fmt.Println("Failed to set value:", err)
        return
    }

    fmt.Println("Value set successfully")
}

启动文件介绍

• pegasus.NewConfig(): 创建一个配置对象。
• pegasus.NewClient(cfg): 根据配置对象创建一个客户端实例。
• client.OpenTable(context.Background(), "temp"): 打开一个名为 temp 的表。
• tb.Set(context.Background(), []byte("h1"), []byte("s1"), []byte("v1")): 在表中设置一个键值对。

3. 项目的配置文件介绍

Pegasus Go 客户端的配置文件主要是 pegasus.NewConfig() 创建的配置对象。以下是一个简单的配置示例：

cfg := pegasus.NewConfig()
cfg.MetaServers = []string{"127.0.0.1:34601", "127.0.0.1:34602", "127.0.0.1:34603"}
cfg.OperationTimeout = 500 * time.Millisecond
cfg.RetryCount = 3

配置文件介绍

• MetaServers: 指定 Pegasus 的元数据服务器地址。
• OperationTimeout: 设置操作的超时时间。
• RetryCount: 设置操作的重试次数。

以上是 Pegasus Go 客户端的基本使用教程，涵盖了项目的目录结构、启动文件和配置文件的介绍。希望对您有所帮助。

pegasus-go-clientHas been migrated to https://github.com/apache/incubator-pegasus/tree/master/go-client项目地址:https://gitcode.com/gh_mirrors/pe/pegasus-go-client