Skip to content

Commit 90b3cb6

Browse files
committed
More documentation
1 parent c70968f commit 90b3cb6

File tree

2 files changed

+12
-3
lines changed

2 files changed

+12
-3
lines changed

docs/source/user-guide/data-sources.rst

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -152,7 +152,6 @@ as Delta Lake. This will require a recent version of
152152
.. code-block:: python
153153
154154
from deltalake import DeltaTable
155-
from datafusion import Table
156155
157156
delta_table = DeltaTable("path_to_table")
158157
ctx.register_table("my_delta_table", delta_table)

python/datafusion/catalog.py

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -148,14 +148,24 @@ class Database(Schema):
148148

149149

150150
class Table:
151-
"""DataFusion table or table provider wrapper."""
151+
"""A DataFusion table.
152+
153+
Internally we currently support the following types of tables:
154+
155+
- Tables created using built-in DataFusion methods, such as
156+
reading from CSV or Parquet
157+
- pyarrow datasets
158+
- DataFusion DataFrames, which will be converted into a view
159+
- Externally provided tables implemented with the FFI PyCapsule
160+
interface (advanced)
161+
"""
152162

153163
__slots__ = ("_inner",)
154164

155165
def __init__(
156166
self, table: Table | TableProviderExportable | DataFrame | pa.dataset.Dataset
157167
) -> None:
158-
"""Wrap a low level table or table provider."""
168+
"""Constructor."""
159169
self._inner = df_internal.catalog.RawTable(table)
160170

161171
def __repr__(self) -> str:

0 commit comments

Comments
 (0)