Skip to content

ARROW-11992: [Rust][Parquet] Add upgrade notes on 4.0 rename of LogicalType - #9731

Closed
alamb wants to merge 3 commits into
apache:masterfrom
alamb:better-docs-on-rename
Closed

ARROW-11992: [Rust][Parquet] Add upgrade notes on 4.0 rename of LogicalType#9731
alamb wants to merge 3 commits into
apache:masterfrom
alamb:better-docs-on-rename

Conversation

@alamb

Copy link
Copy Markdown
Contributor

Rationale

While updating arrow deps in https://github.com/influxdata/influxdb_iox/pull/1003, I got (very) confused for a while with the parquet upgrade as LogicalType was renamed to ConvertedType but then a new type called LogicalType was added in #9592.

Changes

Add some comments to try and help future users save some time during upgrade

@alambalamb changed the title [Rust][Parquet] Add upgrade notes on 4.0 rename of LogicalTypeARROW-11992: [Rust][Parquet] Add upgrade notes on 4.0 rename of LogicalTypeMar 16, 2021
@alamb
alamb requested review from nevi-me and sunchaoMarch 16, 2021 22:13
@github-actions

Copy link
Copy Markdown

Thanks for opening a pull request!

Could you open an issue for this pull request on JIRA?
https://issues.apache.org/jira/browse/ARROW

Then could you also rename pull request title in the following format?

ARROW-${JIRA_ID}: [${COMPONENT}] ${SUMMARY}

See also:

@github-actions

Copy link
Copy Markdown

Comment threadrust/parquet/README.md Outdated

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

It's fine to add this temporarily in README.md but I think we should put them this alongside other breaking changes from 4.0 (seems there're quite a few of them) in a separate doc eventually. Something similar from Apache Spark.

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

Summarizing breaking changes would definitely be valuable. I don't think I have the time to do so at this moment, but I am very supportive of the idea

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I'll add a guide as part of https://issues.apache.org/jira/browse/ARROW-12019, to provide examples of how one can start using LogicalType.

Comment threadrust/parquet/README.md Outdated

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

nit: remove *Upgrade Note*? it looks redundant.

Comment threadrust/parquet/src/basic.rs Outdated

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

I'm not sure if its useful to have this message here as well. Maybe the one in README is enough?

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

I think it is important to put a hint as close to where people will hit the compiler error as possible (e.g. I wouldn't have known to look in the README when I hit the error on upgrade).

That being said, I think you are right that the actual content doesn't need to be duplicated here -- I will change it to point people at the readme for further details.

Comment threadrust/parquet/README.md Outdated

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

nit: to align with the standard -> to align with the LogicalType introduced in Parquet Format 2.4.0 and up.

@alamb
alambforce-pushed the better-docs-on-rename branch from 1e27c5c to 487b631CompareMarch 18, 2021 10:44

@nevi-menevi-me left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Nothing in addition to what @sunchao raised. Thanks @alamb

@sunchaosunchao left a comment

Copy link
Copy Markdown
Member

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 freeto join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants

@alamb@sunchao@nevi-me