SQLAlchemy: print the actual query

by

In the vast majority of cases, the “stringification” of a SQLAlchemy statement or query is as simple as:

print(str(statement))

This applies both to an ORM Query as well as any select() or other statement.

Note: the following detailed answer is being maintained on the sqlalchemy documentation.

To get the statement as compiled to a specific dialect or engine, if the statement itself is not already bound to one you can pass this in to compile():

print(statement.compile(someengine))

or without an engine:

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

When given an ORM Query object, in order to get at the compile() method we only need access the .statement accessor first:

statement = query.statement
print(statement.compile(someengine))

with regards to the original stipulation that bound parameters are to be “inlined” into the final string, the challenge here is that SQLAlchemy normally is not tasked with this, as this is handled appropriately by the Python DBAPI, not to mention bypassing bound parameters is probably the most widely exploited security holes in modern web applications. SQLAlchemy has limited ability to do this stringification in certain circumstances such as that of emitting DDL. In order to access this functionality one can use the ‘literal_binds’ flag, passed to compile_kwargs:

from sqlalchemy.sql import table, column, select

t = table('t', column('x'))

s = select([t]).where(t.c.x == 5)

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

the above approach has the caveats that it is only supported for basic
types, such as ints and strings, and furthermore if a bindparam
without a pre-set value is used directly, it won’t be able to
stringify that either.

To support inline literal rendering for types not supported, implement
a TypeDecorator for the target type which includes a
TypeDecorator.process_literal_param method:

from sqlalchemy import TypeDecorator, Integer


class MyFancyType(TypeDecorator):
    impl = Integer

    def process_literal_param(self, value, dialect):
        return "my_fancy_formatting(%s)" % value

from sqlalchemy import Table, Column, MetaData

tab = Table('mytable', MetaData(), Column('x', MyFancyType()))

print(
    tab.select().where(tab.c.x > 5).compile(
        compile_kwargs={"literal_binds": True})
)

producing output like:

SELECT mytable.x
FROM mytable
WHERE mytable.x > my_fancy_formatting(5)

More Related Contents:

  1. Writing a connection string when password contains special characters
  2. Does SQLAlchemy have an equivalent of Django’s get_or_create?
  3. Speeding up pandas.DataFrame.to_sql with fast_executemany of pyODBC
  4. CS50: LIKE operator, variable substitution with % expansion
  5. SQLAlchemy create_all() does not create tables
  6. SQLAlchemy: What’s the difference between flush() and commit()?
  7. Group by & count function in sqlalchemy
  8. Debugging (displaying) SQL command sent to the db by SQLAlchemy
  9. SQL Alchemy ORM returning a single column, how to avoid common post processing
  10. How do I execute inserts and updates in an Alembic upgrade script?
  11. SQLAlchemy, get object not bound to a Session
  12. Flask sqlalchemy many-to-many insert data
  13. How to delete a record by id in Flask-SQLAlchemy
  14. How to upsert pandas DataFrame to PostgreSQL table?
  15. How to do an upsert with SqlAlchemy?
  16. SQLAlchemy: how to filter date field?
  17. method of iterating over sqlalchemy model’s defined columns?
  18. How to execute “left outer join” in SqlAlchemy
  19. Getting random row through SQLAlchemy
  20. Select NULL Values in SQLAlchemy
  21. sqlalchemy existing database query
  22. How to get number of affected rows in sqlalchemy?
  23. Flask-SQLAlchemy Constructor
  24. convert selected datetime to date in sqlalchemy
  25. Is possible to mapping view with class using mapper in SqlAlchemy?
  26. SQLAlchemy: filtering on values stored in nested list of the JSONB field
  27. How to prevent UUID primary key for new SQLAlchemy objects being created with the same value
  28. Retrieve query results as dict in SQLAlchemy
  29. SQLALchemy dynamic filter_by
  30. SQLAlchemy ordering by count on a many to many relationship

Leave a Comment