This is an automated email from the ASF dual-hosted git repository.
alamb pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/datafusion-sqlparser-rs.git
The following commit(s) were added to refs/heads/main by this push:
new 0adec33b Document micro benchmarks (#1555)
0adec33b is described below
commit 0adec33b94241f19273c371057bc8ad15e849ef4
Author: Andrew Lamb <[email protected]>
AuthorDate: Tue Nov 26 11:11:56 2024 -0500
Document micro benchmarks (#1555)
---
README.md | 12 ++++++++++++
sqlparser_bench/Cargo.toml | 1 +
sqlparser_bench/README.md | 20 ++++++++++++++++++++
3 files changed, 33 insertions(+)
diff --git a/README.md b/README.md
index 934d9d06..f44300f5 100644
--- a/README.md
+++ b/README.md
@@ -210,6 +210,18 @@ Our goal as maintainers is to facilitate the integration
of various features from various contributors, but not to provide the
implementations ourselves, as we simply don't have the resources.
+### Benchmarking
+
+There are several micro benchmarks in the `sqlparser_bench` directory.
+You can run them with:
+
+```
+git checkout main
+cd sqlparser_bench
+cargo bench
+git checkout <your branch>
+cargo bench
+```
## Licensing
diff --git a/sqlparser_bench/Cargo.toml b/sqlparser_bench/Cargo.toml
index 9c33658a..2c1f0ae4 100644
--- a/sqlparser_bench/Cargo.toml
+++ b/sqlparser_bench/Cargo.toml
@@ -17,6 +17,7 @@
[package]
name = "sqlparser_bench"
+description = "Benchmarks for sqlparser"
version = "0.1.0"
authors = ["Dandandan <[email protected]>"]
edition = "2018"
diff --git a/sqlparser_bench/README.md b/sqlparser_bench/README.md
new file mode 100644
index 00000000..4cdcfb29
--- /dev/null
+++ b/sqlparser_bench/README.md
@@ -0,0 +1,20 @@
+<!---
+ Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+-->
+
+Benchmarks for sqlparser. See [the main README](../README.md) for more
information.
\ No newline at end of file
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
