1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139
|
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 321919 $ -->
<refentry xml:id="function.mysqlnd-ms-match-wild" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>mysqlnd_ms_match_wild</refname>
<refpurpose>Finds whether a table name matches a wildcard pattern or not</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type>
<methodname>mysqlnd_ms_match_wild</methodname>
<methodparam><type>string</type><parameter>table_name</parameter></methodparam>
<methodparam><type>string</type><parameter>wildcard</parameter></methodparam>
</methodsynopsis>
<para>
Finds whether a table name matches a wildcard pattern or not.
</para>
<para>
This function is not of much practical relevance with PECL mysqlnd_ms 1.1.0
because the plugin does not support MySQL replication table filtering yet.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>table_name</parameter></term>
<listitem>
<para>
The table name to check if it is matched by the wildcard.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>wildcard</parameter></term>
<listitem>
<para>
The wildcard pattern to check against the table name.
The wildcard pattern supports the same placeholders as
MySQL replication filters do.
</para>
<para>
MySQL replication filters
can be configured by using the MySQL Server configuration
options <literal>--replicate-wild-do-table</literal> and
<literal>--replicate-wild-do-db</literal>. Please, consult
the MySQL Reference Manual to learn more about this MySQL
Server feature.
</para>
<para>
The supported placeholders are:
<itemizedlist>
<listitem>
<simpara>
<literal>%</literal> - zero or more literals
</simpara>
</listitem>
<listitem>
<simpara>
<literal>%</literal> - one literal
</simpara>
</listitem>
</itemizedlist>
</para>
<para>
Placeholders can be escaped using <literal>\</literal>.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns &true; <literal>table_name</literal> is
matched by <literal>wildcard</literal>.
Otherwise, returns &false;
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title><function>mysqlnd_ms_match_wild</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
var_dump(mysqlnd_ms_match_wild("schema_name.table_name", "schema%"));
var_dump(mysqlnd_ms_match_wild("abc", "_"));
var_dump(mysqlnd_ms_match_wild("table1", "table_"));
var_dump(mysqlnd_ms_match_wild("asia_customers", "%customers"));
var_dump(mysqlnd_ms_match_wild("funny%table","funny\%table"));
var_dump(mysqlnd_ms_match_wild("funnytable", "funny%table"));
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
bool(true)
bool(false)
bool(true)
bool(true)
bool(true)
bool(true)
]]>
</screen>
</example>
</para>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->
|