クーポン在庫を順次払い出すAPIをKARTE Craftで実装してみた

<html><head></head><body><p>こんにちは、Customer Engineerの道畑です！最近は「雨と君と」という漫画のたぬき(犬)にドはまりしています！ハマりすぎて自宅のデスクがたぬき(犬)の人形だらけです(笑)。</p>
<p>さて、今回はDatahubで実行したクエリの実行結果をCraft Key-Value Store (Craft KVS)に格納してみました。</p>
<p>Craft Functionsを使ってユーザー固有の接客を実装したいとき、事前に接客情報をCraft KVSに登録しておく必要があります。例えば、ユーザーに固有のクーポンを払い出したいときなどです。初期導入時のコストとハードルを少しでも下げるために、カラム名を変更するだけで使える汎用的なCraft Functionsを作成しました。カラム名を変更するだけで実行できるようにしたので、是非コピペして試してみてください！</p>
<h1 id="全体像">全体像</h1>
<p>実現する処理の全体像は、次の通りです。<br>
DatahubのJobflowからクエリを実行して、実行結果をCraft Functionに渡して、それをCraft KVSに格納するというとてもシンプルなものです。<br>
<img src="https://ik.imagekit.io/plaid/520c53ab-40d2-4ac3-b265-94e3aa45c176/%E6%A7%8B%E6%88%90%E5%9B%B3.jpg" alt="構成図.jpg"></p>
<h1 id="実装手順">実装手順</h1>
<p>実装の手順は次の通りです。</p>
<ol>
<li>Craft KVSに格納したいデータを取得できるSQLを書く</li>
<li>Craft KVSに格納するCraft Functionsを作る</li>
<li>SQLの結果をCraft Functionsに渡すJobflowを作成する</li>
</ol>
<p>順番に説明します。</p>
<h2 id="1. Craft KVSに格納したいデータを取得できるSQLを書く">1. Craft KVSに格納したいデータを取得できるSQLを書く</h2>
<p>まずはSQLを作成します。「Datahub &gt; クエリ &gt; 作成 &gt; クエリを作成」から下記のようにクエリを作成してください。</p>
<pre><code class="hljs"><span class="hljs-keyword">SELECT</span>
  coupon_id,
  already_used,
  user_id
<span class="hljs-keyword">FROM</span>
  `prd<span class="hljs-operator">-</span>karte<span class="hljs-operator">-</span><span class="hljs-keyword">per</span><span class="hljs-operator">-</span>client.xxxx_table名`
</code></pre>
<p>今回はクーポン情報を管理しているテーブルを丸ごと抽出するSQLをテスト用に用意しました。このテーブルは「coupon_id」が一意キーとなるようにテーブルが作られています。「coupon_id」はCraft KVSでもキーになるように後述のサンプルコードを作成しています。一番最初のSELECT項目がCraft KVSのキーになることをご注意ください。例えば、user_idをCraft KVSのキーにしたい場合は次の様にSQLを作成します。</p>
<p>例)user_idをCraft KVSのキーにしたい場合のSQL</p>
<pre><code class="hljs"><span class="hljs-keyword">SELECT</span>
  user_id,
  already_used,
  coupon_id
<span class="hljs-keyword">FROM</span>
  `prd<span class="hljs-operator">-</span>karte<span class="hljs-operator">-</span><span class="hljs-keyword">per</span><span class="hljs-operator">-</span>client.xxxx_table名`
</code></pre>
<h2 id="2. Craft kvsに格納するCraft Functionsを作る">2. Craft kvsに格納するCraft Functionsを作る</h2>
<p>次に、実行したクエリ結果をCraft KVSに格納するCraft Functionsを作ります。次のコードを利用して、Craft Functionsを新規作成します。</p>
<p><a href="https://github.com/plaidev/craft-codes/tree/main/craft-functions/datahub-to-kvs" target="_blank" rel="noreferrer">craft-codes/craft-functions/datahub-to-kvs at main · plaidev/craft-codes</a></p>
<p>実際に利用する際には以下の2つに気をつけてください。</p>
<ol>
<li>「HEADER_COLUMNS」の部分は、SQLのカラムに合わせて修正してください。</li>
<li>「MINUTES_TO_EXPIRE 」はCraft KVSにデータを保存する期間を保持しています。必要に応じて変更してください。<a href="https://craft.developers.karte.io/reference/craft-key-value-store/index.html#write" target="_blank" rel="noreferrer">詳しくはこちらをご確認ください。</a></li>
</ol>
<p>「modules」は次のキャプチャの様に空欄でOKです。</p>
<p><img src="https://ik.imagekit.io/plaid/a7b2ab6a-7067-4e25-85bd-ebf52bdde7a7/%E3%82%B9%E3%82%AF%E3%83%AA%E3%83%BC%E3%83%B3%E3%82%B7%E3%83%A7%E3%83%83%E3%83%882023-09-2612.05.18.png" alt="スクリーンショット2023-09-2612.05.18.png"></p>
<p>Datahubからデータが渡された想定でこちらのCraft Functionsを実行すると、下記のようにCraft KVSに格納されます。「Key」に該当レコードの1つ目のカラム情報が入り、「Value」に「{カラム名：レコード情報}」がカンマ区切りで格納されます。</p>
<h6 id="テーブル情報">テーブル情報</h6>
<div class="TableScroll"><table>
<thead>
<tr>
<th>coupon_id</th>
<th>already_used</th>
<th>user_id</th>
</tr>
</thead>
<tbody>
<tr>
<td>coupon_id01</td>
<td>FALSE</td>
<td>U-001</td>
</tr>
<tr>
<td>coupon_id02</td>
<td>FALSE</td>
<td>U-002</td>
</tr>
<tr>
<td>coupon_id03</td>
<td>FALSE</td>
<td>U-003</td>
</tr>
<tr>
<td>coupon_id04</td>
<td>FALSE</td>
<td>U-004</td>
</tr>
</tbody>
</table></div>
<h6 id="Craft KVS格納イメージ">Craft KVS格納イメージ</h6>
<div class="TableScroll"><table>
<thead>
<tr>
<th>Key</th>
<th>Value</th>
</tr>
</thead>
<tbody>
<tr>
<td>coupon_id01</td>
<td>{"coupon_id":"coupon_id01","already_used":"false","user_id":"U-001"}</td>
</tr>
<tr>
<td>coupon_id02</td>
<td>{"coupon_id":"coupon_id02","already_used":"false","user_id":"U-002"}</td>
</tr>
<tr>
<td>coupon_id03</td>
<td>{"coupon_id":"coupon_id03","already_used":"false","user_id":"U-003"}</td>
</tr>
<tr>
<td>coupon_id04</td>
<td>{"coupon_id":"coupon_id04","already_used":"false","user_id":"U-004"}</td>
</tr>
</tbody>
</table></div>
<h2 id="3. SQLの結果をCraft Functionsに渡すJobflowを作成する">3. SQLの結果をCraft Functionsに渡すJobflowを作成する</h2>
<p>最後に、作成したSQLとCraft Functionsを繋ぐJobflowを作成します。Jobflowを下記の内容で新規作成してください。</p>
<ul>
<li>エクスポート元：作成したクエリ</li>
<li>エクスポート先：外部サービス</li>
<li>接続先：Craft</li>
<li>function名：作成したCraft Functions</li>
<li>行ごとにqueue をpublishする：チェックを入れる</li>
</ul>
<p>「行ごとにqueue をpublishする」のチェックを忘れると、今回作成したCraft Functionsでは正しく動作しないので気をつけてください。</p>
<p><img src="https://ik.imagekit.io/plaid/5ad2b621-10ab-4d66-89f9-a0bf63f75347/%E3%82%B9%E3%82%AF%E3%83%AA%E3%83%BC%E3%83%B3%E3%82%B7%E3%83%A7%E3%83%83%E3%83%882023-09-2612.25.32.png" alt="スクリーンショット2023-09-2612.25.32.png"></p>
<p>このJobflowを実行するとSQLの実行結果をCraft FunctionsでCraft KVSに格納できます。<br>
<img src="https://ik.imagekit.io/plaid/ea854668-0d07-4499-bb53-85379ea22e6d/%E3%82%B9%E3%82%AF%E3%83%AA%E3%83%BC%E3%83%B3%E3%82%B7%E3%83%A7%E3%83%83%E3%83%882023-09-2613.06.08.png" alt="スクリーンショット2023-09-2613.06.08.png"></p>
<h1 id="おわりに">おわりに</h1>
<p>今回はDatahubクエリの結果をCraft KVSに格納する方法をご紹介しました。Craft KVSにはCraft Functionsからしかアクセスできないという制約がありますが、今回のサンプルコードを使えばDatahubクエリの結果をジョブフローの設定だけで簡単にCraft KVSにエクスポートできます。Craft FunctionsからDatahubのデータを参照できるに近しい動きができるようになるので、ぜひ皆さん使ってみてください！</p>
<hr>
<p>プレイドでは、世の中にインパクトを与える新しいソリューションを一緒につくる仲間を募集しています！<br>
ぜひ気軽にお問い合わせください。</p>
<p>↓ パートナー企業になりたい</p>
<ul>
<li><a href="https://ecosystem.plaid.co.jp/" target="_blank" rel="noreferrer">CustomerData-Driven Solution を一緒に創りませんか？ | PLAID Ecosystem</a></li>
</ul>
<p>↓ PLAIDで働きたい</p>
<ul>
<li><a href="https://recruit.plaid.co.jp/requisitions/general-customer-engineer" target="_blank" rel="noreferrer">Customer Engineer | 募集ポジション | 株式会社プレイド</a></li>
<li><a href="https://recruit.plaid.co.jp/requisitions/product-engineer" target="_blank" rel="noreferrer">Product Engineer | 募集ポジション | 株式会社プレイド</a></li>
</ul>
</body></html>

Datahubで実行したクエリ結果をCraft kvsに格納する方法をご紹介します！

Datahubクエリの結果をCraft KVSに格納してみた