Как получить необработанный скомпилированный запрос SQL из выражения SQLAlchemy?

Question

У меня есть объект запроса SQLAlchemy, и я хочу получить текст скомпилированного оператора SQL со всеми его параметрами (например, без %s или других переменных, ожидающих привязки компилятором оператора или механизмом диалекта MySQLdb и т. Д.).

Вызов str() для запроса показывает что-то вроде этого:

SELECT id WHERE date_added <= %s AND date_added >= %s ORDER BY count DESC

Я пробовал искать в query._params, но это пустой запрос.Я написал свой собственный компилятор, используя этот пример sqlalchemy.ext.compiler.compiles декоратора , но даже там есть оператор %s, где я хочу данные.

Я не могу понять, когда мойпараметры смешиваются для создания запроса;при проверке объекта запроса они всегда являются пустым словарем (хотя запрос выполняется нормально, и механизм выводит его на печать при включении эхо-регистрации).

Я начинаю получать сообщение, что SQLAlchemy не 'Я хочу, чтобы я знал базовый запрос, так как он нарушает общую природу интерфейса API-интерфейса выражения для всех различных DB-API.Я не против, если запрос будет выполнен прежде, чем я узнаю, что это было;Я просто хочу знать!

Answer 1

Этот блог предоставляет обновленный ответ.

Цитируя из поста в блоге, это предлагается и работает для меня.

>>> from sqlalchemy.dialects import postgresql
>>> print str(q.statement.compile(dialect=postgresql.dialect()))

Где q определяется как:

>>> q = DBSession.query(model.Name).distinct(model.Name.value) \
             .order_by(model.Name.value)

Или просто любой тип session.query ().

Спасибо Николя Каду за ответ!Я надеюсь, что это поможет другим, которые приходят сюда в поисках.

Answer 2

Документация использует literal_binds для печати запроса q, включая параметры:

print(q.statement.compile(compile_kwargs={"literal_binds": True}))

у вышеуказанного подхода есть предостережения о том, что он поддерживается только для базовых типов, таких как целые и строковые значения, и, кроме того, если bindparam () без предварительно заданного значения используется напрямую, он не сможет выполнить это либо.

Answer 3

Это должно работать с Sqlalchemy> = 0,6

from sqlalchemy.sql import compiler

from psycopg2.extensions import adapt as sqlescape
# or use the appropiate escape function from your db driver

def compile_query(query):
    dialect = query.session.bind.dialect
    statement = query.statement
    comp = compiler.SQLCompiler(dialect, statement)
    comp.compile()
    enc = dialect.encoding
    params = {}
    for k,v in comp.params.iteritems():
        if isinstance(v, unicode):
            v = v.encode(enc)
        params[k] = sqlescape(v)
    return (comp.string.encode(enc) % params).decode(enc)

Answer 4

Для бэкэнда MySQLdb я немного изменил удивительный ответ Альбертова (большое спасибо!).Я уверен, что их можно объединить, чтобы проверить, было ли comp.positional True, но это немного выходит за рамки этого вопроса.

def compile_query(query):
    from sqlalchemy.sql import compiler
    from MySQLdb.converters import conversions, escape

    dialect = query.session.bind.dialect
    statement = query.statement
    comp = compiler.SQLCompiler(dialect, statement)
    comp.compile()
    enc = dialect.encoding
    params = []
    for k in comp.positiontup:
        v = comp.params[k]
        if isinstance(v, unicode):
            v = v.encode(enc)
        params.append( escape(v, conversions) )
    return (comp.string.encode(enc) % tuple(params)).decode(enc)

Answer 5

Дело в том, что sqlalchemy никогда не смешивает данные с вашим запросом.Запрос и данные передаются отдельно вашему базовому драйверу базы данных - интерполяция данных происходит в вашей базе данных.

Sqlalchemy передает запрос, как вы видели в str(myquery), в базу данных, и значения будутперейдите к отдельному кортежу.

Вы можете использовать некоторый подход, при котором вы самостоятельно интерполируете данные с помощью запроса (как предложили ниже альбертов), но это не то же самое, что выполняет sqlalchemy.

Answer 6

Для бэкэнда postgresql, использующего psycopg2, вы можете прослушать событие do_execute, затем использовать курсор, оператор и ввести принудительные параметры вместе с Cursor.mogrify() для встраивания параметров.Вы можете вернуть True, чтобы предотвратить фактическое выполнение запроса.

import sqlalchemy

class QueryDebugger(object):
    def __init__(self, engine, query):
        with engine.connect() as connection:
            try:
                sqlalchemy.event.listen(engine, "do_execute", self.receive_do_execute)
                connection.execute(query)
            finally:
                sqlalchemy.event.remove(engine, "do_execute", self.receive_do_execute)

    def receive_do_execute(self, cursor, statement, parameters, context):
        self.statement = statement
        self.parameters = parameters
        self.query = cursor.mogrify(statement, parameters)
        # Don't actually execute
        return True

Пример использования:

>>> engine = sqlalchemy.create_engine("postgresql://postgres@localhost/test")
>>> metadata = sqlalchemy.MetaData()
>>> users = sqlalchemy.Table('users', metadata, sqlalchemy.Column("_id", sqlalchemy.String, primary_key=True), sqlalchemy.Column("document", sqlalchemy.dialects.postgresql.JSONB))
>>> s = sqlalchemy.select([users.c.document.label("foobar")]).where(users.c.document.contains({"profile": {"iid": "something"}}))
>>> q = QueryDebugger(engine, s)
>>> q.query
'SELECT users.document AS foobar \nFROM users \nWHERE users.document @> \'{"profile": {"iid": "something"}}\''
>>> q.statement
'SELECT users.document AS foobar \nFROM users \nWHERE users.document @> %(document_1)s'
>>> q.parameters
{'document_1': '{"profile": {"iid": "something"}}'}

Answer 7

Сначала позвольте мне предисловие, сказав, что я предполагаю, что вы делаете это в основном для целей отладки - я бы не рекомендовал пытаться изменять оператор за пределами свободно используемого API-интерфейса SQLAlchemy.

К сожалению, нет простого способа показать скомпилированный оператор с включенными параметрами запроса. SQLAlchemy на самом деле не помещает параметры в оператор - они передаются в ядро ​​базы данных в виде словаря . Это позволяет специфичной для базы данных библиотеке обрабатывать такие вещи, как экранирование специальных символов, чтобы избежать внедрения SQL.

Но вы можете сделать это в два этапа достаточно легко. Чтобы получить утверждение, вы можете сделать, как вы уже показали, и просто напечатать запрос:

>>> print(query)
SELECT field_1, field_2 FROM table WHERE id=%s;

Вы можете сделать шаг ближе к query.statement, чтобы увидеть имена параметров. (Примечание :id_1 ниже против %s выше - на самом деле это не проблема в этом очень простом примере, но может быть ключевым в более сложном утверждении.)

>>> print(query.statement)
>>> print(query.statement.compile()) # reasonably equivalent, you can also
                                     # pass in a dialect if you want
SELECT field_1, field_2 FROM table WHERE id=:id_1;

Затем вы можете получить фактические значения параметров, получив свойство params скомпилированного оператора:

>>> print(query.statement.compile().params)
{u'id_1': 1} 

Это сработало, по крайней мере, для бэкэнда MySQL; Я ожидаю, что он также достаточно общий для PostgreSQL без необходимости использования psycopg2.

Answer 8

Следующее решение использует язык выражений SQLAlchemy и работает с SQLAlchemy 1.1.Это решение не смешивает параметры с запросом (как было запрошено первоначальным автором), но предоставляет способ использования моделей SQLAlchemy для генерации строк запроса SQL и словарей параметров для различных диалектов SQL.Пример основан на учебном пособии http://docs.sqlalchemy.org/en/rel_1_0/core/tutorial.html

Учитывая класс

from sqlalchemy import Column, Integer, String
from sqlalchemy.ext.declarative import declarative_base
Base = declarative_base()
class foo(Base):
    __tablename__ = 'foo'
    id = Column(Integer(), primary_key=True)
    name = Column(String(80), unique=True)
    value = Column(Integer())

, мы можем создать оператор запроса, используя функцию select .

from sqlalchemy.sql import select    
statement = select([foo.name, foo.value]).where(foo.value > 0)

Далее мы можем скомпилировать оператор в объект запроса.

query = statement.compile()

По умолчанию оператор скомпилирован с использованием базовой «именованной» реализации, совместимой с базами данных SQL, такими как SQLite иOracle.Если вам нужно указать диалект, такой как PostgreSQL, вы можете сделать

from sqlalchemy.dialects import postgresql
query = statement.compile(dialect=postgresql.dialect())

. Или, если вы хотите явно указать диалект как SQLite, вы можете изменить стиль элемента с «qmark» на «named».

from sqlalchemy.dialects import sqlite
query = statement.compile(dialect=sqlite.dialect(paramstyle="named"))

Из объекта запроса мы можем извлечь строку запроса и параметры запроса

query_str = str(query)
query_params = query.params

и, наконец, выполнить запрос.

conn.execute( query_str, query_params )

Answer 9

Вы можете использовать события из ConnectionEvents семейство: after_cursor_execute или before_cursor_execute.

В sqlalchemy UsageRecipes @zzzeek вы можете найти этот пример:

Profiling

...
@event.listens_for(Engine, "before_cursor_execute")
def before_cursor_execute(conn, cursor, statement,
                        parameters, context, executemany):
    conn.info.setdefault('query_start_time', []).append(time.time())
    logger.debug("Start Query: %s" % statement % parameters)
...

Здесь вы можете получить доступ к вашему заявлению

Answer 10

Я думаю, что .statement, возможно, добьется цели: http://docs.sqlalchemy.org/en/latest/orm/query.html?highlight=query

>>> local_session.query(sqlalchemy_declarative.SomeTable.text).statement
<sqlalchemy.sql.annotation.AnnotatedSelect at 0x6c75a20; AnnotatedSelectobject>
>>> x=local_session.query(sqlalchemy_declarative.SomeTable.text).statement
>>> print(x)
SELECT sometable.text 
FROM sometable