diff --git a/readme.md b/readme.md index 476b275..5522b7e 100644 --- a/readme.md +++ b/readme.md @@ -9,10 +9,12 @@ several queries and measure how long it takes for results to come back to your l Drive Shared Drive replicated locally, you can do it like this: ```commandline -pip install "git+file:///g:\shared drives\data drive\90 useful\10 query_performance_gauge@master"``` +pip install "file:///g:\shared drives\data drive\90 useful\10 query_performance_gauge" ``` -If not, you simply need to clone the repo somewhere in your machine and replace the path in the previous command. +You will install whatever version is in the shared drive at that point. Depending on what you want to achieve, you +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. @@ -26,7 +28,7 @@ measure_query_performance --config my_config_file.json 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 --config my_config_file.json | Out-File -FilePath my_results.txt ``` ## Composing a config file @@ -48,6 +50,8 @@ A few notes: ## A few more details - Queries are run sequentially, as in the second query will only start after the first query is finished. +- The script will run all queries, even if there is an exception when running one or more of them. If one query + fails, the error traceback will be printed so you can debug and the script will move on to the next query. - For this to work, your local machine must have access and permission to the connection you are targeting, so remember to set up VPNs and other necessary configs properly. - A peculiarity: when using MySQL through an SSH tunnel, the port number used by the remote MySQL should be