- 適切な権限を持つ API キー
- Admin Console ロール
最小権限API エンドポイントにクエリを実行するには、API キーに
Member 組織ロールと Query Endpoints サービスアクセスが必要です。データベースロールは、エンドポイントの作成時に設定されます。1
保存クエリを作成する
すでに保存クエリがある場合は、この手順はスキップできます。新しいクエリタブを開きます。デモ用として、約 45 億件のレコードを含む youtube dataset を使用します。
“Create table” セクションの手順に従って、Cloud サービス上にテーブルを作成し、データを挿入します。クエリ例として、ユーザーが入力した このクエリには、上のスニペットで強調表示されているパラメータ (
次に、クエリを保存します。
保存クエリの詳細については、“Saving a query” セクションを参照してください。
year パラメータに基づき、動画あたりの平均視聴回数が最も多い uploader 上位 10 件を返します。year) が含まれている点に注意してください。
クエリパラメータは、パラメータの型とともに { } を使って指定できます。
SQL Console のクエリエディタは ClickHouse のクエリパラメータ式を自動的に検出し、各パラメータ用の入力欄を表示します。正しく動作することを確認するために、SQL エディタ右側のクエリ変数入力ボックスで年 2010 を指定して、このクエリをすばやく実行してみましょう。

2
クエリ API エンドポイントを設定する
クエリ API エンドポイントは、クエリビューで Share ボタンをクリックし、
API キーを選択すると、次の項目を求められます。
インターフェイスに表示される curl コマンドを、便宜上以下に示します。
API Endpoint を選択することで直接設定できます。
どの API キーにエンドポイントへのアクセスを許可するかを指定するよう求められます。
- クエリの実行に使用するデータベースロールを選択する (
Full access、Read only、またはCreate a custom role) - クロスオリジン リソース共有 (CORS) で許可するドメインを指定する
curl コマンドの例が表示されます。
3
クエリ API パラメータ
クエリ内のクエリパラメータは、
{parameter_name: type} 構文で指定できます。これらのパラメータは自動的に検出され、リクエストペイロードの例には queryVariables オブジェクトが含まれるため、それを通じてこれらのパラメータを渡せます。4
テストと監視
クエリ API エンドポイントが作成されたら、
最初のリクエストを送信すると、Share ボタンのすぐ右側に新しいボタンが表示されるはずです。これをクリックすると、クエリに関する監視データを含むフライアウトが開きます。
curl または他の HTTP クライアントを使って動作をテストできます。

GET を使用する場合:
- 複雑にネストしたデータを含まないシンプルなクエリ
- パラメータを簡単に URL エンコードできる
- HTTP GET のセマンティクスによりキャッシュの恩恵を受けられる
- 複雑なクエリ変数 (配列、オブジェクト、長い文字列)
- セキュリティやプライバシーの観点からリクエストボディの使用が望ましい場合
- ファイルのストリーミングアップロードや大容量データ
ステータス:
200 OK
クエリは正常に実行されました。
- リクエストに有効な認証情報が含まれていることを確認する
- 送信前に
queryEndpointIdとqueryVariablesを検証する - 適切なエラーメッセージを表示するよう、適切にエラー処理を実装する
バージョン 1 からバージョン 2 にアップグレードするには、次の 2 つのヘッダーを含めます。
x-clickhouse-endpoint-upgradeヘッダーを1に設定するx-clickhouse-endpoint-versionヘッダーを2に設定する
- すべての ClickHouse フォーマットのサポート
- レスポンスのストリーミング機能
- パフォーマンスと機能の向上
- cURL
- JavaScript
- GET(cURL)
- POST(cURL)
- JavaScript
レスポンス
- GET(cURL)
- POST(cURL)
- JavaScript
レスポンス
- cURL
- JavaScript
- GET(cURL)
- POST(cURL)
- JavaScript
- TypeScript
出力
./samples/my_first_table_2024-07-11.csv を作成してください。