Merge branch 'main' into mysql-users

Author: mvzink

.github/workflows/rust.yml

@@ -37,6 +37,14 @@ jobs:
         uses: ./.github/actions/setup-builder
       - run: cargo clippy --all-targets --all-features -- -D warnings
 
+  benchmark-lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Setup Rust Toolchain
+        uses: ./.github/actions/setup-builder
+      - run: cd sqlparser_bench && cargo clippy --all-targets --all-features -- -D warnings
+
   compile:
     runs-on: ubuntu-latest
     steps:

README.md

@@ -240,11 +240,14 @@ You can run them with:
 ```
 git checkout main
 cd sqlparser_bench
-cargo bench
+cargo bench -- --save-baseline main
 git checkout <your branch>
-cargo bench
+cargo bench -- --baseline main
 ```
 
+By adding the `--save-baseline main` and `--baseline main` you can track the
+progress of your improvements as you continue working on the feature branch.
+
 ## Licensing
 
 All code in this repository is licensed under the [Apache Software License 2.0](LICENSE.txt).

sqlparser_bench/README.md

@@ -17,4 +17,26 @@
   under the License.
 -->
 
-Benchmarks for sqlparser. See [the main README](../README.md) for more information.
+Benchmarks for sqlparser. See [the main README](../README.md) for more information.
+
+Note: this is in a separate, non workspace crate to avoid adding a dependency 
+on `criterion` to the main crate (which complicates testing without std).
+
+# Running Benchmarks
+
+```shell
+cargo bench --bench sqlparser_bench
+```
+
+# Profiling
+
+Note you can generate a [flamegraph] using the following command:
+
+```shell
+cargo flamegraph --bench sqlparser_bench
+```
+
+[flamegraph]: https://crates.io/crates/flamegraph
+
+Here is an example flamegraph:
+![flamegraph](img/flamegraph.svg)

sqlparser_bench/benches/sqlparser_bench.rs

@@ -78,8 +78,7 @@ fn basic_queries(c: &mut Criterion) {
 
     group.bench_function("format_large_statement", |b| {
         b.iter(|| {
-            let formatted_query = large_statement.to_string();
-            assert_eq!(formatted_query, large_statement);
+            let _formatted_query = large_statement.to_string();
         });
     });
 }