This is an automated email from the ASF dual-hosted git repository. kassiez pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/doris-website.git
The following commit(s) were added to refs/heads/master by this push: new efd1c1c3f00 [fix](sql) Delete invalid function and statement (#2009) efd1c1c3f00 is described below commit efd1c1c3f008c27fc013b25901bc6b985f8ea876 Author: KassieZ <139741991+kass...@users.noreply.github.com> AuthorDate: Mon Feb 10 17:36:03 2025 +0800 [fix](sql) Delete invalid function and statement (#2009) ## Versions - [ ] dev - [x] 3.0 - [x] 2.1 - [ ] 2.0 ## Languages - [ ] Chinese - [ ] English ## Docs Checklist - [ ] Checked by AI - [ ] Test Cases Built --- .../SHOW-STORAGE-POLICY-USING.md | 68 ------------- .../sql-statements/system-info-and-help/HELP.md | 111 --------------------- .../SHOW-STORAGE-POLICY-USING.md | 73 -------------- .../sql-statements/system-info-and-help/HELP.md | 108 -------------------- .../scalar-functions/string-functions/overlay.md | 71 ------------- .../SHOW-STORAGE-POLICY-USING.md | 73 -------------- .../sql-statements/system-info-and-help/HELP.md | 107 -------------------- .../SHOW-STORAGE-POLICY-USING.md | 73 -------------- .../sql-statements/system-info-and-help/HELP.md | 108 -------------------- sidebars.json | 7 +- .../scalar-functions/string-functions/overlay.md | 71 ------------- .../string-functions/split-by-regexp.md | 62 ------------ .../SHOW-STORAGE-POLICY-USING.md | 71 ------------- .../sql-statements/system-info-and-help/HELP.md | 111 --------------------- .../string-functions/split-by-regexp.md | 62 ------------ .../SHOW-STORAGE-POLICY-USING.md | 68 ------------- .../sql-statements/system-info-and-help/HELP.md | 111 --------------------- versioned_sidebars/version-2.1-sidebars.json | 11 +- versioned_sidebars/version-3.0-sidebars.json | 7 +- 19 files changed, 8 insertions(+), 1365 deletions(-) diff --git a/docs/sql-manual/sql-statements/cluster-management/storage-management/SHOW-STORAGE-POLICY-USING.md b/docs/sql-manual/sql-statements/cluster-management/storage-management/SHOW-STORAGE-POLICY-USING.md deleted file mode 100644 index eccebb8ca56..00000000000 --- a/docs/sql-manual/sql-statements/cluster-management/storage-management/SHOW-STORAGE-POLICY-USING.md +++ /dev/null @@ -1,68 +0,0 @@ ---- -{ - "title": "SHOW STORAGE POLICY USING", - "language": "en" -} ---- - -<!-- -Licensed to the Apache Software Foundation (ASF) under one -or more contributor license agreements. See the NOTICE file -distributed with this work for additional information -regarding copyright ownership. The ASF licenses this file -to you under the Apache License, Version 2.0 (the -"License"); you may not use this file except in compliance -with the License. You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - -Unless required by applicable law or agreed to in writing, -software distributed under the License is distributed on an -"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY -KIND, either express or implied. See the License for the -specific language governing permissions and limitations -under the License. ---> - -## Description - -This command is used to show tables and partitions which is using storage policy - -```sql -SHOW STORAGE POLICY USING [FOR some_policy] -``` - -## Example - -1. get all objects which are using storage policy - - ```sql - mysql> show storage policy using; - +-----------------------+-----------------------------------------+----------------------------------------+------------+ - | PolicyName | Database | Table | Partitions | - +-----------------------+-----------------------------------------+----------------------------------------+------------+ - | test_storage_policy | regression_test_cold_heat_separation_p2 | table_with_storage_policy_1 | ALL | - | test_storage_policy | regression_test_cold_heat_separation_p2 | partition_with_multiple_storage_policy | p201701 | - | test_storage_policy_2 | regression_test_cold_heat_separation_p2 | partition_with_multiple_storage_policy | p201702 | - | test_storage_policy_2 | regression_test_cold_heat_separation_p2 | table_with_storage_policy_2 | ALL | - | test_policy | db2 | db2_test_1 | ALL | - +-----------------------+-----------------------------------------+----------------------------------------+------------+ - ``` - -2. get objects which are using the storage policy named test_storage_policy - - ```sql - mysql> show storage policy using for test_storage_policy; - +---------------------+-----------+---------------------------------+------------+ - | PolicyName | Database | Table | Partitions | - +---------------------+-----------+---------------------------------+------------+ - | test_storage_policy | db_1 | partition_with_storage_policy_1 | p201701 | - | test_storage_policy | db_1 | table_with_storage_policy_1 | ALL | - +---------------------+-----------+---------------------------------+------------+ - ``` - -## Keywords - - SHOW, STORAGE, POLICY, USING - -## Best Practice diff --git a/docs/sql-manual/sql-statements/system-info-and-help/HELP.md b/docs/sql-manual/sql-statements/system-info-and-help/HELP.md deleted file mode 100644 index d8eab85243f..00000000000 --- a/docs/sql-manual/sql-statements/system-info-and-help/HELP.md +++ /dev/null @@ -1,111 +0,0 @@ ---- -{ - "title": "HELP", - "language": "en" -} ---- - -<!-- -Licensed to the Apache Software Foundation (ASF) under one -or more contributor license agreements. See the NOTICE file -distributed with this work for additional information -regarding copyright ownership. The ASF licenses this file -to you under the Apache License, Version 2.0 (the -"License"); you may not use this file except in compliance -with the License. You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - -Unless required by applicable law or agreed to in writing, -software distributed under the License is distributed on an -"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY -KIND, either express or implied. See the License for the -specific language governing permissions and limitations -under the License. ---> - - - - -## Description - -The directory of help can be queried by changing the command - -grammar: - -``` sql -HELP <item> -``` - -All Doris commands can be listed with `help` - -```sql -List of all MySQL commands: -Note that all text commands must be first on line and end with ';' -? (\?) Synonym for `help'. -clear (\c) Clear the current input statement. -connect (\r) Reconnect to the server. Optional arguments are db and host. -delimiter (\d) Set statement delimiter. -edit (\e) Edit command with $EDITOR. -ego (\G) Send command to mysql server, display result vertically. -exit (\q) Exit mysql. Same as quit. -go (\g) Send command to mysql server. -help (\h) Display this help. -nopager (\n) Disable pager, print to stdout. -note (\t) Don't write into outfile. -pager (\P) Set PAGER [to_pager]. Print the query results via PAGER. -print (\p) Print current command. -prompt (\R) Change your mysql prompt. -quit (\q) Quit mysql. -rehash (\#) Rebuild completion hash. -source (\.) Execute an SQL script file. Takes a file name as an argument. -status (\s) Get status information from the server. -system (\!) Execute a system shell command. -tee (\T) Set outfile [to_outfile]. Append everything into given outfile. -use (\u) Use another database. Takes database name as argument. -charset (\C) Switch to another charset. Might be needed for processing binlog with multi-byte charsets. -warnings (\W) Show warnings after every statement. -nowarning (\w) Don't show warnings after every statement. -resetconnection(\x) Clean session context. - -For server side help, type 'help contents' -``` - -Get the Doris SQL help contents via `help contents` - -```sql -Many help items for your request exist. -To make a more specific request, please type 'help <item>', -where <item> is one of the following -categories: - sql-functions - sql-statements -``` - -## Example - -1. List all SQL help contents of Doris - - ```sql - help contents - ``` - -2. The command to list all function directories of the Doris cluster - - ```sql - help sql-functions - ``` - -3. List all functions under the date function - - ```sql - help date-time-functions - ``` - - -## Keywords - - HELP - -## Best Practice - diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/sql-manual/sql-statements/cluster-management/storage-management/SHOW-STORAGE-POLICY-USING.md b/i18n/zh-CN/docusaurus-plugin-content-docs/current/sql-manual/sql-statements/cluster-management/storage-management/SHOW-STORAGE-POLICY-USING.md deleted file mode 100644 index 1eb53d07321..00000000000 --- a/i18n/zh-CN/docusaurus-plugin-content-docs/current/sql-manual/sql-statements/cluster-management/storage-management/SHOW-STORAGE-POLICY-USING.md +++ /dev/null @@ -1,73 +0,0 @@ ---- -{ - "title": "SHOW STORAGE POLICY USING", - "language": "zh-CN" -} ---- - -<!-- -Licensed to the Apache Software Foundation (ASF) under one -or more contributor license agreements. See the NOTICE file -distributed with this work for additional information -regarding copyright ownership. The ASF licenses this file -to you under the Apache License, Version 2.0 (the -"License"); you may not use this file except in compliance -with the License. You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - -Unless required by applicable law or agreed to in writing, -software distributed under the License is distributed on an -"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY -KIND, either express or implied. See the License for the -specific language governing permissions and limitations -under the License. ---> - - - -## 描述 - -查看所有/指定存储策略关联的表和分区 - -## 语法 - -```sql -SHOW STORAGE POLICY USING [FOR <some_policy>] -``` -## 可选参数 -| 参数名称 | 描述 | -|-------------------|--------------------------------------------------------------| -| `<policy_name>` | 指定要查询的存储策略名称。如果提供了此参数,则只显示指定存储策略的详细信息;如果不提供此参数,则显示所有存储策略的信息。 | - -## 示例 - -1. 查看所有启用了存储策略的对象 - ```sql - show storage policy using; - ``` - ```sql - +-----------------------+-----------------------------------------+----------------------------------------+------------+ - | PolicyName | Database | Table | Partitions | - +-----------------------+-----------------------------------------+----------------------------------------+------------+ - | test_storage_policy | regression_test_cold_heat_separation_p2 | table_with_storage_policy_1 | ALL | - | test_storage_policy | regression_test_cold_heat_separation_p2 | partition_with_multiple_storage_policy | p201701 | - | test_storage_policy_2 | regression_test_cold_heat_separation_p2 | partition_with_multiple_storage_policy | p201702 | - | test_storage_policy_2 | regression_test_cold_heat_separation_p2 | table_with_storage_policy_2 | ALL | - | test_policy | db2 | db2_test_1 | ALL | - +-----------------------+-----------------------------------------+----------------------------------------+------------+ - ``` -2. 查看使用存储策略 test_storage_policy 的对象 - - ```sql - show storage policy using for test_storage_policy; - ``` - ```sql - +---------------------+-----------+---------------------------------+------------+ - | PolicyName | Database | Table | Partitions | - +---------------------+-----------+---------------------------------+------------+ - | test_storage_policy | db_1 | partition_with_storage_policy_1 | p201701 | - | test_storage_policy | db_1 | table_with_storage_policy_1 | ALL | - +---------------------+-----------+---------------------------------+------------+ - ``` - diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/sql-manual/sql-statements/system-info-and-help/HELP.md b/i18n/zh-CN/docusaurus-plugin-content-docs/current/sql-manual/sql-statements/system-info-and-help/HELP.md deleted file mode 100644 index 284dea62b77..00000000000 --- a/i18n/zh-CN/docusaurus-plugin-content-docs/current/sql-manual/sql-statements/system-info-and-help/HELP.md +++ /dev/null @@ -1,108 +0,0 @@ ---- -{ - "title": "HELP", - "language": "zh-CN" -} ---- - -<!-- -Licensed to the Apache Software Foundation (ASF) under one -or more contributor license agreements. See the NOTICE file -distributed with this work for additional information -regarding copyright ownership. The ASF licenses this file -to you under the Apache License, Version 2.0 (the -"License"); you may not use this file except in compliance -with the License. You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - -Unless required by applicable law or agreed to in writing, -software distributed under the License is distributed on an -"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY -KIND, either express or implied. See the License for the -specific language governing permissions and limitations -under the License. ---> - - -## 描述 - -通过改命令可以查询到帮助的目录 - -语法: - -``` sql -HELP <item> -``` - -可以通过 `help` 列出所有的 Doris 命令 - -```sql -List of all MySQL commands: -Note that all text commands must be first on line and end with ';' -? (\?) Synonym for `help'. -clear (\c) Clear the current input statement. -connect (\r) Reconnect to the server. Optional arguments are db and host. -delimiter (\d) Set statement delimiter. -edit (\e) Edit command with $EDITOR. -ego (\G) Send command to mysql server, display result vertically. -exit (\q) Exit mysql. Same as quit. -go (\g) Send command to mysql server. -help (\h) Display this help. -nopager (\n) Disable pager, print to stdout. -notee (\t) Don't write into outfile. -pager (\P) Set PAGER [to_pager]. Print the query results via PAGER. -print (\p) Print current command. -prompt (\R) Change your mysql prompt. -quit (\q) Quit mysql. -rehash (\#) Rebuild completion hash. -source (\.) Execute an SQL script file. Takes a file name as an argument. -status (\s) Get status information from the server. -system (\!) Execute a system shell command. -tee (\T) Set outfile [to_outfile]. Append everything into given outfile. -use (\u) Use another database. Takes database name as argument. -charset (\C) Switch to another charset. Might be needed for processing binlog with multi-byte charsets. -warnings (\W) Show warnings after every statement. -nowarning (\w) Don't show warnings after every statement. -resetconnection(\x) Clean session context. - -For server side help, type 'help contents' -``` - -通过 `help contents` 获取 Doris SQL 帮助目录 - -```sql -Many help items for your request exist. -To make a more specific request, please type 'help <item>', -where <item> is one of the following -categories: - sql-functions - sql-statements -``` - -## 示例 - -1. 列出 Doris 所有的 SQL 帮助目录 - - ```sql - help contents - ``` - -2. 列出 Doris 集群所有函数目录的命令 - - ```sql - help sql-functions - ``` - -3. 列出日期函数下的所有函数列表 - - ```sql - help date-time-functions - ``` - -## 关键词 - - HELP - -### 最佳实践 - diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.1/sql-manual/sql-functions/scalar-functions/string-functions/overlay.md b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.1/sql-manual/sql-functions/scalar-functions/string-functions/overlay.md deleted file mode 100644 index 3ff0734af11..00000000000 --- a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.1/sql-manual/sql-functions/scalar-functions/string-functions/overlay.md +++ /dev/null @@ -1,71 +0,0 @@ ---- -{ - "title": "OVERLAY", - "language": "zh-CN" -} ---- - -<!-- -Licensed to the Apache Software Foundation (ASF) under one -or more contributor license agreements. See the NOTICE file -distributed with this work for additional information -regarding copyright ownership. The ASF licenses this file -to you under the Apache License, Version 2.0 (the -"License"); you may not use this file except in compliance -with the License. You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - -Unless required by applicable law or agreed to in writing, -software distributed under the License is distributed on an -"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY -KIND, either express or implied. See the License for the -specific language governing permissions and limitations -under the License. ---> - -## overlay -## 描述 -## 语法 - -`VARCHAR Overlay (VARCHAR str, INT pos, INT len, VARCHAR newstr)` - - -返回字符串 str,并用字符串 newstr 替换从位置 pos 开始、长度为 len 字符的子字符串。如果 pos 不在字符串长度范围内,则返回原始字符串。如果 len 不在字符串其余部分的长度范围内,则从位置 pos 开始替换字符串其余部分。如果任何参数为 NULL,则返回 NULL。 - -## 举例 - -``` -mysql> select overlay('Quadratic', 3, 4, 'What'); -+------------------------------------+ -| overlay('Quadratic', 3, 4, 'What') | -+------------------------------------+ -| QuWhattic | -+------------------------------------+ -mysql> select overlay('Quadratic', -1, 4, 'What'); -+-------------------------------------+ -| overlay('Quadratic', -1, 4, 'What') | -+-------------------------------------+ -| Quadratic | -+-------------------------------------+ -mysql> select overlay('Quadratic', 3, 100, 'What'); -+--------------------------------------+ -| overlay('Quadratic', 3, 100, 'What') | -+--------------------------------------+ -| QuWhat | -+--------------------------------------+ -mysql> select overlay('Quadratic', 3, -1, 'What'); -+-------------------------------------+ -| overlay('Quadratic', 3, -1, 'What') | -+-------------------------------------+ -| QuWhat | -+-------------------------------------+ -mysql> select overlay('Quadratic', 0, 100, 'What'); -+--------------------------------------+ -| overlay('Quadratic', 0, 100, 'What') | -+--------------------------------------+ -| Quadratic | -+--------------------------------------+ -``` -### keywords - OVERLAY \ No newline at end of file diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.1/sql-manual/sql-statements/cluster-management/storage-management/SHOW-STORAGE-POLICY-USING.md b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.1/sql-manual/sql-statements/cluster-management/storage-management/SHOW-STORAGE-POLICY-USING.md deleted file mode 100644 index e56a607766d..00000000000 --- a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.1/sql-manual/sql-statements/cluster-management/storage-management/SHOW-STORAGE-POLICY-USING.md +++ /dev/null @@ -1,73 +0,0 @@ ---- -{ - "title": "SHOW STORAGE POLICY USING", - "language": "zh-CN" -} ---- - -<!-- -Licensed to the Apache Software Foundation (ASF) under one -or more contributor license agreements. See the NOTICE file -distributed with this work for additional information -regarding copyright ownership. The ASF licenses this file -to you under the Apache License, Version 2.0 (the -"License"); you may not use this file except in compliance -with the License. You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - -Unless required by applicable law or agreed to in writing, -software distributed under the License is distributed on an -"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY -KIND, either express or implied. See the License for the -specific language governing permissions and limitations -under the License. ---> - - - - - -## 描述 - -查看所有/指定存储策略关联的表和分区 - -语法: - -```sql -SHOW STORAGE POLICY USING [FOR some_policy] -``` - -## 示例 - -1. 查看所有启用了存储策略的对象 - ```sql - mysql> show storage policy using; - +-----------------------+-----------------------------------------+----------------------------------------+------------+ - | PolicyName | Database | Table | Partitions | - +-----------------------+-----------------------------------------+----------------------------------------+------------+ - | test_storage_policy | regression_test_cold_heat_separation_p2 | table_with_storage_policy_1 | ALL | - | test_storage_policy | regression_test_cold_heat_separation_p2 | partition_with_multiple_storage_policy | p201701 | - | test_storage_policy_2 | regression_test_cold_heat_separation_p2 | partition_with_multiple_storage_policy | p201702 | - | test_storage_policy_2 | regression_test_cold_heat_separation_p2 | table_with_storage_policy_2 | ALL | - | test_policy | db2 | db2_test_1 | ALL | - +-----------------------+-----------------------------------------+----------------------------------------+------------+ - ``` - -2. 查看使用存储策略 test_storage_policy 的对象 - - ```sql - mysql> show storage policy using for test_storage_policy; - +---------------------+-----------+---------------------------------+------------+ - | PolicyName | Database | Table | Partitions | - +---------------------+-----------+---------------------------------+------------+ - | test_storage_policy | db_1 | partition_with_storage_policy_1 | p201701 | - | test_storage_policy | db_1 | table_with_storage_policy_1 | ALL | - +---------------------+-----------+---------------------------------+------------+ - ``` - -## 关键词 - - SHOW, STORAGE, POLICY, USING - -## 最佳实践 diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.1/sql-manual/sql-statements/system-info-and-help/HELP.md b/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.1/sql-manual/sql-statements/system-info-and-help/HELP.md deleted file mode 100644 index 0d04ff0f9e6..00000000000 --- a/i18n/zh-CN/docusaurus-plugin-content-docs/version-2.1/sql-manual/sql-statements/system-info-and-help/HELP.md +++ /dev/null @@ -1,107 +0,0 @@ ---- -{ - "title": "HELP", - "language": "zh-CN" -} ---- - -<!-- -Licensed to the Apache Software Foundation (ASF) under one -or more contributor license agreements. See the NOTICE file -distributed with this work for additional information -regarding copyright ownership. The ASF licenses this file -to you under the Apache License, Version 2.0 (the -"License"); you may not use this file except in compliance -with the License. You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - -Unless required by applicable law or agreed to in writing, -software distributed under the License is distributed on an -"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY -KIND, either express or implied. See the License for the -specific language governing permissions and limitations -under the License. ---> - -## 描述 - -通过改命令可以查询到帮助的目录 - -语法: - -``` sql -HELP <item> -``` - -可以通过 `help` 列出所有的 Doris 命令 - -```sql -List of all MySQL commands: -Note that all text commands must be first on line and end with ';' -? (\?) Synonym for `help'. -clear (\c) Clear the current input statement. -connect (\r) Reconnect to the server. Optional arguments are db and host. -delimiter (\d) Set statement delimiter. -edit (\e) Edit command with $EDITOR. -ego (\G) Send command to mysql server, display result vertically. -exit (\q) Exit mysql. Same as quit. -go (\g) Send command to mysql server. -help (\h) Display this help. -nopager (\n) Disable pager, print to stdout. -notee (\t) Don't write into outfile. -pager (\P) Set PAGER [to_pager]. Print the query results via PAGER. -print (\p) Print current command. -prompt (\R) Change your mysql prompt. -quit (\q) Quit mysql. -rehash (\#) Rebuild completion hash. -source (\.) Execute an SQL script file. Takes a file name as an argument. -status (\s) Get status information from the server. -system (\!) Execute a system shell command. -tee (\T) Set outfile [to_outfile]. Append everything into given outfile. -use (\u) Use another database. Takes database name as argument. -charset (\C) Switch to another charset. Might be needed for processing binlog with multi-byte charsets. -warnings (\W) Show warnings after every statement. -nowarning (\w) Don't show warnings after every statement. -resetconnection(\x) Clean session context. - -For server side help, type 'help contents' -``` - -通过 `help contents` 获取 Doris SQL 帮助目录 - -```sql -Many help items for your request exist. -To make a more specific request, please type 'help <item>', -where <item> is one of the following -categories: - sql-functions - sql-statements -``` - -## 示例 - -1. 列出 Doris 所有的 SQL 帮助目录 - - ```sql - help contents - ``` - -2. 列出 Doris 集群所有函数目录的命令 - - ```sql - help sql-functions - ``` - -3. 列出日期函数下的所有函数列表 - - ```sql - help date-time-functions - ``` - -## 关键词 - - HELP - -## 最佳实践 - diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/version-3.0/sql-manual/sql-statements/cluster-management/storage-management/SHOW-STORAGE-POLICY-USING.md b/i18n/zh-CN/docusaurus-plugin-content-docs/version-3.0/sql-manual/sql-statements/cluster-management/storage-management/SHOW-STORAGE-POLICY-USING.md deleted file mode 100644 index 1eb53d07321..00000000000 --- a/i18n/zh-CN/docusaurus-plugin-content-docs/version-3.0/sql-manual/sql-statements/cluster-management/storage-management/SHOW-STORAGE-POLICY-USING.md +++ /dev/null @@ -1,73 +0,0 @@ ---- -{ - "title": "SHOW STORAGE POLICY USING", - "language": "zh-CN" -} ---- - -<!-- -Licensed to the Apache Software Foundation (ASF) under one -or more contributor license agreements. See the NOTICE file -distributed with this work for additional information -regarding copyright ownership. The ASF licenses this file -to you under the Apache License, Version 2.0 (the -"License"); you may not use this file except in compliance -with the License. You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - -Unless required by applicable law or agreed to in writing, -software distributed under the License is distributed on an -"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY -KIND, either express or implied. See the License for the -specific language governing permissions and limitations -under the License. ---> - - - -## 描述 - -查看所有/指定存储策略关联的表和分区 - -## 语法 - -```sql -SHOW STORAGE POLICY USING [FOR <some_policy>] -``` -## 可选参数 -| 参数名称 | 描述 | -|-------------------|--------------------------------------------------------------| -| `<policy_name>` | 指定要查询的存储策略名称。如果提供了此参数,则只显示指定存储策略的详细信息;如果不提供此参数,则显示所有存储策略的信息。 | - -## 示例 - -1. 查看所有启用了存储策略的对象 - ```sql - show storage policy using; - ``` - ```sql - +-----------------------+-----------------------------------------+----------------------------------------+------------+ - | PolicyName | Database | Table | Partitions | - +-----------------------+-----------------------------------------+----------------------------------------+------------+ - | test_storage_policy | regression_test_cold_heat_separation_p2 | table_with_storage_policy_1 | ALL | - | test_storage_policy | regression_test_cold_heat_separation_p2 | partition_with_multiple_storage_policy | p201701 | - | test_storage_policy_2 | regression_test_cold_heat_separation_p2 | partition_with_multiple_storage_policy | p201702 | - | test_storage_policy_2 | regression_test_cold_heat_separation_p2 | table_with_storage_policy_2 | ALL | - | test_policy | db2 | db2_test_1 | ALL | - +-----------------------+-----------------------------------------+----------------------------------------+------------+ - ``` -2. 查看使用存储策略 test_storage_policy 的对象 - - ```sql - show storage policy using for test_storage_policy; - ``` - ```sql - +---------------------+-----------+---------------------------------+------------+ - | PolicyName | Database | Table | Partitions | - +---------------------+-----------+---------------------------------+------------+ - | test_storage_policy | db_1 | partition_with_storage_policy_1 | p201701 | - | test_storage_policy | db_1 | table_with_storage_policy_1 | ALL | - +---------------------+-----------+---------------------------------+------------+ - ``` - diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/version-3.0/sql-manual/sql-statements/system-info-and-help/HELP.md b/i18n/zh-CN/docusaurus-plugin-content-docs/version-3.0/sql-manual/sql-statements/system-info-and-help/HELP.md deleted file mode 100644 index 284dea62b77..00000000000 --- a/i18n/zh-CN/docusaurus-plugin-content-docs/version-3.0/sql-manual/sql-statements/system-info-and-help/HELP.md +++ /dev/null @@ -1,108 +0,0 @@ ---- -{ - "title": "HELP", - "language": "zh-CN" -} ---- - -<!-- -Licensed to the Apache Software Foundation (ASF) under one -or more contributor license agreements. See the NOTICE file -distributed with this work for additional information -regarding copyright ownership. The ASF licenses this file -to you under the Apache License, Version 2.0 (the -"License"); you may not use this file except in compliance -with the License. You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - -Unless required by applicable law or agreed to in writing, -software distributed under the License is distributed on an -"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY -KIND, either express or implied. See the License for the -specific language governing permissions and limitations -under the License. ---> - - -## 描述 - -通过改命令可以查询到帮助的目录 - -语法: - -``` sql -HELP <item> -``` - -可以通过 `help` 列出所有的 Doris 命令 - -```sql -List of all MySQL commands: -Note that all text commands must be first on line and end with ';' -? (\?) Synonym for `help'. -clear (\c) Clear the current input statement. -connect (\r) Reconnect to the server. Optional arguments are db and host. -delimiter (\d) Set statement delimiter. -edit (\e) Edit command with $EDITOR. -ego (\G) Send command to mysql server, display result vertically. -exit (\q) Exit mysql. Same as quit. -go (\g) Send command to mysql server. -help (\h) Display this help. -nopager (\n) Disable pager, print to stdout. -notee (\t) Don't write into outfile. -pager (\P) Set PAGER [to_pager]. Print the query results via PAGER. -print (\p) Print current command. -prompt (\R) Change your mysql prompt. -quit (\q) Quit mysql. -rehash (\#) Rebuild completion hash. -source (\.) Execute an SQL script file. Takes a file name as an argument. -status (\s) Get status information from the server. -system (\!) Execute a system shell command. -tee (\T) Set outfile [to_outfile]. Append everything into given outfile. -use (\u) Use another database. Takes database name as argument. -charset (\C) Switch to another charset. Might be needed for processing binlog with multi-byte charsets. -warnings (\W) Show warnings after every statement. -nowarning (\w) Don't show warnings after every statement. -resetconnection(\x) Clean session context. - -For server side help, type 'help contents' -``` - -通过 `help contents` 获取 Doris SQL 帮助目录 - -```sql -Many help items for your request exist. -To make a more specific request, please type 'help <item>', -where <item> is one of the following -categories: - sql-functions - sql-statements -``` - -## 示例 - -1. 列出 Doris 所有的 SQL 帮助目录 - - ```sql - help contents - ``` - -2. 列出 Doris 集群所有函数目录的命令 - - ```sql - help sql-functions - ``` - -3. 列出日期函数下的所有函数列表 - - ```sql - help date-time-functions - ``` - -## 关键词 - - HELP - -### 最佳实践 - diff --git a/sidebars.json b/sidebars.json index 322ccde1b72..de9ed801957 100644 --- a/sidebars.json +++ b/sidebars.json @@ -1604,7 +1604,6 @@ "sql-manual/sql-statements/data-modification/load-and-export/SHOW-STREAM-LOAD", "sql-manual/sql-statements/data-modification/load-and-export/SHOW-CREATE-LOAD", "sql-manual/sql-statements/data-modification/load-and-export/CANCEL-LOAD", - "sql-manual/sql-statements/data-modification/load-and-export/SHOW-LOAD-WARNINGS", "sql-manual/sql-statements/data-modification/load-and-export/CREATE-ROUTINE-LOAD", "sql-manual/sql-statements/data-modification/load-and-export/ALTER-ROUTINE-LOAD", @@ -1945,7 +1944,6 @@ "sql-manual/sql-statements/cluster-management/storage-management/ALTER-STORAGE-POLICY", "sql-manual/sql-statements/cluster-management/storage-management/DROP-STORAGE-POLICY", "sql-manual/sql-statements/cluster-management/storage-management/SHOW-STORAGE-POLICY", - "sql-manual/sql-statements/cluster-management/storage-management/SHOW-STORAGE-POLICY-USING", "sql-manual/sql-statements/cluster-management/storage-management/WARM-UP", "sql-manual/sql-statements/cluster-management/storage-management/CANCEL-WARM-UP", "sql-manual/sql-statements/cluster-management/storage-management/SHOW-WARM-UP-JOB", @@ -2019,8 +2017,7 @@ "type": "category", "label": "Info System and Help", "items": [ - "sql-manual/sql-statements/system-info-and-help/SHOW-PROC", - "sql-manual/sql-statements/system-info-and-help/HELP" + "sql-manual/sql-statements/system-info-and-help/SHOW-PROC" ] } ] @@ -2110,4 +2107,4 @@ ] } ] -} +} \ No newline at end of file diff --git a/versioned_docs/version-2.1/sql-manual/sql-functions/scalar-functions/string-functions/overlay.md b/versioned_docs/version-2.1/sql-manual/sql-functions/scalar-functions/string-functions/overlay.md deleted file mode 100644 index 6490b2238b1..00000000000 --- a/versioned_docs/version-2.1/sql-manual/sql-functions/scalar-functions/string-functions/overlay.md +++ /dev/null @@ -1,71 +0,0 @@ ---- -{ - "title": "OVERLAY", - "language": "en" -} ---- - -<!-- -Licensed to the Apache Software Foundation (ASF) under one -or more contributor license agreements. See the NOTICE file -distributed with this work for additional information -regarding copyright ownership. The ASF licenses this file -to you under the Apache License, Version 2.0 (the -"License"); you may not use this file except in compliance -with the License. You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - -Unless required by applicable law or agreed to in writing, -software distributed under the License is distributed on an -"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY -KIND, either express or implied. See the License for the -specific language governing permissions and limitations -under the License. ---> - -## overlay -### Description -#### Syntax - -`VARCHAR Overlay (VARCHAR str, INT pos, INT len, VARCHAR newstr)` - - -Returns the string str and replaces it with the string newstr, a substring of len characters starting at position pos. If pos is not within the length of the string, the original string is returned. If len is not within the length of the rest of the string, the rest of the string is replaced starting at position pos. If any argument is NULL, NULL is returned. - -### example - -``` -mysql> select overlay('Quadratic', 3, 4, 'What'); -+------------------------------------+ -| overlay('Quadratic', 3, 4, 'What') | -+------------------------------------+ -| QuWhattic | -+------------------------------------+ -mysql> select overlay('Quadratic', -1, 4, 'What'); -+-------------------------------------+ -| overlay('Quadratic', -1, 4, 'What') | -+-------------------------------------+ -| Quadratic | -+-------------------------------------+ -mysql> select overlay('Quadratic', 3, 100, 'What'); -+--------------------------------------+ -| overlay('Quadratic', 3, 100, 'What') | -+--------------------------------------+ -| QuWhat | -+--------------------------------------+ -mysql> select overlay('Quadratic', 3, -1, 'What'); -+-------------------------------------+ -| overlay('Quadratic', 3, -1, 'What') | -+-------------------------------------+ -| QuWhat | -+-------------------------------------+ -mysql> select overlay('Quadratic', 0, 100, 'What'); -+--------------------------------------+ -| overlay('Quadratic', 0, 100, 'What') | -+--------------------------------------+ -| Quadratic | -+--------------------------------------+ -``` -### keywords - OVERLAY \ No newline at end of file diff --git a/versioned_docs/version-2.1/sql-manual/sql-functions/scalar-functions/string-functions/split-by-regexp.md b/versioned_docs/version-2.1/sql-manual/sql-functions/scalar-functions/string-functions/split-by-regexp.md deleted file mode 100644 index 11a7c7d7fc2..00000000000 --- a/versioned_docs/version-2.1/sql-manual/sql-functions/scalar-functions/string-functions/split-by-regexp.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -{ - "title": "SPLIT_BY_REGEXP", - "language": "en" -} ---- - -<!-- -Licensed to the Apache Software Foundation (ASF) under one -or more contributor license agreements. See the NOTICE file -distributed with this work for additional information -regarding copyright ownership. The ASF licenses this file -to you under the Apache License, Version 2.0 (the -"License"); you may not use this file except in compliance -with the License. You may obtain a copy of the License at - http://www.apache.org/licenses/LICENSE-2.0 -Unless required by applicable law or agreed to in writing, -software distributed under the License is distributed on an -"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY -KIND, either express or implied. See the License for the -specific language governing permissions and limitations -under the License. ---> - -## split_by_regexp - -### description - -#### Syntax - -`ARRAY<STRING> split_by_regexp(STRING str, STRING pattern[, int max_limit])` - -Split the string 'str' based on the input regular expression 'pattern', with the option to retain up to the maximum number 'max_imit'. By default, all strings will be retained, and a split string array will be returned. - -#### Arguments -`Str ` - The string that needs to be split Type: `String` -`Pattern `- Regular expression Type: `String` -`Max_imit ` - Reserved number, optional parameter Type: `Int` - - -### example - -``` -mysql [test_query_qa]>select split_by_regexp('abcde',""); -+------------------------------+ -| split_by_regexp('abcde', '') | -+------------------------------+ -| ["a", "b", "c", "d", "e"] | -+------------------------------+ -1 row in set (0.02 sec) - -mysql [test_query_qa]>select split_by_regexp('a12bc23de345f',"\\d+"); -+-----------------------------------------+ -| split_by_regexp('a12bc23de345f', '\d+') | -+-----------------------------------------+ -| ["a", "bc", "de", "f"] | -+-----------------------------------------+ -1 row in set (0.01 sec) -``` -### keywords - -SPLIT_BY_REGEXP,SPLIT \ No newline at end of file diff --git a/versioned_docs/version-2.1/sql-manual/sql-statements/cluster-management/storage-management/SHOW-STORAGE-POLICY-USING.md b/versioned_docs/version-2.1/sql-manual/sql-statements/cluster-management/storage-management/SHOW-STORAGE-POLICY-USING.md deleted file mode 100644 index 5db1cf19818..00000000000 --- a/versioned_docs/version-2.1/sql-manual/sql-statements/cluster-management/storage-management/SHOW-STORAGE-POLICY-USING.md +++ /dev/null @@ -1,71 +0,0 @@ ---- -{ - "title": "SHOW STORAGE POLICY USING", - "language": "en" -} ---- - -<!-- -Licensed to the Apache Software Foundation (ASF) under one -or more contributor license agreements. See the NOTICE file -distributed with this work for additional information -regarding copyright ownership. The ASF licenses this file -to you under the Apache License, Version 2.0 (the -"License"); you may not use this file except in compliance -with the License. You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - -Unless required by applicable law or agreed to in writing, -software distributed under the License is distributed on an -"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY -KIND, either express or implied. See the License for the -specific language governing permissions and limitations -under the License. ---> - - - - -## Description - -This command is used to show tables and partitions which is using storage policy - -```sql -SHOW STORAGE POLICY USING [FOR some_policy] -``` - -## Examples - -1. get all objects which are using storage policy - - ```sql - mysql> show storage policy using; - +-----------------------+-----------------------------------------+----------------------------------------+------------+ - | PolicyName | Database | Table | Partitions | - +-----------------------+-----------------------------------------+----------------------------------------+------------+ - | test_storage_policy | regression_test_cold_heat_separation_p2 | table_with_storage_policy_1 | ALL | - | test_storage_policy | regression_test_cold_heat_separation_p2 | partition_with_multiple_storage_policy | p201701 | - | test_storage_policy_2 | regression_test_cold_heat_separation_p2 | partition_with_multiple_storage_policy | p201702 | - | test_storage_policy_2 | regression_test_cold_heat_separation_p2 | table_with_storage_policy_2 | ALL | - | test_policy | db2 | db2_test_1 | ALL | - +-----------------------+-----------------------------------------+----------------------------------------+------------+ - ``` - -2. get objects which are using the storage policy named test_storage_policy - - ```sql - mysql> show storage policy using for test_storage_policy; - +---------------------+-----------+---------------------------------+------------+ - | PolicyName | Database | Table | Partitions | - +---------------------+-----------+---------------------------------+------------+ - | test_storage_policy | db_1 | partition_with_storage_policy_1 | p201701 | - | test_storage_policy | db_1 | table_with_storage_policy_1 | ALL | - +---------------------+-----------+---------------------------------+------------+ - ``` - -## Keywords - - SHOW, STORAGE, POLICY, USING - -## Best Practice diff --git a/versioned_docs/version-2.1/sql-manual/sql-statements/system-info-and-help/HELP.md b/versioned_docs/version-2.1/sql-manual/sql-statements/system-info-and-help/HELP.md deleted file mode 100644 index b8c6c1fa615..00000000000 --- a/versioned_docs/version-2.1/sql-manual/sql-statements/system-info-and-help/HELP.md +++ /dev/null @@ -1,111 +0,0 @@ ---- -{ - "title": "HELP", - "language": "en" -} ---- - -<!-- -Licensed to the Apache Software Foundation (ASF) under one -or more contributor license agreements. See the NOTICE file -distributed with this work for additional information -regarding copyright ownership. The ASF licenses this file -to you under the Apache License, Version 2.0 (the -"License"); you may not use this file except in compliance -with the License. You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - -Unless required by applicable law or agreed to in writing, -software distributed under the License is distributed on an -"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY -KIND, either express or implied. See the License for the -specific language governing permissions and limitations -under the License. ---> - - - - -## Description - -The directory of help can be queried by changing the command - -grammar: - -``` sql -HELP <item> -``` - -All Doris commands can be listed with `help` - -```sql -List of all MySQL commands: -Note that all text commands must be first on line and end with ';' -? (\?) Synonym for `help'. -clear (\c) Clear the current input statement. -connect (\r) Reconnect to the server. Optional arguments are db and host. -delimiter (\d) Set statement delimiter. -edit (\e) Edit command with $EDITOR. -ego (\G) Send command to mysql server, display result vertically. -exit (\q) Exit mysql. Same as quit. -go (\g) Send command to mysql server. -help (\h) Display this help. -nopager (\n) Disable pager, print to stdout. -note (\t) Don't write into outfile. -pager (\P) Set PAGER [to_pager]. Print the query results via PAGER. -print (\p) Print current command. -prompt (\R) Change your mysql prompt. -quit (\q) Quit mysql. -rehash (\#) Rebuild completion hash. -source (\.) Execute an SQL script file. Takes a file name as an argument. -status (\s) Get status information from the server. -system (\!) Execute a system shell command. -tee (\T) Set outfile [to_outfile]. Append everything into given outfile. -use (\u) Use another database. Takes database name as argument. -charset (\C) Switch to another charset. Might be needed for processing binlog with multi-byte charsets. -warnings (\W) Show warnings after every statement. -nowarning (\w) Don't show warnings after every statement. -resetconnection(\x) Clean session context. - -For server side help, type 'help contents' -``` - -Get the Doris SQL help contents via `help contents` - -```sql -Many help items for your request exist. -To make a more specific request, please type 'help <item>', -where <item> is one of the following -categories: - sql-functions - sql-statements -``` - -## Examples - -1. List all SQL help contents of Doris - - ```sql - help contents - ``` - -2. The command to list all function directories of the Doris cluster - - ```sql - help sql-functions - ``` - -3. List all functions under the date function - - ```sql - help date-time-functions - ``` - - -## Keywords - - HELP - -## Best Practice - diff --git a/versioned_docs/version-3.0/sql-manual/sql-functions/scalar-functions/string-functions/split-by-regexp.md b/versioned_docs/version-3.0/sql-manual/sql-functions/scalar-functions/string-functions/split-by-regexp.md deleted file mode 100644 index 11a7c7d7fc2..00000000000 --- a/versioned_docs/version-3.0/sql-manual/sql-functions/scalar-functions/string-functions/split-by-regexp.md +++ /dev/null @@ -1,62 +0,0 @@ ---- -{ - "title": "SPLIT_BY_REGEXP", - "language": "en" -} ---- - -<!-- -Licensed to the Apache Software Foundation (ASF) under one -or more contributor license agreements. See the NOTICE file -distributed with this work for additional information -regarding copyright ownership. The ASF licenses this file -to you under the Apache License, Version 2.0 (the -"License"); you may not use this file except in compliance -with the License. You may obtain a copy of the License at - http://www.apache.org/licenses/LICENSE-2.0 -Unless required by applicable law or agreed to in writing, -software distributed under the License is distributed on an -"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY -KIND, either express or implied. See the License for the -specific language governing permissions and limitations -under the License. ---> - -## split_by_regexp - -### description - -#### Syntax - -`ARRAY<STRING> split_by_regexp(STRING str, STRING pattern[, int max_limit])` - -Split the string 'str' based on the input regular expression 'pattern', with the option to retain up to the maximum number 'max_imit'. By default, all strings will be retained, and a split string array will be returned. - -#### Arguments -`Str ` - The string that needs to be split Type: `String` -`Pattern `- Regular expression Type: `String` -`Max_imit ` - Reserved number, optional parameter Type: `Int` - - -### example - -``` -mysql [test_query_qa]>select split_by_regexp('abcde',""); -+------------------------------+ -| split_by_regexp('abcde', '') | -+------------------------------+ -| ["a", "b", "c", "d", "e"] | -+------------------------------+ -1 row in set (0.02 sec) - -mysql [test_query_qa]>select split_by_regexp('a12bc23de345f',"\\d+"); -+-----------------------------------------+ -| split_by_regexp('a12bc23de345f', '\d+') | -+-----------------------------------------+ -| ["a", "bc", "de", "f"] | -+-----------------------------------------+ -1 row in set (0.01 sec) -``` -### keywords - -SPLIT_BY_REGEXP,SPLIT \ No newline at end of file diff --git a/versioned_docs/version-3.0/sql-manual/sql-statements/cluster-management/storage-management/SHOW-STORAGE-POLICY-USING.md b/versioned_docs/version-3.0/sql-manual/sql-statements/cluster-management/storage-management/SHOW-STORAGE-POLICY-USING.md deleted file mode 100644 index eccebb8ca56..00000000000 --- a/versioned_docs/version-3.0/sql-manual/sql-statements/cluster-management/storage-management/SHOW-STORAGE-POLICY-USING.md +++ /dev/null @@ -1,68 +0,0 @@ ---- -{ - "title": "SHOW STORAGE POLICY USING", - "language": "en" -} ---- - -<!-- -Licensed to the Apache Software Foundation (ASF) under one -or more contributor license agreements. See the NOTICE file -distributed with this work for additional information -regarding copyright ownership. The ASF licenses this file -to you under the Apache License, Version 2.0 (the -"License"); you may not use this file except in compliance -with the License. You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - -Unless required by applicable law or agreed to in writing, -software distributed under the License is distributed on an -"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY -KIND, either express or implied. See the License for the -specific language governing permissions and limitations -under the License. ---> - -## Description - -This command is used to show tables and partitions which is using storage policy - -```sql -SHOW STORAGE POLICY USING [FOR some_policy] -``` - -## Example - -1. get all objects which are using storage policy - - ```sql - mysql> show storage policy using; - +-----------------------+-----------------------------------------+----------------------------------------+------------+ - | PolicyName | Database | Table | Partitions | - +-----------------------+-----------------------------------------+----------------------------------------+------------+ - | test_storage_policy | regression_test_cold_heat_separation_p2 | table_with_storage_policy_1 | ALL | - | test_storage_policy | regression_test_cold_heat_separation_p2 | partition_with_multiple_storage_policy | p201701 | - | test_storage_policy_2 | regression_test_cold_heat_separation_p2 | partition_with_multiple_storage_policy | p201702 | - | test_storage_policy_2 | regression_test_cold_heat_separation_p2 | table_with_storage_policy_2 | ALL | - | test_policy | db2 | db2_test_1 | ALL | - +-----------------------+-----------------------------------------+----------------------------------------+------------+ - ``` - -2. get objects which are using the storage policy named test_storage_policy - - ```sql - mysql> show storage policy using for test_storage_policy; - +---------------------+-----------+---------------------------------+------------+ - | PolicyName | Database | Table | Partitions | - +---------------------+-----------+---------------------------------+------------+ - | test_storage_policy | db_1 | partition_with_storage_policy_1 | p201701 | - | test_storage_policy | db_1 | table_with_storage_policy_1 | ALL | - +---------------------+-----------+---------------------------------+------------+ - ``` - -## Keywords - - SHOW, STORAGE, POLICY, USING - -## Best Practice diff --git a/versioned_docs/version-3.0/sql-manual/sql-statements/system-info-and-help/HELP.md b/versioned_docs/version-3.0/sql-manual/sql-statements/system-info-and-help/HELP.md deleted file mode 100644 index d8eab85243f..00000000000 --- a/versioned_docs/version-3.0/sql-manual/sql-statements/system-info-and-help/HELP.md +++ /dev/null @@ -1,111 +0,0 @@ ---- -{ - "title": "HELP", - "language": "en" -} ---- - -<!-- -Licensed to the Apache Software Foundation (ASF) under one -or more contributor license agreements. See the NOTICE file -distributed with this work for additional information -regarding copyright ownership. The ASF licenses this file -to you under the Apache License, Version 2.0 (the -"License"); you may not use this file except in compliance -with the License. You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - -Unless required by applicable law or agreed to in writing, -software distributed under the License is distributed on an -"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY -KIND, either express or implied. See the License for the -specific language governing permissions and limitations -under the License. ---> - - - - -## Description - -The directory of help can be queried by changing the command - -grammar: - -``` sql -HELP <item> -``` - -All Doris commands can be listed with `help` - -```sql -List of all MySQL commands: -Note that all text commands must be first on line and end with ';' -? (\?) Synonym for `help'. -clear (\c) Clear the current input statement. -connect (\r) Reconnect to the server. Optional arguments are db and host. -delimiter (\d) Set statement delimiter. -edit (\e) Edit command with $EDITOR. -ego (\G) Send command to mysql server, display result vertically. -exit (\q) Exit mysql. Same as quit. -go (\g) Send command to mysql server. -help (\h) Display this help. -nopager (\n) Disable pager, print to stdout. -note (\t) Don't write into outfile. -pager (\P) Set PAGER [to_pager]. Print the query results via PAGER. -print (\p) Print current command. -prompt (\R) Change your mysql prompt. -quit (\q) Quit mysql. -rehash (\#) Rebuild completion hash. -source (\.) Execute an SQL script file. Takes a file name as an argument. -status (\s) Get status information from the server. -system (\!) Execute a system shell command. -tee (\T) Set outfile [to_outfile]. Append everything into given outfile. -use (\u) Use another database. Takes database name as argument. -charset (\C) Switch to another charset. Might be needed for processing binlog with multi-byte charsets. -warnings (\W) Show warnings after every statement. -nowarning (\w) Don't show warnings after every statement. -resetconnection(\x) Clean session context. - -For server side help, type 'help contents' -``` - -Get the Doris SQL help contents via `help contents` - -```sql -Many help items for your request exist. -To make a more specific request, please type 'help <item>', -where <item> is one of the following -categories: - sql-functions - sql-statements -``` - -## Example - -1. List all SQL help contents of Doris - - ```sql - help contents - ``` - -2. The command to list all function directories of the Doris cluster - - ```sql - help sql-functions - ``` - -3. List all functions under the date function - - ```sql - help date-time-functions - ``` - - -## Keywords - - HELP - -## Best Practice - diff --git a/versioned_sidebars/version-2.1-sidebars.json b/versioned_sidebars/version-2.1-sidebars.json index 7eb9b187abf..15cbb7c6b3e 100644 --- a/versioned_sidebars/version-2.1-sidebars.json +++ b/versioned_sidebars/version-2.1-sidebars.json @@ -976,7 +976,6 @@ "sql-manual/sql-functions/scalar-functions/string-functions/int-to-uuid", "sql-manual/sql-functions/scalar-functions/string-functions/locate", "sql-manual/sql-functions/scalar-functions/string-functions/left", - "sql-manual/sql-functions/scalar-functions/string-functions/overlay", "sql-manual/sql-functions/scalar-functions/string-functions/find-in-set", "sql-manual/sql-functions/scalar-functions/string-functions/replace", "sql-manual/sql-functions/scalar-functions/string-functions/replace-empty", @@ -1583,7 +1582,7 @@ "sql-manual/sql-statements/data-modification/load-and-export/SHOW-LOAD", "sql-manual/sql-statements/data-modification/load-and-export/SHOW-STREAM-LOAD", "sql-manual/sql-statements/data-modification/load-and-export/SHOW-CREATE-LOAD", - "sql-manual/sql-statements/data-modification/load-and-export/CANCEL-LOAD", + "sql-manual/sql-statements/data-modification/load-and-export/CANCEL-LOAD", "sql-manual/sql-statements/data-modification/load-and-export/SHOW-LOAD-WARNINGS", "sql-manual/sql-statements/data-modification/load-and-export/CREATE-ROUTINE-LOAD", "sql-manual/sql-statements/data-modification/load-and-export/ALTER-ROUTINE-LOAD", @@ -1911,8 +1910,7 @@ "sql-manual/sql-statements/cluster-management/storage-management/CREATE-STORAGE-POLICY", "sql-manual/sql-statements/cluster-management/storage-management/ALTER-STORAGE-POLICY", "sql-manual/sql-statements/cluster-management/storage-management/DROP-STORAGE-POLICY", - "sql-manual/sql-statements/cluster-management/storage-management/SHOW-STORAGE-POLICY", - "sql-manual/sql-statements/cluster-management/storage-management/SHOW-STORAGE-POLICY-USING" + "sql-manual/sql-statements/cluster-management/storage-management/SHOW-STORAGE-POLICY" ] } ] @@ -1982,8 +1980,7 @@ "type": "category", "label": "Info System and Help", "items": [ - "sql-manual/sql-statements/system-info-and-help/SHOW-PROC", - "sql-manual/sql-statements/system-info-and-help/HELP" + "sql-manual/sql-statements/system-info-and-help/SHOW-PROC" ] } ] @@ -2073,4 +2070,4 @@ ] } ] -} +} \ No newline at end of file diff --git a/versioned_sidebars/version-3.0-sidebars.json b/versioned_sidebars/version-3.0-sidebars.json index b19ff26cffc..f749b5c3542 100644 --- a/versioned_sidebars/version-3.0-sidebars.json +++ b/versioned_sidebars/version-3.0-sidebars.json @@ -1644,7 +1644,6 @@ "sql-manual/sql-statements/data-modification/load-and-export/SHOW-STREAM-LOAD", "sql-manual/sql-statements/data-modification/load-and-export/SHOW-CREATE-LOAD", "sql-manual/sql-statements/data-modification/load-and-export/CANCEL-LOAD", - "sql-manual/sql-statements/data-modification/load-and-export/SHOW-LOAD-WARNINGS", "sql-manual/sql-statements/data-modification/load-and-export/CREATE-ROUTINE-LOAD", "sql-manual/sql-statements/data-modification/load-and-export/ALTER-ROUTINE-LOAD", @@ -1985,7 +1984,6 @@ "sql-manual/sql-statements/cluster-management/storage-management/ALTER-STORAGE-POLICY", "sql-manual/sql-statements/cluster-management/storage-management/DROP-STORAGE-POLICY", "sql-manual/sql-statements/cluster-management/storage-management/SHOW-STORAGE-POLICY", - "sql-manual/sql-statements/cluster-management/storage-management/SHOW-STORAGE-POLICY-USING", "sql-manual/sql-statements/cluster-management/storage-management/WARM-UP", "sql-manual/sql-statements/cluster-management/storage-management/CANCEL-WARM-UP", "sql-manual/sql-statements/cluster-management/storage-management/SHOW-WARM-UP-JOB", @@ -2059,8 +2057,7 @@ "type": "category", "label": "Info System and Help", "items": [ - "sql-manual/sql-statements/system-info-and-help/SHOW-PROC", - "sql-manual/sql-statements/system-info-and-help/HELP" + "sql-manual/sql-statements/system-info-and-help/SHOW-PROC" ] } ] @@ -2150,4 +2147,4 @@ ] } ] -} +} \ No newline at end of file --------------------------------------------------------------------- To unsubscribe, e-mail: commits-unsubscr...@doris.apache.org For additional commands, e-mail: commits-h...@doris.apache.org