938757e7aa
Now that we don't run SQL script with a single .execute() call, transaction management statements (BEGIN, COMMIT, END) fail with operational error. Ignore them if occurred in a script. All in all, transactions are managed by SQLAlchemy-migrate itself, so there is no reason for the calling code to pass those statements in a SQL script. Warn user about the statements that are ignored. The ideal response to such a warning from library users is removing those redundant transaction management statements from their scripts. Note: ROLLBACK is not ignored even though it's one of transaction management statements because its usage in migration scripts is insane anyway, and we're better fail on it and not (almost) silently ignore it. Change-Id: Ie4179c0e9341d42656d66821aaac23f8dcd33927 Closes-bug: 1368391
70 lines
2.6 KiB
Python
70 lines
2.6 KiB
Python
#!/usr/bin/env python
|
|
# -*- coding: utf-8 -*-
|
|
import logging
|
|
import re
|
|
import shutil
|
|
|
|
import sqlparse
|
|
|
|
from migrate.versioning.script import base
|
|
from migrate.versioning.template import Template
|
|
|
|
|
|
log = logging.getLogger(__name__)
|
|
|
|
class SqlScript(base.BaseScript):
|
|
"""A file containing plain SQL statements."""
|
|
|
|
@classmethod
|
|
def create(cls, path, **opts):
|
|
"""Create an empty migration script at specified path
|
|
|
|
:returns: :class:`SqlScript instance <migrate.versioning.script.sql.SqlScript>`"""
|
|
cls.require_notfound(path)
|
|
|
|
src = Template(opts.pop('templates_path', None)).get_sql_script(theme=opts.pop('templates_theme', None))
|
|
shutil.copy(src, path)
|
|
return cls(path)
|
|
|
|
# TODO: why is step parameter even here?
|
|
def run(self, engine, step=None):
|
|
"""Runs SQL script through raw dbapi execute call"""
|
|
text = self.source()
|
|
# Don't rely on SA's autocommit here
|
|
# (SA uses .startswith to check if a commit is needed. What if script
|
|
# starts with a comment?)
|
|
conn = engine.connect()
|
|
try:
|
|
trans = conn.begin()
|
|
try:
|
|
# ignore transaction management statements that are
|
|
# redundant in SQL script context and result in
|
|
# operational error being returned.
|
|
#
|
|
# Note: we don't ignore ROLLBACK in migration scripts
|
|
# since its usage would be insane anyway, and we're
|
|
# better to fail on its occurance instead of ignoring it
|
|
# (and committing transaction, which is contradictory to
|
|
# the whole idea of ROLLBACK)
|
|
ignored_statements = ('BEGIN', 'END', 'COMMIT')
|
|
ignored_regex = re.compile('^\s*(%s).*;?$' % '|'.join(ignored_statements),
|
|
re.IGNORECASE)
|
|
|
|
# NOTE(ihrachys): script may contain multiple statements, and
|
|
# not all drivers reliably handle multistatement queries or
|
|
# commands passed to .execute(), so split them and execute one
|
|
# by one
|
|
for statement in sqlparse.split(text):
|
|
if statement:
|
|
if re.match(ignored_regex, statement):
|
|
log.warning('"%s" found in SQL script; ignoring' % statement)
|
|
else:
|
|
conn.execute(statement)
|
|
trans.commit()
|
|
except Exception as e:
|
|
log.error("SQL script %s failed: %s", self.path, e)
|
|
trans.rollback()
|
|
raise
|
|
finally:
|
|
conn.close()
|