このページでは、REST API から返されるSQL エラーと警告について説明します。

Overview

REST API 経由でSQL クエリを実行すると、レスポンスにエラーや警告が含まれることがあります。これらは、問題を特定し、是正措置を講じるために役立つ標準化された形式で返されます。

Warnings

リクエストは正常に完了したが、実行中に1つ以上のSQL 警告が発生した場合、API はHTTP レスポンスヘッダにこれらの警告を含めます。

Header Name

SQL の警告

Format

すべての警告はSQL 警告ヘッダーに含まれ、引用符(")で囲まれ、セミコロン(;)で区切られます。

Example

HTTP/1.1 200 OK
Content-Type: application/json
SQL warnings: "First warning.";"Second warning."

クエリが正常に返された場合でも、警告は、潜在的な問題や改善のための領域を理解するのに役立つ貴重なインサイトを提供します。

Errors

クエリが正常に実行されないエラーが発生した場合、API はHTTP エラーステータスコードと、問題を説明するJSON 形式のレスポンスボディを返します。

JSON Response Body Fields

title:エラーの簡単な概要。
description:何が問題だったのかのより詳しい説明。
hint(オプション):問題の解決方法についての提案。ヒントがない場合、このフィールドはnull になります。

Example

GET <http://<cdatavirtuality-server-address>>:8080/rest/api/source/wrong_name

レスポンス(application/json):

STATUS 404
 
{
"title": "Something is wrong",
"description": "Schema 'wrong_name' doesn't exist.",
"hint": null
}


この場合、エラーは要求されたスキーマが見つからなかったことを示しています。SQL クエリにタイプミスがあるか、スキーマ名が正しくない可能性があります。スキーマ名を修正し、リクエストを再実行してください。

Handling Errors and Warnings

警告:成功した応答の後にSQL 警告ヘッダーをチェックしてください。リクエストは成功しましたが、今後このような警告が表示されないように、クエリ、構成、またはデータソースを調整する必要があるかもしれません。

エラー:詳細な説明については、返されたJSON ボディを確認してください。説明フィールドとヒントフィールドの推奨に従って、リクエストパラメータ、SQL クエリ、または基底のデータソース構成を更新します。