mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-25 13:28:56 +00:00
5631fca150
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@335308 c90b9560-bf6c-de11-be94-00142212c4b1
139 lines
3.7 KiB
XML
139 lines
3.7 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
|
|
<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
|
|
-->
|