Skip to content

Commit ff5541e

Browse files
committed
Move API Reference under User Guide > Dataframe
1 parent 5ab5b98 commit ff5541e

File tree

6 files changed

+279
-487
lines changed

6 files changed

+279
-487
lines changed

docs/source/api/dataframe.rst

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

docs/source/api/index.rst

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

docs/source/index.rst

Lines changed: 0 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -79,15 +79,6 @@ Example
7979
user-guide/sql
8080

8181

82-
.. _toc.api:
83-
.. toctree::
84-
:hidden:
85-
:maxdepth: 1
86-
:caption: API REFERENCE
87-
88-
api/index
89-
90-
9182
.. _toc.contributor_guide:
9283
.. toctree::
9384
:hidden:
Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
.. Licensed to the Apache Software Foundation (ASF) under one
2+
.. or more contributor license agreements. See the NOTICE file
3+
.. distributed with this work for additional information
4+
.. regarding copyright ownership. The ASF licenses this file
5+
.. to you under the Apache License, Version 2.0 (the
6+
.. "License"); you may not use this file except in compliance
7+
.. with the License. You may obtain a copy of the License at
8+
9+
.. http://www.apache.org/licenses/LICENSE-2.0
10+
11+
.. Unless required by applicable law or agreed to in writing,
12+
.. software distributed under the License is distributed on an
13+
.. "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
14+
.. KIND, either express or implied. See the License for the
15+
.. specific language governing permissions and limitations
16+
.. under the License.
17+
18+
DataFrame API Reference
19+
=======================
20+
21+
This page provides quick access to DataFusion's DataFrame API documentation.
22+
23+
For comprehensive usage patterns and examples, see the main :doc:`DataFrame Guide <index>`.
24+
25+
Core Classes
26+
------------
27+
28+
**DataFrame**
29+
The main DataFrame class for building and executing queries.
30+
31+
See: :py:class:`datafusion.DataFrame`
32+
33+
**SessionContext**
34+
The primary entry point for creating DataFrames from various data sources.
35+
36+
Key methods for DataFrame creation:
37+
38+
* :py:meth:`~datafusion.SessionContext.read_csv` - Read CSV files
39+
* :py:meth:`~datafusion.SessionContext.read_parquet` - Read Parquet files
40+
* :py:meth:`~datafusion.SessionContext.read_json` - Read JSON files
41+
* :py:meth:`~datafusion.SessionContext.read_avro` - Read Avro files
42+
* :py:meth:`~datafusion.SessionContext.table` - Access registered tables
43+
* :py:meth:`~datafusion.SessionContext.sql` - Execute SQL queries
44+
* :py:meth:`~datafusion.SessionContext.from_pandas` - Create from Pandas DataFrame
45+
* :py:meth:`~datafusion.SessionContext.from_arrow` - Create from Arrow data
46+
47+
See: :py:class:`datafusion.SessionContext`
48+
49+
Expression Classes
50+
------------------
51+
52+
**Expr**
53+
Represents expressions that can be used in DataFrame operations.
54+
55+
See: :py:class:`datafusion.Expr`
56+
57+
**Functions for creating expressions:**
58+
59+
* :py:func:`datafusion.column` - Reference a column by name
60+
* :py:func:`datafusion.literal` - Create a literal value expression
61+
62+
Built-in Functions
63+
------------------
64+
65+
DataFusion provides many built-in functions for data manipulation:
66+
67+
* :py:mod:`datafusion.functions` - Mathematical, string, date/time, and aggregation functions
68+
69+
For a complete list of available functions, see the :py:mod:`datafusion.functions` module documentation.

0 commit comments

Comments
 (0)