Skip to content

Commit a612646

Browse files
committed
Do not pretend mysql_database in private
I think this was an error introduced in f0663f3 which attemted to document *all the things*.
1 parent e01ec23 commit a612646

File tree

2 files changed

+51
-3
lines changed

2 files changed

+51
-3
lines changed

REFERENCE.md

Lines changed: 51 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,14 +44,14 @@
4444

4545
#### Public Resource types
4646

47+
* [`mysql_database`](#mysql_database): Manage a MySQL database.
4748
* [`mysql_grant`](#mysql_grant): Manage a MySQL user's rights.
4849
* [`mysql_login_path`](#mysql_login_path): Manage a MySQL login path.
4950
* [`mysql_plugin`](#mysql_plugin): Manage MySQL plugins.
5051
* [`mysql_user`](#mysql_user): Manage a MySQL user. This includes management of users password as well as privileges.
5152

5253
#### Private Resource types
5354

54-
* `mysql_database`: Manage a MySQL database.
5555
* `mysql_datadir`: Manage MySQL datadirs with mysql_install_db OR mysqld (5.7.6 and above).
5656

5757
### Functions
@@ -1281,6 +1281,56 @@ Default value: `undef`
12811281

12821282
## Resource types
12831283

1284+
### <a name="mysql_database"></a>`mysql_database`
1285+
1286+
Manage a MySQL database.
1287+
1288+
#### Properties
1289+
1290+
The following properties are available in the `mysql_database` type.
1291+
1292+
##### `charset`
1293+
1294+
Valid values: `%r{^\S+$}`
1295+
1296+
The CHARACTER SET setting for the database
1297+
1298+
Default value: `utf8`
1299+
1300+
##### `collate`
1301+
1302+
Valid values: `%r{^\S+$}`
1303+
1304+
The COLLATE setting for the database
1305+
1306+
Default value: `utf8_general_ci`
1307+
1308+
##### `ensure`
1309+
1310+
Valid values: `present`, `absent`
1311+
1312+
The basic property that the resource should be in.
1313+
1314+
Default value: `present`
1315+
1316+
#### Parameters
1317+
1318+
The following parameters are available in the `mysql_database` type.
1319+
1320+
* [`name`](#-mysql_database--name)
1321+
* [`provider`](#-mysql_database--provider)
1322+
1323+
##### <a name="-mysql_database--name"></a>`name`
1324+
1325+
namevar
1326+
1327+
The name of the MySQL database to manage.
1328+
1329+
##### <a name="-mysql_database--provider"></a>`provider`
1330+
1331+
The specific backend to use for this `mysql_database` resource. You will seldom need to specify this --- Puppet will
1332+
usually discover the appropriate provider for your platform.
1333+
12841334
### <a name="mysql_grant"></a>`mysql_grant`
12851335

12861336
Manage a MySQL user's rights.

lib/puppet/type/mysql_database.rb

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,6 @@
33
Puppet::Type.newtype(:mysql_database) do
44
@doc = <<-PUPPET
55
@summary Manage a MySQL database.
6-
7-
@api private
86
PUPPET
97

108
ensurable

0 commit comments

Comments
 (0)