Skip to content

Commit

Permalink
Add Upgrade Guide for DataFusion 46.0.0
Browse files Browse the repository at this point in the history
  • Loading branch information
alamb committed Feb 26, 2025
1 parent 3193014 commit d3942e4
Show file tree
Hide file tree
Showing 3 changed files with 54 additions and 1 deletion.
6 changes: 6 additions & 0 deletions datafusion/core/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -1097,3 +1097,9 @@ doc_comment::doctest!(
"../../../docs/source/library-user-guide/working-with-exprs.md",
library_user_guide_working_with_exprs
);

#[cfg(doctest)]
doc_comment::doctest!(
"../../../docs/source/library-user-guide/upgrading.md",
library_user_guide_upgrading
);
4 changes: 3 additions & 1 deletion docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -133,7 +133,9 @@ To get started, see
library-user-guide/profiling
library-user-guide/query-optimizer
library-user-guide/api-health
.. _toc.contributor-guide:
library-user-guide/upgrading

.. .. _toc.contributor-guide:
.. toctree::
:maxdepth: 1
Expand Down
45 changes: 45 additions & 0 deletions docs/source/library-user-guide/upgrading.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
<!---
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
-->

# Upgrade Guides

## DataFusion `46.0.0`

See more information
- Change PR [PR #14224](https://github.com/apache/datafusion/pull/14224)
- Example of an Upgrade [PR in delta-rs](https://github.com/delta-io/delta-rs/pull/3261)

### `ParquetExec`, `AvroExec`, `CsvExec`, `JsonExec` deprecated

DataFusion 46 has a major change to how the built in DataSources are organized. The

### Cookbook: Changes to `ParquetExecBuilder`

#### Old pattern:
```test
TODO
```

#### New Pattern


```test
TODO
```

0 comments on commit d3942e4

Please sign in to comment.