如何在 SQLAlchemy 上使用 GIN 创建 jsonb 索引？

Question

这是为 JSONB 创建索引的当前代码。

Index("mytable_data_idx_id_key", Mytable.data['id'].astext, postgresql_using='gin')

但我收到了这个错误。

sqlalchemy.exc.ProgrammingError: (psycopg2.ProgrammingError) data type text has no default operator class for access method "gin"
HINT:  You must specify an operator class for the index or define a default operator class for the data type.
 [SQL: "CREATE INDEX event_data_idx_id_key ON event USING gin ((data ->> 'id'))"]

有没有办法在 SQLAlchemy 上创建索引？

Answer 1

http://docs.sqlalchemy.org/en/latest/dialects/postgresql.html#operator-classes 上的 PostgreSQL 特定 SQLAlchemy 文档提到了postgresql_ops字典来提供 PostgreSQL 使用的“操作符类”，并提供这个例子来说明它的用：

Index('my_index', my_table.c.id, my_table.c.data,
                        postgresql_ops={
                            'data': 'text_pattern_ops',
                            'id': 'int4_ops'
                        })

从实验来看，如果要为表达式索引指定“运算符类”，似乎需要使用text()索引描述。 所以，

db.Index(
    'ix_sample',
    sqlalchemy.text("(jsoncol->'values') jsonb_path_ops"),
    postgresql_using="gin")

...在__table_args__用于ORM模型指定上的一个索引GIN jsonb字段包含一个字符串数组，并且，可实现有效的查找，即匹配于任何以JSON阵列字段中的字符串的，看起来像这样：

{
  "values": ["first", "second", "third"],
  "other": "fields",
  "go": "here"
}

在 PostgreSQL 中使用@>运算符进行查询将如下所示：

import sqlalchemy
from sqlalchemy.dialects import postgresql

query = session.query(MyModel).filter(
    sqlalchemy.type_coerce(MyModel.jsoncol['values'], postgresql.JSONB)
    .contains(sqlalchemy.type_coerce("second", postgresql.JSONB)))
results = query.all()

Answer 2

我不知道自上一个接受的答案以来 sqlalchemy 中的情况是否发生了变化，但在我工作的代码库中，这是通过以下方式完成的：

    __table_args__ = (
        db.Index(
            "index_TABLENAME_on_COLUMN_gin", 
            "COLUMN", 
            postgresql_using="gin",
        ),
    )

这将在 Postgresql 中创建预期的 GIN 索引。