@@ -18,7 +18,7 @@ _Private Classes_
18
18
19
19
* ` mysql::backup::mysqlbackup ` : Manage the mysqlbackup client.
20
20
* ` mysql::backup::mysqldump ` : "Provider" for mysqldump
21
- * ` mysql::backup::xtrabackup ` : "Provider" for Percona XtraBackup
21
+ * ` mysql::backup::xtrabackup ` : "Provider" for Percona XtraBackup or MariaBackup
22
22
* ` mysql::bindings::client_dev ` : Private class for installing client development bindings
23
23
* ` mysql::bindings::daemon_dev ` : Private class for installing daemon development bindings
24
24
* ` mysql::bindings::java ` : Private class for installing java language bindings.
@@ -45,25 +45,20 @@ _Private Classes_
45
45
46
46
_ Public Resource types_
47
47
48
+ * [ ` mysql_grant ` ] ( #mysql_grant ) : @summary Manage a MySQL user's rights.
48
49
* [ ` mysql_plugin ` ] ( #mysql_plugin ) : Manage MySQL plugins.
50
+ * [ ` mysql_user ` ] ( #mysql_user ) : @summary Manage a MySQL user. This includes management of users password as well as privileges.
49
51
50
52
_ Private Resource types_
51
53
52
54
* ` mysql_database ` : Manage a MySQL database.
53
55
* ` mysql_datadir ` : Manage MySQL datadirs with mysql_install_db OR mysqld (5.7.6 and above).
54
- * ` mysql_grant ` : Manage a MySQL user's rights.
55
- * ` mysql_user ` : Manage a MySQL user. This includes management of users password as well as privileges.
56
56
57
57
** Functions**
58
58
59
59
* [ ` mysql::password ` ] ( #mysqlpassword ) : Hash a string as mysql's "PASSWORD()" function would do it
60
60
* [ ` mysql::strip_hash ` ] ( #mysqlstrip_hash ) : When given a hash this function strips out all blank entries.
61
- * [ ` mysql_password ` ] ( #mysql_password ) : A wrapper for the 4.x function 'mysql::password' to bridge the gap between
62
- it and the 3.x function 'mysql_password'.
63
61
* [ ` mysql_password ` ] ( #mysql_password ) : Hash a string as mysql's "PASSWORD()" function would do it
64
- * [ ` mysql_strip_hash ` ] ( #mysql_strip_hash ) : A wrapper for the 4.x function 'mysql::strip_hash' to bridge the gap between
65
- it and the 3.x function 'mysql_strip_hash'.
66
- * [ ` mysql_strip_hash ` ] ( #mysql_strip_hash ) : TEMPORARY FUNCTION: EXPIRES 2014-03-10 When given a hash this function strips out all blank entries.
67
62
68
63
** Tasks**
69
64
@@ -1050,6 +1045,51 @@ Default value: $mysql::params::exec_path
1050
1045
1051
1046
## Resource types
1052
1047
1048
+ ### mysql_grant
1049
+
1050
+ @summary
1051
+ Manage a MySQL user's rights.
1052
+
1053
+ #### Properties
1054
+
1055
+ The following properties are available in the ` mysql_grant ` type.
1056
+
1057
+ ##### ` ensure `
1058
+
1059
+ Valid values: present, absent
1060
+
1061
+ The basic property that the resource should be in.
1062
+
1063
+ Default value: present
1064
+
1065
+ ##### ` privileges `
1066
+
1067
+ Privileges for user
1068
+
1069
+ ##### ` table `
1070
+
1071
+ Valid values: %r{.* \. .* }, %r{^[ 0-9a-zA-Z$_ ] * @[ \w%\. :\- /] * $}
1072
+
1073
+ Table to apply privileges to.
1074
+
1075
+ ##### ` user `
1076
+
1077
+ User to operate on.
1078
+
1079
+ ##### ` options `
1080
+
1081
+ Options to grant.
1082
+
1083
+ #### Parameters
1084
+
1085
+ The following parameters are available in the ` mysql_grant ` type.
1086
+
1087
+ ##### ` name `
1088
+
1089
+ namevar
1090
+
1091
+ Name to describe the grant.
1092
+
1053
1093
### mysql_plugin
1054
1094
1055
1095
Manage MySQL plugins.
@@ -1092,95 +1132,105 @@ namevar
1092
1132
1093
1133
The name of the MySQL plugin to manage.
1094
1134
1095
- ## Functions
1135
+ ### mysql_user
1096
1136
1097
- ### mysql::password
1137
+ @summary
1138
+ Manage a MySQL user. This includes management of users password as well as privileges.
1098
1139
1099
- Type: Ruby 4.x API
1140
+ #### Properties
1100
1141
1101
- Hash a string as mysql's "PASSWORD()" function would do it
1142
+ The following properties are available in the ` mysql_user ` type.
1102
1143
1103
- #### ` mysql::password(String $password) `
1144
+ ##### ` ensure `
1104
1145
1105
- The mysql::password function.
1146
+ Valid values: present, absent
1106
1147
1107
- Returns: ` String ` hash
1108
- The mysql password hash from the clear text password.
1148
+ The basic property that the resource should be in.
1109
1149
1110
- ##### ` password `
1150
+ Default value: present
1111
1151
1112
- Data type: ` String `
1152
+ ##### ` password_hash `
1113
1153
1114
- Plain text password.
1154
+ Valid values: %r{\w * }
1115
1155
1116
- ### mysql::strip_hash
1156
+ The password hash of the user. Use mysql_password() for creating such a hash.
1117
1157
1118
- Type: Ruby 4.x API
1158
+ ##### ` plugin `
1119
1159
1120
- When given a hash this function strips out all blank entries.
1160
+ Valid values: %r{\w+}
1121
1161
1122
- #### ` mysql::strip_hash(Hash $hash) `
1162
+ The authentication plugin of the user.
1123
1163
1124
- The mysql::strip_hash function.
1164
+ ##### ` max_user_connections `
1125
1165
1126
- Returns: ` Hash ` hash
1127
- The given hash with all blank entries removed
1166
+ Valid values: %r{\d+}
1128
1167
1129
- ##### ` hash `
1168
+ Max concurrent connections for the user. 0 means no (or global) limit.
1130
1169
1131
- Data type: ` Hash `
1170
+ ##### ` max_connections_per_hour `
1132
1171
1133
- Hash to be stripped
1172
+ Valid values: %r{\d+}
1134
1173
1135
- ### mysql_password
1174
+ Max connections per hour for the user. 0 means no (or global) limit.
1136
1175
1137
- Type: Ruby 4.x API
1176
+ ##### ` max_queries_per_hour `
1138
1177
1139
- A wrapper for the 4.x function 'mysql::password' to bridge the gap between
1140
- it and the 3.x function 'mysql_password'.
1178
+ Valid values: %r{\d+}
1141
1179
1142
- #### ` mysql_password(String $password) `
1180
+ Max queries per hour for the user. 0 means no (or global) limit.
1143
1181
1144
- The mysql_password function.
1182
+ ##### ` max_updates_per_hour `
1145
1183
1146
- Returns: ` String ` The mysql password hash from the 4.x function mysql::password.
1184
+ Valid values: %r{\d+}
1147
1185
1148
- ##### ` password `
1186
+ Max updates per hour for the user. 0 means no (or global) limit.
1149
1187
1150
- Data type: ` String `
1188
+ ##### ` tls_options `
1151
1189
1152
- Plain text password .
1190
+ Options to that set the TLS-related REQUIRE attributes for the user .
1153
1191
1154
- ### mysql_password
1192
+ #### Parameters
1155
1193
1156
- Type: Ruby 3.x API
1194
+ The following parameters are available in the ` mysql_user ` type.
1195
+
1196
+ ##### ` name `
1197
+
1198
+ namevar
1199
+
1200
+ The name of the user. This uses the 'username@hostname' or username@hostname.
1201
+
1202
+ ## Functions
1203
+
1204
+ ### mysql::password
1205
+
1206
+ Type: Ruby 4.x API
1157
1207
1158
1208
Hash a string as mysql's "PASSWORD()" function would do it
1159
1209
1160
- #### ` mysql_password (String $password)`
1210
+ #### ` mysql::password (String $password)`
1161
1211
1162
- The mysql_password function.
1212
+ The mysql::password function.
1163
1213
1164
- Returns: ` String ` the mysql password hash from the clear text password.
1214
+ Returns: ` String ` hash
1215
+ The mysql password hash from the clear text password.
1165
1216
1166
1217
##### ` password `
1167
1218
1168
1219
Data type: ` String `
1169
1220
1170
1221
Plain text password.
1171
1222
1172
- ### mysql_strip_hash
1223
+ ### mysql::strip_hash
1173
1224
1174
1225
Type: Ruby 4.x API
1175
1226
1176
- A wrapper for the 4.x function 'mysql::strip_hash' to bridge the gap between
1177
- it and the 3.x function 'mysql_strip_hash'.
1227
+ When given a hash this function strips out all blank entries.
1178
1228
1179
- #### ` mysql_strip_hash (Hash $hash)`
1229
+ #### ` mysql::strip_hash (Hash $hash)`
1180
1230
1181
- The mysql_strip_hash function.
1231
+ The mysql::strip_hash function.
1182
1232
1183
- Returns: ` Hash ` hash
1233
+ Returns: ` Hash ` hash
1184
1234
The given hash with all blank entries removed
1185
1235
1186
1236
##### ` hash `
@@ -1189,19 +1239,23 @@ Data type: `Hash`
1189
1239
1190
1240
Hash to be stripped
1191
1241
1192
- ### mysql_strip_hash
1242
+ ### mysql_password
1193
1243
1194
1244
Type: Ruby 3.x API
1195
1245
1196
- TEMPORARY FUNCTION: EXPIRES 2014-03-10
1197
- When given a hash this function strips out all blank entries.
1246
+ Hash a string as mysql's "PASSWORD()" function would do it
1247
+
1248
+ #### ` mysql_password(String $password) `
1198
1249
1199
- #### ` mysql_strip_hash() `
1250
+ The mysql_password function.
1200
1251
1201
- TEMPORARY FUNCTION: EXPIRES 2014-03-10
1202
- When given a hash this function strips out all blank entries.
1252
+ Returns: ` String ` the mysql password hash from the clear text password.
1253
+
1254
+ ##### ` password `
1203
1255
1204
- Returns: ` Any `
1256
+ Data type: ` String `
1257
+
1258
+ Plain text password.
1205
1259
1206
1260
## Tasks
1207
1261
0 commit comments