Sqlalchemy json column - how to preform a contains query
Use JSON_CONTAINS(json_doc, val[, path])
:
from sqlalchemy import func
# JSON_CONTAINS returns 0 or 1, not found or found. Not sure if MySQL
# likes integer values in WHERE, added == 1 just to be safe
session.query(Story).filter(func.json_contains(Story.section_ids, X) == 1).all()
As you're searching an array at the top level, you do not need to give path. Alternatively beginning from 8.0.17 you can use value MEMBER OF(json_array)
, but using it in SQLAlchemy is a little less ergonomic in my opinion:
from sqlalchemy import literal
# self_group forces generation of parenthesis that the syntax requires
session.query(Story).filter(literal(X).bool_op('MEMBER OF')(Story.section_ids.self_group())).all()
For whoever get here, but is using PostgreSQL instead:
your fields should be of the type sqlalchemy.dialects.postgresql.JSONB
(and not sqlalchemy_utils.JSONType) -
Then you can use the Comparator
object that is associated with the field with its contains
(and others) operators.
Example:
Query(Mymodel).filter(MyModel.managers.comparator.contains(["[email protected]"]))
(note that the contained part must be a JSON fragment, not just a string)