導入
仕事でプログラムを書いていると、必ず SQL を扱う場面に出くわします。ここで SQL をどのように持つかが問題となることがあります。
なにが問題か
プログラムの中で SQL が定義されている場合です。コード上 SQL は複数行にきれいに書かれています。
まず第一に SQL の定義があちこちに分散してわかりにくいことです。
次に余分な整形作業が発生することです。
動作している SQL を調べたり解析しようとすると、改行が無い長い SQL になっているのです。これをそのまま人間が読むのは至難の業です。そこで、テキストエディタなどにペーストして読みやすく、かつ実行できる状態に整形する手間が発生します。
あるいは、オリジナルの SQL をプログラムコード上で発見したとしても、長い SQL は文字列を連結した書き方になって細切れになっています。改行は適宜入っているので読みやすさはあるかもしれませんが、このままでは実行できません。実行するためには余分な「"」、「\」や「+」などを除去しなければなりません。
どちらの方法であっても手間は増えるわけです。
また、デバッグが終わって SQL をプログラムコードに反映させたい場合にも手間が増えます。実行できる SQL 文を、今度は 「"」、「\」や「+」などを適宜追加して、プログラム内で文字列としてシンタックスエラーにならない状態へ加工しなければなりません。
さらに、デバッグ中では、この一連の作業を何度か繰り返さなければいけない状況になることが多々ある、ということです。一発で直れば良いですが、他人の書いた長文の SQL に潜むバグを修正するのは大変な労力を必要とするのが普通です。
解決方法の一例
SQL をプログラムコード上で、連結した文字列として定義するのではなく、外部ファイルにしておき、プログラムはその SQL が定義されているファイルを読み込んで実行する、という動作に変えるのです。
現状はプログラムのあちこちに SQL の定義が散らばっているわけですが、このようなファイルから読み込んで実行するという共通ライブラリを作っておけば、どの SQL を実行しているのかデバッグで追いかけるのも簡単になります。
しかし、このように改修しても、デバッグで現れる SQL は一行に変化します。が、SQL をファイルにしておけば、整形された SQL がすぐに手に入り、その SQL はそのまますぐ実行できます。デバッグが終わって SQL を更新するのも簡単です。余分な整形をする手間は発生しません。
まとめ
SQL をプログラム上で定義すると、
・SQL の定義があちこちに分散し、デバッグがし辛い。
・余分な整形作業に手間を取られる。
・整形作業においてミスするリスクが発生する。
などデメリットが多く、良い事はなにもありません。