Nile REST API: SQLクエリをエンドポイントに変換する

REST API · エンドポイントへのナイル

ターン ナイル川 SQLクエリを REST API 終点

クエリビルダーでクエリを保存するには、 新しいエンドポイントapi.querystreams.com に独自のキーを持つ URL が割り当てられます。SQL は、Nile データベースに既にインストールされているエージェント上で読み取り専用で実行されます。呼び出し元は JSON または CSV を受け取り、SQL、スキーマ、パスワードを見ることはありません。ホストするものも、開くポートもありません。保存したクエリから約 90 秒で完了し、無料プランでは最初のエンドポイントがカバーされます。

保存済みクエリから約90秒 ホストするサーバーがありません 認証情報はあなたと共にあります 発信者ごとに1つのキー、いつでも取り消し可能

最終的に手に入るもの

URL api.querystreams.com これは、保存したNileクエリの行をJSONまたはCSV形式でキーを持つユーザーに返します。共有する前に、ポータルのコンソールでテストしてください。例：

{
  "名前": 「シアトル」
}

curl -X POST "https://api.querystreams.com/v1/endpoints/8f2c4d1e-6b3a-4f7e-9c21-5d0a7b3e2f19" \ -H "X-API-Key: qsapi_YOUR_KEY" \ -H "Content-Type: application/json" \ -d '{"name": "Seattle"}'

{
  「列」: [ { "名前": 「テナントID」, "タイプ": "整数" }, { "名前": 「顧客ID」, "タイプ": "弦" }, { "名前": "名前", "タイプ": "弦" } ],
  「行」: [
    { 「テナントID」: 1042, 「顧客ID」: 「ノースウィンド・トレーダーズ」, "名前": 「シアトル」 },
    { 「テナントID」: 1057, 「顧客ID」: 「アルパイン・アウトフィッターズ」, "名前": 「デンバー」 },
    { 「テナントID」: 1063, 「顧客ID」: 「ハーバーフーズ」, "名前": 「ハリファックス」 }
  ],
  「メタ」: { 「行数」: 3, 「agent_duration_ms」: 41, 「リクエストID」: "req_7Hq2mKd9" }
}

Nileは、プロバイダーが運用するクラウド上にデータを保持します。他のユーザーがアプリ、ダッシュボード、スクリプトなどでそのデータの一部を利用したい場合、従来の解決策では、プロジェクトの終了まで有効なデータベースログイン、朝食時には古くなってしまう夜間エクスポート、あるいは誰かが運用とパッチ適用をしなければならない小規模なAPIサーバーなど、多くのリソースを渡す必要が生じます。Query Streamsは、エンドポイントを保存済みのクエリとキーで構成します。Nileデータベースに既に存在するエージェントがクエリを実行し、api.querystreams.comがキーとレート制限をチェックし、呼び出し元がデータを取得します。SQL、スキーマ、認証情報は、お客様のアカウントから外部に送信されることはありません。

必要なもの

クエリストリームアカウント

すべてのプランにREST APIが含まれています。無料プランでは、エンドポイント1つ、キー2つ、呼び出しごとに250行まで利用できます。これはこのガイドを作成するのに十分です。サインアップはこちらから。 my.querystreams.com.

ナイル接続が追加された、常時稼働中のコンピュータ上のエージェント

必要なのはインターネット接続だけです。

クエリビルダーに保存されたクエリ

エンドポイントは、保存されたクエリを正確に 1 つラップします。SELECT を記述し、一度実行して保存します。動的フィルタ ( 変数 呼び出し元がフィルタリングできるようにするためには、WHERE句で指定します。

4つのステップで設定できます

1. クエリを保存します

   で クエリビルダー Nile接続を選択し、公開したいSELECT文を記述して一度実行し、行を確認してください。呼び出し元が必要とする列のみを指定してください。エンドポイントはクエリが返すものと全く同じものを返します。

   保存されたクエリ · 顧客

   セレクト テナントID、顧客ID、名前、都市
   フロム 一般のお客様
   注文 による 名称
   リミット 100;

   呼び出し元がフィルタリングできるようにする必要がある場合は、たとえば動的フィルタを追加します。 WHERE name = @name。 それぞれ 変数 ステップ3でAPIパラメータになります。 セーブ そしてクエリに名前を付けます。その名前がエンドポイントの表示名になります。

2. エンドポイントを作成します

   開く API 上部のバーをクリックして 新しいエンドポイント魔法使いには4つのステップがあります。 クエリを選択する, 設定, パラメータをロックする そして シェア。 の上 クエリを選択する先ほど保存したクエリをクリックします。エージェントがオフラインのクエリはグレー表示されます。 次のページ.

   オープンAPI

   ショートカット。 クエリビルダーから開いているクエリを直接表示できます。ウィザードは次の場所から始まります。 設定 既に選択されたクエリを使用しています。

3. パラメータを設定してロックする

   の上 設定 デフォルト設定は最初のエンドポイントには適切です。 表示名 クエリから入力された、 寿命 永久（選択） 期限切れ （一時的なシェアの場合） 応答モード 静的（JSONレスポンス1つ、選択可能） ストリーミング配信 プランの静的行数上限を超える結果については、 内部フォーマット JSON。レスポンスモードとフォーマットは作成後に固定されるため、ここで決定してください。クリック 次のページ.

   の上 パラメータをロックする クエリ内のすべての動的フィルターが一覧表示されます。呼び出し元が設定できるものはそのままにしておきます。 呼び出し可能 そしてそれぞれに クエリ文字列名; チェック 必須 呼び出し時にそれがなければ失敗する可能性がある。呼び出し元が変更してはならない値を固定する。 ロック済みまたは、次のようなデートのシナリオ 月初め. 隠れた クエリのデフォルト値を保持し、それを設定しようとする試みを拒否します。 次のページ.

4. シェアしてキーを手に入れよう

   の上 シェア 招待できます 人々 メールで、または追加 サービスキー サーバーまたは自動化ツールを選択するか、両方とも今はスキップしてください。 キーを作成して取得する成功画面にはエンドポイント URL とキーが表示されます。キーは 49 文字の文字列で、 qsapi_コピーしてください。後でエンドポイントから再度表示できます。 共有 タブとして保存されるため、画面を閉じても失われることはありません。

   クリック 送信 コンソールで、ポータル自体から最初の呼び出しを行います。応答ペインには、 ステータス, 時間 そして サイズ、 体 タブには JSON が表示され、呼び出しは 活動 数秒後にタブキーを押す。

どこからでも電話できます

コンソールのURLバーからエンドポイントIDを自分のものに置き換えて、 qsapi_YOUR_KEY キーを使用して。呼び出し可能なパラメータはGETのクエリ文字列に含まれます。ここでは保存されたクエリが公開されます。 名称:

curl "https://api.querystreams.com/v1/endpoints/8f2c4d1e-6b3a-4f7e-9c21-5d0a7b3e2f19?name=Seattle" \ -H "X-API-Key: qsapi_YOUR_KEY"

{
  「列」: [ { "名前": 「テナントID」, "タイプ": "整数" }, { "名前": 「顧客ID」, "タイプ": "弦" }, { "名前": "名前", "タイプ": "弦" } ],
  「行」: [
    { 「テナントID」: 1042, 「顧客ID」: 「ノースウィンド・トレーダーズ」, "名前": 「シアトル」 },
    { 「テナントID」: 1057, 「顧客ID」: 「アルパイン・アウトフィッターズ」, "名前": 「デンバー」 },
    { 「テナントID」: 1063, 「顧客ID」: 「ハーバーフーズ」, "名前": 「ハリファックス」 }
  ],
  「メタ」: { 「行数」: 3, 「agent_duration_ms」: 41, 「リクエストID」: "req_7Hq2mKd9" }
}

行は列名をキーとするオブジェクトとして返され、列リストと メタ 行数、結果が切り捨てられたかどうか、およびサポートのために引用できるリクエスト ID を示すブロック。POST と同じ呼び出しでパラメータが JSON ボディに格納されます。これは、長い値のリストに適した方法です。

curl -X POST "https://api.querystreams.com/v1/endpoints/8f2c4d1e-6b3a-4f7e-9c21-5d0a7b3e2f19" \ -H "X-API-Key: qsapi_YOUR_KEY" \ -H "Content-Type: application/json" \ -d '{"params": {"name": "Seattle"}}'

?format=csv

JSONではなくCSV形式で、ヘッダー行も含まれます。 受け入れ可能な形式: text/csv も同様です。ストリーミングエンドポイントは、最終的な NDJSON (1 行に 1 つの JSON オブジェクト) を返します。 {"_summary": true, "row_count": N} 行; 最後の行を確認してください。

?sample=true

最大5行まで、課金対象外。顧客への配線に最適です。

?圧縮=lz4

デコーダーを備えた大音量発信者向けのLZ4フレームボディ。 コード タブには言語ごとのデコーダーのスニペットがあります。通常のgzipは、クライアントが送信するときに自動的に行われます。 Accept-Encoding: gzip.

認証: Bearer qsapi_…

別名として受け入れられた X-APIキーブラウザのコードから使用します。

プラグを差し込む場所

計画で許可されている内容

すべての呼び出しには、60秒の固定クエリタイムアウトと8MiBの応答上限が設定されており、返されるバイト数は、ExcelやGoogleスプレッドシートのアドインと同じ、プランの月間データ許容量にカウントされます。無料プランではエンドポイントが1つ、月間5MBまで利用できますが、これは1日に何度も呼び出される小さなテーブルであれば十分対応できます。 価格ページをご覧ください プランごとの手当について。

安全に保つ

何かがうまくいかないとき

すべてのエラーボディは、 {"error": {"code": "…", "message": "…"}} そしてすべての反応には X-QSリクエストID ヘッダー。サポートに問い合わせる際は、IDを引用してください。

人々が尋ねる質問

関連ガイド

• MCPを使用してナイルとクロードを接続する
• データベースREST API：あらゆるSQLクエリをエンドポイントに変換する
• Microsoft SQL Server REST API
• PostgreSQL REST API
• MySQL REST API
• Snowflake REST API