Skip to content
This repository was archived by the owner on Aug 16, 2021. It is now read-only.

Commit 00118e9

Browse files
NikolaySNikolayS
committed
retab
1 parent dd75c0d commit 00118e9

File tree

1 file changed

+111
-111
lines changed

1 file changed

+111
-111
lines changed

‎nancy_run.sh

Lines changed: 111 additions & 111 deletions
Original file line numberDiff line numberDiff line change
@@ -16,180 +16,180 @@ while true; do
1616
1717
\033[1mDESCRIPTION\033[22m
1818
19-
Nancy is a member of Postgres.ai's Artificial DBA team
20-
responsible for conducting experiments.
21-
22-
Use 'nancy run' to request a new run for some experiment
23-
being conducted.
24-
25-
An experiment consists of one or more 'runs'. For instance,
26-
if Nancy is being used to verify that a new index will
27-
affect performance only in a positive way, two runs are needed.
28-
If one needs to only collect query plans for each query group,
29-
a single run is enough. And finally, if there is a goal to
30-
find an optimal value for some PostgreSQL setting,
31-
multiple runs will be needed to check how various
32-
values of specified setting affect performance
33-
of specified database and workload.
34-
35-
4 main parts of each run are:
36-
- environment: where it will happen, PostgreSQL version, etc;
37-
- database: copy or clone of some database;
38-
- workload: 'real' workload or custom SQL;
39-
- target: PostgreSQL config changes or some DDL such as
40-
'CREATE INDEX ...'.
19+
Nancy is a member of Postgres.ai's Artificial DBA team
20+
responsible for conducting experiments.
21+
22+
Use 'nancy run' to request a new run for some experiment
23+
being conducted.
24+
25+
An experiment consists of one or more 'runs'. For instance,
26+
if Nancy is being used to verify that a new index will
27+
affect performance only in a positive way, two runs are needed.
28+
If one needs to only collect query plans for each query group,
29+
a single run is enough. And finally, if there is a goal to
30+
find an optimal value for some PostgreSQL setting,
31+
multiple runs will be needed to check how various
32+
values of specified setting affect performance
33+
of specified database and workload.
34+
35+
4 main parts of each run are:
36+
- environment: where it will happen, PostgreSQL version, etc;
37+
- database: copy or clone of some database;
38+
- workload: 'real' workload or custom SQL;
39+
- target: PostgreSQL config changes or some DDL such as
40+
'CREATE INDEX ...'.
4141
4242
\033[1mOPTIONS\033[22m
4343
44-
NOTICE: A value for a string option that starts with 'file://'
45-
is treated as a path to a local file. A string value
46-
starting with 's3://' is treated as a path
47-
to remote file located in S3 (AWS S3 or its analog).
48-
Otherwise, a string values is considered as 'content',
49-
not a link to a file.
44+
NOTICE: A value for a string option that starts with 'file://'
45+
is treated as a path to a local file. A string value
46+
starting with 's3://' is treated as a path
47+
to remote file located in S3 (AWS S3 or its analog).
48+
Otherwise, a string values is considered as 'content',
49+
not a link to a file.
5050
51-
\033[1m--debug\033[22m (boolean)
51+
\033[1m--debug\033[22m (boolean)
5252
53-
Turn on debug logging.
53+
Turn on debug logging.
5454
55-
\033[1m--debug-timeout\033[22m (string)
55+
\033[1m--debug-timeout\033[22m (string)
5656
57-
How many seconds the entity (Docker container, Docker machine)
58-
where experimental run is being made will be alive after the
59-
main activity is finished. This is useful for various debugging:
60-
one can access container via ssh / docker exec and see PostgreSQL
61-
with data, logs, etc.
57+
How many seconds the entity (Docker container, Docker machine)
58+
where experimental run is being made will be alive after the
59+
main activity is finished. This is useful for various debugging:
60+
one can access container via ssh / docker exec and see PostgreSQL
61+
with data, logs, etc.
6262
63-
\033[1m--run-on\033[22m (string)
63+
\033[1m--run-on\033[22m (string)
6464
65-
Specify, where the experimental run will take place
65+
Specify, where the experimental run will take place
6666
67-
* 'localhost' (default)
67+
* 'localhost' (default)
6868
69-
* aws
69+
* aws
7070
71-
* gcp (WIP)
71+
* gcp (WIP)
7272
73-
If 'localhost' is specified (or --run-on is omitted),
74-
Nancy will perform the run on the localhost in a Docker container
75-
so (`docker run` must work locally).
73+
If 'localhost' is specified (or --run-on is omitted),
74+
Nancy will perform the run on the localhost in a Docker container
75+
so (`docker run` must work locally).
7676
77-
If 'aws' is specified, Nancy will use a Docker machine with a single
78-
container running on an EC2 Spot instance.
77+
If 'aws' is specified, Nancy will use a Docker machine with a single
78+
container running on an EC2 Spot instance.
7979
80-
\033[1m--pg-version\033[22m (string)
80+
\033[1m--pg-version\033[22m (string)
8181
82-
Specify Major PostgreSQL version.
82+
Specify Major PostgreSQL version.
8383
84-
* 9.6 (default)
84+
* 9.6 (default)
8585
86-
* 10
86+
* 10
8787
88-
* 11devel (WIP)
88+
* 11devel (WIP)
8989
90-
\033[1m--pg-config\033[22m (string)
90+
\033[1m--pg-config\033[22m (string)
9191
92-
Specify PostgreSQL config to be used (may be partial).
92+
Specify PostgreSQL config to be used (may be partial).
9393
94-
\033[1m--db-prepared-snapshot\033[22m (string)
94+
\033[1m--db-prepared-snapshot\033[22m (string)
9595
96-
Reserved / Not yet implemented.
96+
Reserved / Not yet implemented.
9797
98-
\033[1m--db-dump-path\033[22m (string)
98+
\033[1m--db-dump-path\033[22m (string)
9999
100-
Specify the path to database dump (creted by pg_dump) to be used
101-
as an input.
100+
Specify the path to database dump (creted by pg_dump) to be used
101+
as an input.
102102
103-
\033[1m--after-db-init-code\033[22m (string)
103+
\033[1m--after-db-init-code\033[22m (string)
104104
105-
Specify additional commands to be executed after database
106-
is initiated (dump loaded or snapshot attached).
105+
Specify additional commands to be executed after database
106+
is initiated (dump loaded or snapshot attached).
107107
108-
\033[1m--workload-full-path\033[22m (string)
108+
\033[1m--workload-full-path\033[22m (string)
109109
110-
Path to 'real' workload prepared by using `nancy prepare-workload`.
110+
Path to 'real' workload prepared by using `nancy prepare-workload`.
111111
112-
\033[1m--workload-basis-path\033[22m (string)
112+
\033[1m--workload-basis-path\033[22m (string)
113113
114-
Reserved / Not yet implemented.
114+
Reserved / Not yet implemented.
115115
116-
\033[1m--workload-custom-sql\033[22m (string)
116+
\033[1m--workload-custom-sql\033[22m (string)
117117
118-
Specify custom SQL queries to be used as an input.
118+
Specify custom SQL queries to be used as an input.
119119
120-
\033[1m--workload-replay-speed\033[22m (string)
120+
\033[1m--workload-replay-speed\033[22m (string)
121121
122-
Reserved / Not yet implemented.
122+
Reserved / Not yet implemented.
123123
124-
\033[1m--target-ddl-do\033[22m (string)
124+
\033[1m--target-ddl-do\033[22m (string)
125125
126-
SQL changing database somehow before workload is applied.
127-
'Do DDL' example:
126+
SQL changing database somehow before workload is applied.
127+
'Do DDL' example:
128128
129-
create index i_t1_experiment on t1 using btree(col1);
130-
vacuum analyze t1;
129+
create index i_t1_experiment on t1 using btree(col1);
130+
vacuum analyze t1;
131131
132-
\033[1m--target-ddl-undo\033[22m (string)
132+
\033[1m--target-ddl-undo\033[22m (string)
133133
134-
SQL reverting changes produced by those specified in the
135-
the value of the `--target-ddl-do` option. Reverting allows
136-
to serialize multiple runs, but it might be not possible
137-
in some cases. 'Undo DDL' example:
134+
SQL reverting changes produced by those specified in the
135+
the value of the `--target-ddl-do` option. Reverting allows
136+
to serialize multiple runs, but it might be not possible
137+
in some cases. 'Undo DDL' example:
138138
139-
drop index i_t1_experiment;
139+
drop index i_t1_experiment;
140140
141-
\033[1m--target-config\033[22m (string)
141+
\033[1m--target-config\033[22m (string)
142142
143-
Config changes to be applied to postgresql.conf before
144-
workload is applied. Once configuration changes are made,
145-
PostgreSQL is restarted. Example:
143+
Config changes to be applied to postgresql.conf before
144+
workload is applied. Once configuration changes are made,
145+
PostgreSQL is restarted. Example:
146146
147-
random_page_cost = 1.1
147+
random_page_cost = 1.1
148148
149-
\033[1m--artifacts-destination\033[22m (string)
149+
\033[1m--artifacts-destination\033[22m (string)
150150
151-
Path to a local ('file://...') or S3 ('s3://...') directory
152-
where Nancy will put all collected results of the run,
153-
including:
151+
Path to a local ('file://...') or S3 ('s3://...') directory
152+
where Nancy will put all collected results of the run,
153+
including:
154154
155-
* detailed performance report in JSON format
155+
* detailed performance report in JSON format
156156
157-
* whole PostgreSQL log, gzipped
157+
* whole PostgreSQL log, gzipped
158158
159-
\033[1m--aws-ec2-type\033[22m (string)
159+
\033[1m--aws-ec2-type\033[22m (string)
160160
161-
EC2 instance type where the run will be performed. EC2 Spot
162-
instance will be used. WARNING: 'i3-metal' instances are
163-
not currently supported (WIP).
161+
EC2 instance type where the run will be performed. EC2 Spot
162+
instance will be used. WARNING: 'i3-metal' instances are
163+
not currently supported (WIP).
164164
165-
The option may be used only with `--run-on aws`.
165+
The option may be used only with `--run-on aws`.
166166
167-
\033[1m--aws-keypair-name\033[22m (string)
167+
\033[1m--aws-keypair-name\033[22m (string)
168168
169-
THe name of key pair used on EC2 instance to allow accessing
170-
to it. Must correspond to the value of the `--aws-ssh-key-path`
171-
option.
169+
THe name of key pair used on EC2 instance to allow accessing
170+
to it. Must correspond to the value of the `--aws-ssh-key-path`
171+
option.
172172
173-
The option may be used only with `--run-on aws`.
173+
The option may be used only with `--run-on aws`.
174174
175-
\033[1m--aws-ssh-key-path\033[22m (string)
175+
\033[1m--aws-ssh-key-path\033[22m (string)
176176
177-
Path to SSH key file (usually, has '.pem' extension).
177+
Path to SSH key file (usually, has '.pem' extension).
178178
179-
The option may be used only with `--run-on aws`.
179+
The option may be used only with `--run-on aws`.
180180
181-
\033[1m--s3cfg-path\033[22m
181+
\033[1m--s3cfg-path\033[22m
182182
183-
The path the '.s3cfg' configuration file to be used when
184-
accessing files in S3. This file must be local and must
185-
be specified if some options' values are in 's3://***'
186-
format.
183+
The path the '.s3cfg' configuration file to be used when
184+
accessing files in S3. This file must be local and must
185+
be specified if some options' values are in 's3://***'
186+
format.
187187
188-
See also: https://github.com/s3tools/s3cmd
188+
See also: https://github.com/s3tools/s3cmd
189189
190190
\033[1mSEE ALSO\033[22m
191191
192-
'nancy help'
192+
'nancy help'
193193
194194
"
195195
exit ;;

0 commit comments

Comments
 (0)