HTTP API

machbase-neoは、HTTP APIで2つの主要機能を提供します。あらゆる種類のSQL文を実行できるqueryと、SQLのINSERT INTO ...と同じ機能を提供するwriteです。

HTTP APIは、センサーやデバイスがMQTTやHTTPでデータを取り込む一方で、ユーザーのサービスアプリケーションやデータ分析ツールが、Machbaseデータベースに保存されたデータにアクセスできるようにすることを主な目的としています。

エンドポイント

アプリケーションやセンサーは、HTTP APIでデータを読み書きできます。

メソッド	パス	説明
GET	`/db/query`	`q`パラメーターでクエリを実行します。
POST	`/db/query`	JSONまたはフォームデータでクエリを実行します。

メソッド	パス	説明
POST	`/db/write`	JSON形式またはCSV形式でデータを保存します。
POST	`/metrics/write`	ILP（Influx Line Protocol）形式でデータを保存します。

メソッド	パス	説明
GET	`/db/tql/{tql_file_path}`	パスで指定したTQLファイルを実行します。
POST	`/db/tql/{tql_file_path}`	リクエストボディを入力として、指定したTQLファイルを実行します。
POST	`/db/tql`	リクエストボディに含まれるTQLスクリプトを実行します。
POST	`/db/tql?$={tql_script}`	クエリパラメーター`$`で渡されたTQLスクリプトを、リクエストボディとともに実行します。 Since v8.0.17

machbase-neoのWeb UIにはREST APIクライアントが組み込まれています。以下の例のように、ワークシートのMarkdownやTQLから直接HTTP APIをテストできます。

```http
GET http://127.0.0.1:5654/db/query
    ?q=select count(*) from example
    &format=ndjson
```

HTTP({
    GET http://127.0.0.1:5654/db/query
        ?q=select count(*) from example
        &format=ndjson
})
TEXT()