Represents the index of a column in a table. This class is used to keep the indexing information for columns in a Table dataset (see :ref:`TableClassDescr`). It is actually a descendant of the Group class (see :ref:`GroupClassDescr`), with some added functionality. An Index is alway
| 111 | |
| 112 | |
| 113 | class Index(NotLoggedMixin, Group, indexesextension.Index): |
| 114 | """Represents the index of a column in a table. |
| 115 | |
| 116 | This class is used to keep the indexing information for columns in a Table |
| 117 | dataset (see :ref:`TableClassDescr`). It is actually a descendant of the |
| 118 | Group class (see :ref:`GroupClassDescr`), with some added functionality. An |
| 119 | Index is always associated with one and only one column in the table. |
| 120 | |
| 121 | .. note:: |
| 122 | |
| 123 | This class is mainly intended for internal use, but some of its |
| 124 | documented attributes and methods may be interesting for the |
| 125 | programmer. |
| 126 | |
| 127 | Parameters |
| 128 | ---------- |
| 129 | parentnode |
| 130 | The parent :class:`Group` object. |
| 131 | |
| 132 | .. versionchanged:: 3.0 |
| 133 | Renamed from *parentNode* to *parentnode*. |
| 134 | |
| 135 | name : str |
| 136 | The name of this node in its parent group. |
| 137 | atom : Atom |
| 138 | An Atom object representing the shape and type of the atomic objects to |
| 139 | be saved. Only scalar atoms are supported. |
| 140 | title |
| 141 | Sets a TITLE attribute of the Index entity. |
| 142 | kind |
| 143 | The desired kind for this index. The 'full' kind specifies a complete |
| 144 | track of the row position (64-bit), while the 'medium', 'light' or |
| 145 | 'ultralight' kinds only specify in which chunk the row is (using |
| 146 | 32-bit, 16-bit and 8-bit respectively). |
| 147 | optlevel |
| 148 | The desired optimization level for this index. |
| 149 | filters : Filters |
| 150 | An instance of the Filters class that provides information about the |
| 151 | desired I/O filters to be applied during the life of this object. |
| 152 | tmp_dir |
| 153 | The directory for the temporary files. |
| 154 | expectedrows |
| 155 | Represents an user estimate about the number of row slices that will be |
| 156 | added to the growable dimension in the IndexArray object. |
| 157 | byteorder |
| 158 | The byteorder of the index datasets *on-disk*. |
| 159 | blocksizes |
| 160 | The four main sizes of the compound blocks in index datasets (a low |
| 161 | level parameter). |
| 162 | new |
| 163 | Whether this Index is new or has to be read from disk. |
| 164 | |
| 165 | """ |
| 166 | |
| 167 | _c_classid = "INDEX" |
| 168 | |
| 169 | @property |
| 170 | def kind(self) -> Literal["ultralight", "light", "medium", "full"]: |
no outgoing calls
no test coverage detected