/usr/share/pyshared/mysql/utilities/command/dbexport.py is in mysql-utilities 1.0.5-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 | #!/usr/bin/env python
#
# Copyright (c) 2010, Oracle and/or its affiliates. All rights reserved.
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; version 2 of the License.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
#
"""
This file contains the export operations that will export object metadata or
table data.
"""
import os
import re
import sys
from mysql.utilities.exception import UtilError, UtilDBError
_RPL_COMMANDS, _RPL_FILE = 0, 1
_RPL_PREFIX = "-- "
def export_metadata(source, src_val, db_list, options):
"""Produce rows to be used to recreate objects in a database.
This method retrieves the objects for each database listed in the form
of CREATE (SQL) statements or in a tabular form to the file specified.
The valid values for the format parameter are SQL, CSV, TSV, VERTICAL,
or GRID.
source[in] Server instance
src_val[in] a dictionary containing connection information for the
source including:
(user, password, host, port, socket)
options[in] a dictionary containing the options for the copy:
(skip_tables, skip_views, skip_triggers, skip_procs,
skip_funcs, skip_events, skip_grants, skip_create,
skip_data, no_header, display, format,
debug, exclude_names, exclude_patterns)
Returns bool True = success, False = error
"""
from mysql.utilities.common.database import Database
from mysql.utilities.common.format import format_tabular_list
from mysql.utilities.common.format import format_vertical_list
format = options.get("format", "sql")
no_headers = options.get("no_headers", False)
column_type = options.get("display", "brief")
skip_create = options.get("skip_create", False)
quiet = options.get("quiet", False)
skip_tables = options.get("skip_tables", False)
skip_views = options.get("skip_views", False)
skip_triggers = options.get("skip_triggers", False)
skip_procs = options.get("skip_procs", False)
skip_funcs = options.get("skip_funcs", False)
skip_events = options.get("skip_events", False)
skip_grants = options.get("skip_grants", False)
if options.get("all", False):
rows = source.get_all_databases()
for row in rows:
db_list.append(row[0])
# Check user permissions on source for all databases
for db_name in db_list:
source_db = Database(source, db_name)
# Make a dictionary of the options
access_options = {
'skip_views' : skip_views,
'skip_procs' : skip_procs,
'skip_funcs' : skip_funcs,
'skip_grants' : skip_grants,
'skip_events' : skip_events,
}
source_db.check_read_access(src_val["user"], src_val["host"],
access_options)
for db_name in db_list:
# Get a Database class instance
db = Database(source, db_name, options)
# Error is source database does not exist
if not db.exists():
raise UtilDBError("Source database does not exist - %s" % db_name,
-1, db_name)
if not quiet:
print "# Exporting metadata from %s" % db_name
# Perform the extraction
if format == "sql":
db.init()
if not skip_create:
print "DROP DATABASE IF EXISTS %s;" % db_name
print "CREATE DATABASE %s;" % db_name
print "USE %s;" % db_name
for dbobj in db.get_next_object():
if dbobj[0] == "GRANT" and not skip_grants:
if not quiet:
print "# Grant:"
if dbobj[1][3]:
create_str = "GRANT %s ON %s.%s TO %s" % \
(dbobj[1][1], db_name,
dbobj[1][3], dbobj[1][0])
else:
create_str = "GRANT %s ON %s.* TO %s" % \
(dbobj[1][1], db_name, dbobj[1][0])
if create_str.find("%"):
create_str = re.sub("%", "%%", create_str)
print create_str
else:
if not quiet:
print "# %s: %s.%s" % (dbobj[0], db_name,
dbobj[1][0])
if (dbobj[0] == "PROCEDURE" and not skip_procs) or \
(dbobj[0] == "FUNCTION" and not skip_funcs) or \
(dbobj[0] == "EVENT" and not skip_events) or \
(dbobj[0] == "TRIGGER" and not skip_triggers):
print "DELIMITER ||"
print "%s;" % db.get_create_statement(db_name,
dbobj[1][0],
dbobj[0])
if (dbobj[0] == "PROCEDURE" and not skip_procs) or \
(dbobj[0] == "FUNCTION" and not skip_funcs) or \
(dbobj[0] == "EVENT" and not skip_events) or \
(dbobj[0] == "TRIGGER" and not skip_triggers):
print "||"
print "DELIMITER ;"
else:
objects = []
if not skip_tables:
objects.append("TABLE")
if not skip_views:
objects.append("VIEW")
if not skip_triggers:
objects.append("TRIGGER")
if not skip_procs:
objects.append("PROCEDURE")
if not skip_funcs:
objects.append("FUNCTION")
if not skip_events:
objects.append("EVENT")
if not skip_grants:
objects.append("GRANT")
for obj_type in objects:
sys.stdout.write("# %sS in %s:" % (obj_type, db_name))
rows = db.get_db_objects(obj_type, column_type, True)
if len(rows[1]) < 1:
print " (none found)"
else:
print
# Cannot use print_list here becasue we must manipulate
# the behavior of format_tabular_list
list_options = {}
if format == "vertical":
format_vertical_list(sys.stdout, rows[0], rows[1])
elif format == "tab":
list_options['print_header'] = not no_headers
list_options['separator'] = '\t'
format_tabular_list(sys.stdout, rows[0], rows[1],
list_options)
elif format == "csv":
list_options['print_header'] = not no_headers
list_options['separator'] = ','
format_tabular_list(sys.stdout, rows[0], rows[1],
list_options)
else: # default to table format
format_tabular_list(sys.stdout, rows[0], rows[1])
if not quiet:
print "#...done."
return True
def _export_row(data_rows, cur_table, format, single, skip_blobs, first=False,
no_headers=False, outfile=None):
"""Export a row
This method will print a row to stdout based on the format chosen -
either SQL statements, GRID, CSV, TSV, or VERTICAL.
datarows[in] one or more rows for exporting
cur_table[in] Table class instance
format[in] desired output format
skip_blobs[in] if True, skip blob data
single[in] if True, generate single INSERT statements (valid
only for format=SQL)
first[in] if True, this is the first row to be exported - this
causes the header to be printed if chosen.
no_headers[in] if True, do not print headers
outfile[in] if is not None, write table data to this file.
"""
from mysql.utilities.common.format import format_tabular_list
from mysql.utilities.common.format import format_vertical_list
tbl_name = cur_table.tbl_name
db_name = cur_table.db_name
full_name = "%s.%s" % (db_name, tbl_name)
list_options = {}
# if outfile is not set, use stdout.
if outfile is None:
outfile = sys.stdout # default file handle
if format == 'sql':
if single:
if single:
data = data_rows
else:
data = data_rows[1]
blob_rows = []
for row in data:
columns = cur_table.get_column_string(row, full_name)
if len(columns[1]) > 0:
blob_rows.extend(columns[1])
row_str = "INSERT INTO %s VALUES%s;" % (full_name, columns[0])
outfile.write(row_str + "\n")
else:
# Generate bulk insert statements
data_lists = cur_table.make_bulk_insert(data_rows, db_name)
rows = data_lists[0]
blob_rows = data_lists[1]
if len(rows) > 0:
for row in rows:
outfile.write("%s;\n" % row)
else:
print "# Table %s has no data." % tbl_name
if len(blob_rows) > 0:
if skip_blobs:
print "# WARNING : Table %s has blob data that " \
"has been excluded by --skip-blobs." % \
tbl_name
else:
print "# Blob data for table %s:" % tbl_name
for blob_row in blob_rows:
outfile.write(blob_row + "\n")
# Cannot use print_list here becasue we must manipulate
# the behavior of format_tabular_list
elif format == "vertical":
format_vertical_list(outfile, cur_table.get_col_names(),
data_rows)
elif format == "tab":
list_options['print_header'] = first
list_options['separator'] = '\t'
list_options['quiet'] = not no_headers
format_tabular_list(outfile, cur_table.get_col_names(),
data_rows, list_options)
elif format == "csv":
list_options['print_header'] = first
list_options['separator'] = ','
list_options['quiet'] = not no_headers
format_tabular_list(outfile, cur_table.get_col_names(),
data_rows, list_options)
else: # default to table format - header is always printed
format_tabular_list(outfile, cur_table.get_col_names(),
data_rows)
def export_data(source, src_val, db_list, options):
"""Produce data for the tables in a database.
This method retrieves the data for each table in the databases listed in
the form of BULK INSERT (SQL) statements or in a tabular form to the file
specified. The valid values for the format parameter are SQL, CSV, TSV,
VERITCAL, or GRID.
source[in] Server instance
src_val[in] a dictionary containing connection information for the
source including:
(user, password, host, port, socket)
options[in] a dictionary containing the options for the copy:
(skip_tables, skip_views, skip_triggers, skip_procs,
skip_funcs, skip_events, skip_grants, skip_create,
skip_data, no_header, display, format, file_per_tbl,
and debug)
Returns bool True = success, False = error
"""
from mysql.utilities.common.database import Database
from mysql.utilities.common.table import Table
format = options.get("format", "sql")
no_headers = options.get("no_headers", True)
column_type = options.get("display", "brief")
single = options.get("single", False)
skip_blobs = options.get("skip_blobs", False)
quiet = options.get("quiet", False)
file_per_table = options.get("file_per_tbl", False)
skip_views = options.get("skip_views", False)
skip_procs = options.get("skip_procs", False)
skip_funcs = options.get("skip_funcs", False)
skip_events = options.get("skip_events", False)
skip_grants = options.get("skip_grants", False)
if options.get("all", False):
rows = source.get_all_databases()
for row in rows:
if row[0] not in db_list:
db_list.append(row[0])
# Check if database exists and user permissions on source for all databases
table_lock_list = []
table_list = []
for db_name in db_list:
source_db = Database(source, db_name)
# Make a dictionary of the options
access_options = {
'skip_views' : skip_views,
'skip_procs' : skip_procs,
'skip_funcs' : skip_funcs,
'skip_grants' : skip_grants,
'skip_events' : skip_events,
}
# Error is source database does not exist
if not source_db.exists():
raise UtilDBError("Source database does not exist - %s" % db_name,
-1, db_name)
source_db.check_read_access(src_val["user"], src_val["host"],
access_options)
# Build table list
tables = source_db.get_db_objects("TABLE")
for table in tables:
table_list.append((db_name, table[0]))
old_db = ""
for table in table_list:
db_name = table[0]
tbl_name = "%s.%s" % (db_name, table[1])
if not quiet and old_db != db_name:
old_db = db_name
if format == "sql":
print "USE %s;" % db_name
print "# Exporting data from %s" % db_name
if file_per_table:
print "# Writing table data to files."
tbl_options = {
'verbose' : False,
'get_cols' : True,
'quiet' : quiet
}
cur_table = Table(source, tbl_name, tbl_options)
if single and format not in ("sql", "grid", "vertical"):
retrieval_mode = -1
first = True
else:
retrieval_mode = 1
first = False
message = "# Data for table %s: " % tbl_name
# switch for writing to files
if file_per_table:
if format == 'sql':
file_name = tbl_name + ".sql"
else:
file_name = tbl_name + ".%s" % format.lower()
outfile = open(file_name, "w")
outfile.write(message + "\n")
else:
outfile = None
print message
for data_rows in cur_table.retrieve_rows(retrieval_mode):
_export_row(data_rows, cur_table, format, single,
skip_blobs, first, no_headers, outfile)
if first:
first = False
if file_per_table:
outfile.close()
if not quiet:
print "#...done."
return True
def get_change_master_command(source, options={}):
"""Get the CHANGE MASTER command for export or copy of databases
This method creates the replication commands based on the options chosen.
This includes the stop and start slave commands as well as the change
master command as follows.
To create the CHANGE MASTER command for connecting to the existing server
as the master, set rpl_mode = 'master'.
To create the CHANGE MASTER command for using the existing server as the
master, set rpl_mode = 'master'.
You can also get both CHANGE MASTER commands by setting rpl_mode = 'both'.
In this case, the second change master command (rpl_mode = 'slave') will
be commented out.
The method also checks the rpl_file option. If a file name is provided, it
is checked to see if file exists or the user does not have access, an error
is thrown. If no file is provided, the method writes the commands to
stdout.
The user may also comment the replication commands by specifying the
comment_rpl option (True = comment).
The method calls the negotiate_rpl_connection method of the replication
module to create the CHANGE MASTER command. Additional error checking is
performed in that method as follows. See the negotiate_rpl_connection
method documentation for complete specifics.
- binary log must be ON for a master
- the rpl_user must exist
source[in] Server instance
options[in] option dictionary
Returns tuple - CHANGE MASTER command[s], output file for writing commands
"""
from mysql.utilities.common.replication import negotiate_rpl_connection
rpl_file = None
rpl_cmds = []
rpl_filename = options.get("rpl_file", None)
rpl_mode = options.get("rpl_mode", "master")
quiet = options.get("quiet", False)
# Check for rpl_file and empty it
if rpl_filename:
rpl_file = rpl_filename
try:
rf = open(rpl_filename, "w")
except:
raise UtilError("File inaccessible or bad path: %s" % rpl_filename)
rf.write("# Replication Commands:\n")
rf.close()
strict = rpl_mode == 'both' or options.get("strict", False)
# Get change master as if this server was a master
if rpl_mode in ["master", "both"]:
if not quiet:
rpl_cmds.append("# Connecting to the current server as master")
change_master = negotiate_rpl_connection(source, True, strict, options)
rpl_cmds.extend(change_master)
# Get change master using this slave's master information
if rpl_mode in ["slave", "both"]:
if not quiet:
rpl_cmds.append("# Connecting to the current server's master")
change_master = negotiate_rpl_connection(source, False, strict, options)
rpl_cmds.extend(change_master)
return (rpl_cmds, rpl_file)
def write_commands(file, rows, options):
"""Write commands to file or stdout
This method writes the rows passed to either a file specified in the
rpl_file option or stdout if no file is specified.
file[in] filename to use or None for sys.stdout
rows[in] rows to write
options[in] replication options
"""
format = options.get("format", "sql")
rpl_filename = options.get("rpl_file", None)
quiet = options.get("quiet", False)
verbosity = options.get("verbosity", 0)
# if using --rpl_file then open the file for append
if rpl_filename:
rpl_file = open(rpl_filename, "a")
else:
rpl_file = sys.stdout
if not quiet:
if verbosity:
rpl_file.write("#\n")
# calculate comment character
if options.get("comment_rpl", False) or \
options.get("rpl_mode", "master") == "both":
prefix_str = "# "
else:
prefix_str = ""
# write rows
for row in rows:
if row[0] == '#':
rpl_file.write("{0}\n".format(row))
else:
if format != 'sql':
prefix_str += _RPL_PREFIX
rpl_file.write("{0}{1}\n".format(prefix_str, row))
if not quiet:
if verbosity:
rpl_file.write("#\n")
# if using --rpl_file then close the file
if rpl_filename:
rpl_file.close()
def export_databases(server_values, db_list, options):
"""Export one or more databases
This method performs the export of a list of databases first dumping the
definitions then the data. It supports dumping replication commands (STOP
SLAVE, CHANGE MASTER, START SLAVE) for exporting data for use in
replication scenarios.
server_values[in] server connection value dictionary
db_list[in] list of database names
options[in] option dictionary
Must include the skip_* options for copy and export
"""
from mysql.utilities.command.dbcopy import get_copy_lock
from mysql.utilities.common.server import connect_servers
export = options.get("export", "definitions")
rpl_mode = options.get("rpl_mode", "master")
quiet = options.get("quiet", False)
verbosity = options.get("verbosity", 0)
locking = options.get("locking", "snapshot")
conn_options = {
'quiet' : quiet,
'version' : "5.1.30",
}
servers = connect_servers(server_values, None, conn_options)
source = servers[0]
# Lock tables first
my_lock = get_copy_lock(source, db_list, options, True)
# if --rpl specified, write initial replication command
if rpl_mode:
rpl_info = get_change_master_command(source, options)
write_commands(rpl_info[_RPL_FILE], ["STOP SLAVE;"], options)
# dump metadata
if export in ("definitions", "both"):
export_metadata(source, server_values, db_list, options)
# dump data
if export in ("data", "both"):
if options.get("display", "brief") != "brief":
print "# NOTE : --display is ignored for data export."
export_data(source, server_values, db_list, options)
# if --rpl specified, write replication end command
if rpl_mode:
write_commands(rpl_info[_RPL_FILE], rpl_info[_RPL_COMMANDS],
options)
write_commands(rpl_info[_RPL_FILE], ["START SLAVE;"], options)
my_lock.unlock()
|