@@ -363,7 +363,7 @@ def spawn_primary(self, name, destroy=True, use_logging=False):
363
363
Create a primary node from a backup.
364
364
365
365
Args:
366
- name: name for a new node (str) .
366
+ name: name for a new node.
367
367
destroy: should we convert this backup into a node?
368
368
use_logging: enable python logging.
369
369
@@ -392,7 +392,7 @@ def spawn_replica(self, name, destroy=True, use_logging=False):
392
392
Create a replica of the original node from a backup.
393
393
394
394
Args:
395
- name: name for a new node (str) .
395
+ name: name for a new node.
396
396
destroy: should we convert this backup into a node?
397
397
use_logging: enable python logging.
398
398
@@ -814,10 +814,10 @@ def psql(self, dbname, query=None, filename=None, username=None):
814
814
Execute a query using psql.
815
815
816
816
Args:
817
- dbname: database name to connect to (str) .
818
- query: query to be executed (str) .
819
- filename: file with a query (str) .
820
- username: database user name (str) .
817
+ dbname: database name to connect to.
818
+ query: query to be executed.
819
+ filename: file with a query.
820
+ username: database user name.
821
821
822
822
Returns:
823
823
A tuple of (code, stdout, stderr).
@@ -857,9 +857,9 @@ def safe_psql(self, dbname, query, username=None):
857
857
Execute a query using psql.
858
858
859
859
Args:
860
- dbname: database name to connect to (str) .
861
- query: query to be executed (str) .
862
- username: database user name (str) .
860
+ dbname: database name to connect to.
861
+ query: query to be executed.
862
+ username: database user name.
863
863
864
864
Returns:
865
865
psql's output as str.
@@ -875,8 +875,8 @@ def dump(self, dbname, filename=None):
875
875
Dump database using pg_dump.
876
876
877
877
Args:
878
- dbname: database name to connect to (str) .
879
- filename: output file (str) .
878
+ dbname: database name to connect to.
879
+ filename: output file.
880
880
881
881
Returns:
882
882
Path to file containing dump.
@@ -900,8 +900,8 @@ def restore(self, dbname, filename, username=None):
900
900
Restore database from pg_dump's file.
901
901
902
902
Args:
903
- dbname: database name to connect to (str) .
904
- filename: database dump taken by pg_dump (str) .
903
+ dbname: database name to connect to.
904
+ filename: database dump taken by pg_dump.
905
905
"""
906
906
907
907
self .psql (dbname = dbname , filename = filename , username = username )
@@ -919,9 +919,9 @@ def poll_query_until(self,
919
919
Run a query once a second until it returs 'expected'.
920
920
921
921
Args:
922
- dbname: database name to connect to (str) .
923
- query: query to be executed (str) .
924
- username: database user name (str) .
922
+ dbname: database name to connect to.
923
+ query: query to be executed.
924
+ username: database user name.
925
925
max_attempts: how many times should we try?
926
926
sleep_time: how long should we sleep after a failure?
927
927
expected: what should be returned to break the cycle?
@@ -970,9 +970,9 @@ def execute(self, dbname, query, username=None, commit=True):
970
970
Execute a query and return all rows as list.
971
971
972
972
Args:
973
- dbname: database name to connect to (str) .
974
- query: query to be executed (str) .
975
- username: database user name (str) .
973
+ dbname: database name to connect to.
974
+ query: query to be executed.
975
+ username: database user name.
976
976
commit: should we commit this query?
977
977
978
978
Returns:
@@ -990,7 +990,7 @@ def backup(self, username=None, xlog_method=DEFAULT_XLOG_METHOD):
990
990
Perform pg_basebackup.
991
991
992
992
Args:
993
- username: database user name (str) .
993
+ username: database user name.
994
994
xlog_method: a method for collecting the logs ('fetch' | 'stream').
995
995
996
996
Returns:
@@ -1008,8 +1008,8 @@ def replicate(self, name, username=None,
1008
1008
Create a replica of this node.
1009
1009
1010
1010
Args:
1011
- name: replica's name (str) .
1012
- username: database user name (str) .
1011
+ name: replica's name.
1012
+ username: database user name.
1013
1013
xlog_method: a method for collecting the logs ('fetch' | 'stream').
1014
1014
use_logging: enable python logging.
1015
1015
"""
@@ -1048,7 +1048,7 @@ def pgbench_init(self, dbname='postgres', scale=1, options=[]):
1048
1048
Prepare database for pgbench (create tables etc).
1049
1049
1050
1050
Args:
1051
- dbname: database name to connect to (str) .
1051
+ dbname: database name to connect to.
1052
1052
scale: report this scale factor in output (int).
1053
1053
options: additional options for pgbench (list).
1054
1054
@@ -1071,7 +1071,7 @@ def pgbench(self, dbname='postgres', stdout=None, stderr=None, options=[]):
1071
1071
Spawn a pgbench process.
1072
1072
1073
1073
Args:
1074
- dbname: database name to connect to (str) .
1074
+ dbname: database name to connect to.
1075
1075
stdout: stdout file to be used by Popen.
1076
1076
stderr: stderr file to be used by Popen.
1077
1077
options: additional options for pgbench (list).
@@ -1091,8 +1091,8 @@ def connect(self, dbname='postgres', username=None):
1091
1091
Connect to a database.
1092
1092
1093
1093
Args:
1094
- dbname: database name to connect to (str) .
1095
- username: database user name (str) .
1094
+ dbname: database name to connect to.
1095
+ username: database user name.
1096
1096
1097
1097
Returns:
1098
1098
An instance of NodeConnection.
@@ -1152,9 +1152,9 @@ def _execute_utility(util, args, logfile, write_to_pipe=True):
1152
1152
Execute utility (pg_ctl, pg_dump etc) using get_bin_path().
1153
1153
1154
1154
Args:
1155
- util: utility to be executed (str) .
1155
+ util: utility to be executed.
1156
1156
args: arguments for utility (list).
1157
- logfile: stores stdout and stderr (str) .
1157
+ logfile: path to file to store stdout and stderr.
1158
1158
write_to_pipe: do we care about stdout?
1159
1159
1160
1160
Returns:
@@ -1174,7 +1174,7 @@ def _execute_utility(util, args, logfile, write_to_pipe=True):
1174
1174
1175
1175
# get result
1176
1176
out , _ = process .communicate ()
1177
- out = '' if not out else out . decode ( 'utf-8' )
1177
+ out = '' if not out else six . text_type ( out )
1178
1178
1179
1179
# write new log entry if possible
1180
1180
try :
@@ -1296,8 +1296,8 @@ def get_new_node(name, base_dir=None, use_logging=False):
1296
1296
Create a new node (select port automatically).
1297
1297
1298
1298
Args:
1299
- name: node's name (str) .
1300
- base_dir: path to node's data directory (str) .
1299
+ name: node's name.
1300
+ base_dir: path to node's data directory.
1301
1301
use_logging: should we use custom logger?
1302
1302
1303
1303
Returns:
0 commit comments