Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

mysql::innobackupex_args: Fix documentation #1616

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
46 changes: 45 additions & 1 deletion REFERENCE.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,7 @@

### Functions

* [`mysql::innobackupex_args`](#mysql--innobackupex_args): this function populates and returns the string of arguments which later gets injected in template.
* [`mysql::normalise_and_deepmerge`](#mysql--normalise_and_deepmerge): Recursively merges two or more hashes together, normalises keys with differing use of dashes and underscores.
* [`mysql::password`](#mysql--password): Hash a string as mysql's "PASSWORD()" function would do it
* [`mysql::strip_hash`](#mysql--strip_hash): When given a hash this function strips out all blank entries.
Expand Down Expand Up @@ -707,7 +708,7 @@ Data type: `Optional[String[1]]`

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

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

##### <a name="-mysql--server--create_root_user"></a>`create_root_user`

Expand Down Expand Up @@ -1606,6 +1607,49 @@ discover the appropriate provider for your platform.

## Functions

### <a name="mysql--innobackupex_args"></a>`mysql::innobackupex_args`

Type: Ruby 4.x API

arguments that return string holds is conditional and decided by the the input given to function.

#### `mysql::innobackupex_args(Optional[String] $backupuser, Boolean $backupcompress, Optional[Variant[String, Sensitive[String]]] $backuppassword_unsensitive, Array[String[1]] $backupdatabases, Array[String[1]] $optional_args)`

arguments that return string holds is conditional and decided by the the input given to function.

Returns: `Variant[String]` String
Generated on the basis of provided values.

##### `backupuser`

Data type: `Optional[String]`



##### `backupcompress`

Data type: `Boolean`



##### `backuppassword_unsensitive`

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



##### `backupdatabases`

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



##### `optional_args`

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



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

Type: Ruby 4.x API
Expand Down
11 changes: 5 additions & 6 deletions lib/puppet/functions/mysql/innobackupex_args.rb
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,11 @@
# arguments that return string holds is conditional and decided by the the input given to function.

Puppet::Functions.create_function(:'mysql::innobackupex_args') do
# @param args
# String backupuser
# Boolean backupcompress
# String backuppassword_unsensitive
# Array backupdatabases
# Array optional_args
# @param backupuser
# @param backupcompress
# @param backuppassword_unsensitive
# @param backupdatabases
# @param optional_args
#
# @return String
# Generated on the basis of provided values.
Expand Down
Loading