ForHosting KIT · サイト取得・監視

SQLを整形してクエリを読みやすく表示

一行に詰まったSQLや表記が不ぞろいなSQLを、予約語の大文字化、一定の空白、構造に沿った字下げによって読みやすく整形します。決定的な字句解析を行うため、引用符で囲まれた文字列や識別子は保持しながら、句や入れ子の式を確認しやすくできます。出力前には構造も検査し、対応する相手がない括弧、閉じていない引用文字列、終端のない引用識別子を不正な入力として拒否します。ブラウザーで直接お使いいただくほか、1回のリクエストにつき$0.002でAPIから同じ処理を自動化できます。

● Beta無料・ブラウザ内で実行

無料で実行 API仕様を見る

ご利用方法ウェブAPIメールTelegramアプリ近日

整形で変更する部分と保持する部分

認識したSQL予約語を大文字に変換し、SELECT、FROM、WHERE、GROUP BY、ORDER BY、HAVING、LIMITや一般的なJOINなどの主要な句を見やすい行に分けます。コンマではリストの各要素を分離し、括弧では入れ子の式やサブクエリに字下げの段階を追加します。演算子の前後には一定の空白を設けます。一方、区切られた内容は保護対象です。単一引用符内の文字列、二重引用符やバッククォート内の識別子、角括弧内の識別子については、元の文字と大文字・小文字を保持します。行コメントとブロックコメントも出力に残します。そのため、データベースのスキーマを推測せずに、クエリを確認しやすくできます。処理は常に決定的で、同じ入力からは同じ出力が得られます。ネットワーク、モデルによる解釈、乱数、実行環境には依存しません。結果はformatted_sqlフィールドのプレーンテキストとして返され、エディター、マイグレーション、報告書、コードレビューへコピーしてお使いいただけます。

構造検査によって結果を安全にする仕組み

見た目が整っていても、不完全なクエリを隠してしまっては役に立ちません。そのため、配置を決めた後ではなく、トークンへ分割する段階で検査します。開き括弧には必ず対応する閉じ括弧が必要で、開く前に閉じ括弧が現れることも認めません。単一引用符の文字列、二重引用符、バッククォート、角括弧の識別子は、いずれも正しく閉じる必要があります。引用された値の中で引用符を二つ重ねた場合はエスケープとして認識するため、SQLで一般的な、アポストロフィを二つの単一引用符で表す記法も扱えます。バックスラッシュによるエスケープも一まとまりとして保持します。終端のないブロックコメントは、残りを安全に整形できないため拒否します。これらは構造の検査であり、意味の検証ではありません。データベースへの接続、表名や列名の確認、方言の選択、実行可能性の判定は行いません。括弧や引用符が対応していても、製品固有の構文誤りが残る場合があります。したがって、完全なSQLコンパイルをうたわず、対応しない括弧や引用符を入力エラーとして明確に示します。

整形済みSQLを確実な作業手順で利用する方法

完全なクエリをqueryフィールドへ貼り付け、文字列として送信してください。対話的に利用する場合は、本番コードを置き換える前に整形結果と原文を比較してください。データベース製品独自の演算子や特殊な引用規則を使う文では、特に確認が重要です。自動処理では、生成したマイグレーションを保存する前、レビュー課題へSQLを添付する前、またはクエリの変更を比較する前に整形できます。配置が統一されると差分の雑音が減り、レビュー担当者は大文字や空白ではなく、結合、条件、選択列、並び順に集中できます。コメントと引用値は保持されるため、文書化にも実行用にも利用できますが、データベース側の検証やテストの代わりにはなりません。ブラウザー版とAPIは同じ純粋関数を使うため、結果が一致します。APIの料金は1回のリクエストにつき$0.002です。外部サービスを使わずに処理し、応答後にクエリを保持する必要はありません。検査に失敗した場合は、対応していない区切り文字を修正し、文全体をもう一度送信してください。

活用例

生成されたSQLを整理

ORM、ログ、帳票ツールが一行で出力したクエリを、確認や相談がしやすい配置へ変換します。

マイグレーションレビューを統一

レビュー前に大文字表記と字下げを一定にし、書式だけに起因する差分を減らします。

貼り付け途中のクエリを検出

括弧や引用符が欠けたSQLを、文書への掲載や別システムへの送信前に拒否します。

よくある質問

SQLは実行されますか？

いいえ。ローカルな字句整形と構造検査だけを行います。データベースへの接続やスキーマの参照は行いません。

大文字と小文字はどのように扱われますか？

認識したSQL予約語を大文字にします。引用された文字列と識別子は元の表記を保持します。

何を検査しますか？

対応しない括弧、閉じていない単一・二重引用符、バッククォートや角括弧内の未完了識別子、終端のないブロックコメントを拒否します。

すべてのSQL方言に対応しますか？

方言を選ばず、一般的なSQL構文を整形します。製品固有の構文は保持しますが、その意味の正しさは保証しません。

APIの料金はいくらですか？

APIは1回のリクエストにつき$0.002です。ブラウザー版でも同じ決定的な整形処理を実行します。

開発者向け — APIアクセス

このページの機能はすべてAPIからも利用できます。自社システムに組み込みたいチーム向けのセクションです。それ以外の方は上のツールをそのままお使いください。

エンドポイント

POSThttps://api.kit.forhosting.com/web/sql-format

Bearerトークンで認証し、POST1回でタスクをキューに登録します。結果はWebhookまたは署名付きリンクで受け取れます。

お使いのスタックから呼び出す

curl -X POST https://api.kit.forhosting.com/web/sql-format \
  -H "Authorization: Bearer $KIT_KEY" \
  -H "Content-Type: application/json" \
  -d '{"query":"select u.id,u.name,count(o.id) as orders from users u left join orders o on o.user_id=u.id where u.active=true group by u.id,u.name order by orders desc;"}'

const res = await fetch("https://api.kit.forhosting.com/web/sql-format", {
  method: "POST",
  headers: {
    "Authorization": `Bearer ${process.env.KIT_KEY}`,
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    "query": "select u.id,u.name,count(o.id) as orders from users u left join orders o on o.user_id=u.id where u.active=true group by u.id,u.name order by orders desc;"
  })
});
const { task_id } = await res.json();

import os, requests

res = requests.post(
    "https://api.kit.forhosting.com/web/sql-format",
    headers={"Authorization": f"Bearer {os.environ['KIT_KEY']}"},
    json={
    "query": "select u.id,u.name,count(o.id) as orders from users u left join orders o on o.user_id=u.id where u.active=true group by u.id,u.name order by orders desc;"
},
)
task_id = res.json()["task_id"]

<?php
$res = file_get_contents("https://api.kit.forhosting.com/web/sql-format", false, stream_context_create([
  "http" => [
    "method"  => "POST",
    "header"  => "Authorization: Bearer " . getenv("KIT_KEY") . "\r\nContent-Type: application/json",
    "content" => '{"query":"select u.id,u.name,count(o.id) as orders from users u left join orders o on o.user_id=u.id where u.active=true group by u.id,u.name order by orders desc;"}',
  ],
]));
$task = json_decode($res, true);

body := bytes.NewBufferString(`{"query":"select u.id,u.name,count(o.id) as orders from users u left join orders o on o.user_id=u.id where u.active=true group by u.id,u.name order by orders desc;"}`)
req, _ := http.NewRequest("POST", "https://api.kit.forhosting.com/web/sql-format", body)
req.Header.Set("Authorization", "Bearer "+os.Getenv("KIT_KEY"))
req.Header.Set("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)

リクエスト例

{
  "query": "select u.id,u.name,count(o.id) as orders from users u left join orders o on o.user_id=u.id where u.active=true group by u.id,u.name order by orders desc;"
}

レスポンス例

{
  "task_id": "tsk_a1b2c3d4e5f6a1b2c3d4e5f6",
  "type": "web.sql_format",
  "status": "queued",
  "_links": {
    "result": "/tasks/tsk_…/result"
  }
}

非同期APIです。task_idは即時に返ります。ポーリングは1秒あたり1リクエストまでです。

料金

1リクエストあたり$0.002

単価はすべて公開しています。トークン換算や独自クレジットはありません。失敗したタスクは課金されません。

制限

`timeout_sec`	30
`max_crawl_pages`	25

エラー

HTTP	コード	意味
`401`	`unauthorized`	APIキーが無効か、指定されていません。Authorizationヘッダーを確認してください。
`402`	`insufficient_balance`	残高が不足しています。チャージ後に再度お試しください。
`404`	`unknown_type`	指定されたタスクタイプは存在しません。タイプ名を確認してください。
`429`	`rate_limited`	リクエストが多すぎます。しばらく待ってから再度お試しください。

KITの完全なドキュメントを見る →