dolphindb 2.0.1024 → 2.0.1026

package/docs.en.json

@@ -27864,7 +27864,7 @@
                         "value": [
                             "This command enables a shared stream table to be persisted to disk. ",
                             "",
-                            "For this command to work, we need to specify the configuration parameter `persistenceDir`. The persistence location of the table is <PERSISTENCE_DIR>/<TABLE_NAME>.  The directory contains 2 types of files: data files (named like `data0.log`, `data1.log`...) and an index file index.log. The data that has been persisted to disk will be loaded into memory after the system is restarted.",
+                            "For this command to work, we need to specify the configuration parameter `persistenceDir` in the configuration file (*dolohindb.cfg* in standalone mode and *cluster.cfg* in cluster mode). For details of this configuration parameter, see :doc:`/DatabaseandDistributedComputing/Configuration/StandaloneMode`. The persistence location of the table is <PERSISTENCE_DIR>/<TABLE_NAME>.  The directory contains 2 types of files: data files (named like `data0.log`, `data1.log`...) and an index file index.log. The data that has been persisted to disk will be loaded into memory after the system is restarted.",
                             "",
                             "The parameter `asynWrite` informs the system whether table persistence is in asynchronous mode. With asynchronous mode, new data are pushed to a queue and persistence workers (threads) will write the data to disk later. With synchronous mode, the table append operation keeps running until new data are persisted to the disk. The default value is true (asynchronous mode). In general, asynchronous mode achieves higher throughput.",
                             "",
@@ -28001,7 +28001,7 @@
                     {
                         "type": "text",
                         "value": [
-                            "Share a stream table, and enable it to be persisted to disk. For this command to work, we need to specify the configuration parameter persistenceDir. The persistence location of the table is <PERSISTENCE_DIR>/<TABLE_NAME>.  The directory contains 2 types of files: data files (named like `data0.log`, `data1.log`...) and an index file index.log. The data that has been persisted to disk will be loaded into memory after the system is restarted.",
+                            "Share a stream table, and enable it to be persisted to disk. For this command to work, we need to specify the configuration parameter `persistenceDir` in the configuration file (*dolohindb.cfg* in standalone mode and *cluster.cfg* in cluster mode). For details of this configuration parameter, see :doc:`/DatabaseandDistributedComputing/Configuration/StandaloneMode`. The persistence location of the table is <PERSISTENCE_DIR>/<TABLE_NAME>.  The directory contains 2 types of files: data files (named like `data0.log`, `data1.log`...) and an index file index.log. The data that has been persisted to disk will be loaded into memory after the system is restarted.",
                             "",
                             "The parameter `asynWrite` informs the system whether table persistence is in asynchronous mode. With asynchronous mode, new data are pushed to a queue and persistence workers (threads) will write the data to disk later. With synchronous mode, the table append operation keeps running until new data are persisted to the disk. The default value is true (asynchronous mode). In general, asynchronous mode achieves higher throughput.",
                             "",
@@ -72448,8 +72448,7 @@
                     {
                         "type": "text",
                         "value": [
-                            "`X` is a vector or a matrix.",
-                            ""
+                            "`X` is a vector or a matrix."
                         ]
                     }
                 ]
@@ -72461,7 +72460,7 @@
                     {
                         "type": "text",
                         "value": [
-                            "If X is a vector, return X(n)\\X(n-1) by scanning X. The first element of the result is always NULL. ",
+                            "If X is a vector, return X(n)\\\\X(n-1) by scanning X. The first element of the result is always NULL. ",
                             "",
                             "If X is a matrix, conduct the aforementioned calculation within each column of X. The result is a matrix with the same shape as X.  "
                         ]
@@ -72518,15 +72517,23 @@
                     {
                         "type": "text",
                         "value": [
-                            "================== ============",
-                            "#0                                          #1",
-                            "================== ============",
-                            "1.05                                      1.06",
-                            "1.038095238095238       0.981132075471698",
-                            "1.027522935779817       0.956730769230769",
-                            "0.964285714285714       1.035175879396985",
-                            "1.074074074074074       1.019417475728155",
-                            "================== ============",
+                            "+-------------------------+-------------------------+",
+                            "| #0                      | #1                      |",
+                            "+=========================+=========================+",
+                            "|                         |                         |",
+                            "+-------------------------+-------------------------+",
+                            "| 1.05                    | 1.06                    |",
+                            "+-------------------------+-------------------------+",
+                            "| 1.038095238095238       | 0.981132075471698       |",
+                            "+-------------------------+-------------------------+",
+                            "| 1.027522935779817       | 0.956730769230769       |",
+                            "+-------------------------+-------------------------+",
+                            "| 0.964285714285714       | 1.035175879396985       |",
+                            "+-------------------------+-------------------------+",
+                            "| 1.074074074074074       | 1.019417475728155       |",
+                            "+-------------------------+-------------------------+",
+                            "",
+                            "",
                             "",
                             "       "
                         ]

package/docs.zh.json

@@ -30312,9 +30312,15 @@
                             "",
                             "`compress` 是一个布尔值。它是可选参数，表示是否以压缩模式模式保存至磁盘。默认值为 true。",
                             "",
-                            "`cacheSize` 是长整型数据类型（long）的整数。它是一个可选参数，表示流数据表在内存中最多保留多少行。默认值为-1。如果它为0或者没有指定（默认值为-1），所有记录行都会保存在内存中。如果 *cacheSize* 是小于100,000的正整数，它会被自动调整为100,000。",
+                            "`cacheSize` 是长整型数据类型（long）的整数。它是一个可选参数，表示流数据表在内存中最多保留多少行。默认值为-1。如果它为0或者没有指定（默认值为-1），所有记录行都会保存在内存中。请注意：",
                             "",
-                            "`retentionMinutes` 是一个整数，表示 log 文件的保留时间（从文件的最后修改时间开始计算），单位是分钟。默认值是1440，即一天。",
+                            "    * 如果 *cacheSize* 设置为小于1000的正整数，它会被自动调整为1000。",
+                            "    * 如果 *cacheSize* 大于1000：",
+                            "",
+                            "      * 每次 append 的数据都不超过 *cacheSize* 时，内存中的数据量不会大于 *cacheSize* 的1.5倍。",
+                            "      * 出现 append 的数据超过 *cacheSize* 时，内存中的数据量不会超过最大追加行数的2倍。",
+                            "",
+                            "`retentionMinutes` 是一个整数，表示保留大小超过 1GB 的 log 文件的时间（从文件的最后修改时间开始计算），单位是分钟。默认值是1440，即一天。",
                             "",
                             "`flushMode` 是一个整数，表示是否开启同步刷盘，取值只能为0或1。默认值是0，表示异步刷盘，内存中的流数据写入操作系统缓存即为写入成功，并进行下一批数据的写入。 若为1，则表示同步刷盘，当前批次的流数据必须落盘完成，才会进行下一批数据的写入。"
                         ]
@@ -30434,7 +30440,7 @@
                         "value": [
                             "`table` 是一个空的流数据表。",
                             "",
-                            "`tableName` 是一个字符串，表示 table d共享后的名称。",
+                            "`tableName` 是一个字符串，表示 table 共享后的名称。",
                             "",
                             "`asynWrite` 是一个布尔值，表示是否异步持久化数据到磁盘。默认值为 true，流数据写入内存即为写入成功，持久化到磁盘的操作将会由另一个线程执行。",
                             "",
@@ -30442,9 +30448,15 @@
                             "",
                             "`compress` 是一个布尔值。它是可选参数，表示是否以压缩模式模式保存至磁盘。默认值为 true。",
                             "",
-                            "`cacheSize` 是长整型数据类型（long）的整数。它是一个可选参数，表示流数据表在内存中最多保留多少行。如果它为0或者没有指定，所有记录行都会保存在内存中。默认值为-1。如果 *cacheSize* 是小于100,000的正整数，它会被自动调整为100,000.",
+                            "`cacheSize` 是长整型数据类型（long）的整数。它是一个可选参数，表示流数据表在内存中最多保留多少行。如果它为0或者没有指定，所有记录行都会保存在内存中。默认值为-1。请注意：",
+                            "    ",
+                            "    * 如果 *cacheSize* 设置为小于1000的正整数，它会被自动调整为1000。",
+                            "    * 如果 *cacheSize* 大于1000：",
+                            "",
+                            "      * 每次 append 的数据都不超过 *cacheSize* 时，内存中的数据量不会大于 *cacheSize* 的1.5倍。",
+                            "      * 出现 append 的数据超过 *cacheSize* 时，内存中的数据量不会超过最大追加行数的2倍。",
                             "",
-                            "`retentionMinutes` 是一个整数，表示 log 文件的保留时间（从文件的最后修改时间开始计算），单位是分钟。默认值是1440，即一天。",
+                            "`retentionMinutes` 是一个整数，表示保留大小超过 1GB 的 log 文件的时间（从文件的最后修改时间开始计算），单位是分钟。默认值是1440，即一天。",
                             "",
                             "`flushMode` 是一个整数，表示是否开启同步刷盘，取值只能为0或1。默认值是0，表示异步刷盘，内存中的流数据写入操作系统缓存即为写入成功，并进行下一批数据的写入。 若为1，则表示同步刷盘，当前批次的流数据必须落盘完成，才会进行下一批数据的写入。",
                             "",
@@ -36237,7 +36249,7 @@
                         "value": [
                             "+---------------+---------------------------------------------+---------------+-----------+-----------------+---------------------+-----------------+---------------------------+-------------+",
                             "| userName type | startTime                                   | dbName        | tableName | totalPartitions | completedPartitions | percentComplete | endTime                   | completed   |",
-                            "+===============+=============================================+===============+===========+=================+=====================+=================+=========================================+",
+                            "+===============+=============================================+===============+===========+=================+=====================+=================+===========================+=============+",
                             "| u1            | BACKUP_BY_COPY_FILE 2022.09.21T17:18:04.264 | dfs://valuedb | pt        | 1               | 1                   | 100             | 2022.09.21T17:18:04.269   | 1           |",
                             "+---------------+---------------------------------------------+---------------+-----------+-----------------+---------------------+-----------------+---------------------------+-------------+",
                             "| u1            | BACKUP 2022.09.21T17:13:04.344              | dfs://valuedb | pt        | 4               | 4                   | 100             | 2022.09.21T17:13:04.413   | 1           |",
@@ -36625,7 +36637,9 @@
                             "2.00.9 版本起，",
                             "",
                             "* 该函数由管理员或拥有 DB_MANAGE 权限的用户执行时，返回集群中所有的分布式表；",
-                            "* 否则，仅返回该用户有访问权限的分布式表。其中，访问权限包含 DB_OWNER, TABLE_READ, TABLE_WRITE, TABLE_INSERT, TABLE_UPDATE, TABLE_DELETE, DB_READ, DB_WRITE, DB_INSERT, DB_UPDATE, DB_DELETE。 "
+                            "* 否则，仅返回该用户有访问权限的分布式表。其中，访问权限包含 DB_OWNER, TABLE_READ, TABLE_WRITE, TABLE_INSERT, TABLE_UPDATE, TABLE_DELETE, DB_READ, DB_WRITE, DB_INSERT, DB_UPDATE, DB_DELETE。 ",
+                            "",
+                            "2.00.10.2 版本起，该函数由拥有 DBOBJ_CREATE 权限的用户执行时，还会返回其创建的分布式表。"
                         ]
                     }
                 ]
@@ -43806,7 +43820,7 @@
                             "",
                             "`keyColumn` 是一个字符串标量或向量，表示主键。它是一个可选参数。",
                             "",
-                            "`retentionMinutes` 是一个整数，表示log文件的保留时间（从文件的最后修改时间开始计算），单位是分钟。默认值是1440，即一天。"
+                            "`retentionMinutes` 是一个整数，表示保留大小超过 1GB 的 log 文件的时间（从文件的最后修改时间开始计算），单位是分钟。默认值是1440，即一天。"
                         ]
                     }
                 ]
@@ -52880,7 +52894,7 @@
                     {
                         "type": "text",
                         "value": [
-                            "`fileName` 可选参数。需要指定的license文件的路径。",
+                            "`fileName` 可选参数。需要指定的 license 文件的路径。",
                             "",
                             "`pubKeyFile` 可选参数。需要指定的公钥文件的路径。"
                         ]
@@ -52894,7 +52908,7 @@
                     {
                         "type": "text",
                         "value": [
-                            "显示 DolphinDB 的许可证信息。",
+                            "显示 DolphinDB 的许可证信息。若不指定 fileName，则默认读取保存在内存中的 license 信息。",
                             "",
                             "返回值说明：",
                             "",
@@ -80908,7 +80922,10 @@
                     {
                         "type": "text",
                         "value": [
-                            "rmdir(directory, [recursive=false])"
+                            ".. versionadded:: 2.00.10.2",
+                            "    参数 *keepRootDir*",
+                            "",
+                            "rmdir(directory, [recursive=false], [keepRootDir=false])"
                         ]
                     }
                 ]
@@ -80922,7 +80939,11 @@
                         "value": [
                             "`directory` 是要删除的文件夹名称。",
                             "",
-                            "如果该目录不为空，则通过设定 `recursive` 的值为true可以删除所有子目录和文件。"
+                            "`recursive` 布尔值，可选参数，设置是否删除所有指定文件夹所有子目录及其中文件如果该目录不为空，默认值为 false。",
+                            "",
+                            "`keepRootDir` 布尔值，用于指定是否保留根目录。默认值为 false。当设置为 true 时，仅删除子目录和文件，而不会删除根目录。",
+                            "",
+                            "注意：若设置 *keepRootDir* = true，则必须设置 *recursive* = true。"
                         ]
                     }
                 ]
@@ -80934,7 +80955,7 @@
                     {
                         "type": "text",
                         "value": [
-                            "删除目录。默认情况下，要删除的目录必须为空。如果目录不为空仍然要删除它时，请设置 *recursive* 的值为true。",
+                            "删除目录。默认情况下，要删除的目录必须为空。如果目录不为空仍然要删除它时，请设置 *recursive* 的值为 true。",
                             "",
                             "该命令必须要用户登录后才能执行。"
                         ]
@@ -100738,7 +100759,7 @@
                             "========== ===== =========",
                             "t          x     tmfirst_t",
                             "========== ===== =========",
-                            "2021.01.02       3 ",
+                            "2021.01.02 3     3 ",
                             "2021.01.02 4     3 ",
                             "2021.01.04       3 ",
                             "2021.01.05 -1     ",
@@ -100763,7 +100784,7 @@
                             "========== ===== =========",
                             "t          x     tmfirst_t",
                             "========== ===== =========",
-                            "2021.01.02       3 ",
+                            "2021.01.02 3     3 ",
                             "2021.01.02 4     3 ",
                             "2021.01.04       3 ",
                             "2021.01.05 -1    3 ",

package/index.d.ts

@@ -158,6 +158,7 @@ export declare class DdbObj<TValue extends DdbValue = DdbValue> {
     static to_ddbobj(value: DdbObj | string | boolean): DdbObj;
     /** 转换 js 数组为 DdbObj[] */
     static to_ddbobjs(values: (DdbObj | string | boolean)[]): DdbObj<DdbValue>[];
+    /** 将 table 转换为 rows，空值转换为 null */
     to_rows<T extends Record<string, any> = Record<string, any>>(): T[];
     /** 将 dict<string, any> 自动转换为 js object (Record<string, any>)  Automatically convert dict<string, any> to js object (Record<string, any>)
         - options?:

package/index.js

@@ -1023,6 +1023,7 @@ export class DdbObj {
                         // av
                         const type_ = this.type - 64;
                         const limit = 10;
+                        const nullstr = inspect(null, options);
                         let array_items = new Array(Math.min(limit, this.rows));
                         let i_items = 0;
                         for (const { lengths, data } of this.value) {
@@ -1035,14 +1036,14 @@ export class DdbObj {
                                         case DdbType.decimal64:
                                         case DdbType.decimal128:
                                             const x = data[acc_len + i];
-                                            if (is_decimal_null_value(type_, x)) {
-                                                items[i] = '';
-                                                break;
+                                            if (is_decimal_null_value(type_, x))
+                                                items[i] = nullstr;
+                                            else {
+                                                const { scale } = this.value;
+                                                const s = String(x < 0 ? -x : x).padStart(scale, '0');
+                                                const str = (x < 0 ? '-' : '') + (scale ? `${s.slice(0, -scale) || '0'}.${s.slice(-scale)}` : s);
+                                                items[i] = options.colors ? str.green : str;
                                             }
-                                            const { scale } = this.value;
-                                            const s = String(x < 0 ? -x : x).padStart(scale, '0');
-                                            const str = (x < 0 ? '-' : '') + (scale ? `${s.slice(0, -scale) || '0'}.${s.slice(-scale)}` : s);
-                                            items[i] = options.colors ? str.green : str;
                                             break;
                                         case DdbType.complex:
                                         case DdbType.point: {
@@ -1176,6 +1177,7 @@ export class DdbObj {
     static to_ddbobjs(values) {
         return values.map(value => this.to_ddbobj(value));
     }
+    /** 将 table 转换为 rows，空值转换为 null */
     to_rows() {
         assert(this.form === DdbForm.table, t('form 必须是 DdbForm.table, 否则不能 to_rows'));
         let rows = new Array(this.rows);
@@ -1192,6 +1194,42 @@ export class DdbObj {
                                 Boolean(value);
                         break;
                     }
+                    case DdbType.char:
+                        row[name] = values[i] === nulls.int8 ? null : values[i];
+                        break;
+                    case DdbType.short:
+                        row[name] = values[i] === nulls.int16 ? null : values[i];
+                        break;
+                    case DdbType.int:
+                    case DdbType.date:
+                    case DdbType.month:
+                    case DdbType.time:
+                    case DdbType.minute:
+                    case DdbType.second:
+                    case DdbType.datetime:
+                    case DdbType.datehour:
+                        row[name] = values[i] === nulls.int32 ? null : values[i];
+                        break;
+                    case DdbType.long:
+                    case DdbType.timestamp:
+                    case DdbType.nanotime:
+                    case DdbType.nanotimestamp:
+                        row[name] = values[i] === nulls.int64 ? null : values[i];
+                        break;
+                    case DdbType.int128:
+                        row[name] = values[i] === nulls.int128 ? null : values[i];
+                        break;
+                    case DdbType.float:
+                        row[name] = values[i] === nulls.float32 ? null : values[i];
+                        break;
+                    case DdbType.double:
+                        row[name] = values[i] === nulls.double ? null : values[i];
+                        break;
+                    case DdbType.decimal32:
+                    case DdbType.decimal64:
+                    case DdbType.decimal128:
+                        row[name] = is_decimal_null_value(type, values[i]) ? null : values[i];
+                        break;
                     case DdbType.ipaddr:
                         row[name] = values.subarray(16 * i, 16 * (i + 1));
                         break;
@@ -1452,6 +1490,7 @@ export function formati(obj, index, options = {}) {
         // av
         const type_ = obj.type - 64;
         let offset = 0;
+        const nullstr = inspect(null, options);
         for (const { lengths, data, rows } of obj.value) {
             let acc_len = 0;
             if (offset + rows <= index) {
@@ -1472,14 +1511,14 @@ export function formati(obj, index, options = {}) {
                         case DdbType.decimal64:
                         case DdbType.decimal128:
                             const x = data[acc_len + i];
-                            if (is_decimal_null_value(type_, x)) {
-                                items[i] = '';
-                                break;
+                            if (is_decimal_null_value(type_, x))
+                                items[i] = nullstr;
+                            else {
+                                const { scale } = obj.value;
+                                const s = String(x < 0 ? -x : x).padStart(scale, '0');
+                                const str = (x < 0 ? '-' : '') + (scale ? `${s.slice(0, -scale) || '0'}.${s.slice(-scale)}` : s);
+                                items[i] = options.colors ? str.green : str;
                             }
-                            const { scale } = obj.value;
-                            const s = String(x < 0 ? -x : x).padStart(scale, '0');
-                            const str = (x < 0 ? '-' : '') + (scale ? `${s.slice(0, -scale) || '0'}.${s.slice(-scale)}` : s);
-                            items[i] = options.colors ? str.green : str;
                             break;
                         case DdbType.complex:
                         case DdbType.point: {