search

GreptimeTeam / greptimedb

An open-source, cloud-native, unified time series database for metrics, logs and events with SQL/PromQL supported. Available on GreptimeCloud.
https://greptime.com/
Apache License 2.0
4.19k stars 299 forks source link

feat: `FLOWS` table in information_schema&SHOW FLOWS #4386

Closed discord9 closed 1 month ago

discord9 commented 1 month ago

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?

add a FLOWS table showing all active flow jobs, it contains all field in FlowInfoValue and FlowId as columns, for complex type in FlowInfoValue, it just got serde to json string, it looks like this:

public=> select * from INFORMATION_SCHEMA.FLOWS;
   flow_name    | flow_id | catalog_name |                      raw_sql                       | comment | expire_after | source_table_ids |       sink_table_name       | flownode_ids | options 
----------------+---------+--------------+----------------------------------------------------+---------+--------------+------------------+-----------------------------+--------------+---------
 filter_numbers |    1024 | greptime     | SELECT number FROM numbers_input WHERE number > 10 |         |              | [1024]           | greptime.public.out_num_cnt | {"0":0}      | {}
(1 row)

and SHOW FLOWS:

public=> SHOW FLOWS;
     Flows      
----------------
 filter_numbers
(1 row)

sqlness test are also added

Checklist

Summary by CodeRabbit

coderabbitai[bot] commented 1 month ago

Walkthrough

The recent changes enhance error handling and flow management across the catalog and SQL modules. New error variants provide detailed reporting for various scenarios, while the SQL parser and query functionalities now support SHOW FLOWS statements. This integration streamlines flow oversight and improves overall error diagnostics, making the system more robust and user-friendly.

Changes

Files Change Summary
src/catalog/src/error.rs Added new error variants (ListFlows, FlowInfoNotFound, Json) with specific fields and updated StatusCode mappings.
src/catalog/src/system_schema/information_schema/flows.rs Introduced flow metadata management, defining structures and methods for information_schema.flows and implementing record batch processing.
src/query/src/sql.rs Enhanced SQL module with flow management capabilities, including the show_flows function and integration of flow-related data.
src/sql/src/parsers/show_parser.rs Implemented parsing for SHOW FLOWS statements, along with test cases to validate the new parsing logic.

Poem

In the heart of our code, new flows arise,
With errors detailed, no more disguise.
Show the paths that data flows take,
SQL and schema, a perfect handshake.
Here's to progress, in every byte,
Better queries, our system's light. 🌟

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](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.
codecov[bot] commented 1 month ago

Codecov Report

Attention: Patch coverage is 40.83770% with 226 lines in your changes missing coverage. Please review.

Project coverage is 84.78%. Comparing base (8ab6136) to head (fd48160). Report is 3 commits behind head on main.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #4386 +/- ## ========================================== - Coverage 85.15% 84.78% -0.37% ========================================== Files 1074 1075 +1 Lines 192011 192388 +377 ========================================== - Hits 163500 163120 -380 - Misses 28511 29268 +757 ```
killme2008 commented 1 month ago

Don't forget to update the documents @discord9