"""
Management of MySQL databases (schemas)
=======================================
:depends: - MySQLdb Python module
:configuration: See :py:mod:`salt.modules.mysql` for setup instructions.
The mysql_database module is used to create and manage MySQL databases.
Databases can be set as either absent or present.
.. code-block:: yaml
frank:
mysql_database.present
"""
import logging
import sys
log = logging.getLogger(__name__)
# pylint: disable=undefined-variable
[docs]
def __virtual__():
"""
Only load if the mysql module is available in __salt__
"""
if "mysql.db_exists" in __salt__:
return True
return (False, "mysql module could not be loaded")
def _get_mysql_error():
"""
Look in module context for a MySQL error. Eventually we should make a less
ugly way of doing this.
"""
return sys.modules[__salt__["test.ping"].__module__].__context__.pop("mysql.error", None)
[docs]
def present(name, character_set=None, collate=None, **connection_args):
"""
Ensure that the named database is present with the specified properties
name
The name of the database to manage
"""
ret = {
"name": name,
"changes": {},
"result": True,
"comment": f"Database {name} is already present",
}
# check if database exists
existing = __salt__["mysql.db_get"](name, **connection_args)
if existing:
alter_charset = False
alter_collate = False
existing_charset = bytes(str(existing.get("character_set")).encode()).decode()
if character_set and character_set != existing_charset:
alter_charset = True
log.debug(
"character set differes from %s : %s",
character_set,
existing_charset,
)
comment = "Database character set {} != {} needs to be updated".format(
character_set, existing_charset
)
if __opts__.get("test", False):
ret["result"] = None
ret["comment"] = comment
else:
ret["comment"] = comment
existing_collate = bytes(str(existing.get("collate")).encode()).decode()
if collate and collate != existing_collate:
alter_collate = True
log.debug(
"collate set differs from %s : %s",
collate,
existing_collate,
)
comment = "Database collate {} != {} needs to be updated".format(
collate, existing_collate
)
if __opts__.get("test", False):
ret["result"] = None
ret["comment"] += f"\n{comment}"
return ret
else:
ret["comment"] += f"\n{comment}"
if alter_charset or alter_collate:
if __opts__.get("test", False):
ret["comment"] += f"\nDatabase {name} is going to be updated"
else:
__salt__["mysql.alter_db"](
name, character_set=character_set, collate=collate, **connection_args
)
current = __salt__["mysql.db_get"](name, **connection_args)
if existing.get("collate", None) != current.get("collate", None):
ret["changes"].update(
{
"collate": {
"before": existing.get("collate", None),
"now": current.get("collate", None),
}
}
)
if existing.get("character_set", None) != current.get("character_set", None):
ret["changes"].update(
{
"character_set": {
"before": existing.get("character_set", None),
"now": current.get("character_set", None),
}
}
)
return ret
else:
err = _get_mysql_error()
if err is not None:
ret["comment"] = err
ret["result"] = False
return ret
if __opts__.get("test", False):
ret["result"] = None
ret["comment"] = f"Database {name} is not present and needs to be created"
return ret
# The database is not present, make it!
if __salt__["mysql.db_create"](
name, character_set=character_set, collate=collate, **connection_args
):
ret["comment"] = f"The database {name} has been created"
ret["changes"][name] = "Present"
else:
ret["comment"] = f"Failed to create database {name}"
err = _get_mysql_error()
if err is not None:
ret["comment"] += f" ({err})"
ret["result"] = False
return ret
[docs]
def absent(name, **connection_args):
"""
Ensure that the named database is absent
name
The name of the database to remove
"""
ret = {"name": name, "changes": {}, "result": True, "comment": ""}
# check if db exists and remove it
if __salt__["mysql.db_exists"](name, **connection_args):
if __opts__.get("test", False):
ret["result"] = None
ret["comment"] = f"Database {name} is present and needs to be removed"
return ret
if __salt__["mysql.db_remove"](name, **connection_args):
ret["comment"] = f"Database {name} has been removed"
ret["changes"][name] = "Absent"
return ret
else:
err = _get_mysql_error()
if err is not None:
ret["comment"] = f"Unable to remove database {name} ({err})"
ret["result"] = False
return ret
else:
err = _get_mysql_error()
if err is not None:
ret["comment"] = err
ret["result"] = False
return ret
# fallback
ret["comment"] = f"Database {name} is not present, so it cannot be removed"
return ret