Doc Attributes (#555) (#557)

* Added Attributes section

* Added Attributes section

(cherry picked from commit b79fd94d51)

Co-authored-by: Pavel Rabel <128324708+elpavel@users.noreply.github.com>
This commit is contained in:
patchback[bot] 2023-05-29 11:02:20 +02:00 committed by GitHub
parent bbbd38855b
commit 89d1637c32
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
8 changed files with 28 additions and 9 deletions

View file

@ -110,4 +110,7 @@ notes:
- Alternatively, to avoid using I(login_unix_socket) argument on each invocation you can specify the socket path
using the `socket` option in your MySQL config file (usually C(~/.my.cnf)) on the destination host, for
example C(socket=/var/lib/mysql/mysql.sock).
attributes:
check_mode:
description: Can run in check_mode and return changed status prediction without modifying target.
'''

View file

@ -173,13 +173,14 @@ requirements:
- mysql (command line binary)
- mysqldump (command line binary)
notes:
- Supports C(check_mode).
- Requires the mysql and mysqldump binaries on the remote host.
- This module is B(not idempotent) when I(state) is C(import),
and will import the dump file each time if run more than once.
attributes:
check_mode:
support: full
extends_documentation_fragment:
- community.mysql.mysql
'''
EXAMPLES = r'''

View file

@ -47,7 +47,10 @@ options:
notes:
- Calculating the size of a database might be slow, depending on the number and size of tables in it.
To avoid this, use I(exclude_fields=db_size).
- Supports C(check_mode).
attributes:
check_mode:
support: full
seealso:
- module: community.mysql.mysql_variables

View file

@ -50,6 +50,9 @@ options:
- Where passed queries run in a single transaction (C(yes)) or commit them one-by-one (C(no)).
type: bool
default: false
attributes:
check_mode:
support: none
seealso:
- module: community.mysql.mysql_db
author:

View file

@ -194,10 +194,13 @@ options:
notes:
- If an empty value for the parameter of string type is needed, use an empty string.
attributes:
check_mode:
support: none
extends_documentation_fragment:
- community.mysql.mysql
seealso:
- module: community.mysql.mysql_info
- name: MySQL replication reference

View file

@ -109,7 +109,10 @@ notes:
- Pay attention that the module runs C(SET DEFAULT ROLE ALL TO)
all the I(members) passed by default when the state has changed.
If you want to avoid this behavior, set I(set_default_role_all) to C(no).
- Supports C(check_mode).
attributes:
check_mode:
support: full
seealso:
- module: community.mysql.mysql_user

View file

@ -131,7 +131,10 @@ notes:
2) drop a C(~/.my.cnf) file containing the new root credentials.
Subsequent runs of the playbook will then succeed by reading the new credentials from the file."
- Currently, there is only support for the C(mysql_native_password) encrypted password hash module.
- Supports (check_mode).
attributes:
check_mode:
support: full
seealso:
- module: community.mysql.mysql_info
@ -148,7 +151,6 @@ author:
- Lukasz Tomaszkiewicz (@tomaszkiewicz)
extends_documentation_fragment:
- community.mysql.mysql
'''
EXAMPLES = r'''

View file

@ -44,8 +44,9 @@ options:
default: global
version_added: '0.1.0'
notes:
- Does not support C(check_mode).
attributes:
check_mode:
support: none
seealso:
- module: community.mysql.mysql_info