Skip to content

Commit

Permalink
Docs: change yes/no to true/false (ansible-collections#480) (ansible-…
Browse files Browse the repository at this point in the history
…collections#482)

(cherry picked from commit 3ff1fad)
  • Loading branch information
Andersson007 authored Jan 3, 2023
1 parent 43e688a commit 43a8037
Show file tree
Hide file tree
Showing 6 changed files with 34 additions and 34 deletions.
24 changes: 12 additions & 12 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'
seealso:
Expand Down Expand Up @@ -215,7 +215,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 @@ -287,7 +287,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 @@ -167,7 +167,7 @@
description:
- Fails on error when calling mysql.
type: bool
default: False
default: false
version_added: '0.1.0'
notes:
Expand Down Expand Up @@ -246,12 +246,12 @@
community.mysql.mysql_replication:
mode: startreplica
connection_name: master-1
fail_on_error: yes
fail_on_error: true
- name: Change master and fail on error (like when replica thread is running)
community.mysql.mysql_replication:
mode: changemaster
fail_on_error: yes
fail_on_error: true
'''

Expand Down
20 changes: 10 additions & 10 deletions plugins/modules/mysql_user.py
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@
description:
- Indicate that the 'password' field is a `mysql_native_password` hash.
type: bool
default: no
default: false
host:
description:
- The 'host' part of the MySQL username.
Expand All @@ -41,7 +41,7 @@
to all hostnames for a given user.
- This option cannot be used when creating users.
type: bool
default: no
default: false
priv:
description:
- "MySQL privileges string in the format: C(db.table:priv1,priv2)."
Expand All @@ -66,7 +66,7 @@
- Append the privileges defined by priv to the existing ones for this
user instead of overwriting existing ones.
type: bool
default: no
default: false
tls_requires:
description:
- Set requirement for secure transport as a dictionary of requirements (see the examples).
Expand All @@ -79,7 +79,7 @@
description:
- Whether binary logging should be enabled or disabled for the connection.
type: bool
default: yes
default: true
state:
description:
- Whether the user should exist.
Expand All @@ -92,7 +92,7 @@
- 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
update_password:
description:
- C(always) will update passwords if they differ. This affects I(password) and the combination of I(plugin), I(plugin_hash_string), I(plugin_auth_string).
Expand Down Expand Up @@ -164,7 +164,7 @@
- name: Removes all anonymous user accounts
community.mysql.mysql_user:
name: ''
host_all: yes
host_all: true
state: absent
- name: Create database user with name 'bob' and password '12345' with all database privileges
Expand All @@ -178,7 +178,7 @@
community.mysql.mysql_user:
name: bob
password: '*EE0D72C1085C46C5278932678FBE2C6A782821B4'
encrypted: yes
encrypted: true
priv: '*.*:ALL'
state: present
Expand Down Expand Up @@ -249,7 +249,7 @@
If mysql allows root/nopassword login, try it without the credentials first.
If it's not allowed, pass the credentials
community.mysql.mysql_user:
check_implicit_admin: yes
check_implicit_admin: true
login_user: root
login_password: 123456
name: sally
Expand All @@ -258,7 +258,7 @@
- name: Ensure no user named 'sally' exists at all
community.mysql.mysql_user:
name: sally
host_all: yes
host_all: true
state: absent
- name: Specify grants composed of more than one word
Expand Down Expand Up @@ -290,7 +290,7 @@
password: 12345
priv: "*.*:USAGE"
state: present
sql_log_bin: no
sql_log_bin: false
- name: Create user 'bob' authenticated with plugin 'AWSAuthenticationPlugin'
community.mysql.mysql_user:
Expand Down
2 changes: 1 addition & 1 deletion plugins/modules/mysql_variables.py
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
description:
- Variable name to operate.
type: str
required: yes
required: true
value:
description:
- If set, then sets variable value to this.
Expand Down

0 comments on commit 43a8037

Please sign in to comment.