Minor: Document third argument of date_bin as optional and default value
#8912
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
# Rationale @mhilton noticed this as part of an internal discussion where we were confused about the output values of `date_bin` for timestamps with timezones (as the default argument is for the unix EPOCH in UTC) # Changes: Document the third parameter to `date_bin` better
alamb
changed the title
date_bin as optional and default value
github-actions
bot
removed
the
documentation
Ted-Jiang
approved these changes
Jan 20, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Which issue does this PR close?
N/A
Rationale for this change
@mhilton noticed this as part of an internal discussion where we were confused about the output values of
date_binfor timestamps with timezones (as the default argument is for the unix EPOCH in UTC)The default is defined here: https://github.com/apache/arrow-datafusion/blob/3a9e23d138c935ffea68408899016c9323aa0f36/datafusion/physical-expr/src/datetime_expressions.rs#L534C1-L538
What changes are included in this PR?
Document the third parameter to
date_binbetterAre these changes tested?
existing tests
Are there any user-facing changes?
Better documentation