feat: export database data #4382

fengjiachun · 2024-07-17T13:27:12Z

I hereby agree to the terms of the GreptimeDB CLA.

Refer to a related PR or issue link (optional)

What's changed and what's your intention?

CLI: support exporting database data with a time range

Checklist

I have written the necessary rustdoc comments.
I have added the necessary unit tests and integration tests.
This PR requires documentation updates.

Summary by CodeRabbit

New Features
- Introduced support for exporting database data, with a new DatabaseData option.
- Deprecated the TableData export target.
Enhancements
- Improved the export functionality to handle database data asynchronously for better performance.
- Added time range specifications for exports, allowing users to set start and end times for greater control over the exported data.

coderabbitai · 2024-07-17T13:27:40Z

Walkthrough

This update introduces a new feature for exporting database data in our CLI tool. A DatabaseData variant has been added to the ExportTarget enum, replacing the deprecated TableData. An asynchronous function, export_database_data, has been implemented to facilitate this export, and the do_work method in the Tool implementation has been updated to handle the DatabaseData target. Additionally, new fields for specifying a time range enhance the export command's functionality.

Changes

File	Change Summary
`src/cmd/src/cli/export.rs`	Added `DatabaseData` variant to `ExportTarget` enum with deprecation note for `TableData`, implemented `export_database_data` function, updated `do_work` function in `Tool` implementation to handle `DatabaseData`, and added `start_time` and `end_time` fields to `ExportCommand`.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant CLI
    participant Export

    User->>CLI: Execute export command
    CLI->>Export: Call do_work with DatabaseData target
    Export->>Export: Check target type
    Export-->>CLI: Return task processing result
    CLI-->>User: Display export completion status

Poem

In lines of code, new paths arise,
DatabaseData now with clear skies.
Exporting data swift and neat,
The CLI tool, a coder's treat.
Deprecated ways now bow and part,
A fresh new start, a work of art. 🐇✨

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>.
- 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 generate interesting stats about this repository and render them as a table.
- @coderabbitai show all the console.log statements in this repository.
- @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 as 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 resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

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.

coderabbitai

Actionable comments posted: 1

Outside diff range, codebase verification and nitpick comments (1)

src/cmd/src/cli/export.rs (1)

485-492: Updated do_work method to handle DatabaseData.

The update to include DatabaseData in the do_work method is consistent with the new functionality introduced in this PR.

Consider adding detailed logging or metrics collection to monitor the performance and outcomes of each export type, which could be valuable for troubleshooting and performance tuning.

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between e39f49f and d9e3beb.

Files selected for processing (1)

src/cmd/src/cli/export.rs (2 hunks)

Additional comments not posted (1)

src/cmd/src/cli/export.rs (1)

49-52: Added new enum variant DatabaseData with deprecation note for TableData.

The addition of DatabaseData and the deprecation of TableData align with the PR's objective to enhance database data export functionality. This change is clear and follows Rust's standard practice for deprecation.

src/cmd/src/cli/export.rs

codecov · 2024-07-17T13:43:47Z

Codecov Report

Attention: Patch coverage is 15.90909% with 74 lines in your changes missing coverage. Please review.

Project coverage is 84.84%. Comparing base (e39f49f) to head (da0207e).
Report is 4 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #4382      +/-   ##
==========================================
- Coverage   85.15%   84.84%   -0.32%     
==========================================
  Files        1074     1074              
  Lines      191979   192113     +134     
==========================================
- Hits       163483   162993     -490     
- Misses      28496    29120     +624

coderabbitai

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between d9e3beb and e44d386.

Files selected for processing (1)

src/cmd/src/cli/export.rs (9 hunks)

Files skipped from review as they are similar to previous changes (1)

src/cmd/src/cli/export.rs

coderabbitai

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between e44d386 and d36737f.

Files selected for processing (1)

src/cmd/src/cli/export.rs (7 hunks)

Files skipped from review as they are similar to previous changes (1)

src/cmd/src/cli/export.rs

fengjiachun · 2024-07-18T05:09:03Z

@WenyXu @waynexia PTAL

killme2008 · 2024-07-18T22:30:06Z

@fengjiachun Good job. The task #4276 should be started!

src/cmd/src/cli/export.rs

coderabbitai

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between d36737f and f58ceb4.

Files selected for processing (1)

src/cmd/src/cli/export.rs (7 hunks)

Files skipped from review as they are similar to previous changes (1)

src/cmd/src/cli/export.rs

coderabbitai

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between f58ceb4 and c38cc50.

Files selected for processing (1)

src/cmd/src/cli/export.rs (8 hunks)

Files skipped from review as they are similar to previous changes (1)

src/cmd/src/cli/export.rs

src/cmd/src/cli/export.rs

coderabbitai

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between c38cc50 and da0207e.

Files selected for processing (1)

src/cmd/src/cli/export.rs (10 hunks)

Files skipped from review as they are similar to previous changes (1)

src/cmd/src/cli/export.rs

feat: export database data

d9e3beb

fengjiachun requested a review from a team as a code owner July 17, 2024 13:27

github-actions bot added the docs-not-required This change does not impact docs. label Jul 17, 2024

coderabbitai bot reviewed Jul 17, 2024

View reviewed changes

src/cmd/src/cli/export.rs Outdated Show resolved Hide resolved

fengjiachun requested review from waynexia and WenyXu July 17, 2024 14:02

coderabbitai bot reviewed Jul 18, 2024

View reviewed changes

fengjiachun force-pushed the feat/export-db branch from e44d386 to d36737f Compare July 18, 2024 04:30

github-actions bot added docs-required This change requires docs update. and removed docs-not-required This change does not impact docs. labels Jul 18, 2024

sunng87 mentioned this pull request Jul 18, 2024

Update docs for feat: export database data GreptimeTeam/docs#1076

Closed

github-actions bot added docs-not-required This change does not impact docs. and removed docs-required This change requires docs update. labels Jul 18, 2024

coderabbitai bot reviewed Jul 18, 2024

View reviewed changes

fengjiachun force-pushed the feat/export-db branch from d36737f to 9d451f0 Compare July 18, 2024 04:37

feat: export data with time range

35edc72

fengjiachun force-pushed the feat/export-db branch from 9d451f0 to 35edc72 Compare July 18, 2024 04:55

WenyXu approved these changes Jul 18, 2024

View reviewed changes

killme2008 reviewed Jul 18, 2024

View reviewed changes

src/cmd/src/cli/export.rs Outdated Show resolved Hide resolved

fengjiachun mentioned this pull request Jul 19, 2024

Redesign backup & restore tool for disaster recovery #4276

Open

coderabbitai bot reviewed Jul 19, 2024

View reviewed changes

feat: refactor the data dir

c38cc50

fengjiachun force-pushed the feat/export-db branch from f58ceb4 to c38cc50 Compare July 19, 2024 07:28

coderabbitai bot reviewed Jul 19, 2024

View reviewed changes

waynexia approved these changes Jul 19, 2024

View reviewed changes

killme2008 reviewed Jul 19, 2024

View reviewed changes

src/cmd/src/cli/export.rs Outdated Show resolved Hide resolved

feat: by comment

da0207e

coderabbitai bot reviewed Jul 19, 2024

View reviewed changes

fengjiachun enabled auto-merge July 19, 2024 09:18

fengjiachun added this pull request to the merge queue Jul 19, 2024

Merged via the queue into GreptimeTeam:main with commit b90267d Jul 19, 2024
52 of 53 checks passed

fengjiachun deleted the feat/export-db branch July 19, 2024 09:48

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: export database data #4382

feat: export database data #4382

fengjiachun commented Jul 17, 2024 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Jul 17, 2024 •

edited

Loading

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

coderabbitai bot left a comment

codecov bot commented Jul 17, 2024 •

edited

Loading

coderabbitai bot left a comment

coderabbitai bot left a comment

fengjiachun commented Jul 18, 2024

killme2008 commented Jul 18, 2024

coderabbitai bot left a comment

coderabbitai bot left a comment

coderabbitai bot left a comment

feat: export database data #4382

feat: export database data #4382

Conversation

fengjiachun commented Jul 17, 2024 • edited by coderabbitai bot Loading

Refer to a related PR or issue link (optional)

What's changed and what's your intention?

Checklist

Summary by CodeRabbit

coderabbitai bot commented Jul 17, 2024 • edited Loading

Walkthrough

Changes

Sequence Diagram(s)

Poem

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

coderabbitai bot left a comment

Choose a reason for hiding this comment

codecov bot commented Jul 17, 2024 • edited Loading

Codecov Report

coderabbitai bot left a comment

Choose a reason for hiding this comment

coderabbitai bot left a comment

Choose a reason for hiding this comment

fengjiachun commented Jul 18, 2024

killme2008 commented Jul 18, 2024

coderabbitai bot left a comment

Choose a reason for hiding this comment

coderabbitai bot left a comment

Choose a reason for hiding this comment

coderabbitai bot left a comment

Choose a reason for hiding this comment

fengjiachun commented Jul 17, 2024 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Jul 17, 2024 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)

codecov bot commented Jul 17, 2024 •

edited

Loading