Skip to content

[pull] main from apache:main#33

Merged
pull[bot] merged 3 commits intoStars1233:mainfrom
apache:main
Apr 19, 2025
Merged

[pull] main from apache:main#33
pull[bot] merged 3 commits intoStars1233:mainfrom
apache:main

Conversation

@pull
Copy link
Copy Markdown

@pull pull bot commented Apr 19, 2025

See Commits and Changes for more details.


Created by pull[bot] (v2.0.0-alpha.1)

Can you help keep this open source service alive? 💖 Please sponsor : )

Summary by Sourcery

Enhance DataFusion's aggregate functions and expression simplification, and update documentation to reflect format options

New Features:

  • Add support for computing average of duration values in aggregate functions
  • Introduce a new documentation page for format options

Enhancements:

  • Improve expression simplification with a new transformed method
  • Update documentation references from write_options to format_options

Documentation:

  • Create a comprehensive documentation page for format options in DataFusion
  • Update references to write options in existing documentation

shruti2522 and others added 3 commits April 19, 2025 07:34
* Support Accumulator for avg duration

* Add tests
* Improve simplify_expressions rule

* address comments

* address comments
* doc:Add documentation for OPTIONS clause syntax

* doc:rename write_options.md to format_options.md and clarify its scope for both reading and writing

* doc: change dml.md, cuz still have wrong write_options filename

* doc: update doctest reference to renamed format_options.md

* docs: update and correct format options documentation

* doc: add more information of options content

* remove execution settings, move note about insert

* wordsmith example

---------

Co-authored-by: Andrew Lamb <andrew@nerdnetworks.org>
@pull pull bot added the ⤵️ pull label Apr 19, 2025
@pull pull bot merged commit f07fb10 into Stars1233:main Apr 19, 2025
@gitstream-cm
Copy link
Copy Markdown

gitstream-cm bot commented Apr 19, 2025

🚨 gitStream Monthly Automation Limit Reached 🚨

Your organization has exceeded the number of pull requests allowed for automation with gitStream.
Monthly PRs automated: 7510/250

To continue automating your PR workflows and unlock additional features, please contact LinearB.

@sourcery-ai
Copy link
Copy Markdown

sourcery-ai bot commented Apr 19, 2025

Reviewer's Guide by Sourcery

This pull request includes several enhancements and refactorings. It introduces support for average aggregation on duration types, refactors the expression simplification process to track transformations, and renames the write options documentation to format options, updating related references.

Sequence diagram for expression simplification with cycle count

sequenceDiagram
    participant ExprSimplifier
    participant Simplifier
    participant ConstEvaluator
    participant ShortenInListSimplifier
    ExprSimplifier->>Simplifier: new()
    ExprSimplifier->>ConstEvaluator: try_new()
    ExprSimplifier->>ShortenInListSimplifier: new()
    loop until no transformation or max cycles
        ExprSimplifier->>Simplifier: transform(expr)
        activate Simplifier
        Simplifier-->>ExprSimplifier: Transformed {data, transformed}
        deactivate Simplifier
        alt transformed
            ExprSimplifier->>ConstEvaluator: transform(expr)
            activate ConstEvaluator
            ConstEvaluator-->>ExprSimplifier: Transformed {data, transformed}
            deactivate ConstEvaluator
        end
    end
    ExprSimplifier->>ShortenInListSimplifier: rewrite(expr)
    activate ShortenInListSimplifier
    ShortenInListSimplifier-->>ExprSimplifier: Transformed {data, transformed}
    deactivate ShortenInListSimplifier
Loading

Updated class diagram for AvgAccumulator

classDiagram
    class Avg {
        <<AggregateUDFImpl>>
    }
    class DurationAvgAccumulator {
        sum: Option<i64>
        count: u64
        time_unit: TimeUnit
        result_unit: TimeUnit
        update_batch(values: &[ArrayRef]) Result<()>
        evaluate() Result<ScalarValue>
        state() Result<Vec<ScalarValue>>
        merge_batch(states: &[ArrayRef]) Result<()>
        retract_batch(values: &[ArrayRef]) Result<()>
        supports_retract_batch() bool
    }
    Avg -- DurationAvgAccumulator : Creates when input is Duration
Loading

Updated class diagram for ExprSimplifier

classDiagram
    class ExprSimplifier {
        -max_simplifier_cycles: u32
        +simplify(expr: Expr) Result<Expr>
        +simplify_with_cycle_count_transformed(expr: Expr) Result<(Transformed<Expr>, u32)>
        +with_max_cycles(max_cycles: u32) ExprSimplifier
    }
    class Transformed {
        data: Expr
        transformed: bool
    }
    ExprSimplifier -- Transformed : Returns
Loading

File-Level Changes

Change Details Files
Implemented average aggregation for duration types.
  • Added DurationAvgAccumulator struct to compute the average for duration values.
  • Implemented the Accumulator trait for DurationAvgAccumulator to handle batch updates, evaluation, state management, merging, and retraction.
  • Updated avg_return_type and avg_sum_type functions to handle DataType::Duration.
  • Modified coerce_avg_type to include DataType::Duration.
  • Added a new match arm in Avg::create_accumulator to handle duration types.
datafusion/functions-aggregate/src/average.rs
datafusion/expr-common/src/type_coercion/aggregates.rs
Refactored simplify_with_cycle_count to return a Transformed<Expr>.
  • Modified simplify_with_cycle_count to simplify_with_cycle_count_transformed to return a Transformed<Expr>.
  • Deprecated the old simplify_with_cycle_count.
  • Updated the return type of simplify_with_cycle_count in tests.
  • Updated SimplifyExpressions to use simplify_with_cycle_count_transformed.
datafusion/optimizer/src/simplify_expressions/expr_simplifier.rs
datafusion/optimizer/src/simplify_expressions/simplify_exprs.rs
datafusion/core/tests/expr_api/simplification.rs
Renamed write_options.md to format_options.md and updated related documentation.
  • Renamed docs/source/user-guide/sql/write_options.md to docs/source/user-guide/sql/format_options.md.
  • Updated references to write_options to format_options.md in docs/source/user-guide/sql/ddl.md and docs/source/user-guide/sql/dml.md.
datafusion/core/src/lib.rs
docs/source/user-guide/sql/ddl.md
docs/source/user-guide/sql/dml.md

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!
  • Generate a plan of action for an issue: Comment @sourcery-ai plan on
    an issue to generate a plan of action for it.

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Apr 19, 2025

Important

Review skipped

Bot user detected.

To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Sign up for free to 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