如何清除原始 sql 文件中的注释

Question

我在清理现有 sql 文件中的 cmets 和空行时遇到问题。 该文件有超过 10k 行，因此不能手动清理它。

我有一个小 Python 脚本，但我不知道如何处理多行插入中的 cmets。

代码：

f = file( 'file.sql', 'r' )
t = filter( lambda x: not x.startswith('--') \
            and not x.isspace() 
  , f.readlines() )
f.close()
t #<- here the cleaned data should be

它应该如何工作：

这应该清洗：

-- normal sql comment

这应该保持原样：

CREATE FUNCTION func1(a integer) RETURNS void
    LANGUAGE plpgsql
    AS $$
BEGIN
        -- comment
       [...]
END;
$$;

INSERT INTO public.texts (multilinetext) VALUES ('
and more lines here \'
-- part of text 
\'
[...]

');

Answer 1

试试sqlparse 模块。

更新示例：将 cmets 留在插入值中，将 cmets 留在 CREATE FUNCTION 块中。您可以进一步调整以调整行为：

import sqlparse
from sqlparse import tokens

queries = '''
CREATE FUNCTION func1(a integer) RETURNS void
    LANGUAGE plpgsql
        AS $$
        BEGIN
                -- comment
       END;
       $$;
SELECT -- comment
* FROM -- comment
TABLE foo;
-- comment
INSERT INTO foo VALUES ('a -- foo bar');
INSERT INTO foo
VALUES ('
a 
-- foo bar'
);

'''

IGNORE = set(['CREATE FUNCTION',])  # extend this

def _filter(stmt, allow=0):
    ddl = [t for t in stmt.tokens if t.ttype in (tokens.DDL, tokens.Keyword)]
    start = ' '.join(d.value for d in ddl[:2])
    if ddl and start in IGNORE:
        allow = 1
    for tok in stmt.tokens:
        if allow or not isinstance(tok, sqlparse.sql.Comment):
            yield tok

for stmt in sqlparse.split(queries):
    sql = sqlparse.parse(stmt)[0]
    print sqlparse.sql.TokenList([t for t in _filter(sql)])

输出：

CREATE FUNCTION func1(a integer) RETURNS void
    LANGUAGE plpgsql
        AS $$
        BEGIN
                -- comment
       END;
       $$;

SELECT * FROM TABLE foo;

INSERT INTO foo VALUES ('a -- foo bar');

INSERT INTO foo
VALUES ('
a
-- foo bar'
);

Answer 2

添加更新的答案:)

import sqlparse

sql_example = """--comment
SELECT * from test;
INSERT INTO test VALUES ('
-- test
a
');
 """
print sqlparse.format(sql_example, strip_comments=True).strip()

输出：

SELECT * from test;
INSERT INTO test VALUES ('
-- test
a
');

它实现了相同的结果，但也涵盖了所有其他极端情况并且更简洁

Answer 3

这是与您的示例一起使用的 samplebias 答案的扩展：

import sqlparse

sql_example = """--comment
SELECT * from test;
INSERT INTO test VALUES ('
-- test
a
');
"""

new_sql = []

for statement in sqlparse.parse(sql_example):
    new_tockens = [stm for stm in statement.tokens 
                   if not isinstance(stm, sqlparse.sql.Comment)]

    new_statement = sqlparse.sql.TokenList(new_tockens)
    new_sql.append(new_statement.to_unicode())

print sqlparse.format("\n".join(new_sql))

输出：

SELECT * from test;

INSERT INTO test VALUES ('
-- test
a
');

Answer 4

可以用正则表达式来做到这一点。首先，您必须按字符串拆分文件，然后您可以按 cmets 拆分文件。下面的 Perl 程序可以做到这一点：

#! /usr/bin/perl -w

# Read hole file.
my $file = join ('', <>);

# Split by strings including the strings.
my @major_parts = split (/('(?:[^'\\]++|\\.)*+')/, $file);

foreach my $part (@major_parts) {
    if ($part =~ /^'/) {
        # Print the part if it is a string.
        print $part; 
    }
    else {
        # Split by comments removing the comments
        my @minor_parts = split (/^--.*$/m, $part);
        # Print the remaining parts.
        print join ('', @minor_parts);
    }
}

Answer 5

# Remove comments i.e. lines beginning with whitespace and '--' (using multi-line flag)
re.sub('^\s*--.*\n?', '', query, flags=re.MULTILINE)

正则表达式字符串解释：

• ^ 行首
• \s 空格
• \s* 零个或多个空白字符
• -- 两个连字符（静态字符串模式）
• .* 零个或多个任意字符（即该行的其余部分）
• \n 换行符
• ?字符串结束
• flags = re.M 是多行修饰符

"指定时，模式字符'^'匹配字符串的开头和每行的开头（紧跟在每个换行符之后）"

有关详细信息，请参阅 Python 正则表达式文档：

https://docs.python.org/3/library/re.html