Skip to content

dump MySQL to AWS S3 #688

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 14 additions & 2 deletions dbutil.py
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@

if __name__ == "__main__":
import argparse
parser = argparse.ArgumentParser(description="Database Maintenance Program. The database to act upon is specified in the ini file specified by the PLANTTRACER_CREDENTIALS environment variable, in the sections for [dbreader] and [dbwriter]",
parser = argparse.ArgumentParser(description="Database Maintenance Program. The database to act upon is specified in the ini file with the --readconfig or --rootconfig",
formatter_class=argparse.ArgumentDefaultsHelpFormatter)
required = parser.add_argument_group('required arguments')
required.add_argument(
Expand Down Expand Up @@ -48,7 +48,8 @@
parser.add_argument("--freshen",help="Non-destructive cleans up the movie metadata for all movies.",action='store_true')
parser.add_argument("--clean",help="Destructive cleans up the movie metadata for all movies.",action='store_true')
parser.add_argument("--schema", help="Specify schema file to use", default=paths.SCHEMA_FILE)
parser.add_argument("--dump", help="Backup all objects as JSON files and movie files to new directory called DUMP. ")
parser.add_argument("--dump", help="Dump all objects as JSON files and movie files to new directory called DUMP.")
parser.add_argument("--sqlbackup", help="Backup the MySQL database to a single SQL file")
parser.add_argument("--add_admin", help="Add --admin_email user as a course admin to the course specified by --course_id, --course_name, or --course_name", action='store_true')
parser.add_argument("--course_id", help="integer course id", type=int)
parser.add_argument("--course_key", help="integer course id")
Expand Down Expand Up @@ -236,6 +237,17 @@
dbmaint.freshen(True)
sys.exit(0)

# These need a database config
if ('dbreader' not in config) and (args.dump or args.sqlbackup):
print("Please use --rootconfig to specify which configuration file to use")
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

arts.sqlbackup probably needs to be args.sqlbackup

exit(1)

if args.dump:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Well, I mean, the test runs seem to be failing because this condition is not satisfied by the tests.

dbmaint.dump(config,args.dump)
sys.exit()

if args.sqlbackup:
dbmaint.sqlbackup(config,args.sqlbackup,all_databases=True)
sys.exit()


20 changes: 20 additions & 0 deletions deploy/app/dbmaint.py
Original file line number Diff line number Diff line change
Expand Up @@ -340,6 +340,7 @@
assert cv == current_version()

def dump(config,dumpdir):
"""Dump all objects as JSON files and movie files to new directory called DUMP."""
if os.path.exists(dumpdir):
raise FileExistsError(f"{dumpdir} exists")
os.mkdir(dumpdir)
Expand All @@ -358,3 +359,22 @@
json.dump(movie, f, default=str)
with open(os.path.join(dumpdir,f"movie_{movie_id}.mp4"),"wb") as f:
f.write(movie_data)

def sqlbackup(config,fname,all_databases=False):
"""Backup to an sqlfile"""
if os.path.exists(fname):
raise FileExistsError(f"{fname} exists")
dbreader = dbfile.DBMySQLAuth.FromConfig(config['dbreader'])
cmd = ['mysqldump','-h' + dbreader.host,'-u' + dbreader.user, '-p' + dbreader.password, '--single-transaction', '--no-tablespaces']
if all_databases:
cmd.append('--all-databases')

Check warning on line 370 in deploy/app/dbmaint.py

View check run for this annotation

Codecov / codecov/patch

deploy/app/dbmaint.py#L365-L370

Added lines #L365 - L370 were not covered by tests
else:
cmd.append(dbreader.database)
if fname.startswith('s3://'):
print("Dumping to ",fname)
with subprocess.Popen(['aws','s3','cp','-',fname], stdin=subprocess.PIPE) as p_s3:
subprocess.run(cmd, stdout=p_s3.stdin)
print("done")
return
with open(fname,'w') as outfile:
subprocess.call(cmd, stdout=outfile)

Check warning on line 380 in deploy/app/dbmaint.py

View check run for this annotation

Codecov / codecov/patch

deploy/app/dbmaint.py#L372-L380

Added lines #L372 - L380 were not covered by tests