API docs by Redocly

Core Interface (0.1.0)

Download OpenAPI specification:

コアDBクエリ専用API
上記のDownloadよりファイルがダウンロードができない場合、openapi.jsonは次のリンクからダウンロードしてください。
openapi.json

DBクエリ実行

DBクエリを実行しその実行結果を返す。 クエリを実行した上でその内容がエラーとなる場合は、ステータスコード200でresult-type:errorのレスポンスを返す。
クエリの実行自体ができない場合は、200以外のステータスコードを返す。

header Parameters
X-hive-api-key
string

トークン認証を有効にした場合に指定するトークン文字列。

Request Body schema: application/json
required

DBクエリ

query
required
string

クエリ文字列

timeout
int [ 1 .. 180 ]
Default: 30

クエリ処理のタイムアウト(秒)、指定時間をすぎるとタイムアウトとなる

timestamp_unit
string
Default: "nanosecond"
Enum: "nanosecond" "microsecond" "millisecond" "second"

返却結果のタイムスタンプの単位

omit_option
string
Default: 0
Enum: 0 1 2

データ無し、NULL値のデータを省略するか指定する(0=NULLとデータ無し省略する,1 or 2=省略しない)

Responses

Request samples

Content type
application/json
{
  • "query": "SELECT \"comp1:data1\", \"comp2:dataA\" FROM SPDB;",
  • "timeout": 15,
  • "timestamp_unit": "nanosecond"
}

Response samples

Content type
application/json
Example
{
  • "query": "SELECT \"comp1:data1\", \"comp2:dataA\" FROM SPDB;",
  • "timestamp_unit": "nanosecond",
  • "success": true,
  • "result": {
    }
}

DBクエリ実行（ストリーム形式）

DBクエリを実行しその実行結果をストリーム形式で返す。 本APIではSELECTなどのサーバーの状態に変化を与えないクエリのみに対応する。 現時点では非対応。（将来的に追加する可能性あり）

Request Body schema: application/json
required

DBクエリ

query
required
string

クエリ文字列

timeout
int [ 1 .. 180 ]
Default: 30

クエリ処理のタイムアウト(秒)、指定時間をすぎるとタイムアウトとなる

timestamp_unit
string
Default: "nanosecond"
Enum: "nanosecond" "microsecond" "millisecond" "second"

返却結果のタイムスタンプの単位

omit_option
string
Default: 0
Enum: 0 1 2

データ無し、NULL値のデータを省略するか指定する(0=NULLとデータ無し省略する,1 or 2=省略しない)

Responses

Request samples

Content type
application/json
{
  • "query": "SELECT \"comp1:data1\", \"comp2:dataA\" FROM SPDB;",
  • "timeout": 15,
  • "timestamp_unit": "nanosecond"
}

Response samples

Content type
application/jsonlines
[
  • {
    }
]