morrySnow commented on code in PR #1998:
URL: https://github.com/apache/doris-website/pull/1998#discussion_r1952221477
##########
docs/sql-manual/sql-statements/cluster-management/storage-management/ALTER-STORAGE-POLICY.md:
##########
@@ -1,6 +1,6 @@
---
{
-"title": "ALTER STORAGE POLICY",
+"title": "ALTER-STORAGE-POLICY",
Review Comment:
去掉标题中的减号
##########
docs/sql-manual/sql-statements/cluster-management/storage-management/CREATE-STORAGE-VAULT.md:
##########
@@ -26,65 +26,71 @@ specific language governing permissions and limitations
under the License.
-->
-## CREATE-STORAGE-VAULT
+## Description
-### Description
+This command is used to create a storage vault. The topic of this document
describes the syntax for creating a self-managed storage vault in Doris.
-This command is used to create a storage vault. The subject of this document
describes the syntax for creating Doris self-maintained storage vault.
+
+## Syntax
```sql
-CREATE STORAGE VAULT [IF NOT EXISTS] vault
-[properties]
+CREATE STORAGE VAULT [IF NOT EXISTS] <`vault_name`> [ <`properties`> ]
Review Comment:
```suggestion
CREATE STORAGE VAULT [IF NOT EXISTS] <vault_name> [ <properties> ]
```
##########
docs/sql-manual/sql-statements/cluster-management/storage-management/SHOW-STORAGE-POLICY-USING.md:
##########
@@ -0,0 +1,71 @@
+---
+{
+ "title": "SHOW STORAGE POLICY USING",
Review Comment:
此文档和 show storage policy 重复，可以去除
##########
docs/sql-manual/sql-statements/cluster-management/storage-management/ALTER-STORAGE-POLICY.md:
##########
@@ -26,29 +26,42 @@ under the License.
## Description
-This statement is used to modify an existing cold and hot separation migration
strategy. Only root or admin users can modify resources.
+This statement is used to modify an existing hot-cold tiered migration policy.
Only root or admin users can modify resources.
+## Syntax
```sql
-ALTER STORAGE POLICY 'policy_name'
-PROPERTIES ("key"="value", ...);
+ALTER STORAGE POLICY '<policy_name>' PROPERTIE ("<key>"="<value>"[, ... ]);
```
-## Example
+## Required Parameters
+| Parameter Name | Description
|
+|-------------------|--------------------------------------------------------------|
+| `<policy_name>` | The name of the storage policy. This is the unique
identifier of the storage policy you want to modify, and an existing policy
name must be specified. |
-1. Modify the name to coolown_datetime Cold and hot separation data migration
time point:
+## Optional Parameters
+
+| Parameter Name | Description
|
+|-------------------|--------------------------------------------------------------|
+| `retention_days` | Data retention period. Defines the duration for which
the data is kept in storage. Data exceeding this period will be automatically
deleted. |
Review Comment:
语句的参数，不是使用表格的形式，参考其他文档，如：https://doris.apache.org/docs/sql-manual/sql-statements/job/CREATE-JOB
##########
docs/sql-manual/sql-statements/cluster-management/storage-management/CREATE-STORAGE-VAULT.md:
##########
@@ -26,65 +26,71 @@ specific language governing permissions and limitations
under the License.
-->
-## CREATE-STORAGE-VAULT
+## Description
-### Description
+This command is used to create a storage vault. The topic of this document
describes the syntax for creating a self-managed storage vault in Doris.
-This command is used to create a storage vault. The subject of this document
describes the syntax for creating Doris self-maintained storage vault.
+
+## Syntax
```sql
-CREATE STORAGE VAULT [IF NOT EXISTS] vault
-[properties]
+CREATE STORAGE VAULT [IF NOT EXISTS] <`vault_name`> [ <`properties`> ]
```
-
-#### properties
-
-| param | is required | desc
|
-|:-------|:------------|:-------------------------------------------------------|
-| `type` | required | Only two types of vaults are allowed: `S3` and
`HDFS`. |
-
-##### S3 Vault
-
-| param | is required | desc
|
-|:----------------|:------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| `s3.endpoint` | required | The endpoint used for object storage.
<br/>**Notice**, please don't provide the endpoint with any `http://` or
`https://`. And for Azure Blob Storage, the endpoint should be
`blob.core.windows.net`. |
-| `s3.region` | required | The region of your bucket.(Not required
when you'r using GCP or AZURE).
|
-| `s3.root.path` | required | The path where the data would be stored.
|
-| `s3.bucket` | required | The bucket of your object storage account.
(StorageAccount if you're using Azure).
|
-| `s3.access_key` | required | The access key of your object storage
account. (AccountName if you're using Azure).
|
-| `s3.secret_key` | required | The secret key of your object storage
account. (AccountKey if you're using Azure).
|
-| `provider` | required | The cloud vendor which provides the object
storage service. The supported values include `COS`, `OSS`, `S3`, `OBS`, `BOS`,
`AZURE`, `GCP`
|
-| `use_path_style` | optional | Indicate using `path-style URL`(private
environment recommended) or `virtual-hosted-style URL`(public cloud
recommended), default `true` (`path-style`)
|
-
-##### HDFS Vault
-
-| param | is required | desc
|
-|:---------------------------------|:------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| `fs.defaultFS` | required | Hadoop configuration
property that specifies the default file system to use.
|
-| `path_prefix` | optional | The path prefix to where
the data would be stored. It would be the root_path of your Hadoop user if you
don't provide any prefix. |
-| `hadoop.username` | optional | Hadoop configuration
property that specifies the user accessing the file system. It would be the
user starting Hadoop process if you don't provide any user. |
-| `hadoop.security.authentication` | optional | The authentication way used
for hadoop. If you'd like to use kerberos you can provide with `kerboros`.
|
-| `hadoop.kerberos.principal` | optional | The path to your kerberos
principal. |
-| `hadoop.kerberos.keytab` | optional | The path to your kerberos
keytab. |
-
-### Example
-
-1. create a HDFS storage vault.
+## Required Parameters
+
+| Parameter | Description |
+|-------|-----------------------|
+| `vault_name` | The name of the storage vault. This is the unique identifier
for the new storage vault you are creating. |
Review Comment:
```suggestion
| `<vault_name>` | The name of the storage vault. This is the unique
identifier for the new storage vault you are creating. |
```
##########
docs/sql-manual/sql-statements/cluster-management/storage-management/ALTER-STORAGE-POLICY.md:
##########
@@ -26,29 +26,42 @@ under the License.
## Description
-This statement is used to modify an existing cold and hot separation migration
strategy. Only root or admin users can modify resources.
+This statement is used to modify an existing hot-cold tiered migration policy.
Only root or admin users can modify resources.
+## Syntax
```sql
-ALTER STORAGE POLICY 'policy_name'
-PROPERTIES ("key"="value", ...);
+ALTER STORAGE POLICY '<policy_name>' PROPERTIE ("<key>"="<value>"[, ... ]);
```
-## Example
+## Required Parameters
+| Parameter Name | Description
|
+|-------------------|--------------------------------------------------------------|
+| `<policy_name>` | The name of the storage policy. This is the unique
identifier of the storage policy you want to modify, and an existing policy
name must be specified. |
-1. Modify the name to coolown_datetime Cold and hot separation data migration
time point:
+## Optional Parameters
+
+| Parameter Name | Description
|
+|-------------------|--------------------------------------------------------------|
+| `retention_days` | Data retention period. Defines the duration for which
the data is kept in storage. Data exceeding this period will be automatically
deleted. |
+| `redundancy_level`| Redundancy level. Defines the number of data replicas to
ensure high availability and fault tolerance. For example, a value of 2 means
each data block has two replicas. |
+| `storage_type` | Storage type. Specifies the storage medium used, such as
SSD, HDD, or hybrid storage. This affects performance and cost. |
+| `cooloff_time` | Cool-off time. The time interval between when data is
marked for deletion and when it is actually deleted. This helps prevent data
loss due to accidental operations. |
+| `location_policy` | Geographical location policy. Defines the geographical
placement of data, such as cross-region replication for disaster recovery. |
Review Comment:
这些都是 `PROPERTIE ("<key>"="<value>"[, ... ])` 中 key 的候选。所以这里这样组织
1. 在必选参数中，增加
```
`PROPERTIE ("<key>"="<value>"[, ... ])`
```
2. 然后这个表格跟在必选参数的表格后面，
##########
docs/sql-manual/sql-statements/cluster-management/storage-management/CREATE-STORAGE-VAULT.md:
##########
@@ -26,65 +26,71 @@ specific language governing permissions and limitations
under the License.
-->
-## CREATE-STORAGE-VAULT
+## Description
-### Description
+This command is used to create a storage vault. The topic of this document
describes the syntax for creating a self-managed storage vault in Doris.
-This command is used to create a storage vault. The subject of this document
describes the syntax for creating Doris self-maintained storage vault.
+
+## Syntax
```sql
-CREATE STORAGE VAULT [IF NOT EXISTS] vault
-[properties]
+CREATE STORAGE VAULT [IF NOT EXISTS] <`vault_name`> [ <`properties`> ]
```
-
-#### properties
-
-| param | is required | desc
|
-|:-------|:------------|:-------------------------------------------------------|
-| `type` | required | Only two types of vaults are allowed: `S3` and
`HDFS`. |
-
-##### S3 Vault
-
-| param | is required | desc
|
-|:----------------|:------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| `s3.endpoint` | required | The endpoint used for object storage.
<br/>**Notice**, please don't provide the endpoint with any `http://` or
`https://`. And for Azure Blob Storage, the endpoint should be
`blob.core.windows.net`. |
-| `s3.region` | required | The region of your bucket.(Not required
when you'r using GCP or AZURE).
|
-| `s3.root.path` | required | The path where the data would be stored.
|
-| `s3.bucket` | required | The bucket of your object storage account.
(StorageAccount if you're using Azure).
|
-| `s3.access_key` | required | The access key of your object storage
account. (AccountName if you're using Azure).
|
-| `s3.secret_key` | required | The secret key of your object storage
account. (AccountKey if you're using Azure).
|
-| `provider` | required | The cloud vendor which provides the object
storage service. The supported values include `COS`, `OSS`, `S3`, `OBS`, `BOS`,
`AZURE`, `GCP`
|
-| `use_path_style` | optional | Indicate using `path-style URL`(private
environment recommended) or `virtual-hosted-style URL`(public cloud
recommended), default `true` (`path-style`)
|
-
-##### HDFS Vault
-
-| param | is required | desc
|
-|:---------------------------------|:------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| `fs.defaultFS` | required | Hadoop configuration
property that specifies the default file system to use.
|
-| `path_prefix` | optional | The path prefix to where
the data would be stored. It would be the root_path of your Hadoop user if you
don't provide any prefix. |
-| `hadoop.username` | optional | Hadoop configuration
property that specifies the user accessing the file system. It would be the
user starting Hadoop process if you don't provide any user. |
-| `hadoop.security.authentication` | optional | The authentication way used
for hadoop. If you'd like to use kerberos you can provide with `kerboros`.
|
-| `hadoop.kerberos.principal` | optional | The path to your kerberos
principal. |
-| `hadoop.kerberos.keytab` | optional | The path to your kerberos
keytab. |
-
-### Example
-
-1. create a HDFS storage vault.
+## Required Parameters
+
+| Parameter | Description |
+|-------|-----------------------|
+| `vault_name` | The name of the storage vault. This is the unique identifier
for the new storage vault you are creating. |
+
+## Optional Parameters
+| Parameter | Description
|
+|-------------------|--------------------------------------------------------------|
+| `[IF NOT EXISTS]` | If the specified storage vault already exists, the
creation operation will not be executed, and no error will be thrown. This
prevents duplicate creation of the same storage vault. |
+| `PROPERTIES` | A set of key-value pairs used to set or update specific
properties of the storage vault. Each property consists of a key (<key>) and a
value (<value>), separated by an equals sign (=). Multiple key-value pairs are
separated by commas (,). |
Review Comment:
```suggestion
| `<properties>` | A set of key-value pairs used to set or update
specific properties of the storage vault. Each property consists of a key
(`<key>`) and a value (`<value>`), separated by an equals sign (=). Multiple
key-value pairs are separated by commas (,). |
```
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
