您可以在自定义FunctionElement
中隐藏实际编译:
from sqlalchemy.ext.compiler import compiles
from sqlalchemy.sql.expression import FunctionElement, column
from sqlalchemy.sql.base import ColumnCollection
from sqlalchemy.types import TEXT, INTEGER
class ts_stat(FunctionElement):
name = "ts_stat"
@property
def columns(self):
# Using (undocumented) `_selectable=self` would allow
# omitting the explicit `select_from(ts_stat_obj)` in
# every query using `ts_stat`.
return ColumnCollection(
column("word", TEXT),
column("ndoc", INTEGER),
column("nentry", INTEGER))
@compiles(ts_stat, 'postgresql')
def pg_ts_stat(element, compiler, **kw):
kw.pop("asfrom", None) # Ignore and set explicitly
arg1, = element.clauses
# arg1 is a FromGrouping, which would force parens around the SELECT.
stmt = compiler.process(
arg1.element, asfrom=False, literal_binds=True, **kw)
# TODO: Choose a random tag for dollar quoting. Another option
# would be to wrap the stmt in `literal()`, compiling that, and
# letting the driver worry about quoting.
return f"ts_stat($${stmt}$$)"
用法很简单:您将 aSelect
或 aQuery
作为唯一参数传递:
from sqlalchemy import select, column, literal
from sqlalchemy.dialects import postgresql
from sqlalchemy.orm import sessionmaker
d = postgresql.dialect()
s = select([1])
f = ts_stat(s)
stmt = select([f.c.word, f.c.ndoc, f.c.nentry]).\
select_from(f).\
order_by(f.c.nentry.desc(),
f.c.ndoc.desc(),
f.c.word).\
compile(dialect=d)
print(stmt)
# SELECT word, ndoc, nentry
# FROM ts_stat($$SELECT 1$$) ORDER BY nentry DESC, ndoc DESC, word
Session = sessionmaker()
session = Session()
q = session.query(literal(1))
f2 = ts_stat(q)
stmt2 = select(['*']).\
select_from(f2).\
order_by(f2.c.nentry.desc(),
f2.c.ndoc.desc(),
f2.c.word).\
compile(dialect=d)
print(stmt2)
# SELECT *
# FROM ts_stat($$SELECT 1 AS param_1$$) ORDER BY nentry DESC, ndoc DESC, word
请注意,使用literal_binds=True
限制您可以作为参数传递给内部选择的内容,如“如何将 SQL 表达式呈现为字符串,可能带有内联的绑定参数?”中所述。.
当然,这样的结构使得其他读者不知道 DB 函数ts_stat()
在现实中接受字符串参数,但在这种情况下,它的便利性可能更胜一筹。