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 '\ n选取FIELD1，FIELD2，字段3，字段4 \ N_ _ ___ 从表\ n _ ___ 其中条件1 = 1 \ n _ ___ _and条件2 = 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“ best”具有热情的人，我想我会分享我们的解决方案。

解决方案是使用python的String Literal Concatenation（http://docs.python.org/）构建SQL语句，该字符串可以限定为Option 2和Option 4之间的某个位置。

代码样例：

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

与f字符串也可以使用：

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的方法，以使其可以正常打印，但是如何更改用于调试日志记录的“ 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'

如果condition的值应该是字符串，则可以这样：

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

您可以将字段名称放入数组“ fields”，然后：


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

Question 8

我建议您坚持使用选项2（我总是将它用于比其更复杂的查询SELECT * FROM table），如果您想以一种不错的方式打印它，则可以始终使用单独的模块。

Question 9

对于适合一两行的简短查询，我在上面投票最多的解决方案中使用了字符串文字解决方案。对于更长的查询，我将它们分解为.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
;
>>>