非同期クエリを送信する

# pg_send_query

(PHP 4 >= 4.2.0, PHP 5, PHP 7, PHP 8)

pg_send_query — 非同期クエリを送信する

### 説明

function pg_send_query(PgSql\Connection `$connection`, string `$query`): int|bool

pg_send_query() は、`connection` に非同期クエリを送信します。pg_query() とは異なり、 PostgreSQL へ一度に複数のクエリを送信することができ、 pg_get_result() を用いて結果を一つずつ取得することが可能です。

スクリプトの実行は、クエリを実行中もブロックされません。 接続がビジーである(すなわち、クエリが実行中である)ことを調べるには、 pg_connection_busy() を使用してください。 クエリは、pg_cancel_query() をコールすることによりキャンセルすることが可能です。

ユーザーは複数のクエリを一度に送信することができますが、 複数のクエリをビジー状態の接続に送信することはできません。 クエリがビジー状態の接続に送信された場合、 最後のクエリが終了するまで待ち、全ての結果は破棄されます。

### パラメータ

`connection`
  PgSql\Connection クラスのインスタンス。
`query`

  実行するひとつまたは複数の SQL 文。

  クエリ内のデータは 適切にエスケープ する必要があります。

### 戻り値

成功した場合に `true` 、失敗した場合に `0` を返します。 クエリの結果を確かめるには pg_get_result() を使用します。

### 変更履歴

バージョン | 説明
--- | ---
8.1.0 | `connection` は、PgSql\Connection クラスのインスタンスを期待するようになりました。 これより前のバージョンでは、resource を期待していました。

### 例

例1 pg_send_query() の例

    <?php
      $dbconn = pg_connect("dbname=publisher") or die("Could not connect");

      if (!pg_connection_busy($dbconn)) {
          pg_send_query($dbconn, "select * from authors; select count(*) from authors;");
      }

      $res1 = pg_get_result($dbconn);
      echo "First call to pg_get_result(): $res1\n";
      $rows1 = pg_num_rows($res1);
      echo "$res1 has $rows1 records\n\n";

      $res2 = pg_get_result($dbconn);
      echo "Second call to pg_get_result(): $res2\n";
      $rows2 = pg_num_rows($res2);
      echo "$res2 has $rows2 records\n";
    ?>

上の例の出力は以下となります。

    First call to pg_get_result(): Resource id #3
    Resource id #3 has 3 records

    Second call to pg_get_result(): Resource id #4
    Resource id #4 has 1 records

### 参考

- pg_query() - クエリを実行する
- pg_cancel_query() - 非同期クエリを取り消す
- pg_get_result() - 非同期クエリの結果を取得する
- pg_connection_busy() - 接続がビジーかどうか調べる

`↑` and `↓` to navigate • `Enter` to select • `Esc` to close • `/` to open