dolphindb 2.0.916 → 2.0.918

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 (9) hide show
  1. package/browser.d.ts +2 -0
  2. package/browser.js +2 -0
  3. package/browser.js.map +1 -1
  4. package/docs.en.json +90 -26
  5. package/docs.zh.json +112 -126
  6. package/index.d.ts +2 -0
  7. package/index.js +2 -0
  8. package/index.js.map +1 -1
  9. package/package.json +1 -1
package/docs.en.json CHANGED
@@ -30983,7 +30983,7 @@
30983
30983
  {
30984
30984
  "type": "text",
30985
30985
  "value": [
30986
- "getJobMessage(job_id)",
30986
+ "getJobMessage(jobId)",
30987
30987
  ""
30988
30988
  ]
30989
30989
  }
@@ -30996,7 +30996,7 @@
30996
30996
  {
30997
30997
  "type": "text",
30998
30998
  "value": [
30999
- "`job_id` is a batch job ID.",
30999
+ "`jobId` is a batch job ID.",
31000
31000
  ""
31001
31001
  ]
31002
31002
  }
@@ -31097,7 +31097,7 @@
31097
31097
  {
31098
31098
  "type": "text",
31099
31099
  "value": [
31100
- "getJobReturn(job_id, [blocking=false])",
31100
+ "getJobReturn(jobId, [blocking=false])",
31101
31101
  ""
31102
31102
  ]
31103
31103
  }
@@ -31110,7 +31110,7 @@
31110
31110
  {
31111
31111
  "type": "text",
31112
31112
  "value": [
31113
- "`job_id` is a batch job ID.",
31113
+ "`jobId` is a batch job ID.",
31114
31114
  "",
31115
31115
  "`blocking` is a Boolean value indicating whether the blocking mode is enabled. If blocking is false, the function will return an exception if the job is not completed. If blocking is true, the function will not return a value until the job is completed. The default value is false.",
31116
31116
  ""
@@ -31284,7 +31284,7 @@
31284
31284
  {
31285
31285
  "type": "text",
31286
31286
  "value": [
31287
- "getJobStatus(job_id)"
31287
+ "getJobStatus(jobId)"
31288
31288
  ]
31289
31289
  }
31290
31290
  ]
@@ -31296,7 +31296,7 @@
31296
31296
  {
31297
31297
  "type": "text",
31298
31298
  "value": [
31299
- "`job_id` is the batch job ID."
31299
+ "`jobId` is the batch job ID."
31300
31300
  ]
31301
31301
  }
31302
31302
  ]
@@ -65494,10 +65494,10 @@
65494
65494
  "",
65495
65495
  "`tiesMethod` is a string indicating how to rank the group of elements with the same value (i.e., ties):",
65496
65496
  "",
65497
- "* 'min' : the smallest rank value of the tie values.",
65498
- "* 'max' : the largest rank value of the tie values. ",
65499
- "* 'average' : the average of the rank values for all ties. ",
65500
- "* 'first': Gives the first found tie value the lowest rank value, and continues with the following rank value for the next tie. ",
65497
+ "- 'min' : Gives all ties the smallest rank value of the tie values.",
65498
+ "- 'max' : Gives all ties the largest rank value of the tie values. ",
65499
+ "- 'average' : Gives all ties the average of the rank values for all ties. ",
65500
+ "- 'first': Gives the first found tie value the lowest rank value, and continues with the following rank value for the next tie. ",
65501
65501
  "",
65502
65502
  "`percent` is a Boolean value, indicating whether to display the returned rankings in percentile form. The default value is false.",
65503
65503
  "",
@@ -65557,13 +65557,15 @@
65557
65557
  " $ rank(X=1 2 2 3, tiesMethod='average');",
65558
65558
  " [0,1.5,1.5,3]",
65559
65559
  "",
65560
+ " $ rank(X=1 2 2 3, tiesMethod='first');",
65561
+ " [0,1,2,3]",
65562
+ "",
65560
65563
  " $ rank(1 NULL NULL 3);",
65561
65564
  " [0,,,1]",
65562
65565
  "",
65563
65566
  " $ rank(X=1 NULL NULL 3, ignoreNA=false);",
65564
65567
  " [2,0,0,3]",
65565
65568
  "",
65566
- " $ t=table(1 1 1 2 2 2 2 as id, 3 5 4 6 2 7 1 as x);",
65567
65569
  " $ t=table(1 1 1 2 2 2 2 as id, 3 5 4 6 2 7 1 as x)",
65568
65570
  " $ t",
65569
65571
  ""
@@ -67458,6 +67460,18 @@
67458
67460
  }
67459
67461
  ]
67460
67462
  },
67463
+ {
67464
+ "title": "Details",
67465
+ "type": "detail",
67466
+ "children": [
67467
+ {
67468
+ "type": "text",
67469
+ "value": [
67470
+ "Send a script or function to a remote database for execution."
67471
+ ]
67472
+ }
67473
+ ]
67474
+ },
67461
67475
  {
67462
67476
  "title": "Examples",
67463
67477
  "type": "example",
@@ -72845,10 +72859,10 @@
72845
72859
  "",
72846
72860
  "`tiesMethod` is a string indicating how to rank the group of elements with the same value (i.e., ties):",
72847
72861
  "",
72848
- " * 'min': the smallest rank value of the tie values. ",
72849
- " * 'max': the largest rank value of the tie values.",
72850
- " * 'average': the average of the rank values for all ties. ",
72851
- " * 'first': Gives the first found tie value the lowest rank value, and continues with the following rank value for the next tie.",
72862
+ "- 'min' : Gives all ties the smallest rank value of the tie values.",
72863
+ "- 'max' : Gives all ties the largest rank value of the tie values. ",
72864
+ "- 'average' : Gives all ties the average of the rank values for all ties. ",
72865
+ "- 'first': Gives the first found tie value the lowest rank value, and continues with the following rank value for the next tie. ",
72852
72866
  "",
72853
72867
  "`percent` is a Boolean value, indicating whether to display the returned rankings in percentile form. The default value is false.",
72854
72868
  "",
@@ -73005,6 +73019,28 @@
73005
73019
  "2 0 1 3 6 5 8 7 4",
73006
73020
  "8 0 2 4 5 6 4 2 7",
73007
73021
  "== == == == == == == == == ",
73022
+ ""
73023
+ ]
73024
+ },
73025
+ {
73026
+ "type": "code",
73027
+ "language": "console",
73028
+ "value": [
73029
+ "",
73030
+ " $ m.rowRank(ignoreNA=false, tiesMethod='first');",
73031
+ ""
73032
+ ]
73033
+ },
73034
+ {
73035
+ "type": "text",
73036
+ "value": [
73037
+ "+------+------+------+------+------+------+------+------+------+",
73038
+ "| col1 | col2 | col3 | col4 | col5 | col6 | col7 | col8 | col9 |",
73039
+ "+======+======+======+======+======+======+======+======+======+",
73040
+ "| 2 | 0 | 1 | 3 | 6 | 5 | 8 | 7 | 4 |",
73041
+ "+------+------+------+------+------+------+------+------+------+",
73042
+ "| 8 | 0 | 1 | 3 | 5 | 6 | 4 | 2 | 7 |",
73043
+ "+------+------+------+------+------+------+------+------+------+",
73008
73044
  "",
73009
73045
  "Related functions: :doc:`rowDenseRank`, :doc:`../r/rank`",
73010
73046
  "",
@@ -77783,7 +77819,7 @@
77783
77819
  {
77784
77820
  "type": "text",
77785
77821
  "value": [
77786
- "setRetentionPolicy(dbHanle, retentionHours, [retentionDimension])"
77822
+ "setRetentionPolicy(dbHandle, retentionHours, [retentionDimension], [hoursToColdVolume])"
77787
77823
  ]
77788
77824
  }
77789
77825
  ]
@@ -77799,7 +77835,11 @@
77799
77835
  "",
77800
77836
  "`retentionHours` is a positive integer indicating the number of hours that data are kept.",
77801
77837
  "",
77802
- "`retentionDimension` is an integer indicating the layer of the temporal partition. The default value is 0 indicating the first layer of a COMPO partition is a temporal partition."
77838
+ "`retentionDimension` is an integer indicating the layer of the temporal partition. The default value is 0 indicating the first layer of a COMPO partition is a temporal partition.",
77839
+ "",
77840
+ "`hoursToColdVolume` is a positive integer indicating the number of hours that data are kept in volumes. Data stored in volumes will be migrated to the specified coldVolumes (configuration parameter) after hoursToColdVolume.",
77841
+ "",
77842
+ "Note: Make sure that retentionHours - hoursToColdVolume > 7 * 24 (7 days)."
77803
77843
  ]
77804
77844
  }
77805
77845
  ]
@@ -77811,9 +77851,15 @@
77811
77851
  {
77812
77852
  "type": "text",
77813
77853
  "value": [
77814
- "Set the time length that data are kept. It only applies to DFS databases.",
77854
+ "Set the policy of data retention and tiered storage. The parameter retentionHours should be specified as large as possible for tiered storage to avoid deleting any data.",
77815
77855
  "",
77816
- "We can check this value with function :doc:`../../FunctionReferences/s/schema`."
77856
+ "Both data retention and tiered storage are partition-based. Therefore, the interval configured by retentionHours and hoursToColdVolume must be divisible by the granularity of the partition.",
77857
+ "",
77858
+ "The system will keep the data with the timestamp of the last retentionHours based on the system time: Data of the last hoursToColdVolume are stored in volumes; Data in [current time - hoursToColdVolumes - checkRange, current time - hoursToColdVolumes) are migrated to coldVolumes. If multiple paths are specified for coldVolumes, the data will be transferred randomly to one of the specified directories.",
77859
+ "",
77860
+ "For other data, only data in the range of [current time - retentionHours - 10 days, current time - retentionHours) are deleted. To delete the data outside the range, you can call function ``dropPartition``.",
77861
+ "",
77862
+ "Note: The function is only applied to a DFS database."
77817
77863
  ]
77818
77864
  }
77819
77865
  ]
@@ -77828,15 +77874,30 @@
77828
77874
  "value": [
77829
77875
  "",
77830
77876
  " $ db=database(\"dfs://db1\",VALUE,2019.06.01..date(now()))",
77831
- " $ retentionHour=7*24",
77832
- " $setRetentionPolicy(db,retentionHour,0);",
77877
+ " $ retentionHour=9*24",
77878
+ " $ hoursToColdVolume=1*24",
77879
+ " $ setRetentionPolicy(db,retentionHour,0, hoursToColdVolume);",
77833
77880
  "",
77834
77881
  " $ schema(db);",
77835
- " partitionSchema->[2019.07.03,2019.07.02,2019.07.01,2019.06.30,2019.06.29,2019.06.28,2019.06.27,2019.06.26,2019.06.25,2019.06.24,...]",
77836
- " databaseDir->dfs://db1",
77882
+ " partitionSchema->[2022.05.05,2022.05.04,2022.05.03,2022.05.02,2022.05.01,2022.04.30,2022.04.29,2022.04.28,2022.04.27,2022.04.26,...]",
77837
77883
  " partitionSites->",
77884
+ " partitionTypeName->VALUE",
77885
+ " hoursToColdVolume->24",
77886
+ " atomic->TRANS",
77887
+ " databaseDir->dfs://db1",
77888
+ " engineType->OLAP",
77889
+ " chunkGranularity->TABLE",
77838
77890
  " retentionDimension->0",
77839
- " retentionHours->168"
77891
+ " partitionType->1",
77892
+ " retentionHours->216",
77893
+ ""
77894
+ ]
77895
+ },
77896
+ {
77897
+ "type": "text",
77898
+ "value": [
77899
+ ".. meta:: ",
77900
+ " :keywords: set"
77840
77901
  ]
77841
77902
  }
77842
77903
  ]
@@ -83449,7 +83510,7 @@
83449
83510
  {
83450
83511
  "type": "text",
83451
83512
  "value": [
83452
- "With function remoteRun:",
83513
+ "use function ``remoteRun`` or ``remoteRunWithCompression``. For example:",
83453
83514
  ""
83454
83515
  ]
83455
83516
  },
@@ -83671,7 +83732,10 @@
83671
83732
  "",
83672
83733
  "`persistOffset` a Boolean value indicating whether to persist the offset of the last processed message in the current subscription. It is used for resubscription and can be obtained with function :doc:`../g/getTopicProcessedOffset`. The default value is false.",
83673
83734
  "",
83674
- "Note: To subscribe to a high-availability stream table, the parameter *persistOffset* should be set to true to prevent data loss on the subscriber.",
83735
+ "Note: ",
83736
+ "",
83737
+ "- To subscribe to a high-availability stream table, the parameter *persistOffset* should be set to true to prevent data loss on the subscriber.",
83738
+ "- To resubscribe from the persisted offset, set *persistOffset* to true and *removeOffset* of function ``unsubscribeTable`` to false.",
83675
83739
  "",
83676
83740
  "`timeTrigger` a Boolean value. If it is set to true, handler is triggered at the intervals specified by parameter throttle even if no new messages arrive. The default value is false.",
83677
83741
  "",