Class IndexesTableG

tables/index.py:2502–2545

Table indexes.

class IndexesTableG(NotLoggedMixin, Group):
    """Table indexes."""

    _c_classid = "TINDEX"

    @property
    def auto(self) -> bool:
        """Return True if auto-index is set."""
        if "AUTO_INDEX" not in self._v_attrs:
            return default_auto_index
        return self._v_attrs.AUTO_INDEX

    @auto.setter
    def auto(self, auto: bool) -> None:
        self._v_attrs.AUTO_INDEX = bool(auto)

    @auto.deleter
    def auto(self) -> None:
        del self._v_attrs.AUTO_INDEX

    def _g_width_warning(self) -> None:
        warnings.warn(
            "the number of indexed columns on a single table "
            "is exceeding the recommended maximum (%d); "
            "be ready to see PyTables asking for *lots* of memory "
            "and possibly slow I/O" % self._v_max_group_width,
            PerformanceWarning,
        )

    def _g_check_name(self, name: str) -> None:
        if not name.startswith("_i_"):
            raise ValueError(
                "names of index groups must start with ``_i_``: %s" % name
            )

    @property
    def table(self) -> Table:
        """Accessor for the `Table` object of this `IndexesTableG` container."""
        names = self._v_pathname.split("/")
        tablename = names.pop()[3:]  # "_i_" is at the beginning
        parentpathname = "/".join(names)
        tablepathname = join_path(parentpathname, tablename)
        table = self._v_file._get_node(tablepathname)
        return table


class OldIndex(NotLoggedMixin, Group):