ステートメント実行アクション

リクエスト

POST /api/query/<ns_name>/<db_name>

説明

ステートメント実行アクションは、ステートメントを実行して結果を返します。

パスパラメータ

• <ns_name>

  名前空間を指定します。現在サポートされているのは default_cluster のみです。

• <db_name>

  データベース名を指定します。このデータベースは現在のセッションのデフォルトデータベースとして扱われます。SQL 内のテーブル名にデータベース名が指定されていない場合、このデータベースが使用されます。

クエリパラメータ

なし

リクエストボディ

{
    "stmt" : "select * from tbl1"
}

• stmt フィールドには、実行する SQL ステートメントを指定します。

レスポンス

• 結果セットを返す場合

  {
      "msg": "success",
      "code": 0,
      "data": {
          "type": "result_set",
          "data": [
              [1],
              [2]
          ],
          "meta": [{
              "name": "k1",
              "type": "INT"
          }],
          "status": {},
          "time": 10
      },
      "count": 0
  }
  • type フィールドが result_set の場合、結果セットが返されます。meta と data の各フィールドを基に結果を取得して表示します。meta フィールドには返された列の情報が、data フィールドには結果行が含まれます。各行の列の型は meta フィールドの内容から判断します。status フィールドには警告行数やステータスコードなど、MySQL に関する情報が含まれます。time フィールドは実行時間をミリ秒単位で表します。

• 実行結果を返す場合

  {
      "msg": "success",
      "code": 0,
      "data": {
          "type": "exec_status",
          "status": {}
      },
      "count": 0,
      "time": 10
  }
  • type フィールドが exec_status の場合、実行結果が返されます。現時点では、この応答を受信した場合、ステートメントは正常に実行されたことを意味します。