Skip to content

Commit cb55906

Browse files
kmitchenerkmitchener
authored
moved python docs from DataFusion project (apache#23)
1 parent 7993e5d commit cb55906

10 files changed

Lines changed: 507 additions & 0 deletions

‎docs/source/python/api.rst‎

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
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+
.. _api:
19+
20+
*************
21+
API Reference
22+
*************
23+
24+
.. toctree::
25+
:maxdepth: 2
26+
27+
api/dataframe
28+
api/execution_context
29+
api/expression
30+
api/functions

‎docs/source/python/api/dataframe.rst‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
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+
.. _api.dataframe:
19+
.. currentmodule:: datafusion
20+
21+
DataFrame
22+
=========
23+
24+
.. autosummary::
25+
:toctree: ../generated/
26+
27+
DataFrame

‎docs/source/python/api/execution_context.rst‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
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+
.. _api.execution_context:
19+
.. currentmodule:: datafusion
20+
21+
SessionContext
22+
================
23+
24+
.. autosummary::
25+
:toctree: ../generated/
26+
27+
SessionContext

‎docs/source/python/api/expression.rst‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
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+
.. _api.expression:
19+
.. currentmodule:: datafusion
20+
21+
Expression
22+
==========
23+
24+
.. autosummary::
25+
:toctree: ../generated/
26+
27+
Expression

‎docs/source/python/api/functions.rst‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
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+
.. _api.functions:
19+
.. currentmodule:: datafusion
20+
21+
Functions
22+
=========
23+
24+
.. autosummary::
25+
:toctree: ../generated/
26+
27+
functions

‎docs/source/python/generated/datafusion.DataFrame.rst‎

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
datafusion.DataFrame
2+
====================
3+
4+
.. currentmodule:: datafusion
5+
6+
.. autoclass:: DataFrame
7+
8+
9+
.. automethod:: __init__
10+
11+
12+
.. rubric:: Methods
13+
14+
.. autosummary::
15+
16+
~DataFrame.__init__
17+
~DataFrame.aggregate
18+
~DataFrame.collect
19+
~DataFrame.explain
20+
~DataFrame.filter
21+
~DataFrame.join
22+
~DataFrame.limit
23+
~DataFrame.schema
24+
~DataFrame.select
25+
~DataFrame.select_columns
26+
~DataFrame.show
27+
~DataFrame.sort
28+
29+
30+
31+
32+
33+

‎docs/source/python/generated/datafusion.Expression.rst‎

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
datafusion.Expression
2+
=====================
3+
4+
.. currentmodule:: datafusion
5+
6+
.. autoclass:: Expression
7+
8+
9+
.. automethod:: __init__
10+
11+
12+
.. rubric:: Methods
13+
14+
.. autosummary::
15+
16+
~Expression.__init__
17+
~Expression.alias
18+
~Expression.cast
19+
~Expression.column
20+
~Expression.is_null
21+
~Expression.literal
22+
~Expression.sort
23+
24+
25+
26+
27+
28+

‎docs/source/python/generated/datafusion.SessionContext.rst‎

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
datafusion.SessionContext
2+
=========================
3+
4+
.. currentmodule:: datafusion
5+
6+
.. autoclass:: SessionContext
7+
8+
9+
.. automethod:: __init__
10+
11+
12+
.. rubric:: Methods
13+
14+
.. autosummary::
15+
16+
~SessionContext.__init__
17+
~SessionContext.catalog
18+
~SessionContext.create_dataframe
19+
~SessionContext.deregister_table
20+
~SessionContext.empty_table
21+
~SessionContext.register_csv
22+
~SessionContext.register_parquet
23+
~SessionContext.register_record_batches
24+
~SessionContext.register_table
25+
~SessionContext.register_udf
26+
~SessionContext.sql
27+
~SessionContext.table
28+
~SessionContext.tables
29+
30+
31+
32+
33+
34+

‎docs/source/python/generated/datafusion.functions.rst‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
datafusion.functions
2+
====================
3+
4+
.. automodule:: datafusion.functions
5+
6+
7+
8+
9+
10+
11+
12+
13+
14+
15+
16+
17+
18+
19+
20+
21+
22+
23+

0 commit comments

Comments
 (0)