Skip to content

Commit 2d5db1f

Browse files
committed
Merge data from dataframe api reference page into main dataframe page
1 parent ff5541e commit 2d5db1f

File tree

3 files changed

+52
-70
lines changed

3 files changed

+52
-70
lines changed

docs/source/index.rst

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -88,3 +88,8 @@ Example
8888
contributor-guide/introduction
8989
contributor-guide/ffi
9090

91+
.. _toc.api:
92+
.. toctree::
93+
:hidden:
94+
:maxdepth: 1
95+
:caption: API

docs/source/user-guide/dataframe/api-reference.rst

Lines changed: 0 additions & 69 deletions
This file was deleted.

docs/source/user-guide/dataframe/index.rst

Lines changed: 47 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -156,8 +156,54 @@ When working in Jupyter notebooks or other environments that support HTML render
156156
automatically display as formatted HTML tables. For detailed information about customizing HTML
157157
rendering, formatting options, and advanced styling, see :doc:`rendering`.
158158

159+
Core Classes
160+
------------
161+
162+
**DataFrame**
163+
The main DataFrame class for building and executing queries.
164+
165+
See: :py:class:`datafusion.DataFrame`
166+
167+
**SessionContext**
168+
The primary entry point for creating DataFrames from various data sources.
169+
170+
Key methods for DataFrame creation:
171+
172+
* :py:meth:`~datafusion.SessionContext.read_csv` - Read CSV files
173+
* :py:meth:`~datafusion.SessionContext.read_parquet` - Read Parquet files
174+
* :py:meth:`~datafusion.SessionContext.read_json` - Read JSON files
175+
* :py:meth:`~datafusion.SessionContext.read_avro` - Read Avro files
176+
* :py:meth:`~datafusion.SessionContext.table` - Access registered tables
177+
* :py:meth:`~datafusion.SessionContext.sql` - Execute SQL queries
178+
* :py:meth:`~datafusion.SessionContext.from_pandas` - Create from Pandas DataFrame
179+
* :py:meth:`~datafusion.SessionContext.from_arrow` - Create from Arrow data
180+
181+
See: :py:class:`datafusion.SessionContext`
182+
183+
Expression Classes
184+
------------------
185+
186+
**Expr**
187+
Represents expressions that can be used in DataFrame operations.
188+
189+
See: :py:class:`datafusion.Expr`
190+
191+
**Functions for creating expressions:**
192+
193+
* :py:func:`datafusion.column` - Reference a column by name
194+
* :py:func:`datafusion.literal` - Create a literal value expression
195+
196+
Built-in Functions
197+
------------------
198+
199+
DataFusion provides many built-in functions for data manipulation:
200+
201+
* :py:mod:`datafusion.functions` - Mathematical, string, date/time, and aggregation functions
202+
203+
For a complete list of available functions, see the :py:mod:`datafusion.functions` module documentation.
204+
205+
159206
.. toctree::
160207
:maxdepth: 1
161208

162209
rendering
163-
api-reference

0 commit comments

Comments
 (0)