community.mysql/changelogs/changelog.yaml

ancestor: null
releases:
  1.0.0:
    changes:
      bugfixes:
      - mysql - dont mask ``mysql_connect`` function errors from modules (https://github.com/ansible/ansible/issues/64560).
      - mysql_db - fix Broken pipe error appearance when state is import and the target
        file is compressed (https://github.com/ansible/ansible/issues/20196).
      - mysql_db - fix bug in the ``db_import`` function introduced by https://github.com/ansible/ansible/pull/56721
        (https://github.com/ansible/ansible/issues/65351).
      - mysql_info - add parameter for __collect to get only what are wanted (https://github.com/ansible-collections/community.general/pull/136).
      - mysql_replication - allow to pass empty values to parameters (https://github.com/ansible/ansible/issues/23976).
      - mysql_user - Fix idempotence when long grant lists are used (https://github.com/ansible/ansible/issues/68044)
      - mysql_user - Remove false positive ``no_log`` warning for ``update_password``
        option
      - mysql_user - add ``INVOKE LAMBDA`` privilege support (https://github.com/ansible-collections/community.general/issues/283).
      - mysql_user - add missed privileges to support (https://github.com/ansible-collections/community.general/issues/617).
      - mysql_user - fix ``host_all`` arguments conversion string formatting error
        (https://github.com/ansible/ansible/issues/29644).
      - mysql_user - fix overriding password to the same (https://github.com/ansible-collections/community.general/issues/543).
      - mysql_user - fix support privileges with underscore (https://github.com/ansible/ansible/issues/66974).
      - mysql_user - fix the error No database selected (https://github.com/ansible/ansible/issues/68070).
      - mysql_user - make sure current_pass_hash is a string before using it in comparison
        (https://github.com/ansible/ansible/issues/60567).
      - mysql_variable - fix the module doesn't support variables name with dot (https://github.com/ansible/ansible/issues/54239).
      minor_changes:
      - mysql_db - add ``master_data`` parameter (https://github.com/ansible/ansible/pull/66048).
      - mysql_db - add ``skip_lock_tables`` option (https://github.com/ansible/ansible/pull/66688).
      - mysql_db - add the ``check_implicit_admin`` parameter (https://github.com/ansible/ansible/issues/24418).
      - mysql_db - add the ``dump_extra_args`` parameter (https://github.com/ansible/ansible/pull/67747).
      - mysql_db - add the ``executed_commands`` returned value (https://github.com/ansible/ansible/pull/65498).
      - mysql_db - add the ``force`` parameter (https://github.com/ansible/ansible/pull/65547).
      - mysql_db - add the ``restrict_config_file`` parameter (https://github.com/ansible/ansible/issues/34488).
      - mysql_db - add the ``unsafe_login_password`` parameter (https://github.com/ansible/ansible/issues/63955).
      - mysql_db - add the ``use_shell`` parameter (https://github.com/ansible/ansible/issues/20196).
      - mysql_info - add ``exclude_fields`` parameter (https://github.com/ansible/ansible/issues/63319).
      - mysql_info - add ``global_status`` filter parameter option and return (https://github.com/ansible/ansible/pull/63189).
      - mysql_info - add ``return_empty_dbs`` parameter to list empty databases (https://github.com/ansible/ansible/issues/65727).
      - mysql_replication - add ``channel`` parameter (https://github.com/ansible/ansible/issues/29311).
      - mysql_replication - add ``connection_name`` parameter (https://github.com/ansible/ansible/issues/46243).
      - mysql_replication - add ``fail_on_error`` parameter (https://github.com/ansible/ansible/pull/66252).
      - mysql_replication - add ``master_delay`` parameter (https://github.com/ansible/ansible/issues/51326).
      - mysql_replication - add ``master_use_gtid`` parameter (https://github.com/ansible/ansible/pull/62648).
      - mysql_replication - add ``queries`` return value (https://github.com/ansible/ansible/pull/63036).
      - mysql_replication - add support of ``resetmaster`` choice to ``mode`` parameter
        (https://github.com/ansible/ansible/issues/42870).
      - mysql_user - ``priv`` parameter can be string or dictionary (https://github.com/ansible/ansible/issues/57533).
      - mysql_user - add TLS REQUIRES parameters (https://github.com/ansible-collections/community.mysql/pull/9).
      - mysql_user - add ``plugin_auth_string`` parameter (https://github.com/ansible/ansible/pull/44267).
      - mysql_user - add ``plugin_hash_string`` parameter (https://github.com/ansible/ansible/pull/44267).
      - mysql_user - add ``plugin`` parameter (https://github.com/ansible/ansible/pull/44267).
      - mysql_user - add the resource_limits parameter (https://github.com/ansible-collections/community.general/issues/133).
      - mysql_variables - add ``mode`` parameter (https://github.com/ansible/ansible/issues/60119).
      release_summary: 'This is the first proper release of the ``community.mysql``
        collection.

        This changelog contains all changes to the modules in this collection that
        were added after the release of Ansible 2.9.0.

        '
    fragments:
    - 1.0.0.yml
    - 142-mysql_user_add_resource_limit_parameter.yml
    - 151-mysql_db_add_use_shell_parameter.yml
    - 18-mysql_user-update_password-no_log.yml
    - 225-mysql_user_fix_no_database_selected.yml
    - 285-mysql_user_invoke_lambda_support.yml
    - 369-mysql_user_add_tls_requires.yml
    - 428-mysql_db_add_unsafe_login_password_param.yml
    - 468-mysql_db_add_restrict_config_file_param.yml
    - 486-mysql_db_add_check_implicit_admin_parameter.yml
    - 490-mysql_user_fix_cursor_errors.yml
    - 609-mysql_user_fix_overriding_password_to_the_same.yml
    - 618-mysql_user_add_missed_privileges.yml
    - 62648-mysql_replication_add_master_use_gtid_param.yml
    - 63036-mysql_replication_add_return_value.yml
    - 63130-mysql_replication_add_master_delay_parameter.yml
    - 63189-mysql_info-global-status.yml
    - 63229-mysql_replication_add_connection_name_parameter.yml
    - 63271-mysql_replication_add_channel_parameter.yml
    - 63321-mysql_replication_add_resetmaster_to_mode.yml
    - 63371-mysql_info_add_exclude_fields_parameter.yml
    - 63546-mysql_replication_allow_to_pass_empty_values.yml
    - 63547-mysql_variables_add_mode_param.yml
    - 64059-mysql_user_fix_password_comparison.yaml
    - 64585-mysql_dont_mask_mysql_connect_errors_from_modules.yml
    - 65498-mysql_db_add_executed_commands_return_val.yml
    - 65547-mysql_db_add_force_param.yml
    - 65755-mysql_info_doesnt_list_empty_dbs.yml
    - 65789-mysql_user_add_plugin_authentication_parameters.yml
    - 66048-mysql_add_master_data_parameter.yml
    - 66252-mysql_replication_fail_on_error.yml
    - 66688-mysql_db_add_skip_lock_tables_option.yml
    - 66801-mysql_user_priv_can_be_dict.yml
    - 66806-mysql_variables_not_support_variables_with_dot.yml
    - 66974-mysql_user_doesnt_support_privs_with_underscore.yml
    - 67337-fix-proxysql-mysql-cursor.yaml
    - 67747-mysql_db_add_dump_extra_args_param.yml
    - 67767-mysql_db_fix_bug_introduced_by_56721.yml
    - mysql_info_add_parameter.yml
    - mysql_user_idempotency.yml
    release_date: '2020-08-17'
  1.0.1:
    changes:
      bugfixes:
      - mysql_db - fix false warning related to ``unsafe_login_password`` option (https://github.com/ansible-collections/community.mysql/issues/33).
      - mysql_user - added tests to verify that TLS requirements are removed with
        an empty ``tls_requires`` option (https://github.com/ansible-collections/community.mysql/issues/20).
      - mysql_user - correct procedure to check existing TLS requirements (https://github.com/ansible-collections/community.mysql/pull/26).
      - mysql_user - minor syntax fixes (https://github.com/ansible-collections/community.mysql/pull/26).
      release_summary: 'This is the patch release of the ``community.mysql`` collection.

        This changelog contains all changes to the modules in this collection that
        have been added after the release of ``community.mysql`` 1.0.0.

        '
    fragments:
    - 1.0.1.yml
    - 26-remove_tls_requirements.yml
    - 34-mysql_db_fix_false_warning.yml
    release_date: '2020-09-29'
  1.0.2:
    changes:
      bugfixes:
      - mysql_user - fix module's crash when modifying a user with ``host_all`` (https://github.com/ansible-collections/community.mysql/issues/39).
      release_summary: 'This is the patch release of the ``community.mysql`` collection.

        This changelog contains all changes to the modules in this collection that
        have been added after the release of ``community.mysql`` 1.0.1.

        '
    fragments:
    - 1.0.2.yml
    - 40-mysql_user_fix_error_when_host_all_used.yml
    release_date: '2020-10-01'
  1.1.0:
    changes:
      bugfixes:
      - mysql modules - fix crash when ``!includedir`` option is in config file (https://github.com/ansible-collections/community.mysql/issues/46).
      minor_changes:
      - mysql modules - add the ``check_hostname`` option (https://github.com/ansible-collections/community.mysql/issues/28).
      - mysql modules - patch the ``Connection`` class to add a destructor that ensures
        connections to the server are explicitly closed (https://github.com/ansible-collections/community.mysql/pull/44).
      release_summary: 'This is the minor release of the ``community.mysql`` collection.

        This changelog contains all changes to the modules in this collection that
        have been added after the release of ``community.mysql`` 1.0.2.

        '
    fragments:
    - 1.1.0.yml
    - 35-disable-hostname-check.yml
    - 44-close-connection.yml
    - 47-mysql_modules_fix_failings_when_include_dir_in_config_file.yml
    release_date: '2020-10-13'
  1.1.1:
    changes:
      bugfixes:
      - mysql_query - fix failing when single-row query contains commas (https://github.com/ansible-collections/community.mysql/issues/51).
      release_summary: 'This is the patch release of the ``community.mysql`` collection.

        This changelog contains all changes to the modules in this collection that

        have been added after the release of ``community.mysql`` 1.1.0.

        '
    fragments:
    - 1.1.1.yml
    - 53-mysql_query_fix_single_query_with_commas.yml
    release_date: '2020-11-03'
  1.1.2:
    changes:
      bugfixes:
      - mysql_db - fix false warning related to ``unsafe_login_password`` option (https://github.com/ansible-collections/community.mysql/issues/33).
      - mysql_replication - fix crashes of mariadb >= 10.5.1 and mysql >= 8.0.22 caused
        by using deprecated terminology (https://github.com/ansible-collections/community.mysql/issues/70).
      - mysql_user - fixed change detection when using append_privs (https://github.com/ansible-collections/community.mysql/pull/72).
      minor_changes:
      - mysql_query - simple refactoring of query type check (https://github.com/ansible-collections/community.mysql/pull/58).
      - mysql_user - simple refactoring of priv type check (https://github.com/ansible-collections/community.mysql/pull/58).
      release_summary: 'This is the patch release of the ``community.mysql`` collection.

        This changelog contains all changes to the modules in this collection that

        have been added after the release of ``community.mysql`` 1.1.1.'
    fragments:
    - 1.1.2.yml
    - 58-mysql_query_refactoring.yml
    - 71-mysql_replication_add_replica_keyword_support.yml
    - 72-mysql_db_fix_false_warning.yml
    - 72-mysql_user_change_detection.yml
    release_date: '2020-12-18'
  1.2.0:
    changes:
      bugfixes:
      - mysql_user - add ``SHOW_ROUTINE`` privilege support (https://github.com/ansible-collections/community.mysql/issues/86).
      - mysql_user - fixed creating user with encrypted password in MySQL 8.0 (https://github.com/ansible-collections/community.mysql/pull/79).
      minor_changes:
      - mysql_user - refactor to reduce cursor.execute() calls in preparation for
        adding query logging (https://github.com/ansible-collections/community.mysql/pull/76).
      release_summary: 'This is the minor release of the ``community.mysql`` collection.

        This changelog contains all changes to the modules in this collection

        that have been added after the release of ``community.mysql`` 1.1.2.'
    fragments:
    - 1.2.0.yml
    - 76-mysql-user-query-refact.yaml
    - 79-mysql-user-tests-and-fixes.yml
    - 87-mysql_user_show_routine_support.yml
    release_date: '2021-01-18'
  1.3.0:
    changes:
      bugfixes:
      - mysql_user - fix handling of INSERT, UPDATE, REFERENCES on columns (https://github.com/ansible-collections/community.mysql/issues/106).
      - mysql_user - the module is not idempotent when SELECT on columns granted (https://github.com/ansible-collections/community.mysql/issues/99).
      major_changes:
      - mysql_replication - the mode options values ``getslave``, ``startslave``,
        ``stopslave``, ``resetslave``, ``resetslaveall` and the master_use_gtid option
        ``slave_pos`` are deprecated (see the alternative values) and will be removed
        in ``community.mysql`` 3.0.0 (https://github.com/ansible-collections/community.mysql/pull/97).
      - mysql_replication - the word ``SLAVE`` in messages returned by the module
        will be changed to ``REPLICA`` in ``community.mysql`` 2.0.0 (https://github.com/ansible-collections/community.mysql/issues/98).
      minor_changes:
      - mysql_replication - deprecate offending terminology, add alternative choices
        to the ``mode`` option (https://github.com/ansible-collections/community.mysql/issues/78).
      release_summary: 'This is the minor release of the ``community.mysql`` collection.

        This changelog contains all changes to the modules in this collection

        that have been added after the release of ``community.mysql`` 1.2.0.'
    fragments:
    - 1.3.0.yml
    - 100-mysql_user_not_idemponent_when_select_on_columns_granted.yml
    - 107-mysql_user_fix_grant_on_col_handling.yml
    - 97-mysql_replication_deprecate_offending_terminology.yml
    release_date: '2021-03-08'
  2.0.0:
    changes:
      bugfixes:
      - mysql_user - add support for ``REPLICA MONITOR`` privilege (https://github.com/ansible-collections/community.mysql/issues/105).
      major_changes:
      - mysql_replication - the return value ``Is_Slave`` and ``Is_Master`` will be
        replaced with ``Is_Replica`` and ``Is_Primary`` in ``community.mysql`` 3.0.0
        (https://github.com/ansible-collections/community.mysql/issues/145).
      - mysql_replication - the word ``master`` in messages returned by the module
        will be replaced with ``primary`` in ``community.mysql`` 3.0.0 (https://github.com/ansible-collections/community.mysql/issues/145).
      - mysql_replication - the word ``slave`` in messages returned by the module
        replaced with ``replica`` (https://github.com/ansible-collections/community.mysql/issues/98).
      - mysql_user - the ``REQUIRESSL`` is an alias for the ``ssl`` key in the ``tls_requires``
        option in ``community.mysql`` 2.0.0 and support will be dropped altogether
        in ``community.mysql`` 3.0.0 (https://github.com/ansible-collections/community.mysql/issues/121).
      minor_changes:
      - mysql module utils - change deprecated connection parameters ``passwd`` and
        ``db`` to ``password`` and ``database`` (https://github.com/ansible-collections/community.mysql/pull/116).
      - mysql_collection - introduce codebabse split to handle divergences between
        MySQL and MariaDB (https://github.com/ansible-collections/community.mysql/pull/103).
      - mysql_info - add `version.full` and `version.suffix` return values (https://github.com/ansible-collections/community.mysql/issues/114).
      - mysql_user - deprecate the ``REQUIRESSL`` privilege (https://github.com/ansible-collections/community.mysql/issues/101).
      release_summary: This is release 2.0.0 of the ``community.mysql`` collection,
        released on 2021-04-15.
    fragments:
    - 101-drop-requiressl-support.yml
    - 103-mysql_and_mariadb_divergence.yml
    - 108-mysql_priv_add_grant.yml
    - 115-add_mysql_full_version_suffix_return_var.yml
    - 116-change_deprecated_connection_ parameters.yml
    - 144-mysql_replication_remove_slave_from_messages.yml
    - 2.0.0.yml
    release_date: '2021-04-15'
  2.1.0:
    changes:
      bugfixes:
      - mysql - revert changes of connector arguments made in pull request 116 causing
        the invalid keyword argument error (https://github.com/ansible-collections/community.mysql/pull/116).
      major_changes:
      - mysql_replication - add deprecation warning that the ``Is_Slave`` and ``Is_Master``
        return values will be replaced with ``Is_Primary`` and ``Is_Replica`` in ``community.mysql``
        3.0.0 (https://github.com/ansible-collections/community.mysql/pull/147).
      - mysql_replication - the choices of the ``state`` option containing ``master``
        will be finally replaced with the alternative ``primary`` choices in ``community.mysql``
        3.0.0, add deprecation warnings (https://github.com/ansible-collections/community.mysql/pull/150).
      minor_changes:
      - mysql_replication - add alternative (``primary``) choices to the ``state``
        option choices containing ``master`` (https://github.com/ansible-collections/community.mysql/pull/150).
      - mysql_replication - add the ``Is_Primary`` and ``Is_Replica`` alternatives
        to the ``Is_Slave`` and ``Is_Master`` return values as a preparation for replacement
        in ``community.mysql`` 3.0.0 (https://github.com/ansible-collections/community.mysql/pull/147).
      - mysql_replication - change ``master_`` options to ``primary_`` options, add
        aliases to keep compatibility (https://github.com/ansible-collections/community.mysql/pull/150).
      release_summary: 'This is the minor release of the ``community.mysql`` collection.

        This changelog contains all changes to the modules in this collection

        that have been added after the release of ``community.mysql`` 2.0.0.'
    fragments:
    - 147-mysql_replication_deprecate_ret_vals.yml
    - 150-mysql_replication_master_related.yml
    - 153-mysql_revert_connector_changes.yml
    release_date: '2021-04-23'
  2.1.1:
    changes:
      minor_changes:
      - mysql_query - correctly reflect changed status in replace statements (https://github.com/ansible-collections/community.mysql/pull/193).
      release_summary: 'This is the patch release of the ``community.mysql`` collection.

        This changelog contains all changes to the modules in this collection that

        have been added after the release of ``community.mysql`` 2.1.0.'
    fragments:
    - 193-reflect_changed_status_in_replace_statements.yml
    - 2.1.1.yml
    release_date: '2021-08-11'
  2.2.0:
    changes:
      release_summary: 'This is the minor release of the ``community.mysql`` collection.

        This changelog contains all changes to the modules in this collection that

        have been added after the release of ``community.mysql`` 2.1.1'
    fragments:
    - 2.2.0.yml
    release_date: '2021-09-23'
  2.2.0-a1:
    changes:
      release_summary: 'This is the minor pre-release of the ``community.mysql`` collection.

        This changelog contains all changes to the modules in this collection that

        have been added after the release of ``community.mysql`` 2.1.1'
    fragments:
    - 2.2.0-a1.yml
    modules:
    - description: Adds, removes, or updates a MySQL role
      name: mysql_role
      namespace: ''
    release_date: '2021-08-11'
  2.3.0:
    changes:
      bugfixes:
      - mysql_info - fix TypeError failure when there are databases that do not contain
        tables (https://github.com/ansible-collections/community.mysql/issues/204).
      minor_changes:
      - mysql_user - replace VALID_PRIVS constant by get_valid_privs() function (https://github.com/ansible-collections/community.mysql/pull/217).
      release_summary: 'This is the minor release of the ``community.mysql`` collection.

        This changelog contains all changes to the modules in this collection that

        have been added after the release of ``community.mysql`` 2.2.0.'
    fragments:
    - 2.3.0.yml
    - 205-mysql_info_fix_failure_when_no_tables_in_db.yml
    - 217-mysql-user-replace-get-valid-privs-from-show-privilegees.yml
    release_date: '2021-09-23'
  2.3.1:
    changes:
      bugfixes:
      - mysql_user - Fix crash reporting ``Invalid privileges specified`` when passing
        privileges that became aliases (https://github.com/ansible-collections/community.mysql/issues/232).
      release_summary: 'This is the patch release of the ``community.mysql`` collection.

        This changelog contains all changes to the modules in this collection that

        have been added after the release of ``community.mysql`` 2.3.0.'
    fragments:
    - 2.3.1.yml
    - 233-mysql_user_return_valid_privs.yml
    release_date: '2021-10-19'
  2.3.2:
    changes:
      bugfixes:
      - mysql_db - Fix mismatch when database name contains a ``%`` character (https://github.com/ansible-collections/community.mysql/pull/227).
      release_summary: 'This is the patch release of the ``community.mysql`` collection.

        This changelog contains all changes to the modules in this collection that

        have been added after the release of ``community.mysql`` 2.3.1.'
    fragments:
    - 2.3.2.yml
    - 227-db-create-special-name.yaml
    release_date: '2021-11-29'
  2.3.3:
    changes:
      bugfixes:
      - Collection core functions - use vendored version of ``distutils.version``
        instead of the deprecated Python standard library ``distutils`` (https://github.com/ansible-collections/community.mysql/pull/269).
      release_summary: This is the patch release of the ``community.mysql`` collection.
        This changelog contains all changes to the modules in this collection that
        have been added after the release of ``community.mysql`` 2.3.2.
    fragments:
    - 2.3.3.yml
    - 267-prepare_for_distutils_be_removed.yml
    release_date: '2022-01-18'
  2.3.4:
    changes:
      bugfixes:
      - mysql_role - make the ``set_default_role_all`` parameter actually working
        (https://github.com/ansible-collections/community.mysql/pull/282).
      release_summary: This is the patch release of the ``community.mysql`` collection.
        This changelog contains all changes to the modules in this collection that
        have been added after the release of ``community.mysql`` 2.3.3.
    fragments:
    - 2.3.4.yml
    - 282-mysql_role_fix_set_default_role_all_argument.yml
    release_date: '2022-02-16'
  2.3.5:
    changes:
      bugfixes:
      - Collection core functions - fixes related to the mysqlclient Python connector
        (https://github.com/ansible-collections/community.mysql/issues/292).
      release_summary: This is the patch release of the ``community.mysql`` collection.
        This changelog contains all changes to the modules in this collection that
        have been added after the release of ``community.mysql`` 2.3.4.
    fragments:
    - 0-mysqlclient.yml
    - 2.3.5.yml
    release_date: '2022-03-14'
  2.3.6:
    changes:
      bugfixes:
      - mysql_role - remove redundant connection closing (https://github.com/ansible-collections/community.mysql/pull/330).
      - mysql_user - fix missing dynamic privileges after revoke and grant privileges
        to user (https://github.com/ansible-collections/community.mysql/issues/120).
      - mysql_user - fix parsing privs when a user has roles assigned (https://github.com/ansible-collections/community.mysql/issues/231).
      - 'mysql_user - fix the possibility for a race condition that breaks certain
        (circular) replication configurations when ``DROP USER`` is executed on multiple
        nodes in the replica set. Adding ``IF EXISTS`` avoids the need to use ``sql_log_bin:
        no`` making the statement always replication safe (https://github.com/ansible-collections/community.mysql/pull/287).'
      major_changes:
      - The community.mysql collection no longer supports ``Ansible 2.9`` and ``ansible-base
        2.10``. While we take no active measures to prevent usage and there are no
        plans to introduce incompatible code to the modules, we will stop testing
        against ``Ansible 2.9`` and ``ansible-base 2.10``. Both will very soon be
        End of Life and if you are still using them, you should consider upgrading
        to the ``latest Ansible / ansible-core 2.11 or later`` as soon as possible
        (https://github.com/ansible-collections/community.mysql/pull/343).
      release_summary: 'This is the patch release of the ``community.mysql`` collection.

        This changelog contains all changes to the modules in this collection

        that have been added after the release of ``community.mysql`` 2.3.5.'
    fragments:
    - 001-mysql_user_fix_pars_users_with_roles_assigned.yml
    - 2.3.6.yml
    - 307-mysql_user_add_if_exists_to_drop.yml
    - 329-mysql_role-remove-redudant-connection-closing.yml
    - 338-mysql_user_fix_missing_dynamic_privileges.yml
    - drop_support_of_2.9-2.10.yml
    release_date: '2022-05-13'