Merge pull request #2341 from dolthub/gitbook-dev

update perf, pick up other changes
dolthub · Sep 9, 2024 · bd57d28 · bd57d28
2 parents f1a11ca + b8b2dba
commit bd57d28
Show file tree

Hide file tree

Showing 2 changed files with 40 additions and 7 deletions.
diff --git a/packages/dolt/content/reference/sql/benchmarks/latency.md b/packages/dolt/content/reference/sql/benchmarks/latency.md
@@ -28,20 +28,20 @@ attempt to run as many queries as possible in a fixed 2 minute time
 window. The `Dolt` and `MySQL` columns show the median latency in 
 milliseconds (ms) of each query during that 2 minute time window.
 
-The Dolt version is `1.42.17`.
+The Dolt version is `1.42.18`.
 
 <!-- START___DOLT___LATENCY_RESULTS_TABLE -->
 |       Read Tests        | MySQL |  Dolt  | Multiple |
 |-------------------------|-------|--------|----------|
-| covering\_index\_scan   |  2.07 |   0.65 |      0.3 |
-| groupby\_scan           |  13.7 |  16.71 |      1.2 |
+| covering\_index\_scan   |  2.07 |   0.67 |      0.3 |
+| groupby\_scan           | 13.22 |  16.41 |      1.2 |
 | index\_join             |  1.37 |   2.66 |      1.9 |
 | index\_join\_scan       |   1.3 |   2.11 |      1.6 |
-| index\_scan             | 34.95 |  54.83 |      1.6 |
+| index\_scan             | 34.33 |  54.83 |      1.6 |
 | oltp\_point\_select     |  0.18 |    0.3 |      1.7 |
-| oltp\_read\_only        |  3.49 |   5.77 |      1.7 |
+| oltp\_read\_only        |  3.49 |   5.88 |      1.7 |
 | select\_random\_points  |  0.34 |   0.67 |      2.0 |
-| select\_random\_ranges  |  0.39 |   0.69 |      1.8 |
+| select\_random\_ranges  |  0.39 |    0.7 |      1.8 |
 | table\_scan             | 34.95 |  54.83 |      1.6 |
 | types\_table\_scan      | 75.82 | 144.97 |      1.9 |
 | reads\_mean\_multiplier |       |        |      1.6 |
@@ -59,7 +59,7 @@ The Dolt version is `1.42.17`.
 
 |    TPC-C TPS Tests    | MySQL | Dolt  | Multiple |
 |-----------------------|-------|-------|----------|
-| tpcc-scale-factor-1   | 98.27 | 39.08 |      2.5 |
+| tpcc-scale-factor-1   | 98.44 | 39.11 |      2.5 |
 | tpcc\_tps\_multiplier |       |       |      2.5 |
 
 | Overall Mean Multiple | 1.67 |

diff --git a/packages/dolt/content/reference/sql/version-control/dolt-sql-procedures.md b/packages/dolt/content/reference/sql/version-control/dolt-sql-procedures.md
@@ -27,6 +27,11 @@ title: Dolt SQL Procedures
   - [dolt_tag()](#dolt_tag)
   - [dolt_undrop()](#dolt_undrop)
   - [dolt_verify_constraints()](#dolt_verify_constraints)
+- [Statistics Updates](#statistics-updates)
+  - [dolt_stats_restart()](#dolt_stats_restart)
+  - [dolt_stats_stop()](#dolt_stats_stop)
+  - [dolt_stats_status()](#dolt_stats_status)
+  - [dolt_stats_drop()](#dolt_stats_drop)
 - [Access Control](#access-control)
 # Dolt SQL Procedures
 
@@ -1587,6 +1592,34 @@ SELECT * from dolt_constraint_violations_child;
 */
 ```
 
+# Statistics Updates
+
+Control functions are used to start and stop background thread activity related to statistics updates.
+See [stats documentation](../sql-support/miscellaneous.md#stats-controller-functions) for more information.
+
+## `dolt_stats_restart()`
+
+If no thread is active for the current database, start a new update
+thread with the current session's interval and threshold parameters
+(`dolt_stats_auto_refresh_interval` and
+`dolt_stats_auto_refresh_threshold`).  If a thread is already active for
+this database, the thread is stopped and started with the new
+parameters.
+
+## `dolt_stats_stop()`
+
+Stop the update thread for the current database
+(otherwise no-op).
+
+## `dolt_stats_status()`
+
+Returns the latest update to statistics for the current database.
+
+## `dolt_stats_drop()`
+
+Deletes the stats ref on disk and wipes the database stats held in memory for the current database.
+Stops update thread if active.
+
 # Access Control
 Dolt stored procedures are access controlled using the GRANT permissions system. MySQL database permissions trickle down to tables and procedures, someone who has Execute permission on a database would have Execute permission on all procedures related to that database. Dolt deviates moderately from this behavior for sensitive operations. See [Administrative Procedures](#administrative-procedures) below.