RETENTION

docs/sql-manual/sql-functions/aggregate-functions/retention.md

@@ -13,9 +13,7 @@ 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
@@ -24,118 +22,72 @@ specific language governing permissions and limitations
 under the License.
 -->
 
-## RETENTION 
-
-RETENTION
-
-### Description
-#### Syntax
-
-`retention(event1, event2, ... , eventN);`
+## Description
 
 The `retention` function takes as arguments a set of conditions from 1 to 32 arguments of type `UInt8` that indicate whether a certain condition was met for the event. Any condition can be specified as an argument.
 
 The conditions, except the first, apply in pairs: the result of the second will be true if the first and second are true, of the third if the first and third are true, etc.
 
 To put it simply, the first digit of the return value array indicates whether `event1` is true or false, the second digit represents the truth and falseness of `event1` and `event2`, and the third digit represents whether `event1` is true or false and `event3` is true False and, and so on. If `event1` is false, return an array full of zeros.
 
-#### Arguments
+## Syntax
 
-`event` — An expression that returns a `UInt8` result (1 or 0).
+```sql
+RETENTION(<event1> [, <event2>, ... , <eventN>]);
+```
 
-##### Returned value
+## Parameters
 
-An array of 1s and 0s with a maximum length of 32 bits, the final output array has the same length as the input parameter.
+| Parameter | Description |
+| -- | -- |
+| `<eventN>` | The `N`th event condition, of type `UInt8` and value 1 or 0. |
 
-1 — Condition was met for the event.
+## Returned value
 
-0 — Condition wasn’t met for the event.
+An array of 1 and 0 with a maximum length of 32, where the final output array length matches the input parameter length.
 
-### example
+- 1: Condition is met.
+- 0: Condition is not met.
 
-```sql
-DROP TABLE IF EXISTS retention_test;
+## Examples
 
+```sql
+-- Create sample table
 CREATE TABLE retention_test(
-                `uid` int COMMENT 'user id', 
-                `date` datetime COMMENT 'date time' 
-                )
-DUPLICATE KEY(uid) 
-DISTRIBUTED BY HASH(uid) BUCKETS 3 
+    `uid` int COMMENT 'user id', 
+    `date` datetime COMMENT 'date time' 
+) DUPLICATE KEY(uid) 
+DISTRIBUTED BY HASH(uid) BUCKETS AUTO
 PROPERTIES ( 
-    "replication_num" = "1"
-); 
-
-INSERT into retention_test (uid, date) values (0, '2022-10-12'),
-                                        (0, '2022-10-13'),
-                                        (0, '2022-10-14'),
-                                        (1, '2022-10-12'),
-                                        (1, '2022-10-13'),
-                                        (2, '2022-10-12'); 
-
-SELECT * from retention_test;
-
-+------+---------------------+
-| uid  | date                |
-+------+---------------------+
-|    0 | 2022-10-14 00:00:00 |
-|    0 | 2022-10-13 00:00:00 |
-|    0 | 2022-10-12 00:00:00 |
-|    1 | 2022-10-13 00:00:00 |
-|    1 | 2022-10-12 00:00:00 |
-|    2 | 2022-10-12 00:00:00 |
-+------+---------------------+
-
+    "replication_allocation" = "tag.location.default: 1"
+);
+
+-- Insert sample data
+INSERT into retention_test values 
+(0, '2022-10-12'),
+(0, '2022-10-13'),
+(0, '2022-10-14'),
+(1, '2022-10-12'),
+(1, '2022-10-13'),
+(2, '2022-10-12');
+
+-- Calculate user retention
 SELECT 
     uid,     
-    retention(date = '2022-10-12')
-        AS r 
-            FROM retention_test 
-            GROUP BY uid 
-            ORDER BY uid ASC;
-
-+------+------+
-| uid  | r    |
-+------+------+
-|    0 | [1]  | 
-|    1 | [1]  |
-|    2 | [1]  |
-+------+------+
-
-SELECT 
-    uid,     
-    retention(date = '2022-10-12', date = '2022-10-13')
-        AS r 
-            FROM retention_test 
-            GROUP BY uid 
-            ORDER BY uid ASC;
-
-+------+--------+
-| uid  | r      |
-+------+--------+
-|    0 | [1, 1] |
-|    1 | [1, 1] |
-|    2 | [1, 0] |
-+------+--------+
-
-SELECT 
-    uid,     
-    retention(date = '2022-10-12', date = '2022-10-13', date = '2022-10-14')
-        AS r 
-            FROM retention_test 
-            GROUP BY uid 
-            ORDER BY uid ASC;
-
-+------+-----------+
-| uid  | r         |
-+------+-----------+
-|    0 | [1, 1, 1] |
-|    1 | [1, 1, 0] |
-|    2 | [1, 0, 0] |
-+------+-----------+
-
+    RETENTION(date = '2022-10-12') AS r,
+    RETENTION(date = '2022-10-12', date = '2022-10-13') AS r2,
+    RETENTION(date = '2022-10-12', date = '2022-10-13', date = '2022-10-14') AS r3 
+FROM retention_test 
+GROUP BY uid 
+ORDER BY uid ASC;
 ```
 
-### keywords
-
-RETENTION
+```text
++------+------+--------+-----------+
+| uid  | r    | r2     | r3        |
++------+------+--------+-----------+
+|    0 | [1]  | [1, 1] | [1, 1, 1] |
+|    1 | [1]  | [1, 1] | [1, 1, 0] |
+|    2 | [1]  | [1, 0] | [1, 0, 0] |
++------+------+--------+-----------+
+```

i18n/zh-CN/docusaurus-plugin-content-docs/current/sql-manual/sql-functions/aggregate-functions/retention.md

@@ -33,7 +33,7 @@ under the License.
 ## 语法
 
 ```sql
-retention(<event1> [, <event2>, ... , <eventN>]);
+RETENTION(<event1> [, <event2>, ... , <eventN>]);
 ```
 
 ## 参数
@@ -75,9 +75,9 @@ INSERT into retention_test values
 -- 计算用户留存
 SELECT 
     uid,     
-    retention(date = '2022-10-12') AS r,
-    retention(date = '2022-10-12', date = '2022-10-13') AS r2,
-    retention(date = '2022-10-12', date = '2022-10-13', date = '2022-10-14') AS r3 
+    RETENTION(date = '2022-10-12') AS r,
+    RETENTION(date = '2022-10-12', date = '2022-10-13') AS r2,
+    RETENTION(date = '2022-10-12', date = '2022-10-13', date = '2022-10-14') AS r3 
 FROM retention_test 
 GROUP BY uid 
 ORDER BY uid ASC;

i18n/zh-CN/docusaurus-plugin-content-docs/version-2.1/sql-manual/sql-functions/aggregate-functions/retention.md

@@ -33,7 +33,7 @@ under the License.
 ## 语法
 
 ```sql
-retention(<event1> [, <event2>, ... , <eventN>]);
+RETENTION(<event1> [, <event2>, ... , <eventN>]);
 ```
 
 ## 参数
@@ -75,9 +75,9 @@ INSERT into retention_test values
 -- 计算用户留存
 SELECT 
     uid,     
-    retention(date = '2022-10-12') AS r,
-    retention(date = '2022-10-12', date = '2022-10-13') AS r2,
-    retention(date = '2022-10-12', date = '2022-10-13', date = '2022-10-14') AS r3 
+    RETENTION(date = '2022-10-12') AS r,
+    RETENTION(date = '2022-10-12', date = '2022-10-13') AS r2,
+    RETENTION(date = '2022-10-12', date = '2022-10-13', date = '2022-10-14') AS r3 
 FROM retention_test 
 GROUP BY uid 
 ORDER BY uid ASC;

i18n/zh-CN/docusaurus-plugin-content-docs/version-3.0/sql-manual/sql-functions/aggregate-functions/retention.md

@@ -33,7 +33,7 @@ under the License.
 ## 语法
 
 ```sql
-retention(<event1> [, <event2>, ... , <eventN>]);
+RETENTION(<event1> [, <event2>, ... , <eventN>]);
 ```
 
 ## 参数
@@ -75,9 +75,9 @@ INSERT into retention_test values
 -- 计算用户留存
 SELECT 
     uid,     
-    retention(date = '2022-10-12') AS r,
-    retention(date = '2022-10-12', date = '2022-10-13') AS r2,
-    retention(date = '2022-10-12', date = '2022-10-13', date = '2022-10-14') AS r3 
+    RETENTION(date = '2022-10-12') AS r,
+    RETENTION(date = '2022-10-12', date = '2022-10-13') AS r2,
+    RETENTION(date = '2022-10-12', date = '2022-10-13', date = '2022-10-14') AS r3 
 FROM retention_test 
 GROUP BY uid 
 ORDER BY uid ASC;

versioned_docs/version-2.1/sql-manual/sql-functions/aggregate-functions/retention.md

@@ -33,7 +33,7 @@ To put it simply, the first digit of the return value array indicates whether `e
 ## Syntax
 
 ```sql
-retention(<event1> [, <event2>, ... , <eventN>]);
+RETENTION(<event1> [, <event2>, ... , <eventN>]);
 ```
 
 ## Parameters
@@ -74,9 +74,9 @@ INSERT into retention_test values
 -- Calculate user retention
 SELECT 
     uid,     
-    retention(date = '2022-10-12') AS r,
-    retention(date = '2022-10-12', date = '2022-10-13') AS r2,
-    retention(date = '2022-10-12', date = '2022-10-13', date = '2022-10-14') AS r3 
+    RETENTION(date = '2022-10-12') AS r,
+    RETENTION(date = '2022-10-12', date = '2022-10-13') AS r2,
+    RETENTION(date = '2022-10-12', date = '2022-10-13', date = '2022-10-14') AS r3 
 FROM retention_test 
 GROUP BY uid 
 ORDER BY uid ASC;

versioned_docs/version-3.0/sql-manual/sql-functions/aggregate-functions/retention.md

@@ -33,7 +33,7 @@ To put it simply, the first digit of the return value array indicates whether `e
 ## Syntax
 
 ```sql
-retention(<event1> [, <event2>, ... , <eventN>]);
+RETENTION(<event1> [, <event2>, ... , <eventN>]);
 ```
 
 ## Parameters
@@ -74,9 +74,9 @@ INSERT into retention_test values
 -- Calculate user retention
 SELECT 
     uid,     
-    retention(date = '2022-10-12') AS r,
-    retention(date = '2022-10-12', date = '2022-10-13') AS r2,
-    retention(date = '2022-10-12', date = '2022-10-13', date = '2022-10-14') AS r3 
+    RETENTION(date = '2022-10-12') AS r,
+    RETENTION(date = '2022-10-12', date = '2022-10-13') AS r2,
+    RETENTION(date = '2022-10-12', date = '2022-10-13', date = '2022-10-14') AS r3 
 FROM retention_test 
 GROUP BY uid 
 ORDER BY uid ASC;