feat: supports gRPC insertion hints, close #42

[killme2008]

Supports gRPC insertion hints while creating tables automatically, adds a new option gprc_hints.

For example, enable append_mdoe:

    Options =
        [{endpoints, [{http, "localhost", 4001}]},
         {pool, greptimedb_client_pool},
         {pool_size, 5},
         %% enable append mode
         {grpc_hints, #{<<"append_mode">> => <<"true">>}},
         {pool_type, random},
         {auth, {basic, #{username => <<"greptime_user">>, password => <<"greptime_pwd">>}}}],

    {ok, Client} = greptimedb:start_client(Options),

Summary by CodeRabbit

• New Features

  • Introduced a new configuration option grpc_hints for enhanced flexibility when connecting to GreptimeDB, allowing users to provide insertion hints for gRPC operations.
  • Enabled "append mode" for the gRPC client in the testing suite.

• Improvements

  • Upgraded the GreptimeDB software version to v0.9.3, which may include bug fixes and performance enhancements.
  • Updated the ecpool library dependency to version 0.5.9 for improved functionality.

• Bug Fixes

  • Enhanced state management and request handling in the GenServer module to utilize new hints for improved request processing.

[coderabbitai]

Walkthrough

This pull request introduces several updates across multiple files. It upgrades the GreptimeDB version in the GitHub Actions workflow, adds a new grpc_hints configuration option for the GreptimeDB client, updates the ecpool dependency version, enhances the state management in the greptimedb_worker module to include hints, and modifies the test suite to support the new configuration. These changes collectively improve the functionality and flexibility of the GreptimeDB service integration.

Changes

Files	Change Summary
.github/workflows/erlang.yml	Updated GREPTIMEDB_VER from v0.9.0 to v0.9.3.
README.md	Added grpc_hints to client options and updated documentation to describe its purpose and usage.
rebar.config	Updated ecpool dependency version from 0.5.7 to 0.5.9.
src/greptimedb_worker.erl	Enhanced state management by adding hints to the state record and updated relevant functions.
test/greptimedb_SUITE.erl	Added grpc_hints option to t_write function for enabling append mode in gRPC client operations.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant greptimedb_worker
    participant GreptimeDB

    Client->>greptimedb_worker: Initiate request with grpc_hints
    greptimedb_worker->>GreptimeDB: Send request with hints
    GreptimeDB-->>greptimedb_worker: Acknowledge request
    greptimedb_worker-->>Client: Return response

Loading

Poem

🐇 In the meadow, changes bloom,
With hints of gRPC, we make room.
Upgraded versions dance and play,
GreptimeDB shines bright today!
With every hop, our code's in tune,
A joyful leap beneath the moon! 🌙

Tip

Announcements

• The review status is no longer posted as a separate comment when there are no actionable or nitpick comments. In such cases, the review status is included in the walkthrough comment.
• We have updated our review workflow to use the Anthropic's Claude family of models. Please share any feedback in the discussion post on our Discord.
• Possibly related PRs: Walkthrough comment now includes a list of potentially related PRs to help you recall past context. Please share any feedback in the discussion post on our Discord.
• Suggested labels: CodeRabbit can now suggest labels by learning from your past PRs in the walkthrough comment. You can also provide custom labeling instructions in the UI or configuration file.
• Possibly related PRs, automatic label suggestions based on past PRs, learnings, and possibly related issues require data opt-in (enabled by default).

---

Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 1b50ef2 and 7b00dae.

Files selected for processing (1)

• README.md (3 hunks)

Additional context used

Markdownlint

README.md

216-216: Expected: 2; Actual: 4
Unordered list indentation

(MD007, ul-indent)

---

217-217: Expected: 2; Actual: 4
Unordered list indentation

(MD007, ul-indent)

---

218-218: Expected: 2; Actual: 4
Unordered list indentation

(MD007, ul-indent)

---

219-219: Expected: 2; Actual: 4
Unordered list indentation

(MD007, ul-indent)

---

220-220: Expected: 2; Actual: 4
Unordered list indentation

(MD007, ul-indent)

Additional comments not posted (2)

README.md (2)

25-25: LGTM!

The code change is approved. Adding the grpc_hints option with an empty map as the default value is a valid way to introduce support for gRPC insertion hints.

---

133-138: Verify the relevance of this change.

The added section describes how to check if the client is alive using the greptimedb:is_alive/1 function. While the change itself is valid, it's unclear how it relates to the PR objective of introducing support for gRPC insertion hints.

Please clarify the purpose of this change in the context of this PR. If it's unrelated, consider moving it to a separate PR.

---

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

• X
• Mastodon
• Reddit
• LinkedIn

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

[coderabbitai]

Actionable comments posted: 1

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 1b50ef2 and 7b00dae.

Files selected for processing (1)

• README.md (3 hunks)

Additional context used

Markdownlint

README.md

216-216: Expected: 2; Actual: 4
Unordered list indentation

(MD007, ul-indent)

---

217-217: Expected: 2; Actual: 4
Unordered list indentation

(MD007, ul-indent)

---

218-218: Expected: 2; Actual: 4
Unordered list indentation

(MD007, ul-indent)

---

219-219: Expected: 2; Actual: 4
Unordered list indentation

(MD007, ul-indent)

---

220-220: Expected: 2; Actual: 4
Unordered list indentation

(MD007, ul-indent)

Additional comments not posted (2)

README.md (2)

25-25: LGTM!

The code change is approved. Adding the grpc_hints option with an empty map as the default value is a valid way to introduce support for gRPC insertion hints.

---

133-138: Verify the relevance of this change.

The added section describes how to check if the client is alive using the greptimedb:is_alive/1 function. While the change itself is valid, it's unclear how it relates to the PR objective of introducing support for gRPC insertion hints.

Please clarify the purpose of this change in the context of this PR. If it's unrelated, consider moving it to a separate PR.