データベース

Cloud Spanner で Golang の GORM のサポートが一般提供に

2023年11月16日

Google Cloud Japan Team

※この投稿は米国時間 2023 年 11 月 8 日に、Google Cloud blog に投稿されたものの抄訳です。

はじめに

GORM は、Golang 向けのオブジェクトリレーショナルマッピング（ORM）ライブラリです。ORM は、オブジェクト指向のプログラミング言語を使用して、互換性のないタイプのシステム間でデータを変換します。ORM ライブラリは、この手法を実装し、リレーショナルデータベースとオブジェクト指向プログラミング言語との間にオブジェクト指向レイヤを提供するライブラリです。GORM を使って開発したアプリケーションで、クラウドデータベースに移行したいものはありませんか？Google Cloud Spanner が GORM Object Relational Mapper に対応するようになりました。既存の GORM のコードを Cloud Spanner で再利用することも、既存の知識を活用して新機能を作成することも可能です。

Cloud Spanner Go ORM で、GORM を介し Cloud Spanner を使うために必要なすべてのクラスやインターフェースを実装できます。以下の方法でプロジェクトに Spanner GORM モジュールを追加して、Cloud Spanner に接続しましょう。

インストール

シェルから go ツールで $GOPATH に簡単にパッケージをインストールします。

読み込んでいます...

接続

GORM を使用して Cloud Spanner に接続します。

読み込んでいます...

なお、GORM の実装では Spanner への接続のために Go クライアントを使用するため、Spanner エミュレータ（GCP プロジェクトや請求先アカウントを作成しなくてもアプリケーションの開発やテストに無料で使用できる、ローカルインメモリエミュレータ）への接続にカスタムエンドポイントを指定する必要はありません。SPANNER_EMULATOR_HOST の環境変数が設定されていれば、エミュレータは自動でドライバに接続されます。

使用方法

Cloud Spanner GORM は、位置パラメータと名前付きパラメータの両方を使用したデータのクエリ、関連付けの管理、トランザクションの実行などの標準の GORM 機能をサポートしています。また、基盤となる接続のラップを解除することで、特定の Spanner 機能（インターリーブされたテーブル、ミューテーション、ステイル読み取りなど）にも対応します。これは、GORM を使用すれば、強力かつスケーラブルなコードを作成できることを意味します。

たとえば、次のコードスニペットは、Spanner の無限のスケーラビリティを利用した Spanner への単純な書き込みと読み取りの操作を示しています。プロダクトのリリース後に、シャーディングなどのために何かを書き換える必要はなく、ノードを追加するだけで済みます。

読み込んでいます...

package main
import (
  "fmt"
  "log"
  "gorm.io/gorm"
  "gorm.io/gorm/logger"
  _ "github.com/googleapis/go-sql-spanner"
  spannergorm "github.com/googleapis/go-gorm-spanner"
)
func main() {
  // データベース接続を開く。
  db, err := gorm.Open(spannergorm.New(spannergorm.Config{
     DriverName: "spanner",
     DSN:        "projects/my-project/instances/my-instance/databases/my-database",
  }), &gorm.Config{PrepareStmt: true, IgnoreRelationshipsWhenMigrating: true, Logger: logger.Default.LogMode(logger.Error)})
  if err != nil {
     log.Fatalf("failed to open database: %v", err)
  }
  type User struct {
     gorm.Model
     Name  string
     Email string
  }
  if err := db.AutoMigrate(&User{}); err != nil {
     log.Fatalf("failed to migrate: %v", err)
  }
  // 新規ユーザーを挿入する
  db.Save(&User{Name: "Alice", Email: "alice@example.com"})
  // ユーザーを読み戻す
  var user User
  if err := db.First(&user, "email = ?", "alice@example.com").Error; err != nil {
     log.Fatalf("Failed to find created data, got error: %v", err)
  }
  // ユーザーの名前をプリントする
  fmt.Println(user.Name)
}

インターリーブされたテーブル

スキーマで親子関係にインターリーブされたテーブルを使うと、パフォーマンスを向上させることができます。子テーブルを親にインターリーブするということは、子レコードが親と物理的に一緒に保存されるということです。こうした関係をモデル化し、GORM で他の関連付けとして使用できます。

読み込んでいます...

CREATE SEQUENCE IF NOT EXISTS albums_seq OPTIONS (sequence_kind = "bit_reversed_positive");
CREATE TABLE IF NOT EXISTS `albums` (
  `id` INT64 DEFAULT (GET_NEXT_SEQUENCE_VALUE(Sequence albums_seq)),
  `created_at` TIMESTAMP,
  `updated_at` TIMESTAMP,
  `deleted_at` TIMESTAMP,
  `title` STRING(MAX),
  `marketing_budget` FLOAT64,
  `release_date` date,
  `cover_picture` BYTES(MAX),
  `singer_id` INT64,
  CONSTRAINT `fk_singers_albums` FOREIGN KEY (`singer_id`) REFERENCES `singers`(`id`)
) PRIMARY KEY (`id`);
CREATE SEQUENCE IF NOT EXISTS tracks_seq OPTIONS (sequence_kind = "bit_reversed_positive");
CREATE TABLE IF NOT EXISTS `tracks` (
  `id` INT64 DEFAULT (GET_NEXT_SEQUENCE_VALUE(Sequence tracks_seq)),
  `created_at` TIMESTAMP,
  `updated_at` TIMESTAMP,
  `deleted_at` TIMESTAMP,
  `track_number` INT64,
  `title` STRING(MAX),
  `sample_rate` FLOAT64,
  ) PRIMARY KEY (`id`,`track_number`), INTERLEAVE IN PARENT albums ON DELETE CASCADE;
// 上記のスキーマを以下の構造体にマッピングして GORM と連携させることができる。
type Album struct {
  gorm.Model
  Title           string
  MarketingBudget sql.NullFloat64
  ReleaseDate     spanner.NullDate
  CoverPicture    []byte
  SingerId        int64
  Singer          Singer
  Tracks          []Track `gorm:"foreignKey:id"`
}
// Track は Album にインターリーブされる。ID 列は、Track の主キーの最初の部分であり、
// Track を所有する Album への参照でもある。
type Track struct {
  gorm.Model
  TrackNumber int64 `gorm:"primaryKey;autoIncrement:false"`
  Title       string
  SampleRate  float64
  Album       Album `gorm:"foreignKey:id"`
}

ミューテーション

GORM は、デフォルトではデータ操作言語（DML）を使用します。Spanner 接続のラップを解除することで、ミューテーションを実行できます。

読み込んでいます...

その他のサンプル

GitHub リポジトリには、GORM や Cloud Spanner を使用する一般的なユースケース用の複数のサンプルのディレクトリが含まれています。

制限事項

GORM でサポートされていない Cloud Spanner の機能は、こちらに一覧化されています。

ご意見をお寄せください

特に、Cloud Spanner を検討されている Golang の開発者の方や、新規プロジェクトに database/sql の使用を検討されている Cloud Spanner の既存のお客様からのご意見をお待ちしています。このプロジェクトはオープンソースのため、GitHub でコメント、バグレポート、pull リクエストを行うことができます。

このプロジェクトに協力してくれた Knut Olav Løite に感謝いたします。

Cloud Spanner で Golang の GORM のサポートが一般提供に

Google Cloud Japan Team

はじめに

インストール

接続

使用方法

インターリーブされたテーブル

ミューテーション

その他のサンプル

制限事項

ご意見をお寄せください

関連情報

関連記事

セッションリークの見つけ方: Cloud Spanner でアプリケーションが応答しないときのデバッグ方法

Spanner で多対多の関係を解決して最適化する

Gramercy Tech と Vatom の「Build Beyond」に対する Cloud SQL の貢献

PostgreSQL の移植性と親和性の高さを Spanner のスケーラビリティと信頼性と組み合わせる

Cloud Spanner で Golang の GORM のサポートが一般提供に

Google Cloud Japan Team

はじめに

インストール

接続

使用方法

インターリーブされたテーブル

ミューテーション

その他のサンプル

制限事項

ご意見をお寄せください

関連情報

関連記事

セッション リークの見つけ方: Cloud Spanner でアプリケーションが応答しないときのデバッグ方法

Spanner で多対多の関係を解決して最適化する

Gramercy Tech と Vatom の「Build Beyond」に対する Cloud SQL の貢献

PostgreSQL の移植性と親和性の高さを Spanner のスケーラビリティと信頼性と組み合わせる

セッションリークの見つけ方: Cloud Spanner でアプリケーションが応答しないときのデバッグ方法