Skip to content

Conversation

@inv-jishnu
Copy link
Contributor

@inv-jishnu inv-jishnu commented Nov 19, 2025

Description

This PR updates the default value of --log-raw-record to true by default so that raw records are logged in failure log unless the user specifies otherwise.

It was set to false by default but that is not really the expected behavior users want. The feature will not be deprecated though so the users have the option to still disable it.

This PR also fixes a few comments that mention the wrong target version for deprecation.

Related issues and/or PRs

NA

Changes made

  • Updated default value for --log-raw-record to true
  • Added a conditional check to log transaction batch to avoid logging raw records if the paramter ``-log-raw-record` is set to false as it was logged always irrespective of flag value set (bug fix)
  • Updated comments for deprecated paramaters
    • Updated deprecated version to 3.17.0
    • Updated comments to specify the deprecation version and removal version

Checklist

The following is a best-effort checklist. If any items in this checklist are not applicable to this PR or are dependent on other, unmerged PRs, please still mark the checkboxes after you have read and understood each item.

  • I have commented my code, particularly in hard-to-understand areas.
  • I have updated the documentation to reflect the changes.
  • I have considered whether similar issues could occur in other products, components, or modules if this PR is for bug fixes.
  • Any remaining open issues linked to this PR are documented and up-to-date (Jira, GitHub, etc.).
  • Tests (unit, integration, etc.) have been added for the changes.
  • My changes generate no new warnings.
  • Any dependent changes in other PRs have been merged and published.

Additional notes (optional)

NA

Release notes

Update default value for --log-raw-record to true

@gemini-code-assist
Copy link
Contributor

Summary of Changes

Hello @inv-jishnu, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request standardizes the behavior of failure logging by setting the --log-raw-record option to true by default, ensuring consistent inclusion of raw records in logs. Additionally, it refines the documentation for several deprecated command-line arguments, updating their deprecation and removal version information for clarity.

Highlights

  • Default --log-raw-record value: The default value for the --log-raw-record command-line option has been changed from false to true, ensuring raw records are included in failure logs by default across all modes.
  • Deprecation comment updates: Comments for several deprecated command-line parameters (--max-threads, --start-exclusive, --end-exclusive, --enable-log-success) have been updated to reflect the correct deprecation version (3.17.0) and removal version (4.0.0).
Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

Copy link
Contributor

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

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

Code Review

This pull request updates the default value for the --log-raw-record option to true in the import command, making the behavior consistent with what was expected. It also standardizes the deprecation comments for several options, improving code documentation. The changes are logical, but I've identified a point of inconsistency with the core options class and a lack of test coverage for the new default value, which should be addressed.

Comment on lines +128 to +129
description = "Include the original source record in the log file output (default: true)",
defaultValue = "true")
Copy link
Contributor

Choose a reason for hiding this comment

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

high

I have a couple of points regarding this change:

  • Inconsistency with Core Options: While changing the default value here to true aligns with the PR's goal, it creates an inconsistency with the core ImportOptions class, where logRawRecord still defaults to false. This means the default behavior will differ depending on whether the tool is used via the CLI or programmatically. For consistency, please consider also updating the default in data-loader/core/src/main/java/com/scalar/db/dataloader/core/dataimport/ImportOptions.java.

  • Missing Test Coverage: Changing a default value is a behavioral change that should be covered by tests. ImportCommandTest.java appears to be missing tests for the --log-raw-record option. Please add a test case to verify that logRawRecord defaults to true when the option is not specified in the command arguments.

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 have updated changes based on suggestion in 58c5051

@ypeckstadt ypeckstadt changed the title Update default value for --log-raw-record to true Set --log-raw-record default to true for all failure logs Nov 19, 2025
@inv-jishnu inv-jishnu closed this Nov 19, 2025
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.

1 participant