GoFreeDB - 基于Google Sheets的简单数据库抽象层插件库

概述

GoFreeDB是一个Golang库，它在Google Sheets之上提供了常见且简单的数据库抽象层。

更快地用Google Sheets作为数据库交付！

特性

1. 在Google Sheets之上提供简单的键值和基于行的数据库接口
2. 无需任何服务器设置即可服务您的数据（通过利用Google Sheets基础设施）
3. 支持足够灵活的查询语言来执行各种数据查询
4. 通过熟悉的Google Sheets UI手动操作数据（无需管理页面）

安装

go get github.com/FreeLeh/GoFreeDB

前提条件

1. 获取Google OAuth2或服务账户凭据
2. 准备一个Google Sheets电子表格用于存储数据

行存储(Row Store)示例

假设表中的每一行都由Person结构体表示：

type Person struct {
    Name string `db:"name"`
    Age  int    `db:"age"`
}

初始化行存储：

import (
    "github.com/FreeLeh/GoFreeDB"
    "github.com/FreeLeh/GoFreeDB/google/auth"
)

// 使用Google服务账户
auth, err := auth.NewServiceFromFile(
    "<path_to_service_account_json>", 
    freedb.FreeDBGoogleAuthScopes, 
    auth.ServiceConfig{},
)

// 使用Google OAuth2流程
auth, err := auth.NewOAuth2FromFile(
    "<path_to_client_secret_json>", 
    "<path_to_cached_credentials_json>", 
    freedb.FreeDBGoogleAuthScopes, 
    auth.OAuth2Config{},
)

store := freedb.NewGoogleSheetRowStore(
    auth, 
    "<spreadsheet_id>", 
    "<sheet_name>", 
    freedb.GoogleSheetRowStoreConfig{Columns: []string{"name", "age"}},
)
defer store.Close(context.Background())

查询行

// 输出变量
var output []Person

// 查询所有行的所有列
err := store.
    Select(&output).
    Exec(context.Background())

// 查询所有行的部分列（未选中的结构体字段将有默认值）
err := store.
    Select(&output, "name").
    Exec(context.Background())

// 带条件的查询
err := store.
    Select(&output).
    Where("name = ? OR age >= ?", "freedb", 10).
    Exec(context.Background())

// 带排序的查询
ordering := []freedb.ColumnOrderBy{
    {Column: "name", OrderBy: freedb.OrderByAsc},
    {Column: "age", OrderBy: freedb.OrderByDesc},
}
err := store.
    Select(&output).
    OrderBy(ordering).
    Exec(context.Background())

// 带偏移和限制的查询
err := store.
    Select(&output).
    Offset(10).
    Limit(20).
    Exec(context.Background())

插入行

err := store.Insert(
    Person{Name: "no_pointer", Age: 10}, 
    &Person{Name: "with_pointer", Age: 20},
).Exec(context.Background())

更新行

colToUpdate := make(map[string]interface{})
colToUpdate["name"] = "new_name"
colToUpdate["age"] = 12

// 更新所有行
err := store.
    Update(colToUpdate).
    Exec(context.Background())

// 带条件的更新
err := store.
    Update(colToUpdate).
    Where("name = ? OR age >= ?", "freedb", 10).
    Exec(context.Background())

删除行

// 删除所有行
err := store.
    Delete().
    Exec(context.Background())

// 带条件的删除
err := store.
    Delete().
    Where("name = ? OR age >= ?", "freedb", 10).
    Exec(context.Background())

键值存储(KV Store)示例

import (
    "github.com/FreeLeh/GoFreeDB"
    "github.com/FreeLeh/GoFreeDB/google/auth"
)

// 初始化认证...

kv := freedb.NewGoogleSheetKVStore(
    auth, 
    "<spreadsheet_id>", 
    "<sheet_name>", 
    freedb.GoogleSheetKVStoreConfig{Mode: freedb.KVSetModeAppendOnly},
)
defer kv.Close(context.Background())

基本操作

// 获取值
value, err := kv.Get(context.Background(), "k1")

// 设置键值
err := kv.Set(context.Background(), "k1", []byte("some_value"))

// 删除键
err := kv.Delete(context.Background(), "k1")

键值存储V2(KV Store V2)示例

KV Store V2在内部使用行存储实现，是更推荐的版本。

kv := freedb.NewGoogleSheetKVStoreV2(
    auth, 
    "<spreadsheet_id>", 
    "<sheet_name>", 
    freedb.GoogleSheetKVStoreV2Config{Mode: freedb.KVSetModeAppendOnly},
)
defer kv.Close(context.Background())

基本操作

// 获取值
value, err := kv.Get(context.Background(), "k1")

// 设置键值
err := kv.Set(context.Background(), "k1", []byte("some_value"))

// 删除键
err := kv.Delete(context.Background(), "k1")

结构体字段到列的映射

db结构体标签可用于定义结构体字段和列名之间的映射，类似于encoding/json中的json标签。

如果没有db标签，库将直接使用字段名（区分大小写）。

// 这将映射到确切的列名"Name"和"Age"
type NoTagPerson struct {
    Name string
    Age  int
}

// 这将映射到确切的列名"name"和"age"
type WithTagPerson struct {
    Name string  `db:"name"`
    Age  int     `db:"age"`
}

许可证

该项目采用MIT许可证。