Python SQLクエリ文字列のフォーマット

Question 1

SQLクエリ文字列をフォーマットするための最良の方法を見つけようとしています。アプリケーションをデバッグしているとき、すべてのSQLクエリ文字列をログに記録したいのですが、文字列が適切にフォーマットされていることが重要です。

オプション1

def myquery():
    sql = "select field1, field2, field3, field4 from table where condition1=1 and condition2=2"
    con = mymodule.get_connection()
    ...

これは、SQL文字列を出力するのに適しています。
文字列が長く、標準の80文字の幅に収まらない場合は、適切な解決策ではありません。

オプション2

def query():
    sql = """
        select field1, field2, field3, field4
        from table
        where condition1=1
        and condition2=2"""
    con = mymodule.get_connection()
    ...

ここではコードは明確ですが、sqlクエリ文字列を出力すると、これらの迷惑な空白がすべて表示されます。

u '\ nselect field1、field2、field3、field4 \ n_ _ ___ テーブルから\ n _ ___ where condition1 = 1 \ n _ ___ and condition2 = 2'

注：空白_はエディターによって削除されるため、空白をアンダースコアに置き換えました。

オプション3

def query():
    sql = """select field1, field2, field3, field4
from table
where condition1=1
and condition2=2"""
    con = mymodule.get_connection()
    ...

このオプションは、適切に集計されたコードの明確さを損なうので、好きではありません。

オプション4

def query():
    sql = "select field1, field2, field3, field4 " \
          "from table " \
          "where condition1=1 " \
          "and condition2=2 "
    con = mymodule.get_connection()    
    ...

各行に余分に入力する必要があり、クエリの編集も難しいため、このオプションは好きではありません。

私にとって最良の解決策はオプション2ですが、sql文字列を出力するときの余分な空白文字は好きではありません。

他のオプションを知っていますか？

Question 2

そのような古いスレッドに投稿して申し訳ありません-しかし、pythonicの「最高」への情熱を共有する誰かとして、私は私たちのソリューションを共有したいと思いました。

解決策は、Pythonの文字列リテラル連結（http://docs.python.org/）を使用してSQLステートメントを構築することです。これは、オプション2とオプション4の間のどこかで修飾できます。

コードサンプル：

sql = ("SELECT field1, field2, field3, field4 "
       "FROM table "
       "WHERE condition1=1 "
       "AND condition2=2;")

f-stringsでも動作します：

fields = "field1, field2, field3, field4"
table = "table"
conditions = "condition1=1 AND condition2=2"

sql = (f"SELECT {fields} "
       f"FROM {table} "
       f"WHERE {conditions};")

長所：

それはpythonicの「よく表化された」フォーマットを保持しますが、余分なスペース文字を追加しません（ロギングを汚染します）。
オプション4のバックスラッシュ継続の醜さを回避し、ステートメントの追加を困難にします（空白の盲目は言うまでもありません）。
さらに、VIMでステートメントを展開するのは非常に簡単です（カーソルを挿入ポイントに置き、SHIFT-Oを押して新しい行を開くだけです）。

Question 3

SQLを出力するように多くの方法でSQLを書き込む方法を検討したことは明らかですが、デバッグログに使用する「print」ステートメントを、好きではない方法でSQLを書き込むのではなく変更してみませんか？上記のお気に入りのオプションを使用して、次のようなロギング機能はどうでしょうか。

def debugLogSQL(sql):
     print ' '.join([line.strip() for line in sql.splitlines()]).strip()

sql = """
    select field1, field2, field3, field4
    from table"""
if debug:
    debugLogSQL(sql)

これにより、行が目的の長さよりも長い場合に、ログに記録された文字列を複数の行に分割するロジックを追加することも簡単になります。

Question 4

私が出会った最もクリーンな方法は、SQLスタイルガイドに触発されました。

sql = """
    SELECT field1, field2, field3, field4
      FROM table
     WHERE condition1 = 1
       AND condition2 = 2;
"""

基本的に、句を開始するキーワードは右揃えにし、フィールド名などは左揃えにする必要があります。これは非常に見栄えがよく、デバッグも簡単です。

Question 5

sql = ("select field1, field2, field3, field4 "
       "from table "
       "where condition1={} "
       "and condition2={}").format(1, 2)

Output: 'select field1, field2, field3, field4 from table 
         where condition1=1 and condition2=2'

条件の値が文字列である必要がある場合は、次のようにすることができます。

sql = ("select field1, field2, field3, field4 "
       "from table "
       "where condition1='{0}' "
       "and condition2='{1}'").format('2016-10-12', '2017-10-12')

Output: "select field1, field2, field3, field4 from table where
         condition1='2016-10-12' and condition2='2017-10-12'"

Question 6

完全にフォーマットすることを避けるために、私はすばらしい解決策は手続きを使うことだと思います。

プロシージャを呼び出すと、このプロシージャに入れたいクエリの結果が得られます。プロシージャ内で複数のクエリを実際に処理できます。呼び出しは、呼び出された最後のクエリを返すだけです。

MYSQL

DROP PROCEDURE IF EXISTS example;
 DELIMITER //
 CREATE PROCEDURE example()
   BEGIN
   SELECT 2+222+2222+222+222+2222+2222 AS this_is_a_really_long_string_test;
   END //
 DELIMITER;

#calling the procedure gives you the result of whatever query you want to put in this procedure. You can actually process multiple queries within a procedure. The call just returns the last query result
 call example;

パイソン

sql =('call example;')

Question 7

フィールド名を配列「フィールド」に入れて、次のようにすることができます。


sql = 'select %s from table where condition1=1 and condition2=2' % (
 ', '.join(fields))

Question 8

オプション2を使用することをお勧めします（常にこれより複雑なクエリに使用していSELECT * FROM tableます）。適切な方法で印刷したい場合は、常に別のモジュールを使用できます。

Question 9

1行または2行に収まる短いクエリの場合は、上記の上位投票ソリューションで文字列リテラルソリューションを使用します。より長いクエリの場合は、.sqlファイルに分割します。次に、ラッパー関数を使用してファイルを読み込み、スクリプトを実行します。

script_cache = {}
def execute_script(cursor,script,*args,**kwargs):
    if not script in script_cache:
        with open(script,'r') as s:
            script_cache[script] = s
    return cursor.execute(script_cache[script],*args,**kwargs)

もちろん、これはクラス内にあることが多いので、通常、cursor明示的に渡す必要はありません。私も一般的にを使用しますcodecs.open()が、これは全体的な考え方を理解します。次に、SQLスクリプトは、独自の構文強調表示を備えた独自のファイルに完全に自己完結します。

Question 10

sql = """\
select field1, field2, field3, field4
from table
where condition1=1
and condition2=2
"""

[コメントに編集]
SQL文字列がメソッド内にあるからといって、それを「表にする」必要があるわけではありません。

>>> class Foo:
...     def fubar(self):
...         sql = """\
... select *
... from frobozz
... where zorkmids > 10
... ;"""
...         print sql
...
>>> Foo().fubar()
select *
from frobozz
where zorkmids > 10
;
>>>