feat: hint options for gRPC insert #4454

fengjiachun · 2024-07-29T10:49:45Z

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?

This PR closes #4441

How to use:

For example, if you need to add a hint during the first write to automatically create a table with the option merge_mode = "last_non_null", then we need to add a hint to the gRPC request header:

("x-greptime-hint-merge_mode", "last_non_null")

Note, you must use the prefix x-greptime-hint-; otherwise, it will not be parsed as a valid hint.

Taking the java ingester client as an example, we modify a line of code in this example to:

https://github.com/GreptimeTeam/greptimedb-ingester-java/blob/4fa729a537df3f49278aef58fa919315ad6a7f88/ingester-example/src/main/java/io/greptime/LowLevelApiWriteQuickStart.java#L76

CompletableFuture<Result<WriteOk, Err>> future = greptimeDB.write(cpuMetric, memMetric);

->

Context ctx = Context.hint("merge_mode", "last_non_null");
CompletableFuture<Result<WriteOk, Err>> future = greptimeDB.write(Arrays.asList(cpuMetric, memMetric), WriteOp.Insert, ctx);

Currently, only two hint options are supported, which are append_mode and merge_mode.

Checklist

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

coderabbitai · 2024-07-29T10:49:51Z

Important

Review skipped

Auto reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. 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.

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.

codecov · 2024-07-29T11:17:45Z

Codecov Report

Attention: Patch coverage is 83.83838% with 16 lines in your changes missing coverage. Please review.

Project coverage is 84.60%. Comparing base (9a5fa49) to head (3fe0516).
Report is 23 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #4454      +/-   ##
==========================================
- Coverage   84.88%   84.60%   -0.29%     
==========================================
  Files        1081     1081              
  Lines      192910   193125     +215     
==========================================
- Hits       163761   163400     -361     
- Misses      29149    29725     +576

killme2008 · 2024-07-29T16:42:28Z

Good job! A little Java API suggestion:

Context.of("x-greptime-hint-merge_mode", "last_non_null"));

Adds an API specified for hints:

Context.hint("merge_mode", "last_non_null"));

killme2008

I think we can add a test to ensure the API working well.

https://github.com/GreptimeTeam/greptimedb/blob/main/tests-integration/tests/http.rs

src/servers/src/grpc/database.rs

fengjiachun · 2024-07-30T01:45:59Z

Good job! A little Java API suggestion:
Context.of("x-greptime-hint-merge_mode", "last_non_null"));
Adds an API specified for hints:
Context.hint("merge_mode", "last_non_null"));

Good point!

GreptimeTeam/greptimedb-ingester-java#43

fengjiachun · 2024-07-30T13:08:43Z

PTAL @killme2008 @WenyXu

killme2008

LGTM

killme2008 · 2024-07-31T18:30:17Z

PTAL @WenyXu

WenyXu

LGTM

fengys1996 · 2024-08-01T02:59:25Z

src/servers/src/grpc/database.rs

+            let key = key.as_str();
+            if !key.starts_with(GREPTIME_DB_HEADER_HINT_PREFIX) {
+                return None;
+            }
+            let Ok(value) = value.to_str() else {
+                // Simply return None for non-string values.
+                return None;
+            };
+            // Safety: we already checked the prefix.
+            let new_key = key
+                .strip_prefix(GREPTIME_DB_HEADER_HINT_PREFIX)
+                .unwrap()
+                .to_string();


Non-blocking: reduce the overhead of calling starts_with?

Suggested change

let key = key.as_str();

if !key.starts_with(GREPTIME_DB_HEADER_HINT_PREFIX) {

return None;

}

let Ok(value) = value.to_str() else {

// Simply return None for non-string values.

return None;

};

// Safety: we already checked the prefix.

let new_key = key

.strip_prefix(GREPTIME_DB_HEADER_HINT_PREFIX)

.unwrap()

.to_string();

let key = key.as_str();

let Some(new_key) = key.strip_prefix(GREPTIME_DB_HEADER_HINT_PREFIX) else {

return None;

};

let Ok(value) = value.to_str() else {

// Simply return None for non-string values.

return None;

};

let new_key = new_key.to_string();

Looks good, I'll do it in next PR

fengjiachun requested a review from a team as a code owner July 29, 2024 10:49

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

fengjiachun force-pushed the feat/hint-options-grpc branch from 8b83aba to 22db359 Compare July 29, 2024 11:00

fengjiachun requested a review from killme2008 July 29, 2024 11:10

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

fengjiachun force-pushed the feat/hint-options-grpc branch from 22db359 to 84c5ca6 Compare July 29, 2024 15:08

feat: hint options for gRPC isnert

0b88d71

fengjiachun force-pushed the feat/hint-options-grpc branch from 84c5ca6 to 0b88d71 Compare July 29, 2024 15:32

killme2008 reviewed Jul 29, 2024

View reviewed changes

src/servers/src/grpc/database.rs Outdated Show resolved Hide resolved

chore: unit test for extract_hints

30fea1e

fengjiachun mentioned this pull request Jul 30, 2024

feat: add hint api for Context GreptimeTeam/greptimedb-ingester-java#43

Merged

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

fengjiachun added 2 commits July 30, 2024 12:21

feat: add integration test for grpc hint

1e6dc03

test: add integration test for hints

3fe0516

fengjiachun requested a review from WenyXu July 30, 2024 13:08

killme2008 approved these changes Jul 30, 2024

View reviewed changes

WenyXu approved these changes Aug 1, 2024

View reviewed changes

WenyXu added this pull request to the merge queue Aug 1, 2024

fengys1996 reviewed Aug 1, 2024

View reviewed changes

Merged via the queue into GreptimeTeam:main with commit 291d9d5 Aug 1, 2024
52 checks passed

fengjiachun mentioned this pull request Aug 1, 2024

feat: improve extract hints #4479

Merged

3 tasks

fengjiachun deleted the feat/hint-options-grpc branch August 1, 2024 04:04

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: hint options for gRPC insert #4454

feat: hint options for gRPC insert #4454

fengjiachun commented Jul 29, 2024 •

edited

Loading

coderabbitai bot commented Jul 29, 2024

Review skipped

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

codecov bot commented Jul 29, 2024 •

edited

Loading

killme2008 commented Jul 29, 2024 •

edited by fengjiachun

Loading

killme2008 left a comment

fengjiachun commented Jul 30, 2024 •

edited

Loading

fengjiachun commented Jul 30, 2024

killme2008 left a comment

killme2008 commented Jul 31, 2024

WenyXu left a comment

fengys1996 Aug 1, 2024

fengjiachun Aug 1, 2024

feat: hint options for gRPC insert #4454

feat: hint options for gRPC insert #4454

Conversation

fengjiachun commented Jul 29, 2024 • edited Loading

Refer to a related PR or issue link (optional)

What's changed and what's your intention?

How to use:

Checklist

coderabbitai bot commented Jul 29, 2024

Review skipped

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

codecov bot commented Jul 29, 2024 • edited Loading

Codecov Report

killme2008 commented Jul 29, 2024 • edited by fengjiachun Loading

killme2008 left a comment

Choose a reason for hiding this comment

fengjiachun commented Jul 30, 2024 • edited Loading

fengjiachun commented Jul 30, 2024

killme2008 left a comment

Choose a reason for hiding this comment

killme2008 commented Jul 31, 2024

WenyXu left a comment

Choose a reason for hiding this comment

fengys1996 Aug 1, 2024

Choose a reason for hiding this comment

fengjiachun Aug 1, 2024

Choose a reason for hiding this comment

fengjiachun commented Jul 29, 2024 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)

codecov bot commented Jul 29, 2024 •

edited

Loading

killme2008 commented Jul 29, 2024 •

edited by fengjiachun

Loading

fengjiachun commented Jul 30, 2024 •

edited

Loading