テーブルレコードは基本的に削除しないもの、との考えから一括削除ができない仕様になっています。
テストデータ等のレコードを一括で削除するには、Tulip APIを使用する必要があります。
本記事ではTulip APIを使用した削除方法を二通りご紹介します。
前提条件
Tulip APIの利用には、「アカウント所有者」の権限が必要です。
App Editor画面右上のユーザーアイコンマークをクリックすると、どの権限が付与されているかが確認できます。
Tulip APIドキュメント上で削除する方法
- App Editor画面右上のユーザーアイコンマークより、設定画面を開く
- 画面左メニューの1番上にある「APIトークン」を開く
- 画面右上「APIトークン作成」より、APIトークンを作成する
・名称:任意の名称を入力ください
・スコープ:tables:write ※レコード全削除はtables:writeの機能が必要です。
- APIキー、シークレット、Authヘッダが表示されるので、メモ帳等にコピーしておく
※シークレットはこのタイミングでしか表示されないため、必ずコピーしてください。
- 画面右上「さらに詳しく」をクリックし、Tulip APIドキュメントを開く
- DELETE /tables/{tableId}/records delete all records of a Tulip Tableを開く
- 右側にある鍵マークより4でコピーしたAPIキーとシークレットを入力し「Authorize」>「Close」をクリックする
・Username:APIキー
・Password:シークレット
- Parameters横の「Try it out」をクリックし、以下情報を入力する
・boolean:true
・tableId:レコードを削除したいテーブルのID
※テーブルIDはテーブルを開き、テーブル名の横「i」マークより確認できます。
- Executeをクリックする
- 該当するテーブルを開き、レコードが削除されていることを確認する
アプリ上で変数にテーブルIDを入力し、削除する方法
アプリでAPIを使用する場合はコネクタを作成する必要があります。
レコードを全削除する際のコネクタの作成、トリガの設定方法について記載します。
-
コネクタの作成
- App Editor上部のメニュー「アプリ」より「コネクタ」を開く
- 画面右上「コネクタを作成」の「+カスタムコネクタの作成」よりコネクタを作成する
・名称:任意の名称 ※本記事では「テストコネクタ」としています。
・コネクタタイプ:HTTP
- 作成したコネクタを開き、画面右側にある環境設定の「本番&検証&環境」をクリックして下記情報を入力する
・実行コネクタ:Cloud Connector Host
・ホスト:インスタンスのURL
・TLS:はい
- 「ヘッダーを編集」を開き、認証項目で「ベーシック認証」を選択後、下記情報を入力して「戻る」をクリックする
・ユーザー名:APIキー
・パスワード:シークレット
- 右下の「テスト」をクリックし、テスト成功と表示されたら「保存」をクリックする
- 画面右上「+作成関数」より関数を作成する
・名称:任意の関数名 ※本記事では「レコード全削除」としています。
- 名称下の項目を下記の通り入力する
・メソッド:DELETE
・エンドポイント:/api/v3/tables/{tableId}/records
※Tulip APIドキュメントのテーブルレコード削除のメソッドとエンドポイントです。
- 7の入力箇所の下にある「関数の入力値を追加」をクリックし、入力値を作成する
・種別:テキスト
・入力値名:任意の入力値名 ※本記事では「テーブルID」としています。
- 8の入力箇所の下にある「関数の出力値を追加」をクリックし、出力値を作成する
・種別:整数
・出力値名:任意の出力値名 ※本記事では「応答コード」としています。
・種類 (ボディの選択肢):HTTPステータス
・エクストラクタ:code
- 7で入力したエンドポイントの{table}を$入力値名$に変更する
※変更すると、画像のようにグレーの四角で表示されます。
- 8入力箇所の右隣にある「クエリパラメータ」を下記の通り設定する
※Tulip APIドキュメントに記載されているパラメータを設定します。
- 画面右上の「作成」をクリックし、コネクタ関数を作成する
-
トリガの設定
- 任意のアプリのApp Editorを開く
- ボタンを配置し、トリガに下記アクションを設定する
コネクタ関数を実行>コネクタ:上記5で作成したコネクタ>上記12で作成したコネクタ関数>入力値名称 ※本記事では「テーブルID」:変数を指定>結果を保存:変数を指定
- 下記ウィジェットを配置する
・トリガで指定した変数 ※本記事では「テーブルID」と「応答コード」
・レコードを削除したいテーブルのインタラクティブテーブル - Tulip Playerでアプリを実行後、変数「テーブルID」にテーブルIDを入力し、ボタンをクリックしてテーブルレコードを削除する
- 変数「応答コード」に「204」が表示されたことを確認する