Class TableMeta

piccolo/table.py:72–206

This is used to store info about the table.

@dataclass
class TableMeta:
    """
    This is used to store info about the table.
    """

    tablename: str = ""
    columns: list[Column] = field(default_factory=list)
    default_columns: list[Column] = field(default_factory=list)
    non_default_columns: list[Column] = field(default_factory=list)
    array_columns: list[Array] = field(default_factory=list)
    email_columns: list[Email] = field(default_factory=list)
    foreign_key_columns: list[ForeignKey] = field(default_factory=list)
    primary_key: Column = field(default_factory=Column)
    json_columns: list[Union[JSON, JSONB]] = field(default_factory=list)
    secret_columns: list[Column] = field(default_factory=list)
    auto_update_columns: list[Column] = field(default_factory=list)
    tags: list[str] = field(default_factory=list)
    help_text: Optional[str] = None
    _db: Optional[Engine] = None
    m2m_relationships: list[M2M] = field(default_factory=list)
    schema: Optional[str] = None

    # Records reverse foreign key relationships - i.e. when the current table
    # is the target of a foreign key. Used by external libraries such as
    # Piccolo API.
    _foreign_key_references: list[ForeignKey] = field(default_factory=list)

    def get_formatted_tablename(
        self, include_schema: bool = True, quoted: bool = True
    ) -> str:
        """
        Returns the tablename, in the desired format.

        :param include_schema:
            If ``True``, the Postgres schema is included. For example,
            'my_schema.my_table'.
        :param quote:
            If ``True``, the name is wrapped in double quotes. For example,
            '"my_schema"."my_table"'.

        """
        components = [self.tablename]
        if include_schema and self.schema:
            components.insert(0, self.schema)

        if quoted:
            return ".".join(f'"{i}"' for i in components)
        else:
            return ".".join(components)

    @property
    def foreign_key_references(self) -> list[ForeignKey]:
        foreign_keys: list[ForeignKey] = list(self._foreign_key_references)
        lazy_column_references = LAZY_COLUMN_REFERENCES.for_tablename(
            tablename=self.tablename
        )
        foreign_keys.extend(lazy_column_references)