sqlalchemy : executing raw sql with parameter bindings

Question

I'm trying to run this simple raw sql statement with parameters with SQLALchemy (within an alembic script) :

from alembic import op

t = {"code": "123", "description": "one two three"}

op.execute("insert into field_tags (id, field_id, code, description) "+
               "values (1,'zasz', :code ,:description')", t)

And I get the following error :

sqlalchemy.exc.StatementError: A value is required for bind parameter 
  'description' (original cause: InvalidRequestError: A value is required for 
  bind parameter 'description') "insert into field_tags (id, field_id, code, 
  description) values (1, 'math', 
  %(code)s ,%(description)s)" []

The solution:

t = {"code": "123", "description": "one two three"}
from sqlalchemy.sql import text

op.get_bind().execute(text("insert into field_tags (id, field_id, code, description) "+
               "values (1,'zasz', :code ,:description')"), **t)

André C. Andersen · Accepted Answer · 2017-11-29 16:04:37Z

88

You need to get the connection object, call execute() on it and pass query parameters as keyword arguments:

from alembic import op
from sqlalchemy.sql import text

conn = op.get_bind()
conn.execute(
    text(
        """
            insert into field_tags 
            (id, field_id, code, description) 
            values 
            (1, 'zasz', :code , :description)
        """
    ), 
    **t
)

Also see: How to execute raw SQL in SQLAlchemy-flask app.

edited Nov 29, 2017 at 16:04

André C. Andersen

9,5053 gold badges59 silver badges84 bronze badges

answered Apr 21, 2014 at 21:50

alecxe

476k127 gold badges1.1k silver badges1.2k bronze badges

Sign up to request clarification or add additional context in comments.

5 Comments

Boutran Over a year ago

I tried this (passing **t as argument) and got : TypeError: execute() got an unexpected keyword argument 'code'

alecxe Over a year ago

@MaxL., my bad, could you try the code from the updated answer? The idea is to get the connection object and call execute() on it.

Boutran Over a year ago

Thanks, that helped, there was another change I had to make : the query must be wrapped by the text function (from sqlalchemy.sql import text), gave a +1 to your answer, it you add the text() wrapp, (like in my update above) I'll accept it as the definitive answer.

Aneil Mallavarapu Over a year ago

The solution is almost correct. It still gives a 'got an unexpected keyword argument' error. Change '**t' to 't', and it works.

André C. Andersen Over a year ago

@AneilMallavarapu Note that execute(..) from Session is different from the one in Connection or Engine.

Collectives™ on Stack Overflow

sqlalchemy : executing raw sql with parameter bindings

1 Answer 1

5 Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

5 Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related