diff options
Diffstat (limited to 'html/mysql_table.5.html')
| -rw-r--r-- | html/mysql_table.5.html | 188 |
1 files changed, 104 insertions, 84 deletions
diff --git a/html/mysql_table.5.html b/html/mysql_table.5.html index 4971e57..5063e65 100644 --- a/html/mysql_table.5.html +++ b/html/mysql_table.5.html @@ -72,56 +72,76 @@ MYSQL_TABLE(5) MYSQL_TABLE(5) <b>dbname</b> The database name on the servers. Example: dbname = customer_database - <b>query</b> The SQL query template used to search the database, where <b>%s</b> is - a substitute for the address Postfix is trying to resolve, e.g. + <b>charset (default: utf8mb4)</b> + The default MySQL client character set; this also implies the + collation order. + + This parameter is available with Postfix 3.9 and later. With + earlier Postfix versions, the default was chosen by the MySQL + implementation (<b>utf8mb4</b> as of MySQL 8.0, <b>latin1</b> historically). + + <b>idle_interval (default: 60)</b> + The number of seconds after which an idle database connection + will be closed. + + This feature is available in Postfix 3.9 and later. + + <b>retry_interval (default: 60)</b> + The number of seconds that a database connection will be skipped + after an error. + + This feature is available in Postfix 3.9 and later. + + <b>query</b> The SQL query template used to search the database, where <b>%s</b> is + a substitute for the address Postfix is trying to resolve, e.g. query = SELECT replacement FROM aliases WHERE mailbox = '%s' - By default, every query must return a result set (instead of - storing its results in a table); with "<b>require_result_set = no</b>" - (Postfix 3.2 and later), the absence of a result set is treated + By default, every query must return a result set (instead of + storing its results in a table); with "<b>require_result_set = no</b>" + (Postfix 3.2 and later), the absence of a result set is treated as "not found". This parameter supports the following '%' expansions: <b>%%</b> This is replaced by a literal '%' character. - <b>%s</b> This is replaced by the input key. SQL quoting is used - to make sure that the input key does not add unexpected + <b>%s</b> This is replaced by the input key. SQL quoting is used + to make sure that the input key does not add unexpected metacharacters. <b>%u</b> When the input key is an address of the form user@domain, - <b>%u</b> is replaced by the SQL quoted local part of the - address. Otherwise, <b>%u</b> is replaced by the entire search - string. If the localpart is empty, the query is sup- + <b>%u</b> is replaced by the SQL quoted local part of the + address. Otherwise, <b>%u</b> is replaced by the entire search + string. If the localpart is empty, the query is sup- pressed and returns no results. <b>%d</b> When the input key is an address of the form user@domain, - <b>%d</b> is replaced by the SQL quoted domain part of the - address. Otherwise, the query is suppressed and returns + <b>%d</b> is replaced by the SQL quoted domain part of the + address. Otherwise, the query is suppressed and returns no results. <b>%[SUD]</b> The upper-case equivalents of the above expansions behave - in the <b>query</b> parameter identically to their lower-case - counter-parts. With the <b>result_format</b> parameter (see - below), they expand the input key rather than the result + in the <b>query</b> parameter identically to their lower-case + counter-parts. With the <b>result_format</b> parameter (see + below), they expand the input key rather than the result value. - <b>%[1-9]</b> The patterns %1, %2, ... %9 are replaced by the corre- - sponding most significant component of the input key's - domain. If the input key is <i>user@mail.example.com</i>, then + <b>%[1-9]</b> The patterns %1, %2, ... %9 are replaced by the corre- + sponding most significant component of the input key's + domain. If the input key is <i>user@mail.example.com</i>, then %1 is <b>com</b>, %2 is <b>example</b> and %3 is <b>mail</b>. If the input key - is unqualified or does not have enough domain components - to satisfy all the specified patterns, the query is sup- + is unqualified or does not have enough domain components + to satisfy all the specified patterns, the query is sup- pressed and returns no results. - The <b>domain</b> parameter described below limits the input keys to - addresses in matching domains. When the <b>domain</b> parameter is + The <b>domain</b> parameter described below limits the input keys to + addresses in matching domains. When the <b>domain</b> parameter is non-empty, SQL queries for unqualified addresses or addresses in non-matching domains are suppressed and return no results. - This parameter is available with Postfix 2.2. In prior releases - the SQL query was built from the separate parameters: - <b>select_field</b>, <b>table</b>, <b>where_field</b> and <b>additional_conditions</b>. The + This parameter is available with Postfix 2.2. In prior releases + the SQL query was built from the separate parameters: + <b>select_field</b>, <b>table</b>, <b>where_field</b> and <b>additional_conditions</b>. The mapping from the old parameters to the equivalent query is: SELECT [<b>select_field</b>] @@ -129,50 +149,50 @@ MYSQL_TABLE(5) MYSQL_TABLE(5) WHERE [<b>where_field</b>] = '%s' [<b>additional_conditions</b>] - The '%s' in the <b>WHERE</b> clause expands to the escaped search - string. With Postfix 2.2 these legacy parameters are used if + The '%s' in the <b>WHERE</b> clause expands to the escaped search + string. With Postfix 2.2 these legacy parameters are used if the <b>query</b> parameter is not specified. NOTE: DO NOT put quotes around the query parameter. <b>result_format (default: %s</b>) Format template applied to result attributes. Most commonly used - to append (or prepend) text to the result. This parameter sup- + to append (or prepend) text to the result. This parameter sup- ports the following '%' expansions: <b>%%</b> This is replaced by a literal '%' character. - <b>%s</b> This is replaced by the value of the result attribute. + <b>%s</b> This is replaced by the value of the result attribute. When result is empty it is skipped. <b>%u</b> When the result attribute value is an address of the form - user@domain, <b>%u</b> is replaced by the local part of the - address. When the result has an empty localpart it is + user@domain, <b>%u</b> is replaced by the local part of the + address. When the result has an empty localpart it is skipped. - <b>%d</b> When a result attribute value is an address of the form - user@domain, <b>%d</b> is replaced by the domain part of the - attribute value. When the result is unqualified it is + <b>%d</b> When a result attribute value is an address of the form + user@domain, <b>%d</b> is replaced by the domain part of the + attribute value. When the result is unqualified it is skipped. <b>%[SUD1-9]</b> - The upper-case and decimal digit expansions interpolate - the parts of the input key rather than the result. Their - behavior is identical to that described with <b>query</b>, and - in fact because the input key is known in advance, - queries whose key does not contain all the information - specified in the result template are suppressed and + The upper-case and decimal digit expansions interpolate + the parts of the input key rather than the result. Their + behavior is identical to that described with <b>query</b>, and + in fact because the input key is known in advance, + queries whose key does not contain all the information + specified in the result template are suppressed and return no results. For example, using "result_format = <a href="smtp.8.html">smtp</a>:[%s]" allows one to use a mailHost attribute as the basis of a <a href="transport.5.html">transport(5)</a> table. After - applying the result format, multiple values are concatenated as + applying the result format, multiple values are concatenated as comma separated strings. The expansion_limit and parameter - explained below allows one to restrict the number of values in + explained below allows one to restrict the number of values in the result, which is especially useful for maps that must return at most one value. - The default value <b>%s</b> specifies that each result value should be + The default value <b>%s</b> specifies that each result value should be used as is. This parameter is available with Postfix 2.2 and later. @@ -180,15 +200,15 @@ MYSQL_TABLE(5) MYSQL_TABLE(5) NOTE: DO NOT put quotes around the result format! <b>domain (default: no domain list)</b> - This is a list of domain names, paths to files, or "<a href="DATABASE_README.html">type:table</a>" + This is a list of domain names, paths to files, or "<a href="DATABASE_README.html">type:table</a>" databases. When specified, only fully qualified search keys with - a *non-empty* localpart and a matching domain are eligible for + a *non-empty* localpart and a matching domain are eligible for lookup: 'user' lookups, bare domain lookups and "@domain" - lookups are not performed. This can significantly reduce the + lookups are not performed. This can significantly reduce the query load on the MySQL server. domain = postfix.org, <a href="DATABASE_README.html#types">hash</a>:/etc/postfix/searchdomains - It is best not to use SQL to store the domains eligible for SQL + It is best not to use SQL to store the domains eligible for SQL lookups. This parameter is available with Postfix 2.2 and later. @@ -197,37 +217,37 @@ MYSQL_TABLE(5) MYSQL_TABLE(5) the input keys are always unqualified. <b>expansion_limit (default: 0)</b> - A limit on the total number of result elements returned (as a + A limit on the total number of result elements returned (as a comma separated list) by a lookup against the map. A setting of - zero disables the limit. Lookups fail with a temporary error if - the limit is exceeded. Setting the limit to 1 ensures that + zero disables the limit. Lookups fail with a temporary error if + the limit is exceeded. Setting the limit to 1 ensures that lookups do not return multiple values. <b>option_file</b> - Read options from the given file instead of the default my.cnf - location. This reads options from the <b>[client]</b> option group, + Read options from the given file instead of the default my.cnf + location. This reads options from the <b>[client]</b> option group, optionally followed by options from the group given with <b>option_group</b>. This parameter is available with Postfix 2.11 and later. <b>option_group (default: Postfix</b> ><b>=3.2: client,</b> <<b>= 3.1: empty)</b> - Read options from the given group of the mysql options file, + Read options from the given group of the mysql options file, after reading options from the <b>[client]</b> group. - Postfix 3.2 and later read <b>[client]</b> option group settings by - default. To disable this specify no <b>option_file</b> and specify + Postfix 3.2 and later read <b>[client]</b> option group settings by + default. To disable this specify no <b>option_file</b> and specify "<b>option_group =</b>" (i.e. an empty value). - Postfix 3.1 and earlier don't read <b>[client]</b> option group set- - tings unless a non-empty <b>option_file</b> or <b>option_group</b> value are + Postfix 3.1 and earlier don't read <b>[client]</b> option group set- + tings unless a non-empty <b>option_file</b> or <b>option_group</b> value are specified. To enable this, specify, for example, "<b>option_group =</b> <b>client</b>". This parameter is available with Postfix 2.11 and later. <b>require_result_set (default: yes)</b> - If "<b>yes</b>", require that every query returns a result set. If + If "<b>yes</b>", require that every query returns a result set. If "<b>no</b>", treat the absence of a result set as "not found". This parameter is available with Postfix 3.2 and later. @@ -238,19 +258,19 @@ MYSQL_TABLE(5) MYSQL_TABLE(5) This parameter is available with Postfix 2.11 and later. <b>tls_key_file</b> - File containing the private key corresponding to <b>tls_cert_file</b>. + File containing the private key corresponding to <b>tls_cert_file</b>. This parameter is available with Postfix 2.11 and later. <b>tls_CAfile</b> - File containing certificates for all of the X509 Certification - Authorities the client will recognize. Takes precedence over + File containing certificates for all of the X509 Certification + Authorities the client will recognize. Takes precedence over <b>tls_CApath</b>. This parameter is available with Postfix 2.11 and later. <b>tls_CApath</b> - Directory containing X509 Certification Authority certificates + Directory containing X509 Certification Authority certificates in separate individual files. This parameter is available with Postfix 2.11 and later. @@ -261,13 +281,13 @@ MYSQL_TABLE(5) MYSQL_TABLE(5) This parameter is available with Postfix 2.11 and later. <b>tls_verify_cert (default: no)</b> - Verify that the server's name matches the common name in the + Verify that the server's name matches the common name in the certificate. This parameter is available with Postfix 2.11 and later. <b>USING MYSQL STORED PROCEDURES</b> - Postfix 3.2 and later support calling a stored procedure instead of + Postfix 3.2 and later support calling a stored procedure instead of using a SELECT statement in the query, e.g. <b>query</b> = CALL lookup('%s') @@ -275,17 +295,17 @@ MYSQL_TABLE(5) MYSQL_TABLE(5) The previously described '%' expansions can be used in the parameter(s) to the stored procedure. - By default, every stored procedure call must return a result set, i.e. - every code path must execute a SELECT statement that returns a result + By default, every stored procedure call must return a result set, i.e. + every code path must execute a SELECT statement that returns a result set (instead of storing its results in a table). With - "<b>require_result_set = no</b>", the absence of a result set is treated as + "<b>require_result_set = no</b>", the absence of a result set is treated as "not found". - A stored procedure must not return multiple result sets. That is, - there must be no code path that executes multiple SELECT statements + A stored procedure must not return multiple result sets. That is, + there must be no code path that executes multiple SELECT statements that return a result (instead of storing their results in a table). - The following is an example of a stored procedure returning a single + The following is an example of a stored procedure returning a single result set: CREATE [DEFINER=`user`@`host`] PROCEDURE @@ -297,26 +317,26 @@ MYSQL_TABLE(5) MYSQL_TABLE(5) END <b>OBSOLETE MAIN.CF PARAMETERS</b> - For compatibility with other Postfix lookup tables, MySQL parameters - can also be defined in <a href="postconf.5.html">main.cf</a>. In order to do that, specify as MySQL - source a name that doesn't begin with a slash or a dot. The MySQL - parameters will then be accessible as the name you've given the source - in its definition, an underscore, and the name of the parameter. For - example, if the map is specified as "<a href="mysql_table.5.html">mysql</a>:<i>mysqlname</i>", the parameter + For compatibility with other Postfix lookup tables, MySQL parameters + can also be defined in <a href="postconf.5.html">main.cf</a>. In order to do that, specify as MySQL + source a name that doesn't begin with a slash or a dot. The MySQL + parameters will then be accessible as the name you've given the source + in its definition, an underscore, and the name of the parameter. For + example, if the map is specified as "<a href="mysql_table.5.html">mysql</a>:<i>mysqlname</i>", the parameter "hosts" would be defined in <a href="postconf.5.html">main.cf</a> as "<i>mysqlname</i>_hosts". - Note: with this form, the passwords for the MySQL sources are written - in <a href="postconf.5.html">main.cf</a>, which is normally world-readable. Support for this form + Note: with this form, the passwords for the MySQL sources are written + in <a href="postconf.5.html">main.cf</a>, which is normally world-readable. Support for this form will be removed in a future Postfix version. <b>OBSOLETE QUERY INTERFACE</b> - This section describes an interface that is deprecated as of Postfix - 2.2. It is replaced by the more general <b>query</b> interface described - above. If the <b>query</b> parameter is defined, the legacy parameters - described here ignored. Please migrate to the new interface as the + This section describes an interface that is deprecated as of Postfix + 2.2. It is replaced by the more general <b>query</b> interface described + above. If the <b>query</b> parameter is defined, the legacy parameters + described here ignored. Please migrate to the new interface as the legacy interface may be removed in a future release. - The following parameters can be used to fill in a SELECT template + The following parameters can be used to fill in a SELECT template statement of the form: SELECT [<b>select_field</b>] @@ -325,7 +345,7 @@ MYSQL_TABLE(5) MYSQL_TABLE(5) [<b>additional_conditions</b>] The specifier %s is replaced by the search string, and is escaped so if - it contains single quotes or other odd characters, it will not cause a + it contains single quotes or other odd characters, it will not cause a parse error, or worse, a security problem. <b>select_field</b> |