Índice de múltiplas colunas ao usar a extensão ORM declarativa de sqlalchemy

94

De acordo com a documentação e os comentários na sqlalchemy.Columnclasse, devemos usar a classe sqlalchemy.schema.Indexpara especificar um índice que contém várias colunas.

No entanto, o exemplo mostra como fazer isso usando diretamente o objeto Tabela desta forma:

meta = MetaData()
mytable = Table('mytable', meta,
    # an indexed column, with index "ix_mytable_col1"
    Column('col1', Integer, index=True),

    # a uniquely indexed column with index "ix_mytable_col2"
    Column('col2', Integer, index=True, unique=True),

    Column('col3', Integer),
    Column('col4', Integer),

    Column('col5', Integer),
    Column('col6', Integer),
    )

# place an index on col3, col4
Index('idx_col34', mytable.c.col3, mytable.c.col4)

Como devemos fazer isso se usarmos a extensão ORM declarativa?

class A(Base):
    __tablename__ = 'table_A'
    id = Column(Integer, , primary_key=True)
    a = Column(String(32))
    b = Column(String(32))

Eu gostaria de um índice na coluna "a" e "b".

Yorjo
fonte
1
A questão é um pouco incerta sobre se você deseja vários índices ou um único índice em várias colunas (e estava mais confuso antes de editá-lo - originalmente, ele pedia "um índice que contém vários índices múltiplos" ). Mas não importa, eu acho, já que a resposta de zzzeek aborda os dois casos.
Mark Amery

Respostas:

137

esses são apenas Columnobjetos, index = True flag funciona normalmente:

class A(Base):
    __tablename__ = 'table_A'
    id = Column(Integer, primary_key=True)
    a = Column(String(32), index=True)
    b = Column(String(32), index=True)

se você gostaria de um índice composto, novamente Tableestá presente aqui como de costume, você apenas não precisa declará-lo, tudo funciona da mesma (certifique-se de que você está no recente 0,6 ou 0,7 para o wrapper declarativo Aa ser interpretado como um Columndepois que a declaração da classe for concluída):

class A(Base):
    __tablename__ = 'table_A'
    id = Column(Integer, primary_key=True)
    a = Column(String(32))
    b = Column(String(32))

Index('my_index', A.a, A.b)

No 0.7 o Indexpode estar nos Tableargumentos também, que com o declarativo é via __table_args__:

class A(Base):
    __tablename__ = 'table_A'
    id = Column(Integer, primary_key=True)
    a = Column(String(32))
    b = Column(String(32))
    __table_args__ = (Index('my_index', "a", "b"), )
zzzeek
fonte
1
Obrigado, atualizei para 0.7 e usar o table_args funciona bem
yorjo
5
O que acontece se você tiver um dicionário para table_args como eu tenho atualmente? table_args = {'mysql_engine': 'InnoDB'}
Nick Holden
6
Então, acho que posso fazer table_args = (Index ('my_index', "a", "b"), {'mysql_engine': 'InnoDB'})
Nick Holden
1
@RyanChou docs.sqlalchemy.org/en/latest/orm/extensions/declarative/… "Argumentos de palavras-chave podem ser especificados com a forma acima especificando o último argumento como um dicionário"
zzzeek
12

Para completar a resposta de @zzzeek .

Se você quiser adicionar um índice composto com DESC e usar o método declarativo ORM, faça o seguinte.

Além disso, eu estava lutando com a documentação dos Índices Funcionais do SQSAlchemy, tentando descobrir como fazer a substituição mytable.c.somecol.

from sqlalchemy import Index

Index('someindex', mytable.c.somecol.desc())

Podemos apenas usar a propriedade model e chamá .desc()-la:

from flask_sqlalchemy import SQLAlchemy

db = SQLAlchemy()

class GpsReport(db.Model):
    __tablename__ = 'gps_report'

    id = db.Column(db.Integer, db.Sequence('gps_report_id_seq'), nullable=False, autoincrement=True, server_default=db.text("nextval('gps_report_id_seq'::regclass)"))

    timestamp = db.Column(db.DateTime, nullable=False, primary_key=True)

    device_id = db.Column(db.Integer, db.ForeignKey('device.id'), primary_key=True, autoincrement=False)
    device = db.relationship("Device", back_populates="gps_reports")


    # Indexes

    __table_args__ = (
        db.Index('gps_report_timestamp_device_id_idx', timestamp.desc(), device_id),
    )

Se você usa o Alembic, estou usando o Flask-Migrate, ele gera algo como:

from alembic import op  
import sqlalchemy as sa
# Added manually this import
from sqlalchemy.schema import Sequence, CreateSequence


def upgrade():
    # ### commands auto generated by Alembic - please adjust! ###
    # Manually added the Sequence creation
    op.execute(CreateSequence(Sequence('gps_report_id_seq')))

    op.create_table('gps_report',
    sa.Column('id', sa.Integer(), server_default=sa.text("nextval('gps_report_id_seq'::regclass)"), nullable=False),
    sa.Column('timestamp', sa.DateTime(), nullable=False))
    sa.Column('device_id', sa.Integer(), autoincrement=False, nullable=False),
    op.create_index('gps_report_timestamp_device_id_idx', 'gps_report', [sa.text('timestamp DESC'), 'device_id'], unique=False)


def downgrade():
    # ### commands auto generated by Alembic - please adjust! ###
    op.drop_index('gps_report_timestamp_device_id_idx', table_name='gps_report')
    op.drop_table('gps_report')

    # Manually added the Sequence removal
    op.execute(sa.schema.DropSequence(sa.Sequence('gps_report_id_seq'))) 
    # ### end Alembic commands ###

Finalmente, você deve ter a seguinte tabela e índices em seu banco de dados PostgreSQL:

psql> \d gps_report;
                                           Table "public.gps_report"
     Column      |            Type             | Collation | Nullable |                Default                 
-----------------+-----------------------------+-----------+----------+----------------------------------------
 id              | integer                     |           | not null | nextval('gps_report_id_seq'::regclass)
 timestamp       | timestamp without time zone |           | not null | 
 device_id       | integer                     |           | not null | 
Indexes:
    "gps_report_pkey" PRIMARY KEY, btree ("timestamp", device_id)
    "gps_report_timestamp_device_id_idx" btree ("timestamp" DESC, device_id)
Foreign-key constraints:
    "gps_report_device_id_fkey" FOREIGN KEY (device_id) REFERENCES device(id)
Mickael
fonte