Port "most" of mysql logic from rattail-fabric

seems i maybe just forgot to commit this last time?
This commit is contained in:
Lance Edgar 2019-01-06 14:14:21 -06:00
parent 76ab2915c8
commit c2fe7586da

145
rattail_fabric2/mysql.py Normal file
View file

@ -0,0 +1,145 @@
# -*- coding: utf-8; -*-
################################################################################
#
# Rattail -- Retail Software Framework
# Copyright © 2010-2018 Lance Edgar
#
# This file is part of Rattail.
#
# Rattail 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, either version 3 of the License, or (at your option) any later
# version.
#
# Rattail 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
# Rattail. If not, see <http://www.gnu.org/licenses/>.
#
################################################################################
"""
Fabric Library for MySQL
"""
from __future__ import unicode_literals, absolute_import
from rattail_fabric2 import apt, make_deploy
deploy = make_deploy(__file__)
def install(c):
"""
Install the MySQL database service
"""
apt.install(c, 'mysql-server')
def user_exists(c, name, host='localhost'):
"""
Determine if a given MySQL user exists.
"""
user = sql(c, "SELECT User FROM user WHERE User = '{0}' and Host = '{1}'".format(name, host), database='mysql').stdout.strip()
return user == name
def create_user(c, name, host='localhost', password=None, checkfirst=True):
"""
Create a MySQL user account.
"""
if not checkfirst or not user_exists(c, name, host):
sql(c, "CREATE USER '{}'@'{}';".format(name, host))
if password:
# with hide('running'):
sql(c, "SET PASSWORD FOR '{}'@'{}' = PASSWORD('{}');".format(
name, host, password))
def db_exists(c, name):
"""
Determine if a given MySQL database exists.
"""
db = sql(c, "SELECT SCHEMA_NAME FROM SCHEMATA WHERE SCHEMA_NAME = '{0}'".format(name), database='information_schema').stdout.strip()
return db == name
def create_db(c, name, checkfirst=True, user=None):
"""
Create a MySQL database.
"""
if not checkfirst or not db_exists(c, name):
c.sudo('mysqladmin create {}'.format(name))
if user:
grant_access(c, name, user)
def drop_db(c, name, checkfirst=True):
"""
Drop a MySQL database.
"""
if not checkfirst or db_exists(c, name):
c.sudo('mysqladmin drop --force {}'.format(name))
def grant_access(c, dbname, username):
"""
Grant full access to the given database for the given user. Note that the
username should be given in MySQL's native format, e.g. 'myuser@localhost'.
"""
sql(c, 'grant all on `{}`.* to {}'.format(dbname, username))
def sql(c, sql, database=''):
"""
Execute some SQL.
"""
# some crazy quoting required here, see also
# http://stackoverflow.com/a/1250279
sql = sql.replace("'", "'\"'\"'")
return c.sudo("mysql --execute='{}' --batch --skip-column-names {}".format(sql, database))
def download_db(c, name, destination=None):
"""
Download a database from the "current" server.
"""
if destination is None:
destination = './{}.sql.gz'.format(name)
c.sudo('mysqldump --result-file={0}.sql {0}'.format(name))
c.sudo('gzip --force {}.sql'.format(name))
c.get('{}.sql.gz'.format(name), destination)
c.sudo('rm {}.sql.gz'.format(name))
def clone_db(c, name, download, user=None, force=False):
"""
Clone a MySQL database from a (presumably live) server
:param name: Name of the database.
:param force: Whether the target database should be forcibly dropped, if it
exists already.
"""
if db_exists(c, name):
if force:
drop_db(c, name, checkfirst=False)
else:
raise RuntimeError("Database '{}' already exists! (pass force=True to override)".format(name))
create_db(c, name, checkfirst=False)
# obtain database dump from live server
download(c, '{}.sql.gz'.format(name), user=user or c.user)
# upload database dump to target server
c.put('{}.sql.gz'.format(name))
c.local('rm {}.sql.gz'.format(name))
# restore database on target server
c.run('gunzip --force {}.sql.gz'.format(name))
c.sudo("bash -c 'mysql {0} < {0}.sql'".format(name))
c.run('rm {}.sql'.format(name))