Skip to content

Commit 0adec33

Browse files
authored
Document micro benchmarks (#1555)
1 parent 525d178 commit 0adec33

File tree

3 files changed

+33
-0
lines changed

3 files changed

+33
-0
lines changed

README.md

+12
Original file line numberDiff line numberDiff line change
@@ -210,6 +210,18 @@ Our goal as maintainers is to facilitate the integration
210210
of various features from various contributors, but not to provide the
211211
implementations ourselves, as we simply don't have the resources.
212212

213+
### Benchmarking
214+
215+
There are several micro benchmarks in the `sqlparser_bench` directory.
216+
You can run them with:
217+
218+
```
219+
git checkout main
220+
cd sqlparser_bench
221+
cargo bench
222+
git checkout <your branch>
223+
cargo bench
224+
```
213225

214226
## Licensing
215227

sqlparser_bench/Cargo.toml

+1
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@
1717

1818
[package]
1919
name = "sqlparser_bench"
20+
description = "Benchmarks for sqlparser"
2021
version = "0.1.0"
2122
authors = ["Dandandan <[email protected]>"]
2223
edition = "2018"

sqlparser_bench/README.md

+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
<!---
2+
Licensed to the Apache Software Foundation (ASF) under one
3+
or more contributor license agreements. See the NOTICE file
4+
distributed with this work for additional information
5+
regarding copyright ownership. The ASF licenses this file
6+
to you under the Apache License, Version 2.0 (the
7+
"License"); you may not use this file except in compliance
8+
with the License. You may obtain a copy of the License at
9+
10+
http://www.apache.org/licenses/LICENSE-2.0
11+
12+
Unless required by applicable law or agreed to in writing,
13+
software distributed under the License is distributed on an
14+
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15+
KIND, either express or implied. See the License for the
16+
specific language governing permissions and limitations
17+
under the License.
18+
-->
19+
20+
Benchmarks for sqlparser. See [the main README](../README.md) for more information.

0 commit comments

Comments
 (0)