Skip to content

fix error handling of DuckDB::Append#append_date #904

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

Merged
merged 1 commit into from
Mar 1, 2025

Conversation

suketa
Copy link
Owner

@suketa suketa commented Mar 1, 2025

Summary by CodeRabbit

  • Documentation

    • Clarified error messages to indicate that date append operations may now fail, with improved usage guidance in method documentation.
  • Refactor

    • Adjusted the error handling for date appending by shifting from an exception-based approach to returning a success status, ensuring more consistent feedback.

Copy link

coderabbitai bot commented Mar 1, 2025

Walkthrough

This pull request updates the error handling and documentation for the DuckDB::Appender#append_date method. The CHANGELOG now lists append_date among the methods that can fail. In the C implementation, the function now returns a boolean result instead of raising an exception, while the Ruby binding in lib/duckdb/appender.rb enhances its documentation with an explicit call sequence and introduces conditional error handling that raises an error on failure.

Changes

File(s) Change Summary
CHANGELOG.md, lib/.../appender.rb Updated error message documentation to include DuckDB::Appender#append_date and clarify method signature with a call-seq comment.
ext/.../appender.c, lib/.../appender.rb Modified error handling for append_date: the C function now returns a boolean instead of raising an exception, and the Ruby method raises an error if the append fails.

Sequence Diagram(s)

sequenceDiagram
    participant R as Ruby Appender
    participant C as C appender__append_date
    participant DB as DuckDB System

    R->>C: Call append_date(date)
    C->>DB: Execute duckdb_append_date(dt)
    DB-->>C: Return execution state
    C-->>R: Return boolean success value
    alt Success is true
        R->>R: Return self
    else Failure detected
        R->>R: Raise error "failed to append_date"
    end
Loading

Possibly related PRs

Poem

Oh, I’m a rabbit with a hop so light,
Fixing errors in code deep into the night,
Append_date now sings a tidy tune,
With booleans and docs that make bugs prune,
In DuckDB fields, I leap with delight! 🐰✨

✨ Finishing Touches
  • 📝 Generate Docstrings

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ 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.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between fd3fda2 and 147cffe.

📒 Files selected for processing (3)
  • CHANGELOG.md (1 hunks)
  • ext/duckdb/appender.c (1 hunks)
  • lib/duckdb/appender.rb (2 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (19)
  • GitHub Check: test (head, 1.2.0)
  • GitHub Check: test (mswin, 1.1.1)
  • GitHub Check: test (mswin, 1.1.3)
  • GitHub Check: test (mswin, 1.2.0)
  • GitHub Check: test (mingw, 1.1.3)
  • GitHub Check: test (mingw, 1.2.0)
  • GitHub Check: test (ucrt, 1.1.1)
  • GitHub Check: test (3.4.1, 1.1.1)
  • GitHub Check: test (3.4.1, 1.1.3)
  • GitHub Check: test (3.4.1, 1.2.0)
  • GitHub Check: test (3.3.6, 1.1.1)
  • GitHub Check: test (3.3.6, 1.1.3)
  • GitHub Check: test (3.3.6, 1.2.0)
  • GitHub Check: test (3.2.6, 1.1.1)
  • GitHub Check: test (3.2.6, 1.1.3)
  • GitHub Check: test (3.2.6, 1.2.0)
  • GitHub Check: test (3.1.6, 1.1.1)
  • GitHub Check: test (3.1.6, 1.1.3)
  • GitHub Check: test (3.1.6, 1.2.0)
🔇 Additional comments (3)
ext/duckdb/appender.c (1)

284-284: Changed error handling approach to align with other methods

The function now returns a boolean value using duckdb_state_to_bool_value() instead of raising an exception directly. This makes the error handling consistent with other similar appender methods.

CHANGELOG.md (1)

12-13: Documentation updated correctly

The CHANGELOG now includes DuckDB::Appender#append_date in the list of methods that can fail, maintaining consistency with the implementation changes.

lib/duckdb/appender.rb (1)

461-465: Documentation improved with clear method signature

The added call-seq comment clarifies the method signature and return value, improving the API documentation.

Comment on lines +480 to +482
return self if _append_date(date.year, date.month, date.day)

raise_appender_error('failed to append_date')
Copy link

Choose a reason for hiding this comment

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

⚠️ Potential issue

Fixed error handling by checking return value

The implementation now properly checks the return value from _append_date and raises an appropriate error when the operation fails, matching the pattern used by other appender methods.

This change fixes a previously inconsistent error handling approach that could potentially hide errors when appending date values.

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.

1 participant