counterweight/query-performance-gauge
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Updated readme.

Browse source
This commit is contained in:
Pablo Martin 2022-08-22 15:05:59 +02:00
parent 10a7d379f2
commit ee51c82145
1 changed files with 10 additions and 6 deletions
Download patch file Download diff file Expand all files Collapse all files

16
readme.md
View file

@ -16,28 +16,32 @@ You will install whatever version is in the shared drive at that point. Dependin
might want to instead make a copy of the repository in your own local machine and install from there. That way, you
won't be affected by someone making `git checkout` in the shared drive.
2. Afterwards, you need to make a config file. See below details on how to compose one.
2. Afterwards, you need to make a credentials and a query config file. See below details on how to compose one.
3. Once you have your config file ready, run the following command from the terminal.
```commandline
measure_query_performance --config my_config_file.json
measure_query_performance --credentials my_credentials.json --queries my_queries.json
```
4. Results will be printed in your console as they are available. If instead you would like to store them in a file, a
quick and easy hack is to redirect output in Powershell to a file. You can do it like this:
```commandline
measure_query_performance --config my_config_file.json | Out-File -FilePath my_results.txt
measure_query_performance --credentials my_credentials.json --queries my_queries.json | Out-File -FilePath my_results.txt
```
## Composing a config file
## Composing config files
The application takes two config files: one for the credentials and connection details, one for the queries to run.
You can mix and match several of both (as in, you can run the same query set at different dbs, or you can have
multiple query sets run on the same database).
You can take a look at examples for different setups in `config_examples`. If you want to make a new config file, it
will probably be easier for you to start from one of those templates.
will probably be easier for you to start from one of those templates. The legacy examples should be ignored unless
you want to understand outdated config files.
A few notes:
- The valid engines are `"trino"` and `"mysql"`.
- You can place as many queries as you would like in the `queries_to_measure` list.
- I advice you to make the first query a silly, fast query such as `SELECT 1` to validate your connection and