Skip to content

Commit

Permalink
Docs: change yes/no to true/false (ansible-collections#480)
Browse files Browse the repository at this point in the history
  • Loading branch information
Andersson007 authored Jan 3, 2023
1 parent 8a579b4 commit 3ff1fad
Show file tree
Hide file tree
Showing 7 changed files with 54 additions and 54 deletions.
26 changes: 13 additions & 13 deletions plugins/modules/mysql_db.py
Original file line number Diff line number Diff line change
Expand Up @@ -53,12 +53,12 @@
description:
- Execute the dump in a single transaction.
type: bool
default: no
default: false
quick:
description:
- Option used for dumping large tables.
type: bool
default: yes
default: true
ignore_tables:
description:
- A list of table names that will be ignored in the dump
Expand All @@ -70,14 +70,14 @@
description:
- Dump binary columns using hexadecimal notation.
type: bool
default: no
default: false
version_added: '0.1.0'
force:
description:
- Continue dump or import even if we get an SQL error.
- Used only when I(state) is C(dump) or C(import).
type: bool
default: no
default: false
version_added: '0.1.0'
master_data:
description:
Expand All @@ -96,7 +96,7 @@
description:
- Skip locking tables for read. Used when I(state=dump), ignored otherwise.
type: bool
default: no
default: false
version_added: '0.1.0'
dump_extra_args:
description:
Expand All @@ -110,7 +110,7 @@
- If C(yes), the module will internally execute commands via a shell.
- Used when I(state=import), ignored otherwise.
type: bool
default: no
default: false
version_added: '0.1.0'
unsafe_login_password:
description:
Expand All @@ -121,7 +121,7 @@
- Used only when I(state) is C(import) or C(dump) and
I(login_password) is passed, ignored otherwise.
type: bool
default: no
default: false
version_added: '0.1.0'
restrict_config_file:
description:
Expand All @@ -132,14 +132,14 @@
under the hood that read named option file in addition to usual option files.
- If this behavior is undesirable, use C(yes) to read only named option file.
type: bool
default: no
default: false
version_added: '0.1.0'
check_implicit_admin:
description:
- Check if mysql allows login as root/nopassword before trying supplied credentials.
- If success, passed I(login_user)/I(login_password) will be ignored.
type: bool
default: no
default: false
version_added: '0.1.0'
config_overrides_defaults:
description:
Expand All @@ -148,7 +148,7 @@
- Used when I(stat) is C(present) or C(absent), ignored otherwise.
- It needs Python 3.5+ as the default interpreter on a target host.
type: bool
default: no
default: false
version_added: '0.1.0'
chdir:
description:
Expand All @@ -163,7 +163,7 @@
- The default is C(no) to prevent issues on systems without bash as a default interpreter.
- The default will change to C(yes) in community.mysql 4.0.0.
type: bool
default: no
default: false
version_added: '3.4.0'
seealso:
Expand Down Expand Up @@ -230,7 +230,7 @@
name: my_db
state: import
target: /tmp/dump.sql.bz2
force: yes
force: true
- name: Dump multiple databases
community.mysql.mysql_db:
Expand Down Expand Up @@ -302,7 +302,7 @@
- name: Try to create database as root/nopassword first. If not allowed, pass the credentials
community.mysql.mysql_db:
check_implicit_admin: yes
check_implicit_admin: true
login_user: bob
login_password: 123456
name: bobdata
Expand Down
10 changes: 5 additions & 5 deletions plugins/modules/mysql_info.py
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@
description:
- Includes names of empty databases to returned dictionary.
type: bool
default: no
default: false
notes:
- Calculating the size of a database might be slow, depending on the number and size of tables in it.
Expand Down Expand Up @@ -96,28 +96,28 @@
filter: "!settings,!users"
- name: Collect info about databases and version using ~/.my.cnf as a credential file
become: yes
become: true
community.mysql.mysql_info:
filter:
- databases
- version
- name: Collect info about databases and version using ~alice/.my.cnf as a credential file
become: yes
become: true
community.mysql.mysql_info:
config_file: /home/alice/.my.cnf
filter:
- databases
- version
- name: Collect info about databases including empty and excluding their sizes
become: yes
become: true
community.mysql.mysql_info:
config_file: /home/alice/.my.cnf
filter:
- databases
exclude_fields: db_size
return_empty_dbs: yes
return_empty_dbs: true
'''

RETURN = r'''
Expand Down
6 changes: 3 additions & 3 deletions plugins/modules/mysql_query.py
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@
the state has been changed even if it has not. If it is important in your
workflow, use the C(PyMySQL) connector instead.
type: raw
required: yes
required: true
positional_args:
description:
- List of values to be passed as positional arguments to the query.
Expand All @@ -46,7 +46,7 @@
description:
- Where passed queries run in a single transaction (C(yes)) or commit them one-by-one (C(no)).
type: bool
default: no
default: false
seealso:
- module: community.mysql.mysql_db
author:
Expand Down Expand Up @@ -87,7 +87,7 @@
query:
- INSERT INTO articles (id, story) VALUES (2, 'my_long_story')
- INSERT INTO prices (id, price) VALUES (123, '100.00')
single_transaction: yes
single_transaction: true
'''

RETURN = r'''
Expand Down
6 changes: 3 additions & 3 deletions plugins/modules/mysql_replication.py
Original file line number Diff line number Diff line change
Expand Up @@ -184,7 +184,7 @@
description:
- Fails on error when calling mysql.
type: bool
default: False
default: false
version_added: '0.1.0'
notes:
Expand Down Expand Up @@ -263,12 +263,12 @@
community.mysql.mysql_replication:
mode: startreplica
connection_name: primary-1
fail_on_error: yes
fail_on_error: true
- name: Change primary and fail on error (like when replica thread is running)
community.mysql.mysql_replication:
mode: changeprimary
fail_on_error: yes
fail_on_error: true
'''

Expand Down
32 changes: 16 additions & 16 deletions plugins/modules/mysql_role.py
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@
- Append the privileges defined by the I(priv) option to the existing ones
for this role instead of overwriting them. Mutually exclusive with I(subtract_privs).
type: bool
default: no
default: false
subtract_privs:
description:
Expand All @@ -62,7 +62,7 @@
Mutually exclusive with I(append_privs).
version_added: '3.2.0'
type: bool
default: no
default: false
members:
description:
Expand All @@ -80,23 +80,23 @@
for this role instead of overwriting them.
- Mutually exclusive with the I(detach_members) and I(admin) option.
type: bool
default: no
default: false
detach_members:
description:
- Detaches members defined by the I(members) option from the role
instead of overwriting all the current members.
- Mutually exclusive with the I(append_members) and I(admin) option.
type: bool
default: no
default: false
set_default_role_all:
description:
- Is not supported by MariaDB and is silently ignored when working with MariaDB.
- If C(yes), runs B(SET DEFAULT ROLE ALL TO) each of the I(members) when changed.
- If you want to avoid this behavior, set this option to C(no) explicitly.
type: bool
default: yes
default: true
state:
description:
Expand All @@ -112,14 +112,14 @@
- Check if mysql allows login as root/nopassword before trying supplied credentials.
- If success, passed I(login_user)/I(login_password) will be ignored.
type: bool
default: no
default: false
members_must_exist:
description:
- When C(yes), the module fails if any user in I(members) does not exist.
- When C(no), users in I(members) which don't exist are simply skipped.
type: bool
default: yes
default: true
notes:
- Pay attention that the module runs C(SET DEFAULT ROLE ALL TO)
Expand Down Expand Up @@ -181,15 +181,15 @@
members:
- 'alice@%'
- 'bob@%'
set_default_role_all: no
set_default_role_all: false
# Assuming that the role developers exists,
# add john to the current members
- name: Add members to an existing role
community.mysql.mysql_role:
name: developers
state: present
append_members: yes
append_members: true
members:
- 'joe@localhost'
Expand All @@ -208,7 +208,7 @@
name: readers
state: present
priv: 'fiction.*:UPDATE'
append_privs: yes
append_privs: true
- name: Create role with the 'SELECT' and 'UPDATE' privileges in db1 and db2
community.mysql.mysql_role:
Expand All @@ -224,7 +224,7 @@
name: readers
members:
- 'joe@localhost'
detach_members: yes
detach_members: true
- name: Remove the role readers if exists
community.mysql.mysql_role:
Expand Down Expand Up @@ -258,16 +258,16 @@
community.mysql.mysql_role:
state: present
name: foo
subtract_privs: yes
subtract_privs: true
priv:
'db1.*': DELETE
- name: Add some members to a role and skip not-existent users
community.mysql.mysql_role:
state: present
name: foo
append_members: yes
members_must_exist: no
append_members: true
members_must_exist: false
members:
- 'existing_user@localhost'
- 'not_existing_user@localhost'
Expand All @@ -276,8 +276,8 @@
community.mysql.mysql_role:
state: present
name: foo
detach_members: yes
members_must_exist: no
detach_members: true
members_must_exist: false
members:
- 'existing_user@localhost'
- 'not_existing_user@localhost'
Expand Down
Loading

0 comments on commit 3ff1fad

Please sign in to comment.