pg-escape-identifier.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: c2eca73ef79ebe78cebb34053e41b565af504c4f Maintainer: takagi Status: ready -->
<!-- Credits: mumumu -->
<refentry xml:id='function.pg-escape-identifier' xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>pg_escape_identifier</refname>
  <refpurpose>
   テキスト型フィールドに挿入するために、識別子をエスケープする
  </refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>string</type><methodname>pg_escape_identifier</methodname>
   <methodparam choice="opt"><type>PgSql\Connection</type><parameter>connection</parameter></methodparam>
   <methodparam><type>string</type><parameter>data</parameter></methodparam>
  </methodsynopsis>
  <para>
   <function>pg_escape_identifier</function> は、データベースへの問い合わせに使う識別子
   (テーブル名やフィールド名など) をエスケープします。
   PostgreSQL サーバー用にエスケープされた識別子を返します。
   <function>pg_escape_identifier</function> は、データの前後にダブルクォートを追加します。
   ユーザーが自分で追加してはいけません。
   この関数は、クエリ内で使う識別子のパラメータに有用です。SQL リテラル
   (bytea 以外のパラメータ) には、<function>pg_escape_literal</function>
   あるいは <function>pg_escape_string</function> を使わなければなりません。
   bytea 型のフィールドには、<function>pg_escape_bytea</function>
   を使わなければなりません。
  </para>
  <note>
   <para>
    この関数は内部的なエスケープコードを使い、PostgreSQL 8.4 より前のバージョンでも使えます。
    </para>
  </note>
 </refsect1>

<refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>connection</parameter></term>
     <listitem>
      &pgsql.parameter.connection-with-unspecified-default;
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>data</parameter></term>
     <listitem>
      <para>
       エスケープするテキスト文字列。
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   エスケープされたデータを文字列で返します。
  </para>
 </refsect1>

 <refsect1 role="changelog">
  &reftitle.changelog;
  <informaltable>
   <tgroup cols="2">
    <thead>
     <row>
      <entry>&Version;</entry>
      <entry>&Description;</entry>
     </row>
    </thead>
    <tbody>
     &pgsql.changelog.connection-object;
    </tbody>
   </tgroup>
  </informaltable>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title><function>pg_escape_identifier</function> の例</title>
    <programlisting role="php">
<![CDATA[
<?php 
  // データベースに接続します
  $dbconn = pg_connect('dbname=foo');
  
  // テーブル名をエスケープします
  $escaped = pg_escape_identifier($table_name);
  
  // $table_name から行を取得します
  pg_query("SELECT * FROM {$escaped};");
?>
]]>
    </programlisting>
   </example>
  </para>
 </refsect1>
 
 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>pg_escape_literal</function></member>
    <member><function>pg_escape_bytea</function></member>
    <member><function>pg_escape_string</function></member>
   </simplelist>
  </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
-->