You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@shardingsphere.apache.org by me...@apache.org on 2022/06/10 15:22:23 UTC
[shardingsphere] branch master updated: add CosId keygen documentation (#18286)
This is an automated email from the ASF dual-hosted git repository.
menghaoran pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/shardingsphere.git
The following commit(s) were added to refs/heads/master by this push:
new c3fea749a24 add CosId keygen documentation (#18286)
c3fea749a24 is described below
commit c3fea749a242abbebcb112870b78f40f72f88044
Author: Ahoo Wang <ah...@qq.com>
AuthorDate: Fri Jun 10 23:22:18 2022 +0800
add CosId keygen documentation (#18286)
---
.../builtin-algorithm/keygen.cn.md | 23 ++++++++++++++++++++++
.../builtin-algorithm/keygen.en.md | 23 ++++++++++++++++++++++
2 files changed, 46 insertions(+)
diff --git a/docs/document/content/user-manual/shardingsphere-jdbc/builtin-algorithm/keygen.cn.md b/docs/document/content/user-manual/shardingsphere-jdbc/builtin-algorithm/keygen.cn.md
index fbde360c932..df2e5c9a80a 100644
--- a/docs/document/content/user-manual/shardingsphere-jdbc/builtin-algorithm/keygen.cn.md
+++ b/docs/document/content/user-manual/shardingsphere-jdbc/builtin-algorithm/keygen.cn.md
@@ -19,3 +19,26 @@ weight = 3
类型：UUID
可配置属性：无
+
+## CosId
+
+类型: COSID
+
+可配置属性：
+
+| *属性名称* | *数据类型* | *说明* | *默认值* |
+|-----------|--------|----------------------------------------------------------------------------------------------|-------------|
+| id-name | String | ID 生成器名称 | `__share__` |
+| as-string | bool | 是否生成字符串类型ID: 将 `long` 类型 ID 转换成 62 进制 `String` 类型（`Long.MAX_VALUE` 最大字符串长度11位），并保证字符串 ID 有序性 | `false` |
+
+## CosId-Snowflake
+
+类型: COSID_SNOWFLAKE
+
+可配置属性：
+
+| *属性名称* | *数据类型* | *说明* | *默认值* |
+|-----------|--------|----------------------------------------------------------------------------------------------|-----------------|
+| epoch | String | 雪花 ID 算法的 EPOCH | `1477929600000` |
+| as-string | bool | 是否生成字符串类型ID: 将 `long` 类型 ID 转换成 62 进制 `String` 类型（`Long.MAX_VALUE` 最大字符串长度11位），并保证字符串 ID 有序性 | `false` |
+
diff --git a/docs/document/content/user-manual/shardingsphere-jdbc/builtin-algorithm/keygen.en.md b/docs/document/content/user-manual/shardingsphere-jdbc/builtin-algorithm/keygen.en.md
index 56c8f71baf0..6c8a2557047 100644
--- a/docs/document/content/user-manual/shardingsphere-jdbc/builtin-algorithm/keygen.en.md
+++ b/docs/document/content/user-manual/shardingsphere-jdbc/builtin-algorithm/keygen.en.md
@@ -19,3 +19,26 @@ Attributes:
Type: UUID
Attributes: None
+
+## CosId
+
+Type: COSID
+
+Attributes：
+
+| *Name* | *DataType* | *Description* | *Default Value* |
+|-----------|------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------|
+| id-name | String | ID generator name | `__share__` |
+| as-string | bool | Whether to generate a string type ID: Convert `long` type ID to Base-62 `String` type (`Long.MAX_VALUE` maximum string length is 11 digits), and ensure the ordering of string IDs | `false` |
+
+## CosId-Snowflake
+
+Type: COSID_SNOWFLAKE
+
+Attributes：
+
+| *Name* | *DataType* | *Description* | *Default Value* |
+|-----------|------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------|
+| epoch | String | EPOCH of Snowflake ID Algorithm | `1477929600000` |
+| as-string | bool | Whether to generate a string type ID: Convert `long` type ID to Base-62 `String` type (`Long.MAX_VALUE` maximum string length is 11 digits), and ensure the ordering of string IDs | `false` |
+