「分析SQLスタイルガイド」をかなり真面目に考えた - Qiita

目次 なぜSQLのスタイルガイドが重要なのか この記事の目的 この記事の対象者 分析SQLスタイルガイドの指針 基本ルール 命名規則 インデントルール 別名ルール joinルール クエリ分割ルール ⭐ コメント欄で「いや私はこう思う！」という意見をたくさんいただきました！ぜひそちらも御覧ください！（決して揶揄ではないです） なぜSQLのスタイルガイドが重要なのか SQLはプログラミング未経験者でもとっつきやすい言語と言われ、エンジニアや分析を本業としていない人でもSQLを使う機会が増えてきていると思います。 そんなSQLですが、こちらのブログでも指摘されている通り、一般的なスタイルガイドが定まっていません。スタイルガイドとはコードの書き方マナーようなもので、どこで改行するか、空白はいくつ入れるか、大文字を使うかなどの諸々を指します。 もしスタイルガイドが無いとこんな事が起こります コードに

[roshi]

カンマは先頭より後ろに持っていく派。入力忘れやコピペミスは機械が教えてくれるけど、見た目のインデントがずれるのはずっと付きまとうので。

[kyopeco]

"where 1=1"は言及されてないけど、たまに見る作法。書き換えるときに、どの条件式が先頭かを考えなくて良いので、合理性は一応ある。ローカルルール混じると統一やっぱり難しい。

[nmcli]

弊社では、少なくとも更新系 SQL ではカンマを後ろにする派。 SQL はその構造上セミコロンがなくても実行できてしまうことが多く、文末を誤りやすい。カンマが後ろにあれば続きの条件があることを認識しやすい。

[yamadar]

予約語大文字、インデント揃える派だけど、チームで使うなら統一したルールがあれば何でも良い。その場合は個人の好みより優先する。

[shashido]

SQL用フォーマッター https://dev.classmethod.jp/articles/sqlfluff-dbtcoalesce/

[su_zu_ki_1010]

筆者の言うこともわかるし、コメント欄の方の言うこともわかる。せめて、SQLのフォーマットだけはプロジェクトで統一したいところ。使うSQLエディタのフォーマット機能を使えば何も考えなくていいので楽。

[kabochatori]

スタイルはフォーマッターで機械的に揃えたいところだけどSQLのって意外と無いんだよなぁ…

[masatomo-m]

JetBrains IDE使ってると多言語のソース内でも文字列リテラル中だけSQL syntax highlightすることができるので、ソース内埋め込みのものはそれに任せてるな。Redashとかに突っ込む長大SQLやBigQueryのクエリはコメント欲しい

[Error401]

Joe Celko派(https://www.sqlstyle.guide/ja/と大体同じ）は、JetbrainのIDEがおすすめ。100%思い通りではないが95点はつけられるくらいできが良い。

[koyancya]

ドーモ、Joe Celko 派です......

[syou6162]

予約語は大文字派なんだよなぁ

[youko03]

“right joinと全く同じことはleft joinで実現できます。両者が混在すると読む人に大きな負担を与えます。人間は左側を起点に考える傾向があり、それに逆らうメリットがない以上right joinを使う理由が全くありません”

[tmatsuu]

スタイルは好みがあるのであれですが、中間テーブルを作るのところは更新を忘れるなどもあるので、時と場合によってはVIEWもご検討ください。right joinはたしかに殆ど使わないけどleftとrightが混在する場合があるかもね。

[nekoruri]

宗教上の「決め」でしかないものをBad/Goodでまとめるのには反感を覚えるなあ。プロジェクトで統一しろというのはその通り。

[masadream]

SQLの書き方は特に各人の信仰が反映されやすいと思う。個人的にはこの人の信仰心とかなり合致する

[diveintounlimit]

いつも適当なSQL文整形ツール探してやってもらってる。自分で整形するのはやりたくない。

[misshiki]

Bad、Goodの比較図が見やすい。

[civitaspo]

,

[uta_mory]

SQLフォーマッターはcockroachdbの中の人が作ってるsqlfmtがいいかも Prettierみたいに有無を言わせないから争いが起きない https://www.cockroachlabs.com/blog/sql-fmt-online-sql-formatter/

[yuuAn]

フォーマッターも欲しいけど、AltSQL がほしい

[uunfo]

「中央線に寄せて書く流派」ってなにそれこわい／左側は右揃え、右側は左揃えにするやつか。フォーマッタがやるならわかる

[miau]

最近 SQL は BigQuery でしか使ってないから、普通に行末にカンマ書いてる（BigQuery は FROM の直前にカンマがあってもエラーにならないので）

[cbkf]

SQLとのタイトルで例示がほぼselect文だけなのが少し足りないと感じたかな。細かいのだとdelete fromを1行に書くか、fromを次行の頭に持ってくるか(whereと頭を揃えるか)、みたいな話が出ることもあるので／なるほど「分析」か

[daira4000]

こなれたフォーマッターが欲しい

[odakaho]

前カンマと left join基本は違和感あるけど、分析用途でカラム追加/削除が多い・データ漏れのリスクを無くしたい、ってことならまあアリか

[shag]

with区というか CTE は知らないと大分損するよな。

[n314]

カンマは派閥があって良いと思うけど、userをuに置き換えるのだけは許されなくない？pointをp2にすると分かりやすくなる？joinとwithもちょっと気になるな…。

[ghostbass]

前カンマは使わない。エイリアスも point as p1, purchase as p2 とかやるぐらいなら使わない。短くなる以上の効果がない。識別子が30文字まで？そんなアホなDBは使わない。

[nunulk]

前カンマ派だけど、どっちでも大差ないと思ってるのでチームの方針に合わせたい

[EastHop]

with句は読みやすいかもしれないけど性能的に問題も多いので時と場合ですかね

[yatchi_00]

きったないクエリ見慣れすぎて、一人で意識するのはよいけどみんなが守るのはほんと難しいと思ってる。

[demacs]

概ね同意、というか「カンマを先頭に持ってくる」以外は同じ書き方をしてる気がする。カンマ先頭記法は、カラム追加・削除の際に確かに便利だけど、どうしても違和感を感じてしまうので使ってない。