Movatterモバイル変換

[0]ホーム
URL:

Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

 Sign up
Appearance settings

Commit384a3c7

Browse files
committed
Updated docs
1 parent928c31f commit384a3c7

File tree

7 files changed

+139
-525
lines changed

7 files changed

+139
-525
lines changed

‎_sources/testgres.rst.txt

Lines changed: 6 additions & 59 deletions
Original file line numberDiff line numberDiff line change
@@ -17,21 +17,14 @@ testgres.backup
1717
:undoc-members:
1818
:show-inheritance:
1919

20-
testgres.cache
21-
--------------
22-
23-
..automodule::testgres.cache
24-
:members:
25-
:undoc-members:
26-
:show-inheritance:
27-
2820
testgres.config
2921
---------------
3022

3123
..automodule::testgres.config
3224
:members:
3325
:undoc-members:
3426
:show-inheritance:
27+
:member-order: groupwise
3528

3629
testgres.connection
3730
-------------------
@@ -41,30 +34,6 @@ testgres.connection
4134
:undoc-members:
4235
:show-inheritance:
4336

44-
testgres.consts
45-
---------------
46-
47-
..automodule::testgres.consts
48-
:members:
49-
:undoc-members:
50-
:show-inheritance:
51-
52-
testgres.decorators
53-
-------------------
54-
55-
..automodule::testgres.decorators
56-
:members:
57-
:undoc-members:
58-
:show-inheritance:
59-
60-
testgres.defaults
61-
-----------------
62-
63-
..automodule::testgres.defaults
64-
:members:
65-
:undoc-members:
66-
:show-inheritance:
67-
6837
testgres.enums
6938
--------------
7039

@@ -81,35 +50,13 @@ testgres.exceptions
8150
:undoc-members:
8251
:show-inheritance:
8352

84-
testgres.logger
85-
---------------
86-
87-
..automodule::testgres.logger
88-
:members:
89-
:undoc-members:
90-
:show-inheritance:
91-
9253
testgres.node
9354
-------------
9455

95-
..automodule::testgres.node
96-
:members:
97-
:undoc-members:
98-
:show-inheritance:
56+
..autoclass::testgres.node.PostgresNode
57+
:members:
9958

100-
testgres.utils
101-
--------------
59+
..automethod::__init__
10260

103-
..automodule::testgres.utils
104-
:members:
105-
:undoc-members:
106-
:show-inheritance:
107-
108-
109-
Module contents
110-
---------------
111-
112-
..automodule::testgres
113-
:members:
114-
:undoc-members:
115-
:show-inheritance:
61+
..autoclass::testgres.node.ProcessProxy
62+
:members:

‎genindex.html

Lines changed: 25 additions & 93 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,8 @@
3434
<h1id="index">Index</h1>
3535

3636
<divclass="genindex-jumpbox">
37-
<ahref="#A"><strong>A</strong></a>
37+
<ahref="#_"><strong>_</strong></a>
38+
|<ahref="#A"><strong>A</strong></a>
3839
|<ahref="#B"><strong>B</strong></a>
3940
|<ahref="#C"><strong>C</strong></a>
4041
|<ahref="#D"><strong>D</strong></a>
@@ -44,7 +45,6 @@ <h1 id="index">Index</h1>
4445
|<ahref="#I"><strong>I</strong></a>
4546
|<ahref="#K"><strong>K</strong></a>
4647
|<ahref="#L"><strong>L</strong></a>
47-
|<ahref="#M"><strong>M</strong></a>
4848
|<ahref="#N"><strong>N</strong></a>
4949
|<ahref="#P"><strong>P</strong></a>
5050
|<ahref="#Q"><strong>Q</strong></a>
@@ -56,6 +56,14 @@ <h1 id="index">Index</h1>
5656
|<ahref="#X"><strong>X</strong></a>
5757

5858
</div>
59+
<h2id="_">_</h2>
60+
<tablestyle="width: 100%"class="indextable genindextable"><tr>
61+
<tdstyle="width: 33%; vertical-align: top;"><ul>
62+
<li><ahref="testgres.html#testgres.node.PostgresNode.__init__">__init__() (testgres.node.PostgresNode method)</a>
63+
</li>
64+
</ul></td>
65+
</tr></table>
66+
5967
<h2id="A">A</h2>
6068
<tablestyle="width: 100%"class="indextable genindextable"><tr>
6169
<tdstyle="width: 33%; vertical-align: top;"><ul>
@@ -82,8 +90,6 @@ <h2 id="B">B</h2>
8290
</ul></td>
8391
<tdstyle="width: 33%; vertical-align: top;"><ul>
8492
<li><ahref="testgres.html#testgres.exceptions.BackupException">BackupException</a>
85-
</li>
86-
<li><ahref="testgres.html#testgres.node.PostgresNode.base_dir">base_dir (testgres.node.PostgresNode attribute)</a>
8793
</li>
8894
<li><ahref="testgres.html#testgres.connection.NodeConnection.begin">begin() (testgres.connection.NodeConnection method)</a>
8995
</li>
@@ -93,15 +99,13 @@ <h2 id="B">B</h2>
9399
<h2id="C">C</h2>
94100
<tablestyle="width: 100%"class="indextable genindextable"><tr>
95101
<tdstyle="width: 33%; vertical-align: top;"><ul>
96-
<li><ahref="testgres.html#testgres.config.GlobalConfig.cache_initdb">cache_initdb (testgres.config.GlobalConfig attribute)</a>,<ahref="testgres.html#testgres.config.GlobalConfig.cache_initdb">[1]</a>
102+
<li><ahref="testgres.html#testgres.config.GlobalConfig.cache_initdb">cache_initdb (testgres.config.GlobalConfig attribute)</a>
97103
</li>
98-
<li><ahref="testgres.html#testgres.config.GlobalConfig.cache_pg_config">cache_pg_config (testgres.config.GlobalConfig attribute)</a>,<ahref="testgres.html#testgres.config.GlobalConfig.cache_pg_config">[1]</a>
104+
<li><ahref="testgres.html#testgres.config.GlobalConfig.cache_pg_config">cache_pg_config (testgres.config.GlobalConfig attribute)</a>
99105
</li>
100-
<li><ahref="testgres.html#testgres.cache.cached_initdb">cached_initdb() (in moduletestgres.cache)</a>
106+
<li><ahref="testgres.html#testgres.config.GlobalConfig.cached_initdb_dir">cached_initdb_dir (testgres.config.GlobalConfig attribute)</a>
101107
</li>
102-
<li><ahref="testgres.html#testgres.config.GlobalConfig.cached_initdb_dir">cached_initdb_dir (testgres.config.GlobalConfig attribute)</a>,<ahref="testgres.html#testgres.config.GlobalConfig.cached_initdb_dir">[1]</a>
103-
</li>
104-
<li><ahref="testgres.html#testgres.config.GlobalConfig.cached_initdb_unique">cached_initdb_unique (testgres.config.GlobalConfig attribute)</a>,<ahref="testgres.html#testgres.config.GlobalConfig.cached_initdb_unique">[1]</a>
108+
<li><ahref="testgres.html#testgres.config.GlobalConfig.cached_initdb_unique">cached_initdb_unique (testgres.config.GlobalConfig attribute)</a>
105109
</li>
106110
<li><ahref="testgres.html#testgres.node.PostgresNode.catchup">catchup() (testgres.node.PostgresNode method)</a>
107111
</li>
@@ -113,8 +117,6 @@ <h2 id="C">C</h2>
113117
</li>
114118
</ul></td>
115119
<tdstyle="width: 33%; vertical-align: top;"><ul>
116-
<li><ahref="testgres.html#testgres.utils.clean_on_error">clean_on_error() (in module testgres.utils)</a>
117-
</li>
118120
<li><ahref="testgres.html#testgres.backup.NodeBackup.cleanup">cleanup() (testgres.backup.NodeBackup method)</a>
119121

120122
<ul>
@@ -141,16 +143,10 @@ <h2 id="C">C</h2>
141143
<h2id="D">D</h2>
142144
<tablestyle="width: 100%"class="indextable genindextable"><tr>
143145
<tdstyle="width: 33%; vertical-align: top;"><ul>
144-
<li><ahref="testgres.html#testgres.node.PostgresNode.data_dir">data_dir (testgres.node.PostgresNode attribute)</a>
145-
</li>
146146
<li><ahref="testgres.html#testgres.node.PostgresNode.default_conf">default_conf() (testgres.node.PostgresNode method)</a>
147147
</li>
148148
</ul></td>
149149
<tdstyle="width: 33%; vertical-align: top;"><ul>
150-
<li><ahref="testgres.html#testgres.defaults.default_dbname">default_dbname() (in module testgres.defaults)</a>
151-
</li>
152-
<li><ahref="testgres.html#testgres.defaults.default_username">default_username() (in module testgres.defaults)</a>
153-
</li>
154150
<li><ahref="testgres.html#testgres.node.PostgresNode.dump">dump() (testgres.node.PostgresNode method)</a>
155151
</li>
156152
</ul></td>
@@ -159,9 +155,7 @@ <h2 id="D">D</h2>
159155
<h2id="E">E</h2>
160156
<tablestyle="width: 100%"class="indextable genindextable"><tr>
161157
<tdstyle="width: 33%; vertical-align: top;"><ul>
162-
<li><ahref="testgres.html#testgres.utils.eprint">eprint() (in module testgres.utils)</a>
163-
</li>
164-
<li><ahref="testgres.html#testgres.config.GlobalConfig.error_log_lines">error_log_lines (testgres.config.GlobalConfig attribute)</a>,<ahref="testgres.html#testgres.config.GlobalConfig.error_log_lines">[1]</a>
158+
<li><ahref="testgres.html#testgres.config.GlobalConfig.error_log_lines">error_log_lines (testgres.config.GlobalConfig attribute)</a>
165159
</li>
166160
<li><ahref="testgres.html#testgres.connection.NodeConnection.execute">execute() (testgres.connection.NodeConnection method)</a>
167161

@@ -171,8 +165,6 @@ <h2 id="E">E</h2>
171165
</ul></li>
172166
</ul></td>
173167
<tdstyle="width: 33%; vertical-align: top;"><ul>
174-
<li><ahref="testgres.html#testgres.utils.execute_utility">execute_utility() (in module testgres.utils)</a>
175-
</li>
176168
<li><ahref="testgres.html#testgres.exceptions.ExecUtilException">ExecUtilException</a>
177169
</li>
178170
</ul></td>
@@ -185,8 +177,6 @@ <h2 id="F">F</h2>
185177
</li>
186178
</ul></td>
187179
<tdstyle="width: 33%; vertical-align: top;"><ul>
188-
<li><ahref="testgres.html#testgres.utils.file_tail">file_tail() (in module testgres.utils)</a>
189-
</li>
190180
<li><ahref="testgres.html#testgres.node.PostgresNode.free_port">free_port() (testgres.node.PostgresNode method)</a>
191181
</li>
192182
</ul></td>
@@ -195,19 +185,11 @@ <h2 id="F">F</h2>
195185
<h2id="G">G</h2>
196186
<tablestyle="width: 100%"class="indextable genindextable"><tr>
197187
<tdstyle="width: 33%; vertical-align: top;"><ul>
198-
<li><ahref="testgres.html#testgres.defaults.generate_app_name">generate_app_name() (in module testgres.defaults)</a>
199-
</li>
200-
<li><ahref="testgres.html#testgres.defaults.generate_system_id">generate_system_id() (in module testgres.defaults)</a>
201-
</li>
202-
<li><ahref="testgres.html#testgres.utils.get_bin_path">get_bin_path() (in module testgres.utils)</a>
188+
<li><ahref="testgres.html#testgres.node.PostgresNode.get_control_data">get_control_data() (testgres.node.PostgresNode method)</a>
203189
</li>
204190
</ul></td>
205191
<tdstyle="width: 33%; vertical-align: top;"><ul>
206-
<li><ahref="testgres.html#testgres.node.PostgresNode.get_control_data">get_control_data() (testgres.node.PostgresNode method)</a>
207-
</li>
208-
<li><ahref="testgres.html#testgres.utils.get_pg_config">get_pg_config() (in module testgres.utils)</a>
209-
</li>
210-
<li><ahref="testgres.html#testgres.utils.get_pg_version">get_pg_version() (in module testgres.utils)</a>
192+
<li><ahref="testgres.html#testgres.api.get_new_node">get_new_node() (in module testgres.api)</a>
211193
</li>
212194
<li><ahref="testgres.html#testgres.config.GlobalConfig">GlobalConfig (class in testgres.config)</a>
213195
</li>
@@ -246,20 +228,6 @@ <h2 id="L">L</h2>
246228
</ul></td>
247229
<tdstyle="width: 33%; vertical-align: top;"><ul>
248230
<li><ahref="testgres.html#testgres.enums.ProcessType.LogicalReplicationLauncher">LogicalReplicationLauncher (testgres.enums.ProcessType attribute)</a>
249-
</li>
250-
<li><ahref="testgres.html#testgres.node.PostgresNode.logs_dir">logs_dir (testgres.node.PostgresNode attribute)</a>
251-
</li>
252-
</ul></td>
253-
</tr></table>
254-
255-
<h2id="M">M</h2>
256-
<tablestyle="width: 100%"class="indextable genindextable"><tr>
257-
<tdstyle="width: 33%; vertical-align: top;"><ul>
258-
<li><ahref="testgres.html#testgres.node.PostgresNode.master">master (testgres.node.PostgresNode attribute)</a>
259-
</li>
260-
</ul></td>
261-
<tdstyle="width: 33%; vertical-align: top;"><ul>
262-
<li><ahref="testgres.html#testgres.decorators.method_decorator">method_decorator() (in module testgres.decorators)</a>
263231
</li>
264232
</ul></td>
265233
</tr></table>
@@ -269,11 +237,11 @@ <h2 id="N">N</h2>
269237
<tdstyle="width: 33%; vertical-align: top;"><ul>
270238
<li><ahref="testgres.html#testgres.connection.NodeConnection.node">node (testgres.connection.NodeConnection attribute)</a>
271239
</li>
272-
<li><ahref="testgres.html#testgres.config.GlobalConfig.node_cleanup_full">node_cleanup_full (testgres.config.GlobalConfig attribute)</a>,<ahref="testgres.html#testgres.config.GlobalConfig.node_cleanup_full">[1]</a>
240+
<li><ahref="testgres.html#testgres.config.GlobalConfig.node_cleanup_full">node_cleanup_full (testgres.config.GlobalConfig attribute)</a>
273241
</li>
274-
<li><ahref="testgres.html#testgres.config.GlobalConfig.node_cleanup_on_bad_exit">node_cleanup_on_bad_exit (testgres.config.GlobalConfig attribute)</a>,<ahref="testgres.html#testgres.config.GlobalConfig.node_cleanup_on_bad_exit">[1]</a>
242+
<li><ahref="testgres.html#testgres.config.GlobalConfig.node_cleanup_on_bad_exit">node_cleanup_on_bad_exit (testgres.config.GlobalConfig attribute)</a>
275243
</li>
276-
<li><ahref="testgres.html#testgres.config.GlobalConfig.node_cleanup_on_good_exit">node_cleanup_on_good_exit (testgres.config.GlobalConfig attribute)</a>,<ahref="testgres.html#testgres.config.GlobalConfig.node_cleanup_on_good_exit">[1]</a>
244+
<li><ahref="testgres.html#testgres.config.GlobalConfig.node_cleanup_on_good_exit">node_cleanup_on_good_exit (testgres.config.GlobalConfig attribute)</a>
277245
</li>
278246
</ul></td>
279247
<tdstyle="width: 33%; vertical-align: top;"><ul>
@@ -292,10 +260,6 @@ <h2 id="P">P</h2>
292260
<tablestyle="width: 100%"class="indextable genindextable"><tr>
293261
<tdstyle="width: 33%; vertical-align: top;"><ul>
294262
<li><ahref="testgres.html#testgres.node.PostgresNode.pg_ctl">pg_ctl() (testgres.node.PostgresNode method)</a>
295-
</li>
296-
<li><ahref="testgres.html#testgres.node.PostgresNode.pg_log_file">pg_log_file (testgres.node.PostgresNode attribute)</a>
297-
</li>
298-
<li><ahref="testgres.html#testgres.utils.pg_version_ge">pg_version_ge() (in module testgres.utils)</a>
299263
</li>
300264
<li><ahref="testgres.html#testgres.node.PostgresNode.pgbench">pgbench() (testgres.node.PostgresNode method)</a>
301265
</li>
@@ -314,8 +278,6 @@ <h2 id="P">P</h2>
314278
</ul></td>
315279
<tdstyle="width: 33%; vertical-align: top;"><ul>
316280
<li><ahref="testgres.html#testgres.config.pop_config">pop_config() (in module testgres.config)</a>
317-
</li>
318-
<li><ahref="testgres.html#testgres.decorators.positional_args_hack">positional_args_hack() (in module testgres.decorators)</a>
319281
</li>
320282
<li><ahref="testgres.html#testgres.node.PostgresNode">PostgresNode (class in testgres.node)</a>
321283
</li>
@@ -348,26 +310,20 @@ <h2 id="R">R</h2>
348310
<li><ahref="testgres.html#testgres.enums.IsolationLevel.ReadCommitted">ReadCommitted (testgres.enums.IsolationLevel attribute)</a>
349311
</li>
350312
<li><ahref="testgres.html#testgres.enums.IsolationLevel.ReadUncommitted">ReadUncommitted (testgres.enums.IsolationLevel attribute)</a>
351-
</li>
352-
<li><ahref="testgres.html#testgres.utils.release_port">release_port() (in module testgres.utils)</a>
353313
</li>
354314
<li><ahref="testgres.html#testgres.node.PostgresNode.reload">reload() (testgres.node.PostgresNode method)</a>
355315
</li>
356316
<li><ahref="testgres.html#testgres.enums.IsolationLevel.RepeatableRead">RepeatableRead (testgres.enums.IsolationLevel attribute)</a>
357-
</li>
358-
<li><ahref="testgres.html#testgres.node.PostgresNode.replicate">replicate() (testgres.node.PostgresNode method)</a>
359317
</li>
360318
</ul></td>
361319
<tdstyle="width: 33%; vertical-align: top;"><ul>
362-
<li><ahref="testgres.html#testgres.utils.reserve_port">reserve_port() (in moduletestgres.utils)</a>
320+
<li><ahref="testgres.html#testgres.node.PostgresNode.replicate">replicate() (testgres.node.PostgresNode method)</a>
363321
</li>
364322
<li><ahref="testgres.html#testgres.node.PostgresNode.restart">restart() (testgres.node.PostgresNode method)</a>
365323
</li>
366324
<li><ahref="testgres.html#testgres.node.PostgresNode.restore">restore() (testgres.node.PostgresNode method)</a>
367325
</li>
368326
<li><ahref="testgres.html#testgres.connection.NodeConnection.rollback">rollback() (testgres.connection.NodeConnection method)</a>
369-
</li>
370-
<li><ahref="testgres.html#testgres.logger.TestgresLogger.run">run() (testgres.logger.TestgresLogger method)</a>
371327
</li>
372328
<li><ahref="testgres.html#testgres.enums.NodeStatus.Running">Running (testgres.enums.NodeStatus attribute)</a>
373329
</li>
@@ -401,12 +357,8 @@ <h2 id="S">S</h2>
401357
</li>
402358
<li><ahref="testgres.html#testgres.node.PostgresNode.status">status() (testgres.node.PostgresNode method)</a>
403359
</li>
404-
<li><ahref="testgres.html#testgres.logger.TestgresLogger.stop">stop() (testgres.logger.TestgresLogger method)</a>
405-
406-
<ul>
407-
<li><ahref="testgres.html#testgres.node.PostgresNode.stop">(testgres.node.PostgresNode method)</a>
360+
<li><ahref="testgres.html#testgres.node.PostgresNode.stop">stop() (testgres.node.PostgresNode method)</a>
408361
</li>
409-
</ul></li>
410362
<li><ahref="testgres.html#testgres.enums.NodeStatus.Stopped">Stopped (testgres.enums.NodeStatus attribute)</a>
411363
</li>
412364
<li><ahref="testgres.html#testgres.enums.XLogMethod.stream">stream (testgres.enums.XLogMethod attribute)</a>
@@ -417,41 +369,23 @@ <h2 id="S">S</h2>
417369
<h2id="T">T</h2>
418370
<tablestyle="width: 100%"class="indextable genindextable"><tr>
419371
<tdstyle="width: 33%; vertical-align: top;"><ul>
420-
<li><ahref="testgres.html#testgres.config.GlobalConfig.temp_dir">temp_dir (testgres.config.GlobalConfig attribute)</a>,<ahref="testgres.html#testgres.config.GlobalConfig.temp_dir">[1]</a>
421-
</li>
422-
<li><ahref="testgres.html#module-testgres">testgres (module)</a>
372+
<li><ahref="testgres.html#testgres.config.GlobalConfig.temp_dir">temp_dir (testgres.config.GlobalConfig attribute)</a>
423373
</li>
424374
<li><ahref="testgres.html#module-testgres.api">testgres.api (module)</a>
425375
</li>
426376
<li><ahref="testgres.html#module-testgres.backup">testgres.backup (module)</a>
427-
</li>
428-
<li><ahref="testgres.html#module-testgres.cache">testgres.cache (module)</a>
429377
</li>
430378
<li><ahref="testgres.html#module-testgres.config">testgres.config (module)</a>
431-
</li>
432-
<li><ahref="testgres.html#module-testgres.connection">testgres.connection (module)</a>
433-
</li>
434-
<li><ahref="testgres.html#module-testgres.consts">testgres.consts (module)</a>
435-
</li>
436-
<li><ahref="testgres.html#module-testgres.decorators">testgres.decorators (module)</a>
437379
</li>
438380
</ul></td>
439381
<tdstyle="width: 33%; vertical-align: top;"><ul>
440-
<li><ahref="testgres.html#module-testgres.defaults">testgres.defaults (module)</a>
382+
<li><ahref="testgres.html#module-testgres.connection">testgres.connection (module)</a>
441383
</li>
442384
<li><ahref="testgres.html#module-testgres.enums">testgres.enums (module)</a>
443385
</li>
444386
<li><ahref="testgres.html#module-testgres.exceptions">testgres.exceptions (module)</a>
445-
</li>
446-
<li><ahref="testgres.html#module-testgres.logger">testgres.logger (module)</a>
447-
</li>
448-
<li><ahref="testgres.html#module-testgres.node">testgres.node (module)</a>
449-
</li>
450-
<li><ahref="testgres.html#module-testgres.utils">testgres.utils (module)</a>
451387
</li>
452388
<li><ahref="testgres.html#testgres.exceptions.TestgresException">TestgresException</a>
453-
</li>
454-
<li><ahref="testgres.html#testgres.logger.TestgresLogger">TestgresLogger (class in testgres.logger)</a>
455389
</li>
456390
<li><ahref="testgres.html#testgres.exceptions.TimeoutException">TimeoutException</a>
457391
</li>
@@ -469,9 +403,7 @@ <h2 id="U">U</h2>
469403
<tdstyle="width: 33%; vertical-align: top;"><ul>
470404
<li><ahref="testgres.html#testgres.config.GlobalConfig.update">update() (testgres.config.GlobalConfig method)</a>
471405
</li>
472-
<li><ahref="testgres.html#testgres.config.GlobalConfig.use_python_logging">use_python_logging (testgres.config.GlobalConfig attribute)</a>,<ahref="testgres.html#testgres.config.GlobalConfig.use_python_logging">[1]</a>
473-
</li>
474-
<li><ahref="testgres.html#testgres.node.PostgresNode.utils_log_file">utils_log_file (testgres.node.PostgresNode attribute)</a>
406+
<li><ahref="testgres.html#testgres.config.GlobalConfig.use_python_logging">use_python_logging (testgres.config.GlobalConfig attribute)</a>
475407
</li>
476408
</ul></td>
477409
</tr></table>

0 commit comments

Comments
 (0)
[8]ページ先頭
©2009-2025 Movatter.jp