dolphindb 2.0.926 → 2.0.928

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (5) hide show
  1. package/docs.en.json +55 -20
  2. package/docs.zh.json +1057 -1004
  3. package/language.js +1 -1
  4. package/language.js.map +1 -1
  5. package/package.json +1 -1
package/docs.en.json CHANGED
@@ -14829,9 +14829,13 @@
14829
14829
  {
14830
14830
  "type": "text",
14831
14831
  "value": [
14832
- "Create an empty unpartitioned table in a distributed database (also called dimension table). To append data to the dimension table, use function append! or tableInsert.",
14832
+ "This function creates an empty dimension table. A dimension table is a non-partitioned table in a DFS database, used to store small datasets with infrequent updates.",
14833
14833
  "",
14834
- "A dimension table is used to store small datasets in a distributed database. Just like partitioned tables, a dimension table can have copies (determined by the configuration parameter dfsReplicationFactor). Read and write operations on a dimension table also support transactions. "
14834
+ "After a dimension table is loaded into memory with function ``loadTable``, the memory taken up by the table will not be released by the system automatically. It is not recommended to store more than 2 million records in a dimension table. To clear the cached data, you can manually call command ``clearCachedDatabase()``. ",
14835
+ "",
14836
+ "Just like partitioned tables, a dimension table can have multiple replicas (determined by the configuration parameter *dfsReplicationFactor*).",
14837
+ "",
14838
+ "To enable concurrent writes, updates or deletes on a dimension table, set the configuration parameter *enableConcurrentDimensionalTableWrite* to true. "
14835
14839
  ]
14836
14840
  }
14837
14841
  ]
@@ -18116,11 +18120,11 @@
18116
18120
  {
18117
18121
  "type": "text",
18118
18122
  "value": [
18119
- "`X` is a vector.",
18123
+ "`X` is a scalar/vector.",
18120
18124
  "",
18121
- "`size` is an integer scalar and must satisfy 2<=a<size(X). Function cut divides X into a list of vectors with the given size.",
18125
+ "`size` is a positive integer that must be no greater than the size of *X*.",
18122
18126
  "",
18123
- "`cutPositions` is a sorted integer vector. Function cut divides X into a list of vectors at the specified positions. Each of the vectors in the result starts at a position that is specified in cutPositions."
18127
+ "`cutPositions` is a vector of INT type with increasing elements, which is used to specify the starting position of each vector in the result."
18124
18128
  ]
18125
18129
  }
18126
18130
  ]
@@ -18132,7 +18136,12 @@
18132
18136
  {
18133
18137
  "type": "text",
18134
18138
  "value": [
18135
- "A vector is divided into a list of vectors. Please refer to function :doc:`../f/flatten` for the reverse operation."
18139
+ "This function divides *X* based on the specified size or *cutPositions*, and returns a tuple:",
18140
+ "",
18141
+ "* If the *size* is specified, it divides *X* into a list of scalars (size=1) or vectors (size>1) of length size.",
18142
+ "* If the *cutPositions* is specified, it divides *X* into a list of vectors at the specified positions.",
18143
+ "",
18144
+ "Refer to function :doc:`../f/flatten` for the reverse operation."
18136
18145
  ]
18137
18146
  }
18138
18147
  ]
@@ -35107,7 +35116,9 @@
35107
35116
  {
35108
35117
  "type": "text",
35109
35118
  "value": [
35110
- "Return real-time CPU utilization. To use this function, we must set perfMonitoring=1 in the configuration file to enable performance monitoring. "
35119
+ "This function returns the CPU utilization rate taken by a DolphinDB process on the current node. ",
35120
+ "",
35121
+ "Note that if a DolphinDB process uses multiple CPU cores, the total usage rate is returned."
35111
35122
  ]
35112
35123
  }
35113
35124
  ]
@@ -36822,7 +36833,15 @@
36822
36833
  "value": [
36823
36834
  "`X` is a vector.",
36824
36835
  "",
36825
- "`mode` is an optional parameter indicating whether to return a dictionary or a table. It can be \"dict\" (default) or \"table\". "
36836
+ "`mode` is an optional parameter indicating the data form returned by the function. The default value is \"dict\". It can be specified as:",
36837
+ "",
36838
+ "- \"dict\": return a dictionary. The key of the dictionary stores the unique value in *X*; the value is a vector that stores the indices of all elements that hold the value.",
36839
+ "",
36840
+ "- \"table\": return a table with 2 columns, \"key\" and \"index\", storing the unique value in *X* and the corresponding indices.",
36841
+ "",
36842
+ "- \"vector\": return an array vector. The elements are the indices of each unique value in *X*, sorted in ascending order.",
36843
+ "",
36844
+ "- \"tuple\": return a tuple. The elements are stored the same as mode=\"vector\"."
36826
36845
  ]
36827
36846
  }
36828
36847
  ]
@@ -36834,7 +36853,7 @@
36834
36853
  {
36835
36854
  "type": "text",
36836
36855
  "value": [
36837
- "For each unique value in X, return the indices of all elements that hold the value.",
36856
+ "For each unique value in *X*, return the indices of all elements that hold the value.",
36838
36857
  "",
36839
36858
  "If mode = \"dict\", return a dictionary.",
36840
36859
  "",
@@ -36861,6 +36880,12 @@
36861
36880
  " 14->[7]",
36862
36881
  " 15->[3,6]",
36863
36882
  "",
36883
+ " $ groups(x, \"vector\")",
36884
+ " [[0,1,8,9],[2,4],[7],[3,6],[5]]",
36885
+ "",
36886
+ " $ groups(x, \"tuple\")",
36887
+ " ([0,1,8,9],[2,4],[7],[3,6],[5])",
36888
+ "",
36864
36889
  " $ groups(x, \"table\")",
36865
36890
  ""
36866
36891
  ]
@@ -36882,7 +36907,6 @@
36882
36907
  "| 6 | [5] |",
36883
36908
  "+-----+---------+",
36884
36909
  "",
36885
- "",
36886
36910
  ""
36887
36911
  ]
36888
36912
  }
@@ -71252,7 +71276,7 @@
71252
71276
  "language": "console",
71253
71277
  "value": [
71254
71278
  "",
71255
- " $ s.resample(rule=`3min, func=sum, closed=`right,origin=`end);",
71279
+ " $ s.resample(rule=`3min, func=sum, closed=`left,origin=`end);",
71256
71280
  ""
71257
71281
  ]
71258
71282
  },
@@ -72031,6 +72055,8 @@
72031
72055
  "destNode alias of destination node",
72032
72056
  "================== =================================================",
72033
72057
  "",
72058
+ "Note: This function can only be executed on the controller.",
72059
+ "",
72034
72060
  "You can get the status of recovery tasks by :doc:`/FunctionsandCommands/FunctionReferences/g/getRecoveryTaskStatus` on a controller."
72035
72061
  ]
72036
72062
  }
@@ -82404,7 +82430,7 @@
82404
82430
  {
82405
82431
  "type": "text",
82406
82432
  "value": [
82407
- "`str` is a STRING scalar.",
82433
+ "`str` is a STRING scalar or vector.",
82408
82434
  "",
82409
82435
  "`delimiter` is a CHAR or STRING scalar. "
82410
82436
  ]
@@ -82418,9 +82444,11 @@
82418
82444
  {
82419
82445
  "type": "text",
82420
82446
  "value": [
82421
- "If `delimiter` is not specified, split str into a CHAR vector.",
82447
+ "* *str* is a scalar:",
82448
+ " * If *delimiter* is not specified, split *str* into a CHAR vector.",
82449
+ " * If *delimiter* is specified, use *delimiter* as the delimiter to split str into a CHAR vector or a STRING vector.",
82422
82450
  "",
82423
- "If `delimiter` is specified, use delimiter as the delimiter to split str into a CHAR vector or a STRING vector."
82451
+ "* *str* is a vector: Split each element of the vector as described above. Return the results in a columnar tuple."
82424
82452
  ]
82425
82453
  }
82426
82454
  ]
@@ -82446,12 +82474,19 @@
82446
82474
  " $ split(`xyz1,`xyz)[1];",
82447
82475
  " 1",
82448
82476
  "",
82449
- " $ split(\"xyz 1 ABCD 3241.32\",\" \");",
82450
- " [\"xyz\",\"1\",\"ABCD\",\"3241.32\"]",
82477
+ " $ a = split(\"20220101 09:00:00\" \"20220101 09:12:20\" \"20220101 10:00:00\", \" \")",
82478
+ " ([\"20220101\",\"09:00:00\"],[\"20220101\",\"09:12:20\"],[\"20220101\",\"10:00:00\"])",
82451
82479
  "",
82452
- " $ split(\"XOM|2018.02.15|76.21\", \"|\");",
82453
- " [\"XOM\",\"2018.02.15\",\"76.21\"]",
82454
- ""
82480
+ " // access by column",
82481
+ " $ a[0];",
82482
+ " [\"20220101\",\"20220101\",\"20220101\"]",
82483
+ "",
82484
+ " $ a[1];",
82485
+ " [\"09:00:00\",\"09:12:20\",\"10:00:00\"]",
82486
+ "",
82487
+ " //access by row",
82488
+ " $ a.row(0)",
82489
+ " [\"20220101\",\"09:00:00\"]"
82455
82490
  ]
82456
82491
  }
82457
82492
  ]
@@ -84509,7 +84544,7 @@
84509
84544
  "* 'condition':",
84510
84545
  "",
84511
84546
  " * When processing a heterogeneous stream table: It is a STRING referring to a dictionary key from the *inputTables* of :doc:`../r/replay`. The engine will filter records by the specified key.",
84512
- " * When processing a standard stream table: It is a STRING scalar/vector indicating the value(s) from the *conditionColumn*, or metacode of one or more Boolean expressions (without any function calls). The engine will filter records by the specified condition.",
84547
+ " * When processing a standard stream table: It is a STRING scalar/vector indicating the value(s) from the *conditionColumn*, or metacode of one or more Boolean expressions (can contain built-in functions; cannot contain partial applications). The engine will filter records by the specified condition.",
84513
84548
  "",
84514
84549
  "* 'handler' is a unary function or a table (can be the table object returned by a streaming engine).",
84515
84550
  "",