Spanner Graph スキーマを作成、更新、削除する

このドキュメントでは、Spanner Graph を設定してクエリを実行するで作成したサンプルスキーマを使用して、Spanner Graph でプロパティグラフを作成、更新、削除する方法について説明します。

Spanner を使用すると、ダウンタイムなしでスキーマの更新を行うことができます。既存のデータベースのスキーマは、次のいずれかの方法で更新できます。

Google Cloud コンソール

[Spanner Studio] ページでコマンドを送信します。

[Spanner Studio] ページにアクセスするには、[データベースの概要] ページまたは [テーブルの概要] ページで [Spanner Studio] をクリックします。Spanner Studio へのアクセスの詳細については、Google Cloud コンソールを使用してデータを管理するをご覧ください。
gcloud spanner コマンドラインツール

gcloud spanner databases ddl update コマンドを使用してコマンドを送信します。
クライアントライブラリ
projects.instances.databases.updateDdl REST API
UpdateDatabaseDdl RPC API

プロパティグラフスキーマを作成する

プロパティグラフスキーマの詳細については、Spanner Graph スキーマの概要をご覧ください。

プロパティグラフスキーマを作成するには、次の操作を行います。

ノード入力テーブル Person と Account を作成します。これらのテーブルは、プロパティグラフの例のノード定義の入力テーブルとして使用されます。

CREATE TABLE Person (
  id               INT64 NOT NULL,
  name             STRING(MAX),
  birthday         TIMESTAMP,
  country          STRING(MAX),
  city             STRING(MAX),
) PRIMARY KEY (id);

CREATE TABLE Account (
  id               INT64 NOT NULL,
  create_time      TIMESTAMP,
  is_blocked       BOOL,
  nick_name        STRING(MAX),
) PRIMARY KEY (id);

エッジ入力テーブル PersonOwnAccount と AccountTransferAccount を作成します。これらのテーブルは、プロパティグラフの例のエッジ定義の入力テーブルとして使用されます。

CREATE TABLE PersonOwnAccount (
  id               INT64 NOT NULL,
  account_id       INT64 NOT NULL,
  create_time      TIMESTAMP,
  FOREIGN KEY (account_id) REFERENCES Account (id)
) PRIMARY KEY (id, account_id),
  INTERLEAVE IN PARENT Person ON DELETE CASCADE;

CREATE TABLE AccountTransferAccount (
  id               INT64 NOT NULL,
  to_id            INT64 NOT NULL,
  amount           FLOAT64,
  create_time      TIMESTAMP NOT NULL,
  order_number     STRING(MAX),
  FOREIGN KEY (to_id) REFERENCES Account (id)
) PRIMARY KEY (id, to_id, create_time),
  INTERLEAVE IN PARENT Account ON DELETE CASCADE;

CREATE PROPERTY GRAPH ステートメントの例を使用して、プロパティグラフを定義します。

次の例では、Account ノード、Person ノード、PersonOwnAccount エッジ、AccountTransferAccount エッジを持つ FinGraph という名前のプロパティグラフを定義しています。

CREATE PROPERTY GRAPH FinGraph
  NODE TABLES (
    Account,
    Person
  )
  EDGE TABLES (
    PersonOwnAccount
      SOURCE KEY (id) REFERENCES Person (id)
      DESTINATION KEY (account_id) REFERENCES Account (id)
      LABEL Owns,
    AccountTransferAccount
      SOURCE KEY (id) REFERENCES Account (id)
      DESTINATION KEY (to_id) REFERENCES Account (id)
      LABEL Transfers
  );

この例は、次のベストプラクティスに従っています。

詳細については、グラフスキーマ設計のベストプラクティスをご覧ください。

Spanner Graph スキーマの一般的なエラーについては、Spanner Graph のトラブルシューティングをご覧ください。

プロパティグラフスキーマを更新する

プロパティグラフスキーマは、次の方法で更新できます。

新しいノード定義またはエッジ定義を追加します。
既存のノード定義またはエッジ定義を更新します。
既存のノード定義またはエッジ定義を削除します。

いずれの場合も、更新されたスキーマを使用してプロパティグラフを再作成する必要があります。

新しいノード定義またはエッジ定義を追加する

新しいノード定義と新しいエッジ定義を追加する手順は次のとおりです。

新しい入力テーブルを追加します。

新しいグラフ要素定義に関連付けられた入力テーブルを定義します。次の例では、2 つの新しい入力テーブル Company と PersonInvestCompany を追加されます。

CREATE TABLE Company (
  id INT64 NOT NULL,
  name STRING(MAX)
) PRIMARY KEY (id);

CREATE TABLE PersonInvestCompany (
  id INT64 NOT NULL,
  company_id INT64 NOT NULL,
  FOREIGN KEY (company_id) REFERENCES Company (id)
) PRIMARY KEY (id, company_id),
  INTERLEAVE IN PARENT Person ON DELETE CASCADE;

CREATE OR REPLACE PROPERTY GRAPH を使用してグラフを更新します。次の例では、新しいノード定義 Company と新しいエッジ定義 PersonInvestCompany を追加して、FinGraph スキーマを更新します。

CREATE OR REPLACE PROPERTY GRAPH FinGraph
  NODE TABLES (
    Person,
    Account,
    Company
  )
  EDGE TABLES (
    AccountTransferAccount
      SOURCE KEY (id) REFERENCES Account
      DESTINATION KEY (to_id) REFERENCES Account
      LABEL Transfers,
    PersonOwnAccount
      SOURCE KEY (id) REFERENCES Person
      DESTINATION KEY (account_id) REFERENCES Account
      LABEL Owns,
    PersonInvestCompany
      SOURCE KEY (id) REFERENCES Person
      DESTINATION KEY (company_id) REFERENCES Company
      LABEL Invests
  );

既存のノード定義またはエッジ定義を更新する

既存のノード定義またはエッジ定義を更新する手順は次のとおりです。

入力テーブルのスキーマを更新します。次の例では、入力テーブル Person に mailing_address 列を追加します。
```
ALTER TABLE Person
ADD COLUMN mailing_address STRING(MAX);
```
CREATE OR REPLACE PROPERTY GRAPH を使用してプロパティグラフスキーマを更新します。次の例では、CREATE OR REPLACE PROPERTY GRAPH ステートメントを使用して、Person ノード定義に新しいプロパティ mailing_address を追加します。この例では、入力テーブルのスキーマが変更されたため、Person ノード定義が変更された Person テーブル定義を自動的に取得します。
```
CREATE OR REPLACE PROPERTY GRAPH FinGraph
  NODE TABLES (
    Person,
    Account
  )
  EDGE TABLES (
    AccountTransferAccount
      SOURCE KEY (id) REFERENCES Account
      DESTINATION KEY (to_id) REFERENCES Account
      LABEL Transfers,
    PersonOwnAccount
      SOURCE KEY (id) REFERENCES Person
      DESTINATION KEY (account_id) REFERENCES Account
      LABEL Owns
  );
```
PROPERTIES clause() を使用して、入力テーブルから公開されるプロパティをカスタマイズすることもできます。詳細については、ラベルとプロパティをカスタマイズするをご覧ください。

既存のノード定義またはエッジ定義を削除する

既存のノード定義またはエッジ定義を削除するには、それらのノードまたはエッジテーブルのないプロパティグラフを再作成します。

次の例では、Person ノード定義と PersonOwnAccount エッジ定義を削除します。

CREATE OR REPLACE PROPERTY GRAPH FinGraph
  NODE TABLES (
    Account
  )
  EDGE TABLES (
    AccountTransferAccount
      SOURCE KEY (id) REFERENCES Account
      DESTINATION KEY (to_id) REFERENCES Account
      LABEL Transfers
  );

プロパティグラフスキーマを削除する

グラフスキーマを削除するには、DROP PROPERTY GRAPH DDL ステートメントを使用します。

次の例では、FinGraph プロパティグラフスキーマを削除します。

DROP PROPERTY GRAPH FinGraph;

Spanner Graph スキーマを作成、更新、削除する

プロパティ グラフ スキーマを作成する

プロパティ グラフ スキーマを更新する