File size: 4,347 Bytes
2c3c408 | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 | TileDB Python API Reference
===========================
Modules
-------
Typical usage of the Python interface to TileDB will use the top-level module ``tiledb``, e.g.
.. code-block:: python
import tiledb
There is also a submodule ``libtiledb`` which contains the necessary bindings to the underlying TileDB native library. Most of the time you will not need to interact with ``tiledb.libtiledb`` unless you need native-library specific information, e.g. the version number:
.. code-block:: python
import tiledb
tiledb.libtiledb.version() # Native TileDB library version number
Getting Started
---------------
Arrays may be opened with the ``tiledb.open`` function:
.. autofunction:: tiledb.open
Data import helpers
-------------------
.. autofunction:: tiledb.from_numpy
.. autofunction:: tiledb.from_csv
.. autofunction:: tiledb.from_pandas
Context
-------
.. autoclass:: tiledb.Ctx
:members:
.. autofunction:: tiledb.default_ctx
.. autofunction:: tiledb.scope_ctx
Config
------
.. autoclass:: tiledb.Config
:members:
Current Domain
--------------
.. autoclass:: tiledb.CurrentDomain
:members:
NDRectangle
-----------
.. autoclass:: tiledb.NDRectangle
:members:
Array Schema
------------
.. autoclass:: tiledb.ArraySchema
:members:
.. autofunction:: tiledb.empty_like
Attribute
---------
.. autoclass:: tiledb.Attr
:members:
Filters
-------
.. autoclass:: tiledb.FilterList
:members:
.. automethod:: __getitem__(idx)
.. automethod:: __len__
.. autoclass:: tiledb.CompressionFilter
:members:
.. autoclass:: tiledb.GzipFilter
:members:
.. autoclass:: tiledb.ZstdFilter
:members:
.. autoclass:: tiledb.LZ4Filter
:members:
.. autoclass:: tiledb.Bzip2Filter
:members:
.. autoclass:: tiledb.RleFilter
:members:
.. autoclass:: tiledb.DoubleDeltaFilter
:members:
.. autoclass:: tiledb.BitShuffleFilter
:members:
.. autoclass:: tiledb.ByteShuffleFilter
:members:
.. autoclass:: tiledb.BitWidthReductionFilter
:members:
.. autoclass:: tiledb.PositiveDeltaFilter
:members:
Dimension
---------
.. autoclass:: tiledb.Dim
:members:
Domain
------
.. autoclass:: tiledb.Domain
:members:
Array
-----
.. autoclass:: tiledb.libtiledb.Array
:members:
.. autofunction:: tiledb.consolidate
.. autofunction:: tiledb.vacuum
Dense Array
-----------
.. autoclass:: tiledb.DenseArray
:members: query
:special-members: __getitem__, __setitem__
Sparse Array
------------
.. autoclass:: tiledb.SparseArray
:members: query
:special-members: __getitem__, __setitem__
Query
---------------
.. autoclass:: tiledb.libtiledb.Query
:members:
Query Condition
---------------
.. autoclass:: tiledb.QueryCondition
:members:
Group
-----
.. autoclass:: tiledb.Group
:members:
.. automethod:: __getitem__(member)
.. automethod:: __delitem__(uri)
.. automethod:: __contains__(member)
.. automethod:: __len__
.. autoclass:: tiledb.Group.GroupMetadata
:members:
.. automethod:: __setitem__(key, value)
.. automethod:: __getitem__(key)
.. automethod:: __delitem__(key)
.. automethod:: __contains__(key)
.. automethod:: __len__
.. automethod:: __keys__
.. automethod:: __values__
.. automethod:: __items__
Object
------
.. autoclass:: tiledb.Object
.. autoattribute:: uri
.. autoattribute:: type
Object Management
-----------------
.. autofunction:: tiledb.array_exists
.. autofunction:: tiledb.group_create
.. autofunction:: tiledb.object_type
.. autofunction:: tiledb.remove
.. autofunction:: tiledb.move
.. autofunction:: tiledb.ls
.. autofunction:: tiledb.walk
Fragment Info
-------------
.. autoclass:: tiledb.FragmentInfoList
:members:
.. autoclass:: tiledb.FragmentInfo
:members:
Enumeration
------------
.. autoclass:: tiledb.Enumeration
:members:
Exceptions
----------
.. autoexception:: tiledb.TileDBError
:members:
VFS
---
.. autoclass:: tiledb.VFS
:members:
.. autoclass:: tiledb.FileIO
:members:
.. automethod:: __len__
Filestore
---------
.. autoclass:: tiledb.Filestore
:members:
.. automethod:: __len__
Version
-------
.. autofunction:: tiledb.libtiledb.version
Statistics
----------
.. autofunction:: tiledb.stats_enable
.. autofunction:: tiledb.stats_disable
.. autofunction:: tiledb.stats_reset
.. autofunction:: tiledb.stats_dump
|