Skip to content

クラウドデータ取り込み: SQLエディター

このページでは、Brazeクラウドデータ取り込み(CDI)SQLエディターを使用して、SQLクエリで同期を作成および検証する方法について説明します。

クラウドデータ取り込みのSQLエディターを使用すると、データウェアハウスに対してSQLクエリを直接記述して同期を作成できます。これにより、以前データウェアハウス統合のステップ1.1で必要だった専用のCDIテーブルの作成やメンテナンスが不要になります。

SQLエディターは、以下のような場合に使用します。

  • アップストリームテーブルを変更せずにデータを同期したい場合
  • データウェアハウス内の生データを操作したい場合
  • PAYLOADカラムの構築を避けたい場合
  • SQLを使用してより複雑なデータユースケースを処理したい場合

前提条件と制限事項

ベータ期間中、SQLエディターには以下の制限事項があります。

  • ユーザー属性の同期のみ利用可能
  • サポートされるデータウェアハウスソースは1つ: Snowflake

新しいSQLエディター同期の作成

以下の手順に従って、SQLエディターで同期を作成します。CDI用のSnowflakeソースをすでに設定している場合は、ステップ3に進んでください。

ステップ1: Snowflakeのロール、権限、ウェアハウス、ユーザーの設定

CDIでSnowflakeソースを作成する前に、Brazeが使用するSnowflakeユーザーがクエリ対象のデータにアクセスでき、クエリを実行するためのウェアハウスを持っていることを確認してください。

ステップ1.1:(オプション)データベースとスキーマの作成

必要に応じて、CDIデータ用の専用データベースとスキーマを作成します。

1
2
CREATE DATABASE BRAZE_CLOUD_PRODUCTION;
CREATE SCHEMA BRAZE_CLOUD_PRODUCTION.INGESTION;

ステップ1.2: ロールとデータベース権限の設定

同期するテーブルへのアクセスを付与します。

1
2
3
4
5
CREATE ROLE BRAZE_INGESTION_ROLE;

GRANT USAGE ON DATABASE BRAZE_CLOUD_PRODUCTION TO ROLE BRAZE_INGESTION_ROLE;
GRANT USAGE ON SCHEMA BRAZE_CLOUD_PRODUCTION.INGESTION TO ROLE BRAZE_INGESTION_ROLE;
GRANT SELECT ON TABLE BRAZE_CLOUD_PRODUCTION.INGESTION.MY_USER_TABLE TO ROLE BRAZE_INGESTION_ROLE;

ユースケースに応じて、複数のテーブルや将来のテーブルへのアクセスを付与することもできます。たとえば、スキーマ内のすべての将来のテーブルへのアクセスを付与するには、以下のようにします。

1
GRANT SELECT ON FUTURE TABLES IN SCHEMA BRAZE_CLOUD_PRODUCTION.INGESTION TO ROLE BRAZE_INGESTION_ROLE;

ステップ1.3: ウェアハウスの設定とBrazeロールへのアクセス付与

Brazeがクエリを実行するためのウェアハウスを作成します。

1
2
CREATE WAREHOUSE BRAZE_INGESTION_WAREHOUSE;
GRANT USAGE ON WAREHOUSE BRAZE_INGESTION_WAREHOUSE TO ROLE BRAZE_INGESTION_ROLE;

ステップ1.4: Snowflakeユーザーの作成

Braze用のユーザーを作成し、ロールを割り当てます。

1
2
CREATE USER BRAZE_INGESTION_USER;
GRANT ROLE BRAZE_INGESTION_ROLE TO USER BRAZE_INGESTION_USER;

このユーザーは、BrazeでSnowflakeソースを設定する際に使用します。

ステップ2: Brazeダッシュボードでの新しいソースの作成

このステップでは、BrazeでSnowflakeソースを作成し、接続を検証します。

ステップ2.1: Snowflakeソースの追加

  1. Brazeダッシュボードで、データ設定 > クラウドデータ取り込み > ソースに移動します。
  2. データソースを追加を選択します。
  3. Snowflakeを選択します。

ステップ2.2: 接続情報の入力

ソースの名前を選択し、Snowflakeの認証情報と設定を入力します。

ステップ2.3: RSAキーの設定完了

認証情報と設定を入力した後、認証情報を保存を選択してRSAキーを生成します。次に、Snowflakeに戻って設定を完了します。ダッシュボードに表示される公開キーを、BrazeがSnowflakeに接続するために作成したユーザーに追加します。

詳細については、Snowflakeキーペア認証を参照してください。キーをローテーションしたい場合、Brazeは新しいキーペアを生成し、新しい公開キーを提供できます。

1
ALTER USER BRAZE_INGESTION_USER SET RSA_PUBLIC_KEY='MIIBIjANBgkqhkiG9w0BA...';

Brazeに戻り、接続をテストを選択してソースへのアクセスを確認し、ソースを作成します。

ステップ3: 新しい同期の作成とSQLクエリの記述

  1. データ設定 > クラウドデータ取り込み > 同期に移動します。
  2. データ同期を作成を選択します。
  3. データタイプユーザー属性を選択します。
  4. ステップ2のSnowflakeソースを参照します。
  5. SQLを選択し、データウェアハウスからユーザーデータを返すSQLクエリを記述します。SQLクエリは、Brazeに同期するデータを定義します。クエリ結果が同期のスキーマになります。

SQLが選択され、SQLエディターにサンプルクエリが表示されたデータ同期作成フロー。

SQLクエリは以下を返す必要があります。

  • ユーザー識別子(EXTERNAL_IDBRAZE_IDALIAS_NAMEALIAS_LABELEMAIL、またはPHONE
  • UPDATED_ATカラム
  • 少なくとも1つの追加カラム(属性)

ステップ4: クエリのプレビューと検証

プレビューと検証を選択してクエリを実行します。

プレビューでは以下が表示されます。

  • テーブル形式での結果
  • 最大100行
  • 最大250カラム

続行する前に、クエリのプレビューと検証を正常に完了する必要があります。エラーと修正方法の詳細については、検証の動作トラブルシューティングを参照してください。

ステップ5: 属性マッピングの確認と同期の作成

検証後:

  • 識別子カラムがユーザーと照合されます
  • UPDATED_ATカラムが増分同期を制御します
  • Brazeはその他すべてのカラムを属性として同期します

検証が成功したら、次へ: 通知に進み、同期を作成します。

SQLの制約

クエリは以下の要件を満たす必要があります。

ユーザー識別子を含める

クエリには以下のうち少なくとも1つを含める必要があります。

  • EXTERNAL_ID
  • BRAZE_ID
  • EMAIL
  • PHONE
  • ALIAS_NAMEALIAS_LABEL

有効な識別子が検出されない場合、検証は失敗します。

UPDATED_ATを含める

クエリにはUPDATED_ATカラムを含める必要があります。

UPDATED_ATは大文字と小文字が区別され、大文字で記述する必要があります。

欠落している場合、検証は失敗します。

少なくとも1つの属性カラムを含める

クエリには、以下に加えて少なくとも1つのカラムを含める必要があります。

  • ユーザー識別子カラム
  • UPDATED_AT

含まれていない場合、検証は失敗します。

SELECTクエリのみを使用する

読み取り専用クエリのみがサポートされています。

使用できるもの:

  • SELECT
  • WITH(CTE)
  • JOIN

使用できないもの:

  • INSERTUPDATE、またはDELETE
  • CREATEまたはDROP
  • ;で区切られた複数のステートメント

単一のステートメントを使用する

クエリは単一の実行可能なステートメントである必要があります。

検証の動作

SQLエディターは、続行を許可する前にクエリを検証します。

SQLエラー

クエリに構文エラーが含まれている場合:

  • 検証が失敗します
  • プレビューは表示されません
  • データウェアハウスからエラーメッセージが返されます

コンパイルエラー

クエリが無効なテーブル、カラム、または権限のないオブジェクトを参照している場合:

  • 検証が失敗します
  • プレビューは表示されません
  • データウェアハウスからエラーメッセージが返されます

接続エラー

Brazeがデータウェアハウスに接続できない場合:

  • 検証が失敗します
  • プレビューは表示されません
  • 接続エラーメッセージが表示されます

クエリタイムアウト

クエリの実行時間が長すぎる場合:

  • Brazeがクエリを終了します
  • 検証が失敗します
  • タイムアウトエラーが表示されます

必須カラムの欠落

クエリがコンパイルされても、以下の場合は検証が失敗する可能性があります。

  • 識別子カラムが見つからない
  • UPDATED_ATが欠落している
  • 属性カラムが存在しない

この場合、検証の成功に向けて役立つよう、プレビューは引き続き表示されます。

ゼロ行の結果

クエリがゼロ行を返す場合:

  • 検証は合格します
  • 同期を作成できます
  • 行が返されるまでユーザーは更新されません

PAYLOADサポート(レガシー)

SQLエディターは、PAYLOADカラムが存在するレガシーCDIテーブルをサポートしています。

クエリに以下が含まれている場合:

  • 有効な識別子
  • UPDATED_AT
  • PAYLOADカラム
  • 追加カラム

その場合:

  • BrazeはPAYLOADカラムのみを同期します
  • Brazeは追加カラムを無視します

SQL同期の編集

既存の同期を編集する場合:

  • SQLの変更には再検証が必要です
  • 無効な変更は保存できません
  • 有効な変更は保存後に反映されます

同期の実行がすでに進行中の場合、変更は次回の実行時に反映されます。

トラブルシューティング

このセクションでは、一般的なエラーとそのトラブルシューティング方法について説明します。

「プレビューを利用できません」

「プレビューを利用できません」と表示された場合、以下のいずれかのエラータイプが原因である可能性があります。

エラータイプ 解決手順
「プレビューを利用できません」 エラーバナーのヒントを確認してください。
「ソースに接続できません」 設定されたユーザー名、アカウントロケーター、RSAキーペア認証の設定を確認してください。
ウェアハウスが実行中であることを確認してください。
ネットワークアクセスを確認してください。
「SQL構文エラー」 SQL構文を確認してください。
「オブジェクトが存在しないか、権限がありません」 ロールがテーブルに対するSELECTアクセス権を持っていることを確認してください。
データベースとスキーマの権限を確認してください。
テーブル名のタイプミスを確認してください。

「識別子カラムが必要です」

クエリにexternal_idなどの有効な識別子が含まれていることを確認してください。

UPDATED_ATカラムがありません」

増分同期用のタイムスタンプカラムを追加してください。

「同期する属性がありません」

識別子とUPDATED_AT以外に、少なくとも1つの追加カラムを追加してください。

「クエリの実行がタイムアウトしました」

クエリを最適化するか、より大きなウェアハウスを使用してください。

New Stuff!