# Reference

<!-- DO NOT EDIT: This document was generated by Puppet Strings -->

## Table of Contents

### Classes

#### Public Classes

* [`mysql::bindings`](#mysqlbindings): Parent class for MySQL bindings.
* [`mysql::client`](#mysqlclient): Installs and configures the MySQL client.
* [`mysql::server`](#mysqlserver): Installs and configures the MySQL server.
* [`mysql::server::backup`](#mysqlserverbackup): Create and manage a MySQL backup.

#### Private Classes

* `mysql::backup::mysqlbackup`: Manage the mysqlbackup client.
* `mysql::backup::mysqldump`: "Provider" for mysqldump
* `mysql::backup::xtrabackup`: "Provider" for Percona XtraBackup/MariaBackup
* `mysql::bindings::client_dev`: Private class for installing client development bindings
* `mysql::bindings::daemon_dev`: Private class for installing daemon development bindings
* `mysql::bindings::java`: Private class for installing java language bindings.
* `mysql::bindings::perl`: Private class for installing perl language bindings.
* `mysql::bindings::php`: Private class for installing php language bindings
* `mysql::bindings::python`: Private class for installing python language bindings
* `mysql::bindings::ruby`: Private class for installing ruby language bindings
* `mysql::client::install`: Private class for MySQL client install.
* `mysql::params`: Params class.
* `mysql::server::account_security`: Private class for ensuring localhost accounts do not exist
* `mysql::server::config`: Private class for MySQL server configuration.
* `mysql::server::install`: Private class for managing MySQL package.
* `mysql::server::installdb`: Builds initial databases on installation.
* `mysql::server::managed_dirs`: Binary log configuration requires the mysql user to be present. This must be done after package install.
* `mysql::server::providers`: Convenience class to call each of the three providers with the corresponding hashes provided in mysql::server.
* `mysql::server::root_password`: Private class for managing the root password
* `mysql::server::service`: Private class for managing the MySQL service

### Defined types

* [`mysql::db`](#mysqldb): Create and configure a MySQL database.

### Resource types

#### Public Resource types

* [`mysql_grant`](#mysql_grant): @summary Manage a MySQL user's rights.
* [`mysql_login_path`](#mysql_login_path): Manage a MySQL login path.
* [`mysql_plugin`](#mysql_plugin): Manage MySQL plugins.
* [`mysql_user`](#mysql_user): @summary Manage a MySQL user. This includes management of users password as well as privileges.

#### Private Resource types

* `mysql_database`: Manage a MySQL database.
* `mysql_datadir`: Manage MySQL datadirs with mysql_install_db OR mysqld (5.7.6 and above).

### Functions

* [`mysql::normalise_and_deepmerge`](#mysqlnormalise_and_deepmerge): Recursively merges two or more hashes together, normalises keys with differing use of dashes and underscores.
* [`mysql::password`](#mysqlpassword): Hash a string as mysql's "PASSWORD()" function would do it
* [`mysql::strip_hash`](#mysqlstrip_hash): When given a hash this function strips out all blank entries.
* [`mysql_password`](#mysql_password): DEPRECATED. Use the namespaced function [`mysql::password`](#mysqlpassword) instead.

### Data types

* [`Mysql::Options`](#mysqloptions): A hash of options structured like the override_options, but not merged with the default options.

### Tasks

* [`export`](#export): Allows you to backup your database to local file.
* [`sql`](#sql): Allows you to execute arbitary SQL

## Classes

### <a name="mysqlbindings"></a>`mysql::bindings`

Parent class for MySQL bindings.

#### Examples

##### Install Ruby language bindings

```puppet
class { 'mysql::bindings':
  ruby_enable           => true,
  ruby_package_ensure   => 'present',
  ruby_package_name     => 'ruby-mysql-2.7.1-1mdv2007.0.sparc.rpm',
  ruby_package_provider => 'rpm',
}
```

#### Parameters

The following parameters are available in the `mysql::bindings` class:

* [`install_options`](#install_options)
* [`java_enable`](#java_enable)
* [`perl_enable`](#perl_enable)
* [`php_enable`](#php_enable)
* [`python_enable`](#python_enable)
* [`ruby_enable`](#ruby_enable)
* [`client_dev`](#client_dev)
* [`daemon_dev`](#daemon_dev)
* [`java_package_ensure`](#java_package_ensure)
* [`java_package_name`](#java_package_name)
* [`java_package_provider`](#java_package_provider)
* [`perl_package_ensure`](#perl_package_ensure)
* [`perl_package_name`](#perl_package_name)
* [`perl_package_provider`](#perl_package_provider)
* [`php_package_ensure`](#php_package_ensure)
* [`php_package_name`](#php_package_name)
* [`php_package_provider`](#php_package_provider)
* [`python_package_ensure`](#python_package_ensure)
* [`python_package_name`](#python_package_name)
* [`python_package_provider`](#python_package_provider)
* [`ruby_package_ensure`](#ruby_package_ensure)
* [`ruby_package_name`](#ruby_package_name)
* [`ruby_package_provider`](#ruby_package_provider)
* [`client_dev_package_ensure`](#client_dev_package_ensure)
* [`client_dev_package_name`](#client_dev_package_name)
* [`client_dev_package_provider`](#client_dev_package_provider)
* [`daemon_dev_package_ensure`](#daemon_dev_package_ensure)
* [`daemon_dev_package_name`](#daemon_dev_package_name)
* [`daemon_dev_package_provider`](#daemon_dev_package_provider)

##### <a name="install_options"></a>`install_options`

Data type: `Any`

Passes `install_options` array to managed package resources. You must pass the [appropriate options](https://docs.puppetlabs.com/references/latest/type.html#package-attribute-install_options) for the package manager(s).

Default value: ``undef``

##### <a name="java_enable"></a>`java_enable`

Data type: `Any`

Specifies whether `::mysql::bindings::java` should be included. Valid values are `true`, `false`.

Default value: ``false``

##### <a name="perl_enable"></a>`perl_enable`

Data type: `Any`

Specifies whether `mysql::bindings::perl` should be included. Valid values are `true`, `false`.

Default value: ``false``

##### <a name="php_enable"></a>`php_enable`

Data type: `Any`

Specifies whether `mysql::bindings::php` should be included. Valid values are `true`, `false`.

Default value: ``false``

##### <a name="python_enable"></a>`python_enable`

Data type: `Any`

Specifies whether `mysql::bindings::python` should be included. Valid values are `true`, `false`.

Default value: ``false``

##### <a name="ruby_enable"></a>`ruby_enable`

Data type: `Any`

Specifies whether `mysql::bindings::ruby` should be included. Valid values are `true`, `false`.

Default value: ``false``

##### <a name="client_dev"></a>`client_dev`

Data type: `Any`

Specifies whether `::mysql::bindings::client_dev` should be included. Valid values are `true`', `false`.

Default value: ``false``

##### <a name="daemon_dev"></a>`daemon_dev`

Data type: `Any`

Specifies whether `::mysql::bindings::daemon_dev` should be included. Valid values are `true`, `false`.

Default value: ``false``

##### <a name="java_package_ensure"></a>`java_package_ensure`

Data type: `Any`

Whether the package should be present, absent, or a specific version. Valid values are 'present', 'absent', or 'x.y.z'. Only applies if `java_enable => true`.

Default value: `$mysql::params::java_package_ensure`

##### <a name="java_package_name"></a>`java_package_name`

Data type: `Any`

The name of the Java package to install. Only applies if `java_enable => true`.

Default value: `$mysql::params::java_package_name`

##### <a name="java_package_provider"></a>`java_package_provider`

Data type: `Any`

The provider to use to install the Java package. Only applies if `java_enable => true`.

Default value: `$mysql::params::java_package_provider`

##### <a name="perl_package_ensure"></a>`perl_package_ensure`

Data type: `Any`

Whether the package should be present, absent, or a specific version. Valid values are 'present', 'absent', or 'x.y.z'. Only applies if `perl_enable => true`.

Default value: `$mysql::params::perl_package_ensure`

##### <a name="perl_package_name"></a>`perl_package_name`

Data type: `Any`

The name of the Perl package to install. Only applies if `perl_enable => true`.

Default value: `$mysql::params::perl_package_name`

##### <a name="perl_package_provider"></a>`perl_package_provider`

Data type: `Any`

The provider to use to install the Perl package. Only applies if `perl_enable => true`.

Default value: `$mysql::params::perl_package_provider`

##### <a name="php_package_ensure"></a>`php_package_ensure`

Data type: `Any`

Whether the package should be present, absent, or a specific version. Valid values are 'present', 'absent', or 'x.y.z'. Only applies if `php_enable => true`.

Default value: `$mysql::params::php_package_ensure`

##### <a name="php_package_name"></a>`php_package_name`

Data type: `Any`

The name of the PHP package to install. Only applies if `php_enable => true`.

Default value: `$mysql::params::php_package_name`

##### <a name="php_package_provider"></a>`php_package_provider`

Data type: `Any`

The provider to use to install the PHP package. Only applies if `php_enable => true`.

Default value: `$mysql::params::php_package_provider`

##### <a name="python_package_ensure"></a>`python_package_ensure`

Data type: `Any`

Whether the package should be present, absent, or a specific version. Valid values are 'present', 'absent', or 'x.y.z'. Only applies if `python_enable => true`.

Default value: `$mysql::params::python_package_ensure`

##### <a name="python_package_name"></a>`python_package_name`

Data type: `Any`

The name of the Python package to install. Only applies if `python_enable => true`.

Default value: `$mysql::params::python_package_name`

##### <a name="python_package_provider"></a>`python_package_provider`

Data type: `Any`

The provider to use to install the Python package. Only applies if `python_enable => true`.

Default value: `$mysql::params::python_package_provider`

##### <a name="ruby_package_ensure"></a>`ruby_package_ensure`

Data type: `Any`

Whether the package should be present, absent, or a specific version. Valid values are 'present', 'absent', or 'x.y.z'. Only applies if `ruby_enable => true`.

Default value: `$mysql::params::ruby_package_ensure`

##### <a name="ruby_package_name"></a>`ruby_package_name`

Data type: `Any`

The name of the Ruby package to install. Only applies if `ruby_enable => true`.

Default value: `$mysql::params::ruby_package_name`

##### <a name="ruby_package_provider"></a>`ruby_package_provider`

Data type: `Any`

What provider should be used to install the package.

Default value: `$mysql::params::ruby_package_provider`

##### <a name="client_dev_package_ensure"></a>`client_dev_package_ensure`

Data type: `Any`

Whether the package should be present, absent, or a specific version. Valid values are 'present', 'absent', or 'x.y.z'. Only applies if `client_dev => true`.

Default value: `$mysql::params::client_dev_package_ensure`

##### <a name="client_dev_package_name"></a>`client_dev_package_name`

Data type: `Any`

The name of the client_dev package to install. Only applies if `client_dev => true`.

Default value: `$mysql::params::client_dev_package_name`

##### <a name="client_dev_package_provider"></a>`client_dev_package_provider`

Data type: `Any`

The provider to use to install the client_dev package. Only applies if `client_dev => true`.

Default value: `$mysql::params::client_dev_package_provider`

##### <a name="daemon_dev_package_ensure"></a>`daemon_dev_package_ensure`

Data type: `Any`

Whether the package should be present, absent, or a specific version. Valid values are 'present', 'absent', or 'x.y.z'. Only applies if `daemon_dev => true`.

Default value: `$mysql::params::daemon_dev_package_ensure`

##### <a name="daemon_dev_package_name"></a>`daemon_dev_package_name`

Data type: `Any`

The name of the daemon_dev package to install. Only applies if `daemon_dev => true`.

Default value: `$mysql::params::daemon_dev_package_name`

##### <a name="daemon_dev_package_provider"></a>`daemon_dev_package_provider`

Data type: `Any`

The provider to use to install the daemon_dev package. Only applies if `daemon_dev => true`.

Default value: `$mysql::params::daemon_dev_package_provider`

### <a name="mysqlclient"></a>`mysql::client`

Installs and configures the MySQL client.

#### Examples

##### Install the MySQL client

```puppet
class {'::mysql::client':
  package_name    => 'mysql-client',
  package_ensure  => 'present',
  bindings_enable => true,
}
```

#### Parameters

The following parameters are available in the `mysql::client` class:

* [`bindings_enable`](#bindings_enable)
* [`install_options`](#install_options)
* [`package_ensure`](#package_ensure)
* [`package_manage`](#package_manage)
* [`package_name`](#package_name)
* [`package_provider`](#package_provider)
* [`package_source`](#package_source)

##### <a name="bindings_enable"></a>`bindings_enable`

Data type: `Any`

Whether to automatically install all bindings. Valid values are `true`, `false`. Default to `false`.

Default value: `$mysql::params::bindings_enable`

##### <a name="install_options"></a>`install_options`

Data type: `Any`

Array of install options for managed package resources. You must pass the appropriate options for the package manager.

Default value: ``undef``

##### <a name="package_ensure"></a>`package_ensure`

Data type: `Any`

Whether the MySQL package should be present, absent, or a specific version. Valid values are 'present', 'absent', or 'x.y.z'.

Default value: `$mysql::params::client_package_ensure`

##### <a name="package_manage"></a>`package_manage`

Data type: `Any`

Whether to manage the MySQL client package. Defaults to `true`.

Default value: `$mysql::params::client_package_manage`

##### <a name="package_name"></a>`package_name`

Data type: `Any`

The name of the MySQL client package to install.

Default value: `$mysql::params::client_package_name`

##### <a name="package_provider"></a>`package_provider`

Data type: `Any`



Default value: ``undef``

##### <a name="package_source"></a>`package_source`

Data type: `Any`



Default value: ``undef``

### <a name="mysqlserver"></a>`mysql::server`

Installs and configures the MySQL server.

#### Examples

##### Install MySQL Server

```puppet
class { '::mysql::server':
  package_name            => 'mysql-server',
  package_ensure          => '5.7.1+mysql~trusty',
  root_password           => 'strongpassword',
  remove_default_accounts => true,
}
```

#### Parameters

The following parameters are available in the `mysql::server` class:

* [`config_file`](#config_file)
* [`config_file_mode`](#config_file_mode)
* [`includedir`](#includedir)
* [`install_options`](#install_options)
* [`install_secret_file`](#install_secret_file)
* [`manage_config_file`](#manage_config_file)
* [`options`](#options)
* [`override_options`](#override_options)
* [`package_ensure`](#package_ensure)
* [`package_manage`](#package_manage)
* [`package_name`](#package_name)
* [`package_provider`](#package_provider)
* [`package_source`](#package_source)
* [`purge_conf_dir`](#purge_conf_dir)
* [`remove_default_accounts`](#remove_default_accounts)
* [`restart`](#restart)
* [`root_group`](#root_group)
* [`mysql_group`](#mysql_group)
* [`mycnf_owner`](#mycnf_owner)
* [`mycnf_group`](#mycnf_group)
* [`root_password`](#root_password)
* [`service_enabled`](#service_enabled)
* [`service_manage`](#service_manage)
* [`service_name`](#service_name)
* [`service_provider`](#service_provider)
* [`create_root_user`](#create_root_user)
* [`create_root_my_cnf`](#create_root_my_cnf)
* [`users`](#users)
* [`grants`](#grants)
* [`databases`](#databases)
* [`enabled`](#enabled)
* [`manage_service`](#manage_service)
* [`old_root_password`](#old_root_password)
* [`managed_dirs`](#managed_dirs)
* [`create_root_login_file`](#create_root_login_file)
* [`login_file`](#login_file)

##### <a name="config_file"></a>`config_file`

Data type: `Any`

The location, as a path, of the MySQL configuration file.

Default value: `$mysql::params::config_file`

##### <a name="config_file_mode"></a>`config_file_mode`

Data type: `Any`

The MySQL configuration file's permissions mode.

Default value: `$mysql::params::config_file_mode`

##### <a name="includedir"></a>`includedir`

Data type: `Any`

The location, as a path, of !includedir for custom configuration overrides.

Default value: `$mysql::params::includedir`

##### <a name="install_options"></a>`install_options`

Data type: `Any`

Passes [install_options](https://docs.puppetlabs.com/references/latest/type.html#package-attribute-install_options) array to managed package resources. You must pass the appropriate options for the specified package manager

Default value: ``undef``

##### <a name="install_secret_file"></a>`install_secret_file`

Data type: `Any`

Path to secret file containing temporary root password.

Default value: `$mysql::params::install_secret_file`

##### <a name="manage_config_file"></a>`manage_config_file`

Data type: `Any`

Whether the MySQL configuration file should be managed. Valid values are `true`, `false`. Defaults to `true`.

Default value: `$mysql::params::manage_config_file`

##### <a name="options"></a>`options`

Data type: `Mysql::Options`

A hash of options structured like the override_options, but not merged with the default options. Use this if you don't want your options merged with the default options.

Default value: `{}`

##### <a name="override_options"></a>`override_options`

Data type: `Any`

Specifies override options to pass into MySQL. Structured like a hash in the my.cnf file:  See  above for usage details.

Default value: `{}`

##### <a name="package_ensure"></a>`package_ensure`

Data type: `Any`

Whether the package exists or should be a specific version. Valid values are 'present', 'absent', or 'x.y.z'. Defaults to 'present'.

Default value: `$mysql::params::server_package_ensure`

##### <a name="package_manage"></a>`package_manage`

Data type: `Any`

Whether to manage the MySQL server package. Defaults to `true`.

Default value: `$mysql::params::server_package_manage`

##### <a name="package_name"></a>`package_name`

Data type: `Any`

The name of the MySQL server package to install.

Default value: `$mysql::params::server_package_name`

##### <a name="package_provider"></a>`package_provider`

Data type: `Any`

Define a specific provider for package install.

Default value: ``undef``

##### <a name="package_source"></a>`package_source`

Data type: `Any`

The location of the package source (require for some package provider)

Default value: ``undef``

##### <a name="purge_conf_dir"></a>`purge_conf_dir`

Data type: `Any`

Whether the `includedir` directory should be purged. Valid values are `true`, `false`. Defaults to `false`.

Default value: `$mysql::params::purge_conf_dir`

##### <a name="remove_default_accounts"></a>`remove_default_accounts`

Data type: `Any`

Specifies whether to automatically include `mysql::server::account_security`. Valid values are `true`, `false`. Defaults to `false`.

Default value: ``false``

##### <a name="restart"></a>`restart`

Data type: `Any`

Whether the service should be restarted when things change. Valid values are `true`, `false`. Defaults to `false`.

Default value: `$mysql::params::restart`

##### <a name="root_group"></a>`root_group`

Data type: `Any`

The name of the group used for root. Can be a group name or a group ID. See more about the [group](https://docs.puppetlabs.com/references/latest/type.html#file-attribute-group).

Default value: `$mysql::params::root_group`

##### <a name="mysql_group"></a>`mysql_group`

Data type: `Any`

The name of the group of the MySQL daemon user. Can be a group name or a group ID. See more about the [group](https://docs.puppetlabs.com/references/latest/type.html#file-attribute-group).

Default value: `$mysql::params::mysql_group`

##### <a name="mycnf_owner"></a>`mycnf_owner`

Data type: `Any`

Name or user-id who owns the mysql-config-file.

Default value: `$mysql::params::mycnf_owner`

##### <a name="mycnf_group"></a>`mycnf_group`

Data type: `Any`

Name or group-id which owns the mysql-config-file.

Default value: `$mysql::params::mycnf_group`

##### <a name="root_password"></a>`root_password`

Data type: `Variant[String, Sensitive[String]]`

The MySQL root password. Puppet attempts to set the root password and update `/root/.my.cnf` with it. This is required if `create_root_user` or `create_root_my_cnf` are true. If `root_password` is 'UNSET', then `create_root_user` and `create_root_my_cnf` are assumed to be false --- that is, the MySQL root user and `/root/.my.cnf` are not created. Password changes are supported; however, the old password must be set in `/root/.my.cnf`. Effectively, Puppet uses the old password, configured in `/root/my.cnf`, to set the new password in MySQL, and then updates `/root/.my.cnf` with the new password.

Default value: `$mysql::params::root_password`

##### <a name="service_enabled"></a>`service_enabled`

Data type: `Any`

Specifies whether the service should be enabled. Valid values are `true`, `false`. Defaults to `true`.

Default value: `$mysql::params::server_service_enabled`

##### <a name="service_manage"></a>`service_manage`

Data type: `Any`

Specifies whether the service should be managed. Valid values are `true`, `false`. Defaults to `true`.

Default value: `$mysql::params::server_service_manage`

##### <a name="service_name"></a>`service_name`

Data type: `Any`

The name of the MySQL server service. Defaults are OS dependent, defined in 'params.pp'.

Default value: `$mysql::params::server_service_name`

##### <a name="service_provider"></a>`service_provider`

Data type: `Any`

The provider to use to manage the service. For Ubuntu, defaults to 'upstart'; otherwise, default is undefined.

Default value: `$mysql::params::server_service_provider`

##### <a name="create_root_user"></a>`create_root_user`

Data type: `Any`

Whether root user should be created. Valid values are `true`, `false`. Defaults to `true`. This is useful for a cluster setup with Galera. The root user has to be created only once. You can set this parameter true on one node and set it to false on the remaining nodes.

Default value: `$mysql::params::create_root_user`

##### <a name="create_root_my_cnf"></a>`create_root_my_cnf`

Data type: `Any`

Whether to create `/root/.my.cnf`. Valid values are `true`, `false`. Defaults to `true`. `create_root_my_cnf` allows creation of `/root/.my.cnf` independently of `create_root_user`. You can use this for a cluster setup with Galera where you want `/root/.my.cnf` to exist on all nodes.

Default value: `$mysql::params::create_root_my_cnf`

##### <a name="users"></a>`users`

Data type: `Any`

Optional hash of users to create, which are passed to [mysql_user](#mysql_user).

Default value: `{}`

##### <a name="grants"></a>`grants`

Data type: `Any`

Optional hash of grants, which are passed to [mysql_grant](#mysql_grant).

Default value: `{}`

##### <a name="databases"></a>`databases`

Data type: `Any`

Optional hash of databases to create, which are passed to [mysql_database](#mysql_database).

Default value: `{}`

##### <a name="enabled"></a>`enabled`

Data type: `Any`

_Deprecated_

Default value: ``undef``

##### <a name="manage_service"></a>`manage_service`

Data type: `Any`

_Deprecated_

Default value: ``undef``

##### <a name="old_root_password"></a>`old_root_password`

Data type: `Any`

This parameter no longer does anything. It exists only for backwards compatibility. See the `root_password` parameter above for details on changing the root password.

Default value: ``undef``

##### <a name="managed_dirs"></a>`managed_dirs`

Data type: `Any`



Default value: `$mysql::params::managed_dirs`

##### <a name="create_root_login_file"></a>`create_root_login_file`

Data type: `Any`



Default value: `$mysql::params::create_root_login_file`

##### <a name="login_file"></a>`login_file`

Data type: `Any`



Default value: `$mysql::params::login_file`

### <a name="mysqlserverbackup"></a>`mysql::server::backup`

Create and manage a MySQL backup.

#### Examples

##### Create a basic MySQL backup:

```puppet
class { 'mysql::server':
  root_password => 'password'
}
class { 'mysql::server::backup':
  backupuser     => 'myuser',
  backuppassword => 'mypassword',
  backupdir      => '/tmp/backups',
}
class { 'mysql::server::backup':
  backupmethod => 'mariabackup',
  provider     => 'xtrabackup',
  backupdir    => '/tmp/backups',
}
```

#### Parameters

The following parameters are available in the `mysql::server::backup` class:

* [`backupuser`](#backupuser)
* [`backuppassword`](#backuppassword)
* [`backupdir`](#backupdir)
* [`backupdirmode`](#backupdirmode)
* [`backupdirowner`](#backupdirowner)
* [`backupdirgroup`](#backupdirgroup)
* [`backupcompress`](#backupcompress)
* [`backupmethod`](#backupmethod)
* [`backup_success_file_path`](#backup_success_file_path)
* [`backuprotate`](#backuprotate)
* [`ignore_events`](#ignore_events)
* [`delete_before_dump`](#delete_before_dump)
* [`backupdatabases`](#backupdatabases)
* [`file_per_database`](#file_per_database)
* [`include_routines`](#include_routines)
* [`include_triggers`](#include_triggers)
* [`incremental_backups`](#incremental_backups)
* [`ensure`](#ensure)
* [`time`](#time)
* [`prescript`](#prescript)
* [`postscript`](#postscript)
* [`execpath`](#execpath)
* [`provider`](#provider)
* [`maxallowedpacket`](#maxallowedpacket)
* [`optional_args`](#optional_args)
* [`install_cron`](#install_cron)
* [`compression_command`](#compression_command)
* [`compression_extension`](#compression_extension)

##### <a name="backupuser"></a>`backupuser`

Data type: `Any`

MySQL user to create with backup administrator privileges.

Default value: ``undef``

##### <a name="backuppassword"></a>`backuppassword`

Data type: `Optional[Variant[String, Sensitive[String]]]`

Password to create for `backupuser`.

Default value: ``undef``

##### <a name="backupdir"></a>`backupdir`

Data type: `Any`

Directory to store backup.

Default value: ``undef``

##### <a name="backupdirmode"></a>`backupdirmode`

Data type: `Any`

Permissions applied to the backup directory. This parameter is passed directly to the file resource.

Default value: `'0700'`

##### <a name="backupdirowner"></a>`backupdirowner`

Data type: `Any`

Owner for the backup directory. This parameter is passed directly to the file resource.

Default value: `'root'`

##### <a name="backupdirgroup"></a>`backupdirgroup`

Data type: `Any`

Group owner for the backup directory. This parameter is passed directly to the file resource.

Default value: `$mysql::params::root_group`

##### <a name="backupcompress"></a>`backupcompress`

Data type: `Any`

Whether or not to compress the backup (when using the mysqldump or xtrabackup provider)

Default value: ``true``

##### <a name="backupmethod"></a>`backupmethod`

Data type: `Any`

The execution binary for backing up. ex. mysqldump, xtrabackup, mariabackup

Default value: ``undef``

##### <a name="backup_success_file_path"></a>`backup_success_file_path`

Data type: `Any`

Specify a path where upon successfull backup a file should be created for checking purposes.

Default value: `'/tmp/mysqlbackup_success'`

##### <a name="backuprotate"></a>`backuprotate`

Data type: `Any`

Backup rotation interval in 24 hour periods.

Default value: `30`

##### <a name="ignore_events"></a>`ignore_events`

Data type: `Any`

Ignore the mysql.event table.

Default value: ``true``

##### <a name="delete_before_dump"></a>`delete_before_dump`

Data type: `Any`

Whether to delete old .sql files before backing up. Setting to true deletes old files before backing up, while setting to false deletes them after backup.

Default value: ``false``

##### <a name="backupdatabases"></a>`backupdatabases`

Data type: `Any`

Databases to backup (required if using xtrabackup provider). By default `[]` will back up all databases.

Default value: `[]`

##### <a name="file_per_database"></a>`file_per_database`

Data type: `Any`

Use file per database mode creating one file per database backup.

Default value: ``false``

##### <a name="include_routines"></a>`include_routines`

Data type: `Any`

Dump stored routines (procedures and functions) from dumped databases when doing a `file_per_database` backup.

Default value: ``false``

##### <a name="include_triggers"></a>`include_triggers`

Data type: `Any`

Dump triggers for each dumped table when doing a `file_per_database` backup.

Default value: ``false``

##### <a name="incremental_backups"></a>`incremental_backups`

Data type: `Any`

A flag to activate/deactivate incremental backups. Currently only supported by the xtrabackup provider.

Default value: ``true``

##### <a name="ensure"></a>`ensure`

Data type: `Any`



Default value: `'present'`

##### <a name="time"></a>`time`

Data type: `Any`

An array of two elements to set the backup time. Allows ['23', '5'] (i.e., 23:05) or ['3', '45'] (i.e., 03:45) for HH:MM times.

Default value: `['23', '5']`

##### <a name="prescript"></a>`prescript`

Data type: `Any`

A script that is executed before the backup begins.

Default value: ``false``

##### <a name="postscript"></a>`postscript`

Data type: `Any`

A script that is executed when the backup is finished. This could be used to sync the backup to a central store. This script can be either a single line that is directly executed or a number of lines supplied as an array. It could also be one or more externally managed (executable) files.

Default value: ``false``

##### <a name="execpath"></a>`execpath`

Data type: `Any`

Allows you to set a custom PATH should your MySQL installation be non-standard places. Defaults to `/usr/bin:/usr/sbin:/bin:/sbin`.

Default value: `'/usr/bin:/usr/sbin:/bin:/sbin'`

##### <a name="provider"></a>`provider`

Data type: `Any`

Sets the server backup implementation. Valid values are:

Default value: `'mysqldump'`

##### <a name="maxallowedpacket"></a>`maxallowedpacket`

Data type: `Any`

Defines the maximum SQL statement size for the backup dump script. The default value is 1MB, as this is the default MySQL Server value.

Default value: `'1M'`

##### <a name="optional_args"></a>`optional_args`

Data type: `Any`

Specifies an array of optional arguments which should be passed through to the backup tool. (Supported by the xtrabackup and mysqldump providers.)

Default value: `[]`

##### <a name="install_cron"></a>`install_cron`

Data type: `Any`

Manage installation of cron package

Default value: ``true``

##### <a name="compression_command"></a>`compression_command`

Data type: `Any`

Configure the command used to compress the backup (when using the mysqldump provider). Make sure the command exists
on the target system. Packages for it are NOT automatically installed.

Default value: ``undef``

##### <a name="compression_extension"></a>`compression_extension`

Data type: `Any`

Configure the file extension for the compressed backup (when using the mysqldump provider)

Default value: ``undef``

## Defined types

### <a name="mysqldb"></a>`mysql::db`

Create and configure a MySQL database.

#### Examples

##### Create a database

```puppet
mysql::db { 'mydb':
  user     => 'myuser',
  password => 'mypass',
  host     => 'localhost',
  grant    => ['SELECT', 'UPDATE'],
}
```

#### Parameters

The following parameters are available in the `mysql::db` defined type:

* [`user`](#user)
* [`password`](#password)
* [`tls_options`](#tls_options)
* [`dbname`](#dbname)
* [`charset`](#charset)
* [`collate`](#collate)
* [`host`](#host)
* [`grant`](#grant)
* [`grant_options`](#grant_options)
* [`sql`](#sql)
* [`enforce_sql`](#enforce_sql)
* [`ensure`](#ensure)
* [`import_timeout`](#import_timeout)
* [`import_cat_cmd`](#import_cat_cmd)
* [`mysql_exec_path`](#mysql_exec_path)

##### <a name="user"></a>`user`

Data type: `Any`

The user for the database you're creating.

##### <a name="password"></a>`password`

Data type: `Variant[String, Sensitive[String]]`

The password for $user for the database you're creating.

##### <a name="tls_options"></a>`tls_options`

Data type: `Any`

The tls_options for $user for the database you're creating.

Default value: ``undef``

##### <a name="dbname"></a>`dbname`

Data type: `Any`

The name of the database to create.

Default value: `$name`

##### <a name="charset"></a>`charset`

Data type: `Any`

The character set for the database.

Default value: `'utf8'`

##### <a name="collate"></a>`collate`

Data type: `Any`

The collation for the database.

Default value: `'utf8_general_ci'`

##### <a name="host"></a>`host`

Data type: `Any`

The host to use as part of user@host for grants.

Default value: `'localhost'`

##### <a name="grant"></a>`grant`

Data type: `Any`

The privileges to be granted for user@host on the database.

Default value: `'ALL'`

##### <a name="grant_options"></a>`grant_options`

Data type: `Any`

The grant_options for the grant for user@host on the database.

Default value: ``undef``

##### <a name="sql"></a>`sql`

Data type: `Optional[Variant[Array, Hash, String]]`

The path to the sqlfile you want to execute. This can be single file specified as string, or it can be an array of strings.

Default value: ``undef``

##### <a name="enforce_sql"></a>`enforce_sql`

Data type: `Any`

Specifies whether executing the sqlfiles should happen on every run. If set to false, sqlfiles only run once.

Default value: ``false``

##### <a name="ensure"></a>`ensure`

Data type: `Enum['absent', 'present']`

Specifies whether to create the database. Valid values are 'present', 'absent'. Defaults to 'present'.

Default value: `'present'`

##### <a name="import_timeout"></a>`import_timeout`

Data type: `Any`

Timeout, in seconds, for loading the sqlfiles. Defaults to 300.

Default value: `300`

##### <a name="import_cat_cmd"></a>`import_cat_cmd`

Data type: `Any`

Command to read the sqlfile for importing the database. Useful for compressed sqlfiles. For example, you can use 'zcat' for .gz files.

Default value: `'cat'`

##### <a name="mysql_exec_path"></a>`mysql_exec_path`

Data type: `Any`



Default value: ``undef``

## Resource types

### <a name="mysql_grant"></a>`mysql_grant`

@summary
Manage a MySQL user's rights.

#### Properties

The following properties are available in the `mysql_grant` type.

##### `ensure`

Valid values: `present`, `absent`

The basic property that the resource should be in.

Default value: `present`

##### `options`

Options to grant.

##### `privileges`

Privileges for user

##### `table`

Valid values: `%r{.*\..*}`, `%r{^[0-9a-zA-Z$_]*@[\w%\.:\-/]*$}`

Table to apply privileges to.

##### `user`

User to operate on.

#### Parameters

The following parameters are available in the `mysql_grant` type.

* [`name`](#name)
* [`provider`](#provider)

##### <a name="name"></a>`name`

namevar

Name to describe the grant.

##### <a name="provider"></a>`provider`

The specific backend to use for this `mysql_grant` resource. You will seldom need to specify this --- Puppet will
usually discover the appropriate provider for your platform.

### <a name="mysql_login_path"></a>`mysql_login_path`

This type provides Puppet with the capabilities to store authentication credentials in an obfuscated login path file
named .mylogin.cnf created with the mysql_config_editor utility. Supports only MySQL Community Edition > v5.6.6.

* **See also**
  * https://dev.mysql.com/doc/refman/8.0/en/mysql-config-editor.html

#### Examples

##### 

```puppet
mysql_login_path { 'local_socket':
  owner    => 'root',
  host     => 'localhost',
  user     => 'root',
  password => Sensitive('secure'),
  socket   => '/var/run/mysql/mysql.sock',
  ensure   => present,
}

mysql_login_path { 'local_tcp':
  owner    => 'root',
  host     => '127.0.0.1',
  user     => 'root',
  password => Sensitive('more_secure'),
  port     => 3306,
  ensure   => present,
}
```

#### Properties

The following properties are available in the `mysql_login_path` type.

##### `ensure`

Data type: `Enum[present, absent]`

Whether this resource should be present or absent on the target system.

##### `host`

Data type: `Optional[String]`

Host name to be entered into the login path.

##### `password`

Data type: `Optional[Sensitive[String[1]]]`

Password to be entered into login path

##### `port`

Data type: `Optional[Integer[0,65535]]`

Port number to be entered into login path.

##### `socket`

Data type: `Optional[String]`

Socket path to be entered into login path

##### `user`

Data type: `Optional[String]`

Username to be entered into the login path.

#### Parameters

The following parameters are available in the `mysql_login_path` type.

* [`name`](#name)
* [`owner`](#owner)

##### <a name="name"></a>`name`

namevar

Data type: `String`

Name of the login path you want to manage.

##### <a name="owner"></a>`owner`

namevar

Data type: `String`

The user to whom the logon path should belong.

Default value: `root`

### <a name="mysql_plugin"></a>`mysql_plugin`

Manage MySQL plugins.

#### Examples

##### 

```puppet
mysql_plugin { 'some_plugin':
  soname => 'some_pluginlib.so',
}
```

#### Properties

The following properties are available in the `mysql_plugin` type.

##### `ensure`

Valid values: `present`, `absent`

The basic property that the resource should be in.

Default value: `present`

##### `soname`

Valid values: `%r{^\w+\.\w+$}`

The name of the library

#### Parameters

The following parameters are available in the `mysql_plugin` type.

* [`name`](#name)
* [`provider`](#provider)

##### <a name="name"></a>`name`

namevar

The name of the MySQL plugin to manage.

##### <a name="provider"></a>`provider`

The specific backend to use for this `mysql_plugin` resource. You will seldom need to specify this --- Puppet will
usually discover the appropriate provider for your platform.

### <a name="mysql_user"></a>`mysql_user`

@summary
Manage a MySQL user. This includes management of users password as well as privileges.

#### Properties

The following properties are available in the `mysql_user` type.

##### `ensure`

Valid values: `present`, `absent`

The basic property that the resource should be in.

Default value: `present`

##### `max_connections_per_hour`

Valid values: `%r{\d+}`

Max connections per hour for the user. 0 means no (or global) limit.

##### `max_queries_per_hour`

Valid values: `%r{\d+}`

Max queries per hour for the user. 0 means no (or global) limit.

##### `max_updates_per_hour`

Valid values: `%r{\d+}`

Max updates per hour for the user. 0 means no (or global) limit.

##### `max_user_connections`

Valid values: `%r{\d+}`

Max concurrent connections for the user. 0 means no (or global) limit.

##### `password_hash`

Valid values: `%r{\w*}`

The password hash of the user. Use mysql::password() for creating such a hash.

##### `plugin`

Valid values: `%r{\w+}`

The authentication plugin of the user.

##### `tls_options`

Options to that set the TLS-related REQUIRE attributes for the user.

#### Parameters

The following parameters are available in the `mysql_user` type.

* [`name`](#name)
* [`provider`](#provider)

##### <a name="name"></a>`name`

namevar

The name of the user. This uses the 'username@hostname' or username@hostname.

##### <a name="provider"></a>`provider`

The specific backend to use for this `mysql_user` resource. You will seldom need to specify this --- Puppet will usually
discover the appropriate provider for your platform.

## Functions

### <a name="mysqlnormalise_and_deepmerge"></a>`mysql::normalise_and_deepmerge`

Type: Ruby 4.x API

- When there is a duplicate key that is a hash, they are recursively merged.
- When there is a duplicate key that is not a hash, the key in the rightmost hash will "win."
- When there are conficting uses of dashes and underscores in two keys (which mysql would otherwise equate), the rightmost style will win.

#### Examples

##### 

```puppet
$hash1 = {'one' => 1, 'two' => 2, 'three' => { 'four' => 4 } }
$hash2 = {'two' => 'dos', 'three' => { 'five' => 5 } }
$merged_hash = mysql::normalise_and_deepmerge($hash1, $hash2)
# The resulting hash is equivalent to:
# $merged_hash = { 'one' => 1, 'two' => 'dos', 'three' => { 'four' => 4, 'five' => 5 } }
```

#### `mysql::normalise_and_deepmerge(Any *$args)`

- When there is a duplicate key that is a hash, they are recursively merged.
- When there is a duplicate key that is not a hash, the key in the rightmost hash will "win."
- When there are conficting uses of dashes and underscores in two keys (which mysql would otherwise equate), the rightmost style will win.

Returns: `Any` hash
The given hash normalised

##### Examples

###### 

```puppet
$hash1 = {'one' => 1, 'two' => 2, 'three' => { 'four' => 4 } }
$hash2 = {'two' => 'dos', 'three' => { 'five' => 5 } }
$merged_hash = mysql::normalise_and_deepmerge($hash1, $hash2)
# The resulting hash is equivalent to:
# $merged_hash = { 'one' => 1, 'two' => 'dos', 'three' => { 'four' => 4, 'five' => 5 } }
```

##### `*args`

Data type: `Any`

Hash to be normalised

### <a name="mysqlpassword"></a>`mysql::password`

Type: Ruby 4.x API

Hash a string as mysql's "PASSWORD()" function would do it

#### `mysql::password(Variant[String, Sensitive[String]] $password, Optional[Boolean] $sensitive)`

Hash a string as mysql's "PASSWORD()" function would do it

Returns: `Variant[String, Sensitive[String]]` hash
The mysql password hash from the clear text password.

##### `password`

Data type: `Variant[String, Sensitive[String]]`

Plain text password.

##### `sensitive`

Data type: `Optional[Boolean]`

If the Postgresql-Passwordhash should be of Datatype Sensitive[String]

### <a name="mysqlstrip_hash"></a>`mysql::strip_hash`

Type: Ruby 4.x API

When given a hash this function strips out all blank entries.

#### `mysql::strip_hash(Hash $hash)`

The mysql::strip_hash function.

Returns: `Hash` hash
The given hash with all blank entries removed

##### `hash`

Data type: `Hash`

Hash to be stripped

### <a name="mysql_password"></a>`mysql_password`

Type: Ruby 4.x API

DEPRECATED. Use the namespaced function [`mysql::password`](#mysqlpassword) instead.

#### `mysql_password(Variant[String, Sensitive[String]] $password, Optional[Boolean] $sensitive)`

The mysql_password function.

Returns: `Variant[String, Sensitive[String]]` The mysql password hash from the 4.x function mysql::password.

##### `password`

Data type: `Variant[String, Sensitive[String]]`

Plain text password.

##### `sensitive`

Data type: `Optional[Boolean]`



## Data types

### <a name="mysqloptions"></a>`Mysql::Options`

Use this if you don’t want your options merged with the default options.

Alias of

```puppet
Hash[String, Hash]
```

## Tasks

### <a name="export"></a>`export`

Allows you to backup your database to local file.

**Supports noop?** false

#### Parameters

##### `database`

Data type: `Optional[String[1]]`

Database to connect to

##### `user`

Data type: `Optional[String[1]]`

The user

##### `password`

Data type: `Optional[String[1]]`

The password

##### `file`

Data type: `String[1]`

Path to file you want backup to

### <a name="sql"></a>`sql`

Allows you to execute arbitary SQL

**Supports noop?** false

#### Parameters

##### `database`

Data type: `Optional[String[1]]`

Database to connect to

##### `user`

Data type: `Optional[String[1]]`

The user

##### `password`

Data type: `Optional[String[1]]`

The password

##### `sql`

Data type: `String[1]`

The SQL you want to execute