feat: Alter column fulltext option #4637

irenjj · 2024-08-28T15:26:27Z

I hereby agree to the terms of the GreptimeDB CLA.

Refer to a related PR or issue link (optional)

closes: #4395

What's changed and what's your intention?

Supports alter column options like:

ALTER TABLE monitor SET COLUMN load_15 fulltext WITH(analyzer = 'Chinese', case_sensitive = 'false');

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-08-28T15:26:33Z

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>, please review it.
-- 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
-- @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.

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.

WenyXu · 2024-09-09T03:03:42Z

Hi @irenjj there are some conflicts

zhongzc · 2024-09-09T03:20:53Z

src/sql/src/parsers/alter_parser.rs

-                column_name,
-                target_type,
+            if self.parser.parse_keyword(Keyword::SET) {
+                let _ = self.parser.parse_keyword(Keyword::FULLTEXT);


Maybe we can check the parse result to avoid receiving unexpected input

zhongzc · 2024-09-09T03:23:32Z

src/sql/src/parsers/alter_parser.rs

+                let options = self
+                    .parser
+                    .parse_options(Keyword::WITH)?
+                    .into_iter()
+                    .map(|option: SqlOption| -> Result<(String, String)> {
+                        let (key, value) = (option.name, option.value);
+                        let v = match value {
+                            Expr::Value(sqlparser::ast::Value::SingleQuotedString(v))
+                            | Expr::Value(sqlparser::ast::Value::DoubleQuotedString(v)) => v,
+                            Expr::Identifier(v) => v.value,
+                            Expr::Value(sqlparser::ast::Value::Number(v, _)) => v.to_string(),
+                            _ => return error::InvalidTableOptionValueSnafu { key, value }.fail(),
+                        };
+                        let k = key.value.to_lowercase();
+                        Ok((k, v))
+                    })
+                    .collect::<Result<HashMap<String, String>>>()
+                    .unwrap();


Can be simplied as

Suggested change

let options = self

.parser

.parse_options(Keyword::WITH)?

.into_iter()

.map(|option: SqlOption| -> Result<(String, String)> {

let (key, value) = (option.name, option.value);

let v = match value {

Expr::Value(sqlparser::ast::Value::SingleQuotedString(v))

| Expr::Value(sqlparser::ast::Value::DoubleQuotedString(v)) => v,

Expr::Identifier(v) => v.value,

Expr::Value(sqlparser::ast::Value::Number(v, _)) => v.to_string(),

_ => return error::InvalidTableOptionValueSnafu { key, value }.fail(),

};

let k = key.value.to_lowercase();

Ok((k, v))

})

.collect::<Result<HashMap<String, String>>>()

.unwrap();

let options = self

.parser

.parse_options(Keyword::WITH)?

.into_iter()

.map(parse_option_string)

.collect::<Result<HashMap<String, String>>>()?;

zhongzc · 2024-09-09T03:26:30Z

src/table/src/metadata.rs

+        let index = table_schema
+            .column_index_by_name(column_name)
+            .with_context(|| error::ColumnNotExistsSnafu {
+                column_name,
+                table_name,
+            })?;
+        let column = &table_schema.column_schemas()[index];


Suggested change

let index = table_schema

.column_index_by_name(column_name)

.with_context(|| error::ColumnNotExistsSnafu {

column_name,

table_name,

})?;

let column = &table_schema.column_schemas()[index];

let column = &table_schema.column_schema_by_name(column_name).with_context(...);

zhongzc · 2024-09-09T03:32:00Z

tests/cases/standalone/common/alter/change_fulltext_options.sql

I propose that we only allow modify column to create a fulltext index on columns that do not already have one, rather than modifying fulltext options for existing columns.

zhongzc · 2024-09-09T03:36:24Z

src/datatypes/src/schema/column_schema.rs

@@ -262,6 +262,14 @@ impl ColumnSchema {
        );
        Ok(self)
    }
+
+    pub fn set_fulltext_options(&mut self, options: FulltextOptions) -> Result<()> {
+        self.metadata.insert(


Maybe you can add a check whether the column type is string: self.data_type == ConcreteDataType::string_datatype(), and also change the with_fulltext_options above

WenyXu

Nice work!

Some nitpicking:

Add more unit tests
Reduce duplicate code by introducing functions
Avoid unnecessary cloning

WenyXu · 2024-09-09T03:15:12Z

Cargo.toml

@@ -151,7 +151,7 @@ reqwest = { version = "0.12", default-features = false, features = [
    "stream",
    "multipart",
 ] }
-# SCRAM-SHA-512 requires https://github.com/dequbed/rsasl/pull/48, https://github.com/influxdata/rskafka/pull/247 
+# SCRAM-SHA-512 requires https://github.com/dequbed/rsasl/pull/48, https://github.com/influxdata/rskafka/pull/247


nit: No need to change this. The comments have been removed in the latest main.

WenyXu · 2024-09-09T03:21:24Z

src/datatypes/src/schema/column_schema.rs

+    pub fn set_fulltext_options(&mut self, options: FulltextOptions) -> Result<()> {
+        self.metadata.insert(
+            FULLTEXT_KEY.to_string(),
+            serde_json::to_string(&options).context(error::SerializeSnafu)?,
+        );
+        Ok(())
+    }


Prefer to reduce the duplicated code

Option 1: refactor the with_fulltext_options method

pub fn with_fulltext_options(mut self, options: FulltextOptions) -> Result<Self> { self. set_fulltext_options(options)?; Ok(self) }

Option 2: use the with_fulltext_options method

column_meta.column_schema = column_meta.column_schema.with_fulltext_options(fulltext)?;

src/sql/src/statements/alter.rs

WenyXu · 2024-09-09T03:23:48Z

src/store-api/src/metadata.rs

+                    _ => {}
+                }
+            }
+            column_meta.column_schema.set_fulltext_options(fulltext).expect("set fulltext");


Handle the error

WenyXu · 2024-09-09T03:24:46Z

src/store-api/src/metadata.rs

+                        fulltext.enable = true;
+                        fulltext.case_sensitive = false;
+                    }
+                    _ => {}


It's better to throw an error here. What will happen if the user sets the invalid full-text options while creating a table? @zhongzc

will return error

return FulltextInvalidOptionSnafu { msg: format!("{analyzer}, expected: 'English' | 'Chinese'"), } .fail();

WenyXu · 2024-09-09T03:30:33Z

src/table/src/metadata.rs

+        if let Some(analyzer) = options.get(COLUMN_FULLTEXT_OPT_KEY_ANALYZER) {
+            match analyzer.to_ascii_lowercase().as_str() {
+                "english" => {
+                    fulltext.enable = true;
+                    fulltext.analyzer = FulltextAnalyzer::English;
+                }
+                "chinese" => {
+                    fulltext.enable = true;
+                    fulltext.analyzer = FulltextAnalyzer::Chinese;
+                }
+                _ => {
+                    return error::InvalidFulltextOptionsSnafu { column_name }.fail()?;
+                }
+            }
+        }
+        if let Some(case_sensitive) = options.get(COLUMN_FULLTEXT_OPT_KEY_CASE_SENSITIVE) {
+            match case_sensitive.to_ascii_lowercase().as_str() {
+                "true" => {
+                    fulltext.enable = true;
+                    fulltext.case_sensitive = true;
+                }
+                "false" => {
+                    fulltext.enable = true;
+                    fulltext.case_sensitive = false;
+                }
+                _ => {
+                    return error::InvalidFulltextOptionsSnafu { column_name }.fail()?;
+                }
+            }
+        }


ditto, repeated code.

src/table/src/metadata.rs

tests/cases/standalone/common/alter/change_fulltext_options.sql

WenyXu · 2024-09-09T03:43:51Z

src/sql/src/parsers/alter_parser.rs

+            if self.parser.parse_keyword(Keyword::SET) {
+                let _ = self.parser.parse_keyword(Keyword::FULLTEXT);
+
+                let options = self
+                    .parser
+                    .parse_options(Keyword::WITH)?
+                    .into_iter()
+                    .map(|option: SqlOption| -> Result<(String, String)> {
+                        let (key, value) = (option.name, option.value);
+                        let v = match value {
+                            Expr::Value(sqlparser::ast::Value::SingleQuotedString(v))
+                            | Expr::Value(sqlparser::ast::Value::DoubleQuotedString(v)) => v,
+                            Expr::Identifier(v) => v.value,
+                            Expr::Value(sqlparser::ast::Value::Number(v, _)) => v.to_string(),
+                            _ => return error::InvalidTableOptionValueSnafu { key, value }.fail(),
+                        };
+                        let k = key.value.to_lowercase();
+                        Ok((k, v))
+                    })
+                    .collect::<Result<HashMap<String, String>>>()
+                    .unwrap();
+
+                AlterTableOperation::AlterColumnFulltext {
+                    column_name,
+                    options: options.into(),
+                }
+            } else {
+                let target_type = self.parser.parse_data_type()?;
+
+                AlterTableOperation::ChangeColumnType {
+                    column_name,
+                    target_type,
+                }


Add unit tests

WenyXu · 2024-09-09T03:44:28Z

src/table/src/metadata.rs

@@ -588,6 +597,95 @@ impl TableMeta {
        Ok(meta_builder)
    }

+    fn change_column_fulltext(


Do we have a way to add tests to verify it?

src/common/meta/src/ddl/alter_table/region_request.rs

Co-authored-by: Weny Xu <wenymedia@gmail.com>

WenyXu

Some nitpicking

src/datatypes/src/schema.rs

src/store-api/src/region_request.rs

WenyXu · 2024-09-18T03:32:05Z

Hi @irenjj There are some conflicts 👀

Co-authored-by: Weny Xu <wenymedia@gmail.com>

irenjj · 2024-09-18T16:09:47Z

Hi @irenjj There are some conflicts 👀

yep, it's greptime.proto that conflicts, i'll merge it first when this pr is ready to merge.

v0y4g3r

Good job. Left some comments. I'll start the alter table option work soon, feel free to engage if you're interested in that.

src/datatypes/src/schema/column_schema.rs

src/datatypes/src/schema.rs

src/store-api/src/metadata.rs

src/store-api/src/region_request.rs

src/table/src/metadata.rs

v0y4g3r · 2024-09-18T22:44:57Z

src/table/src/metadata.rs

+                    column = column
+                        .clone()
+                        .with_fulltext_options(fulltext.clone())
+                        .unwrap();


maybe add the doc for the safety of unwrap here or handle the error

Co-authored-by: Lei, HUANG <6406592+v0y4g3r@users.noreply.github.com>

WenyXu · 2024-09-20T07:48:00Z

I prefer to use the struct instead of a hashmap, then we don't need to validate the hashmap everywhere. cc @evenyag @zhongzc
GreptimeTeam/greptime-proto#185 (comment)

feat: Alter column option

693130c

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

irenjj added 4 commits September 5, 2024 23:41

update

ebc5ced

fix hash_options empty

1cfc57b

refactor & add test

8f94e7f

fix

8b7f57f

irenjj changed the title ~~feat: Alter column option~~ feat: Alter column fulltext option Sep 7, 2024

change alter syntax

093c5c6

irenjj marked this pull request as ready for review September 7, 2024 12:07

irenjj requested review from v0y4g3r, MichaelScofield and a team as code owners September 7, 2024 12:07

shuiyisong requested a review from zhongzc September 9, 2024 03:05

zhongzc reviewed Sep 9, 2024

View reviewed changes

WenyXu reviewed Sep 9, 2024

View reviewed changes

zhongzc reviewed Sep 9, 2024

View reviewed changes

src/common/meta/src/ddl/alter_table/region_request.rs Outdated Show resolved Hide resolved

irenjj and others added 5 commits September 11, 2024 20:45

Update src/store-api/src/metadata.rs

7ac9a20

Co-authored-by: Weny Xu <wenymedia@gmail.com>

Update src/sql/src/statements/alter.rs

1543268

Co-authored-by: Weny Xu <wenymedia@gmail.com>

simplify

3601a40

typo

0356c66

add test

20a7b82

WenyXu reviewed Sep 18, 2024

View reviewed changes

src/datatypes/src/schema.rs Outdated Show resolved Hide resolved

src/store-api/src/region_request.rs Outdated Show resolved Hide resolved

Update src/store-api/src/region_request.rs

8a61fdd

Co-authored-by: Weny Xu <wenymedia@gmail.com>

Update src/datatypes/src/schema.rs

6484664

Co-authored-by: Weny Xu <wenymedia@gmail.com>

fix error

820d75b

v0y4g3r reviewed Sep 18, 2024

View reviewed changes

irenjj and others added 2 commits September 19, 2024 20:16

Update src/store-api/src/region_request.rs

5331ed4

Co-authored-by: Lei, HUANG <6406592+v0y4g3r@users.noreply.github.com>

fix

6ae407c

irenjj requested review from evenyag and waynexia as code owners September 19, 2024 15:57

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

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: Alter column fulltext option #4637

feat: Alter column fulltext option #4637

irenjj commented Aug 28, 2024 •

edited by WenyXu

Loading

coderabbitai bot commented Aug 28, 2024 •

edited

Loading

Review skipped

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

Documentation and Community

WenyXu commented Sep 9, 2024

zhongzc Sep 9, 2024

zhongzc Sep 9, 2024

zhongzc Sep 9, 2024

zhongzc Sep 9, 2024 •

edited

Loading

zhongzc Sep 9, 2024

WenyXu left a comment

WenyXu Sep 9, 2024

WenyXu Sep 9, 2024

WenyXu Sep 9, 2024

WenyXu Sep 9, 2024

zhongzc Sep 9, 2024 •

edited

Loading

WenyXu Sep 9, 2024

WenyXu Sep 9, 2024

WenyXu Sep 9, 2024 •

edited

Loading

WenyXu left a comment

WenyXu commented Sep 18, 2024

irenjj commented Sep 18, 2024 •

edited

Loading

v0y4g3r left a comment

v0y4g3r Sep 18, 2024

WenyXu commented Sep 20, 2024

feat: Alter column fulltext option #4637

Are you sure you want to change the base?

feat: Alter column fulltext option #4637

Conversation

irenjj commented Aug 28, 2024 • edited by WenyXu Loading

Refer to a related PR or issue link (optional)

What's changed and what's your intention?

Checklist

coderabbitai bot commented Aug 28, 2024 • edited Loading

Review skipped

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

Documentation and Community

WenyXu commented Sep 9, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

zhongzc Sep 9, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

WenyXu left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

zhongzc Sep 9, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

WenyXu Sep 9, 2024 • edited Loading

Choose a reason for hiding this comment

WenyXu left a comment

Choose a reason for hiding this comment

WenyXu commented Sep 18, 2024

irenjj commented Sep 18, 2024 • edited Loading

v0y4g3r left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

WenyXu commented Sep 20, 2024

irenjj commented Aug 28, 2024 •

edited by WenyXu

Loading

coderabbitai bot commented Aug 28, 2024 •

edited

Loading

zhongzc Sep 9, 2024 •

edited

Loading

zhongzc Sep 9, 2024 •

edited

Loading

WenyXu Sep 9, 2024 •

edited

Loading

irenjj commented Sep 18, 2024 •

edited

Loading