docs: create table fulltext column options #1053
Conversation
Signed-off-by: Zhenchi <zhongzc_arch@outlook.com>
WalkthroughThe recent updates to the SQL Changes
Poem
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? TipsChatThere are 3 ways to chat with CodeRabbit:
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)
Additionally, you can add CodeRabbit Configration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (1)
- docs/nightly/zh/reference/sql/create.md (3 hunks)
Additional comments not posted (4)
docs/nightly/zh/reference/sql/create.md (4)
57-58: Approved: Updated syntax forCREATE TABLE.The addition of
FULLTEXTandFULLTEXT WITH optionsto theCREATE TABLEsyntax is clear and consistent.
165-165: Approved: Addition ofFULLTEXTcolumn option.The description of the
FULLTEXTcolumn option is clear and correctly placed in the column options table.
205-230: Approved: New section forFULLTEXTcolumn option.The new section provides a clear and detailed explanation of the
FULLTEXTcolumn option, including usage examples and default values. This addition enhances the documentation by providing comprehensive information about the new feature.
Line range hint
1-56:
Approved: Overall document consistency.The rest of the document maintains consistency and provides clear context and examples for various
CREATEstatements.Also applies to: 59-164, 166-204, 231-360
Signed-off-by: Zhenchi <zhongzc_arch@outlook.com>
There was a problem hiding this comment.
Actionable comments posted: 0
Outside diff range, codebase verification and nitpick comments (1)
docs/nightly/en/reference/sql/create.md (1)
200-225: Detailed Documentation forFULLTEXTColumn OptionThe new section provides a comprehensive explanation of the
FULLTEXTcolumn option, including its usage, configurations, and examples. This addition is clear and well-documented.Language Improvement
Correct the punctuation in the list items for better readability.
- The `FULLTEXT` option is used to create a full-text index, accelerating full-text search operations. This option can only be applied to string-type columns. - You can specify the following options using `FULLTEXT WITH`: - `analyzer`: Sets the language analyzer for the full-text index. Supported values are `English` and `Chinese`. - `case_sensitive`: Determines whether the full-text index is case-sensitive. Supported values are `true` and `false`. - If `WITH` is not specified, `FULLTEXT` will use the following default values: - `analyzer`: default is `English` - `case_sensitive`: default is `true` + The `FULLTEXT` option is used to create a full-text index, accelerating full-text search operations. This option can only be applied to string-type columns. + + You can specify the following options using `FULLTEXT WITH`: + - `analyzer`: Sets the language analyzer for the full-text index. Supported values are `English` and `Chinese`. + - `case_sensitive`: Determines whether the full-text index is case-sensitive. Supported values are `true` and `false`. + + If `WITH` is not specified, `FULLTEXT` will use the following default values: + - `analyzer`: default is `English` + - `case_sensitive`: default is `true`Tools
LanguageTool
[uncategorized] ~206-~206: Loose punctuation mark.
Context: ...ons usingFULLTEXT WITH: -analyzer: Sets the language analyzer for the full...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~207-~207: Loose punctuation mark.
Context: ...glishandChinese. -case_sensitive`: Determines whether the full-text index ...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~211-~211: Loose punctuation mark.
Context: ... following default values: -analyzer: default isEnglish-case_sensitive...(UNLIKELY_OPENING_PUNCTUATION)
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (1)
- docs/nightly/en/reference/sql/create.md (3 hunks)
Additional context used
LanguageTool
docs/nightly/en/reference/sql/create.md
[uncategorized] ~206-~206: Loose punctuation mark.
Context: ...ons usingFULLTEXT WITH: -analyzer: Sets the language analyzer for the full...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~207-~207: Loose punctuation mark.
Context: ...glishandChinese. -case_sensitive`: Determines whether the full-text index ...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~211-~211: Loose punctuation mark.
Context: ... following default values: -analyzer: default isEnglish-case_sensitive...(UNLIKELY_OPENING_PUNCTUATION)
Additional comments not posted (4)
docs/nightly/en/reference/sql/create.md (4)
56-57: Syntax Update forCREATE TABLEThe
CREATE TABLEsyntax now includesFULLTEXTandFULLTEXT WITH optionsfor column definitions. This is correctly integrated and documented.
162-162: Column Option AdditionThe
FULLTEXToption is correctly added to the column options table, indicating it creates a full-text index for string-type columns.
214-222: Example forFULLTEXTColumn OptionThe example for creating a table with a full-text index is clear and demonstrates the use of the
FULLTEXT WITHoption effectively.
224-224: Reference to Additional DocumentationThe reference to the Log Query Documentation for more information on full-text indexing and search is appropriate and relevant.
Signed-off-by: Zhenchi <zhongzc_arch@outlook.com> Co-authored-by: Yiran <cuiyiran3@gmail.com>
What's Changed in this PR
Describe the change in this PR
Checklist
summary.ymlmatches the current document structure when you changed the document structure.Summary by CodeRabbit
New Features
CREATE TABLEsyntax withFULLTEXTcolumn options for full-text indexing.FULLTEXT WITHoptions for specifying analyzer language and case sensitivity in full-text indexes.Documentation
CREATE TABLEdocumentation to reflect new full-text indexing capabilities.