<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$TOC_DEPRECATED = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/ref.pgsql.inc";
$setup = array (
  'home' => 
  array (
    0 => 'index.php',
    1 => 'PHP Manual',
  ),
  'head' => 
  array (
    0 => 'UTF-8',
    1 => 'ja',
  ),
  'this' => 
  array (
    0 => 'function.pg-execute.php',
    1 => 'pg_execute',
    2 => '指定したパラメータを用いてプリペアドステートメントを実行するリクエストを
   送信し、その結果を待つ',
  ),
  'up' => 
  array (
    0 => 'ref.pgsql.php',
    1 => 'PostgreSQL 関数',
  ),
  'prev' => 
  array (
    0 => 'function.pg-escape-string.php',
    1 => 'pg_escape_string',
  ),
  'next' => 
  array (
    0 => 'function.pg-fetch-all.php',
    1 => 'pg_fetch_all',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'ja',
    'path' => 'reference/pgsql/functions/pg-execute.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="function.pg-execute" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">pg_execute</h1>
  <p class="verinfo">(PHP 5 &gt;= 5.1.0, PHP 7, PHP 8)</p><p class="refpurpose"><span class="refname">pg_execute</span> &mdash; <span class="dc-title">
   指定したパラメータを用いてプリペアドステートメントを実行するリクエストを
   送信し、その結果を待つ
  </span></p>

 </div>

 <div class="refsect1 description" id="refsect1-function.pg-execute-description">
  <h3 class="title">説明</h3>
  <div class="methodsynopsis dc-description">
   <span class="methodname"><strong>pg_execute</strong></span>(<span class="methodparam"><span class="type"><a href="class.pgsql-connection.php" class="type PgSql\Connection">PgSql\Connection</a></span> <code class="parameter">$connection</code><span class="initializer"> = ?</span></span>, <span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$statement_name</code></span>, <span class="methodparam"><span class="type"><a href="language.types.array.php" class="type array">array</a></span> <code class="parameter">$params</code></span>): <span class="type"><span class="type"><a href="class.pgsql-result.php" class="type PgSql\Result">PgSql\Result</a></span>|<span class="type"><a href="language.types.singleton.php" class="type false">false</a></span></span></div>

  <p class="para rdfs-comment">
    指定したパラメータを用いてプリペアドステートメントを実行するリクエストを
    送信し、その結果を待ちます。
  </p>
  <p class="para">
    <span class="function"><strong>pg_execute()</strong></span> は <span class="function"><a href="function.pg-query-params.php" class="function">pg_query_params()</a></span>
    と似ています。しかし、実行するコマンドはクエリを指定することで
    決まるのではなく、事前に準備されたステートメントに値を指定する
    ことによって決まります。この機能のおかげで、繰り返し使用される
    コマンドに構文解析や実行計画作成が最初の一度だけで済みます。
    実行するステートメントは、カレントのセッションで事前に準備しておく
    必要があります。
  </p>
  <p class="para">
    パラメータは <span class="function"><a href="function.pg-query-params.php" class="function">pg_query_params()</a></span> と同じですが、
    クエリ文字列のかわりにプリペアドステートメントの名前を指定する
    という点だけが違います。
  </p>
 </div>


<div class="refsect1 parameters" id="refsect1-function.pg-execute-parameters">
  <h3 class="title">パラメータ</h3>
  <p class="para">
   <dl>
    
     <dt><code class="parameter">connection</code></dt>
     <dd>
      <p class="para"><span class="classname"><a href="class.pgsql-connection.php" class="classname">PgSql\Connection</a></span> クラスのインスタンス。
<code class="parameter">connection</code> が指定されない場合は、デフォルトの接続を使います。
デフォルトの接続とは、<span class="function"><a href="function.pg-connect.php" class="function">pg_connect()</a></span> または <span class="function"><a href="function.pg-pconnect.php" class="function">pg_pconnect()</a></span> によって確立された直近の接続です。
<div class="warning"><strong class="warning">警告</strong><p class="simpara">PHP 8.1.0 以降では、デフォルトの接続を使うことは推奨されなくなりました。</p></div></p>
     </dd>
    
    
     <dt><code class="parameter">statement_name</code></dt>
     <dd>
      <p class="para">
       実行するプリペアドステートメントの名前。&quot;&quot; が指定された場合は
       無名ステートメントが実行されます。名前は、事前に
       <span class="function"><a href="function.pg-prepare.php" class="function">pg_prepare()</a></span>・<span class="function"><a href="function.pg-send-prepare.php" class="function">pg_send_prepare()</a></span>
       あるいは <code class="literal">PREPARE</code> SQL コマンドで準備されたものである
       必要があります。
      </p>
     </dd>
    
    
     <dt><code class="parameter">params</code></dt>
     <dd>
      <p class="para">
        プリペアドステートメント中の $1、$2 などのプレースホルダを
        置き換えるパラメータの配列。配列の要素数はプレースホルダの
        数と一致する必要があります。
      </p>
      <div class="warning"><strong class="warning">警告</strong>
       <p class="para">
        この関数をコールする際に、要素の内容は文字列に変換されます。
       </p>
      </div>
     </dd>
    
   </dl>
  </p>
 </div>


 <div class="refsect1 returnvalues" id="refsect1-function.pg-execute-returnvalues">
  <h3 class="title">戻り値</h3>
  <p class="para">
    成功した場合に
    <span class="classname"><a href="class.pgsql-result.php" class="classname">PgSql\Result</a></span>
    クラスのインスタンスを返します。
    失敗した場合に <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong> を返します.
  </p>
 </div>

 
 <div class="refsect1 changelog" id="refsect1-function.pg-execute-changelog">
  <h3 class="title">変更履歴</h3>
  <table class="doctable informaltable">
   
    <thead>
     <tr>
      <th>バージョン</th>
      <th>説明</th>
     </tr>

    </thead>

    <tbody class="tbody">
     <tr>
 <td>8.1.0</td>
 <td>
  <span class="classname"><a href="class.pgsql-result.php" class="classname">PgSql\Result</a></span> クラスのインスタンスを返すようになりました。
  これより前のバージョンでは、<span class="type"><a href="language.types.resource.php" class="type resource">resource</a></span> を返していました。
 </td>
</tr>

     <tr>
 <td>8.1.0</td>
 <td>
  <code class="parameter">connection</code> は、<span class="classname"><a href="class.pgsql-connection.php" class="classname">PgSql\Connection</a></span> クラスのインスタンスを期待するようになりました。
  これより前のバージョンでは、<span class="type"><a href="language.types.resource.php" class="type resource">resource</a></span> を期待していました。
 </td>
</tr>

    </tbody>
   
  </table>

 </div>


 <div class="refsect1 examples" id="refsect1-function.pg-execute-examples">
  <h3 class="title">例</h3>
  <p class="para">
   <div class="example" id="example-1">
    <p><strong>例1 <span class="function"><strong>pg_execute()</strong></span> の使用法</strong></p>
    <div class="example-contents">
<div class="phpcode"><code><span style="color: #000000"><span style="color: #0000BB">&lt;?php<br /></span><span style="color: #FF8000">// "mary"という名前のデータベースに接続<br /></span><span style="color: #0000BB">$dbconn </span><span style="color: #007700">= </span><span style="color: #0000BB">pg_connect</span><span style="color: #007700">(</span><span style="color: #DD0000">"dbname=mary"</span><span style="color: #007700">);<br /><br /></span><span style="color: #FF8000">// 実行するクエリを準備<br /></span><span style="color: #0000BB">$result </span><span style="color: #007700">= </span><span style="color: #0000BB">pg_prepare</span><span style="color: #007700">(</span><span style="color: #0000BB">$dbconn</span><span style="color: #007700">, </span><span style="color: #DD0000">"my_query"</span><span style="color: #007700">, </span><span style="color: #DD0000">'SELECT * FROM shops WHERE name = $1'</span><span style="color: #007700">);<br /><br /></span><span style="color: #FF8000">// プリペアドクエリの実行。文字列 "Joe's Widgets" のエスケープ処理は<br />// 一切必要ないことに注意<br /></span><span style="color: #0000BB">$result </span><span style="color: #007700">= </span><span style="color: #0000BB">pg_execute</span><span style="color: #007700">(</span><span style="color: #0000BB">$dbconn</span><span style="color: #007700">, </span><span style="color: #DD0000">"my_query"</span><span style="color: #007700">, array(</span><span style="color: #DD0000">"Joe's Widgets"</span><span style="color: #007700">));<br /><br /></span><span style="color: #FF8000">// 同じプリペアドクエリを違うパラメータで実行<br /></span><span style="color: #0000BB">$result </span><span style="color: #007700">= </span><span style="color: #0000BB">pg_execute</span><span style="color: #007700">(</span><span style="color: #0000BB">$dbconn</span><span style="color: #007700">, </span><span style="color: #DD0000">"my_query"</span><span style="color: #007700">, array(</span><span style="color: #DD0000">"Clothes Clothes Clothes"</span><span style="color: #007700">));<br /><br /></span><span style="color: #0000BB">?&gt;</span></span></code></div>
    </div>

   </div>
  </p>
 </div>

 
 <div class="refsect1 seealso" id="refsect1-function.pg-execute-seealso">
  <h3 class="title">参考</h3>
  <p class="para">
   <ul class="simplelist">
    <li><span class="function"><a href="function.pg-prepare.php" class="function" rel="rdfs-seeAlso">pg_prepare()</a> - 指定したパラメータでプリペアドステートメントを作成するリクエストを
   サーバーに送信し、その完了を待つ</span></li>
    <li><span class="function"><a href="function.pg-send-prepare.php" class="function" rel="rdfs-seeAlso">pg_send_prepare()</a> - 指定したパラメータでプリペアドステートメントを作成するリクエストを
   送信し、その結果を待たない</span></li>
    <li><span class="function"><a href="function.pg-query-params.php" class="function" rel="rdfs-seeAlso">pg_query_params()</a> - SQL コマンドとパラメータを分割してサーバーへ送信し、その結果を待つ</span></li>
   </ul>
  </p>
 </div>

</div><?php manual_footer($setup); ?>