Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Restore DocBuilder::new() to avoid breaking API change #13870

Open
wants to merge 5 commits into
base: main
Choose a base branch
from

Conversation

alamb
Copy link
Contributor

@alamb alamb commented Dec 21, 2024

Which issue does this PR close?

Rationale for this change

I would like to help people upgrade DataFusion versions with as much help as possible. This means following the deprecation guidelines

Changes to DocBuilder introduced a breaking API change that could be confusing to some during upgrade

What changes are included in this PR?

  1. Restore DocumentationBuilder::new, and mark it `#[deprecated]``, following the deprecation guidelines
  2. Make DocumentationBuilder::new_with_defaults new to help users find the new API
  3. Add Default for DocSection to make it easier for users to bash out their own docs
  4. Improve some other docs

Are these changes tested?

Are there any user-facing changes?

@github-actions github-actions bot added the sql SQL Planner label Dec 21, 2024
@alamb alamb changed the title Restore DocBuilder::new() to avoid API change Restore DocBuilder::new() to avoid breaking API change Dec 21, 2024
@alamb alamb requested a review from comphead December 22, 2024 13:42
@alamb
Copy link
Contributor Author

alamb commented Dec 22, 2024

@Omega359 or @comphead I wonder if you have time to review this change prior to the 44 release?

@@ -62,8 +62,8 @@ use sqlparser::ast::{
Assignment, AssignmentTarget, ColumnDef, CreateIndex, CreateTable,
CreateTableOptions, Delete, DescribeAlias, Expr as SQLExpr, FromTable, Ident, Insert,
ObjectName, ObjectType, OneOrManyWithParens, Query, SchemaName, SetExpr,
ShowCreateObject, Statement, TableConstraint, TableFactor, TableWithJoins,
TransactionMode, UnaryOperator, Value,
ShowCreateObject, ShowStatementFilter, Statement, TableConstraint, TableFactor,
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

cargo fmt drive by change?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it was something I needed to to do iix the build. I'll merge up and it should go away

Copy link
Contributor

@Omega359 Omega359 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@github-actions github-actions bot removed the sql SQL Planner label Dec 22, 2024
@alamb alamb mentioned this pull request Dec 22, 2024
10 tasks
Copy link
Contributor

@comphead comphead left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm thanks @alamb

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Make DocBuilder migration in 44.0.0 easier
3 participants