Method create_earray

tables/file.py:1374–1513

Create a new enlargeable array. Parameters ---------- where : str or Group The parent group from which the new array will hang. It can be a path string (for example '/level1/leaf5'), or a Group instance (see :ref:`GroupClassDescr`).

(
        self,
        where: Group | str,
        name: str,
        atom: Atom | None = None,
        shape: tuple[int, ...] | None = None,
        title: str = "",
        filters: Filters | None = None,
        expectedrows: int = 1000,
        chunkshape: int | tuple[int, ...] | None = None,
        byteorder: str | None = None,
        createparents: bool = False,
        obj: np.ndarray | None = None,
        track_times: bool = True,
    )

        return ptobj

    def create_earray(
        self,
        where: Group | str,
        name: str,
        atom: Atom | None = None,
        shape: tuple[int, ...] | None = None,
        title: str = "",
        filters: Filters | None = None,
        expectedrows: int = 1000,
        chunkshape: int | tuple[int, ...] | None = None,
        byteorder: str | None = None,
        createparents: bool = False,
        obj: np.ndarray | None = None,
        track_times: bool = True,
    ) -> EArray:
        """Create a new enlargeable array.

        Parameters
        ----------
        where : str or Group
            The parent group from which the new array will hang. It can be a
            path string (for example '/level1/leaf5'), or a Group instance
            (see :ref:`GroupClassDescr`).
        name : str
            The name of the new array
        atom : Atom
            An Atom (see :ref:`AtomClassDescr`) instance representing the
            *type* and *shape* of the atomic objects to be saved.

            .. versionchanged:: 3.0
               The *atom* parameter can be None (default) if *obj* is
               provided.

        shape : tuple
            The shape of the new array.  One (and only one) of the shape
            dimensions *must* be 0.  The dimension being 0 means that the
            resulting EArray object can be extended along it.  Multiple
            enlargeable dimensions are not supported right now.

            .. versionchanged:: 3.0
               The *shape* parameter can be None (default) if *obj* is
               provided.

        title : str, optional
            A description for this node (it sets the TITLE HDF5 attribute on
            disk).
        filters : Filters, optional
            An instance of the Filters class (see :ref:`FiltersClassDescr`)
            that provides information about the desired I/O filters to
            be applied during the life of this object.
        expectedrows : int, optional
            A user estimate about the number of row elements that will be added
            to the growable dimension in the EArray node.  If not provided, the
            default value is EXPECTED_ROWS_EARRAY (see tables/parameters.py).
            If you plan to create either a much smaller or a much bigger array
            try providing a guess; this will optimize the HDF5 B-Tree creation
            and management process time and the amount of memory used.
        chunkshape : tuple, numeric, or None, optional