Source code for tortoise.contrib.postgres.indexes

from typing import Optional, Tuple

from pypika.terms import Term, ValueWrapper

from tortoise.indexes import PartialIndex


class PostgreSQLIndex(PartialIndex):
    INDEX_CREATE_TEMPLATE = (
        "CREATE INDEX {exists}{index_name} ON {table_name} USING{index_type}({fields}){extra};"
    )

    def __init__(
        self,
        *expressions: Term,
        fields: Optional[Tuple[str, ...]] = None,
        name: Optional[str] = None,
        condition: Optional[dict] = None,
    ):
        super().__init__(*expressions, fields=fields, name=name)
        if condition:
            cond = " WHERE "
            items = []
            for k, v in condition.items():
                items.append(f"{k} = {ValueWrapper(v)}")
            cond += " AND ".join(items)
            self.extra = cond


[docs]class BloomIndex(PostgreSQLIndex):
    INDEX_TYPE = "BLOOM"


[docs]class BrinIndex(PostgreSQLIndex):
    INDEX_TYPE = "BRIN"


[docs]class GinIndex(PostgreSQLIndex):
    INDEX_TYPE = "GIN"


[docs]class GistIndex(PostgreSQLIndex):
    INDEX_TYPE = "GIST"


[docs]class HashIndex(PostgreSQLIndex):
    INDEX_TYPE = "HASH"


[docs]class SpGistIndex(PostgreSQLIndex):
    INDEX_TYPE = "SPGIST"