このクエリのテーブルを指定するために from() メソッドを使用します。テーブル名は、単純に文字列で指定できます。 Zend_Db_Select はテーブル名を識別子としてクォートするので、 特殊文字を使用することもできます。

// できあがるクエリは、このようになります
//   SELECT *
//   FROM "products"

$select = $db->select()
             ->from( 'products' );

テーブルの相関名 (あるいは "エイリアス" とも言われます) を指定することもできます。その場合は、 単純な文字列ではなく連想配列を使用し、相関名とテーブル名の対応を指定します。 SQL のその他の句で、この相関名を使用できるようになります。 複数のテーブルを結合したクエリを作成する場合は、 Zend_Db_Select はそのテーブル名に基づいた一意な相関名を作成します。

// できあがるクエリは、このようになります
//   SELECT p.*
//   FROM "products" AS p

$select = $db->select()
             ->from( array('p' => 'products') );

RDBMS によっては、テーブル名の前にスキーマ名をつなげる方式をサポートしているものもあります。 テーブル名として、"schemaName.tableName" のように指定できます。この場合、 Zend_Db_Select は各部分を個別にクォートします。 あるいはスキーマ名とテーブル名を別々に指定することもできます。 もし両方でスキーマ名を指定した場合は、 テーブル名と同時に指定したもののほうが優先されます。

// できあがるクエリは、このようになります
//   SELECT *
//   FROM "myschema"."products"

$select = $db->select()
             ->from( 'myschema.products' );

// あるいは

$select = $db->select()
             ->from('products', '*', 'myschema');

from() メソッドの二番目の引数で、 対応するテーブルから取得するカラムを指定できます。 カラムを指定しなかった場合のデフォルトは "*" で、これは "すべてのカラム" を表す SQL のワイルドカードです。

カラム名を指定するには、単純な文字列の配列を使用するか、 あるいは連想配列でエイリアスとカラム名を対応させます。 取得したいカラムがひとつだけの場合でエイリアスを使用しない場合は、 配列ではなく単純な文字列で指定することもできます。

空の配列をカラムの引数として指定すると、 対応するテーブルからのカラムは結果セットに含まれなくなります。 join() メソッドの コード例 を参照ください。

カラム名を "correlationName.columnName" の形式で指定することもできます。この場合、 Zend_Db_Select は各部分を個別にクォートします。 カラムの correlationName (相関名) を指定しなかった場合は、 現在の from() メソッドで指定したテーブルの名前を使用します。

// できあがるクエリは、このようになります
//   SELECT p."product_id", p."product_name"
//   FROM "products" AS p

$select = $db->select()
             ->from(array('p' => 'products'),
                    array('product_id', 'product_name'));

// 同じクエリを、相関名を指定して作成します
//   SELECT p."product_id", p."product_name"
//   FROM "products" AS p

$select = $db->select()
             ->from(array('p' => 'products'),
                    array('p.product_id', 'p.product_name'));

// このクエリを、カラムのひとつにエイリアスを指定して作成します
//   SELECT p."product_id" AS prodno, p."product_name"
//   FROM "products" AS p

$select = $db->select()
             ->from(array('p' => 'products'),
                    array('prodno' => 'product_id', 'product_name'));

SQL クエリでは、単にテーブルのカラムを使用するだけでなく 何らかの式をカラムとして使用することもあります。 このような場合は、相関名をつけたりクォートを適用したりしてはいけません。 カラム文字列に括弧が含まれている場合に、Zend_Db_Select はそれを式として扱います。

Zend_Db_Expr 型のオブジェクトを明示的に作成し、 文字列がカラム名と解釈されてしまうことを防ぐこともできます。 Zend_Db_Expr は、文字列をひとつだけ含む最小限のクラスです。 Zend_Db_Select は Zend_Db_Expr 型のオブジェクトを認識し、 それを文字列に変換しますが、 その際にクォートや相関名などの処理を適用しません。

// できあがるクエリは、このようになります
//   SELECT p."product_id", LOWER(product_name)
//   FROM "products" AS p
// 括弧つきの式は、暗黙のうちに
// Zend_Db_Expr として扱われます

$select = $db->select()
             ->from(array('p' => 'products'),
                    array('product_id', 'LOWER(product_name)'));

// できあがるクエリは、このようになります
//   SELECT p."product_id", (p.cost * 1.08) AS cost_plus_tax
//   FROM "products" AS p

$select = $db->select()
             ->from(array('p' => 'products'),
                    array('product_id',
                          'cost_plus_tax' => '(p.cost * 1.08)')
                   );

// このクエリを、明示的に Zend_Db_Expr を指定して作成します
//   SELECT p."product_id", p.cost * 1.08 AS cost_plus_tax
//   FROM "products" AS p

$select = $db->select()
             ->from(array('p' => 'products'),
                    array('product_id',
                          'cost_plus_tax' =>
                              new Zend_Db_Expr('p.cost * 1.08'))
                    );

上の例では、Zend_Db_Select は 相関名の設定や識別子のクォートといった処理を行いません。 あいまいさを解決するためにそのような処理が必要な場合は、 手動で文字列を変更する必要があります。

カラム名が SQL キーワードや特殊文字を含んでいる場合は、 アダプタの quoteIdentifier() メソッドを使用して結果を操作する必要があります。 quoteIdentifier() は、 識別子に対して SQL のクォート処理を行います。 これによりテーブルやカラムといった識別子を SQL のそれ以外の部分と区別できるようになります。

クォート処理を直接文字列に埋め込んでしまわずに quoteIdentifier() メソッドを使用することで、 あなたのコードをデータベースに依存しないものにできます。 というのも、RDBMS によってはあまり標準的ではない文字でクォートを行うものもあるからです。 quoteIdentifier() メソッドは、 アダプタの型に応じて適切なクォート文字を使用するように設計されています。 quoteIdentifier() メソッドはまた、 識別子の名前の中に登場するクォート文字自体もエスケープします。

// このクエリを作成する際に、式の中にある特別なカラム名 "from" をクォートします
//   SELECT p."from" + 10 AS origin
//   FROM "products" AS p

$select = $db->select()
             ->from(array('p' => 'products'),
                    array('origin' =>
                              '(p.' . $db->quoteIdentifier('from') . ' + 10)')
                   );

既存の FROM や JOIN のテーブルに対して、それらのメソッドをコールした後で カラムを追加したくなることもあるかもしれません。 columns() メソッドを使用すると、 クエリを実行する前ならいつでも好きなときに特定のカラムを追加できます。 カラムは、文字列あるいは Zend_Db_Expr、 あるいはその配列で指定します。 このメソッドの 2 番目の引数は省略可能です。 省略した場合は、FROM テーブルにカラムが追加されます。 指定する場合は、既存の相関名を使用しなければなりません。

// できあがるクエリは、このようになります
//   SELECT p."product_id", p."product_name"
//   FROM "products" AS p

$select = $db->select()
             ->from(array('p' => 'products'), 'product_id')
             ->columns('product_name');

// 同じクエリを、相関名を指定して作成します
//   SELECT p."product_id", p."product_name"
//   FROM "products" AS p

$select = $db->select()
             ->from(array('p' => 'products'), 'p.product_id')
             ->columns('product_name', 'p');
             // あるいは columns('p.product_name')

有用なクエリの多くは、JOIN を使用して複数テーブルの行を結合しています。 テーブルを Zend_Db_Select クエリに追加するには、 join() メソッドを使用します。 このメソッドの使用法は from() メソッドと似ていますが、ほとんどの場合に結合条件を指定するという点が異なります。

// できあがるクエリは、このようになります
//   SELECT p."product_id", p."product_name", l.*
//   FROM "products" AS p JOIN "line_items" AS l
//     ON p.product_id = l.product_id

$select = $db->select()
             ->from(array('p' => 'products'),
                    array('product_id', 'product_name'))
             ->join(array('l' => 'line_items'),
                    'p.product_id = l.product_id');

join() の二番目の引数として、 結合条件を文字列で指定します。これは、 あるテーブルの行が別のテーブルのどの行と対応するのかを表す条件式です。 式の中では相関名を使用できます。

join() の三番目の引数はカラム名を表す配列です。 これは from() メソッドで使用する形式と似ています。 デフォルトは "*" です。 相関名や式、Zend_Db_Expr についての扱いは、 from() メソッドにおけるカラム名の配列と同じです。

テーブルからカラムを取得しない場合は、 カラムリストに空の配列を使用します。 これは from() メソッドでも同様に動作しますが、 普通は最初のテーブルからは何らかのカラムを取得するでしょう。 一方、連結するテーブルについてはカラムを取得しないこともありえます。

// できあがるクエリは、このようになります
//   SELECT p."product_id", p."product_name"
//   FROM "products" AS p JOIN "line_items" AS l
//     ON p.product_id = l.product_id

$select = $db->select()
             ->from(array('p' => 'products'),
                    array('product_id', 'product_name'))
             ->join(array('l' => 'line_items'),
                    'p.product_id = l.product_id',
                    array() ); // 空のカラムリスト

SQL の結合にはいくつかの形式があります。 以下に、Zend_Db_Select がサポートする結合の形式をまとめます。

これらの結合メソッドに加え、クエリを単純にするために JoinUsing メソッドを使用できます。完全な結合条件を渡すかわりに、 単純に結合するカラム名の配列を渡してやれば Zend_Db_Select オブジェクトが結合条件を作成してくれます。

// できあがるクエリは、このようになります
//   SELECT *
//   FROM "table1"
//   JOIN "table2"
//   ON "table1".column1 = "table2".column1
//   WHERE column2 = 'foo'

$select = $db->select()
             ->from('table1')
             ->joinUsing('table2', 'column1')
             ->where('column2 = ?', 'foo');

Zend_Db_Select の結合メソッドには、 それぞれ対応する 'using' メソッドがあります。

結果セットの行を制限するための条件を指定するには where() メソッドを使用します。 このメソッドの最初の引数は SQL の式で、これをクエリの SQL で WHERE 句として使用します。

// できあがるクエリは、このようになります
//   SELECT product_id, product_name, price
//   FROM "products"
//   WHERE price > 100.00

$select = $db->select()
             ->from('products',
                    array('product_id', 'product_name', 'price'))
             ->where('price > 100.00');

where() メソッドの二番目の引数はオプションです。 これは式を置き換える値となります。 Zend_Db_Select は値をクォートし、式の中の クエスチョンマーク ("?") をその値で置き換えます。

// できあがるクエリは、このようになります
//   SELECT product_id, product_name, price
//   FROM "products"
//   WHERE (price > 100.00)

$minimumPrice = 100;

$select = $db->select()
             ->from('products',
                    array('product_id', 'product_name', 'price'))
             ->where('price > ?', $minimumPrice);

SQL の IN 演算子を使うとき、 where() メソッドに 第２引数として配列を渡せます。

// クエリをビルド
//   SELECT product_id, product_name, price
//   FROM "products"
//   WHERE (product_id IN (1, 2, 3))

$productIds = array(1, 2, 3);

$select = $db->select()
             ->from('products',
                    array('product_id', 'product_name', 'price'))
             ->where('product_id IN (?)', $productIds);

Zend_Db_Select オブジェクト上で、where() メソッドを複数回実行することもできます。その結果のクエリは、 指定した条件を AND でひとつにまとめたものとなります。

// できあがるクエリは、このようになります
//   SELECT product_id, product_name, price
//   FROM "products"
//   WHERE (price > 100.00)
//     AND (price < 500.00)

$minimumPrice = 100;
$maximumPrice = 500;

$select = $db->select()
             ->from('products',
                    array('product_id', 'product_name', 'price'))
             ->where('price > ?', $minimumPrice)
             ->where('price < ?', $maximumPrice);

複数の条件を OR で連結したい場合は、 orWhere() メソッドを使用します。 このメソッドの使用法は where() メソッドとほとんど同じですが、条件の前には AND ではなく OR がつくことになります。

// できあがるクエリは、このようになります
//   SELECT product_id, product_name, price
//   FROM "products"
//   WHERE (price < 100.00)
//     OR (price > 500.00)

$minimumPrice = 100;
$maximumPrice = 500;

$select = $db->select()
             ->from('products',
                    array('product_id', 'product_name', 'price'))
             ->where('price < ?', $minimumPrice)
             ->orWhere('price > ?', $maximumPrice);

Zend_Db_Select は、where() メソッドや orWhere() メソッドで指定した式の両側に 自動的に括弧をつけます。これにより、 論理演算子が予期せぬ結果を引き起こすことを防ぎます。

// できあがるクエリは、このようになります
//   SELECT product_id, product_name, price
//   FROM "products"
//   WHERE (price < 100.00 OR price > 500.00)
//     AND (product_name = 'Apple')

$minimumPrice = 100;
$maximumPrice = 500;
$prod = 'Apple';

$select = $db->select()
             ->from('products',
                    array('product_id', 'product_name', 'price'))
             ->where("price < $minimumPrice OR price > $maximumPrice")
             ->where('product_name = ?', $prod);

上の例では、括弧がなければ結果はまったく異なるものとなります。 なぜなら、AND のほうが OR よりも優先順位が高いからです。Zend_Db_Select は括弧をつけるので、それぞれの where() で指定された式の結合度が AND より高くなります。

SQL で GROUP BY 句を使用すると、 結果セットの行数を減らすことができます。 GROUP BY 句で指定したカラムの一意な値ごとに、 結果が一行にまとめられます。

Zend_Db_Select では、行のグループ化を行うためのカラムを group() メソッドで指定します。 このメソッドへの引数は、GROUP BY 句で使用するカラムあるいは複数カラムの配列となります。

// できあがるクエリは、このようになります
//   SELECT p."product_id", COUNT(*) AS line_items_per_product
//   FROM "products" AS p JOIN "line_items" AS l
//     ON p.product_id = l.product_id
//   GROUP BY p.product_id

$select = $db->select()
             ->from(array('p' => 'products'),
                    array('product_id'))
             ->join(array('l' => 'line_items'),
                    'p.product_id = l.product_id',
                    array('line_items_per_product' => 'COUNT(*)'))
             ->group('p.product_id');

from() メソッドでのカラムの配列と同様、 カラム名には相関名を使用できます。また、 カラム名は識別子としてクォートされます。 ただし、文字列に括弧が含まれたり Zend_Db_Expr 型のオブジェクトを指定したりした場合は別です。

SQL で HAVING 句を使用すると、 グループ化した行に制約を適用します。これは、 WHERE 句が行に対して制約を適用するのと同じです。 しかし、これらには相違点があります。 WHERE 条件はグループ化の前に適用されますが、 HAVING 条件はグループ化された後に適用されます。

Zend_Db_Select では、グループに対する制約を指定するには having() メソッドを使用します。 このメソッドの使用法は where() メソッドと似ています。 最初の引数が SQL の式を含む文字列です。二番目の引数はオプションで、 SQL 式の中のパラメータプレースホルダを置き換える値となります。 having() を複数回実行すると、それらの条件が 論理演算子 AND で連結されます。 orHaving() メソッドを使用した場合は、論理演算子 OR で連結されます。

// できあがるクエリは、このようになります
//   SELECT p."product_id", COUNT(*) AS line_items_per_product
//   FROM "products" AS p JOIN "line_items" AS l
//     ON p.product_id = l.product_id
//   GROUP BY p.product_id
//   HAVING line_items_per_product > 10

$select = $db->select()
             ->from(array('p' => 'products'),
                    array('product_id'))
             ->join(array('l' => 'line_items'),
                    'p.product_id = l.product_id',
                    array('line_items_per_product' => 'COUNT(*)'))
             ->group('p.product_id')
             ->having('line_items_per_product > 10');

SQL の ORDER BY 句では、 クエリの結果セットの並べ替えの基準となるカラムや式を指定します。 複数のカラムを指定すると、最初のカラムの値が同じだった場合に 二番目のカラムを用いて並べ替えを行います。 デフォルトでは、小さいほうから大きいほうに向かって並べ替えます。 逆に大きいほうから小さいほうに向かって並べ替えるには、 カラムリストの中のそのカラム名の後に、キーワード DESC を指定します。

Zend_Db_Select では、order() メソッドを使用して 並べ替えの基準となるカラムあるいはカラムの配列を指定します。 配列の各要素はカラム名を表す文字列です。オプションとして、 スペースをはさんでキーワード ASC や DESC を続けます。

from() メソッドや group() メソッドと同様、カラム名は識別子としてクォートされます。 ただし、文字列に括弧が含まれたり Zend_Db_Expr 型のオブジェクトを指定したりした場合は別です。

// できあがるクエリは、このようになります
//   SELECT p."product_id", COUNT(*) AS line_items_per_product
//   FROM "products" AS p JOIN "line_items" AS l
//     ON p.product_id = l.product_id
//   GROUP BY p.product_id
//   ORDER BY "line_items_per_product" DESC, "product_id"

$select = $db->select()
             ->from(array('p' => 'products'),
                    array('product_id'))
             ->join(array('l' => 'line_items'),
                    'p.product_id = l.product_id',
                    array('line_items_per_product' => 'COUNT(*)'))
             ->group('p.product_id')
             ->order(array('line_items_per_product DESC',
                           'product_id'));

RDBMS によっては、SQL を拡張して、いわゆる LIMIT 句を使用できるようにしているものもあります。 これは、結果セットの行数を、最大でも指定した数までに制限します。 また、出力を始める前に読み飛ばす行数を指定することもできます。 この機能を使用すると、結果セットの一部だけを取得することが簡単になります。 たとえば、クエリの結果をページに分けて出力する場合などに便利です。

Zend_Db_Select では、limit() メソッドを使用して結果の行数および読み飛ばしの行数を指定します。 このメソッドの最初の引数は取得したい行数、 そして二番目の引数は読み飛ばす行数となります。

// できあがるクエリは、このようになります
//   SELECT p."product_id", p."product_name"
//   FROM "products" AS p
//   LIMIT 10, 20
// 以下に相当します
//   SELECT p."product_id", p."product_name"
//   FROM "products" AS p
//   LIMIT 20 OFFSET 10
$select = $db->select()
             ->from(array('p' => 'products'),
                    array('product_id', 'product_name'))
             ->limit(20, 10);

一方、limitPage() メソッドを用いることによっても行数とオフセットを指定できます。 このメソッドは、クエリの結果セット全体から特定の箇所の連続した行のみを取得するものです。 つまり、結果の「ページ」を指定することで、 そのページに該当する部分の結果のみを取得するというわけです。 limitPage() メソッドの最初の引数にページ数、 2 番目の引数にページあたりの行数を指定します。 どちらの引数も必須で、デフォルト値はありません。

// できあがるクエリは、このようになります
//   SELECT p."product_id", p."product_name"
//   FROM "products" AS p
//   LIMIT 10, 20

$select = $db->select()
             ->from(array('p' => 'products'),
                    array('product_id', 'product_name'))
             ->limitPage(2, 10);

distinct() メソッドを使用すると、SQL クエリに DISTINCT キーワードを追加できます。

// できあがるクエリは、このようになります
//   SELECT DISTINCT p."product_name"
//   FROM "products" AS p

$select = $db->select()
             ->distinct()
             ->from(array('p' => 'products'), 'product_name');

forUpdate() メソッドを使用すると、SQL クエリに FOR UPDATE 修飾子を追加できます。

// できあがるクエリは、このようになります
//   SELECT FOR UPDATE p.*
//   FROM "products" AS p

$select = $db->select()
             ->forUpdate()
             ->from(array('p' => 'products'));

union()メソッドにZend_Db_Selectの配列、 または SQL クエリ文字列を渡すことによって、 Zend_Db_Selectで結合クエリを構築できます。 どの種類の結合を実行したいか指定するために、 第２引数として、Zend_Db_Select::SQL_UNION、 またはZend_Db_Select::SQL_UNION_ALL定数を渡せます。

$sql1 = $db->select();
$sql2 = "SELECT ...";

$select = $db->select()
    ->union(array($sql1, $sql2))
    ->order("id");

Zend_Db_Select オブジェクトが表すクエリを実行するには、それを Zend_Db_Adapter_Abstract オブジェクトの query() メソッドの最初の引数として渡します。すると、 文字列のクエリのかわりに Zend_Db_Select オブジェクトを使用するようになります。

query() メソッドは、アダプタの型によって Zend_Db_Statement あるいは PDOStatement 型のオブジェクトを返します。

$select = $db->select()
             ->from('products');

$stmt = $db->query($select);
$result = $stmt->fetchAll();

アダプタオブジェクトの query() メソッドを使用する以外の方法としては、Zend_Db_Select オブジェクトの query() メソッドを使用するものがあります。 どちらのメソッドも、アダプタの型によって Zend_Db_Statement あるいは PDOStatement 型のオブジェクトを返します。

$select = $db->select()
             ->from('products');

$stmt = $select->query();
$result = $stmt->fetchAll();

Zend_Db_Select オブジェクトに対応する SQL クエリ文字列にアクセスしたい場合は、 __toString() メソッドを使用します。

$select = $db->select()
             ->from('products');

$sql = $select->__toString();
echo "$sql\n";

// 出力は、次のような文字列になります
//   SELECT * FROM "products"

getPart() メソッドは、SQL クエリの一部を返します。 たとえば、このメソッドを使用すると、 WHERE 句の式を表す配列や SELECT するカラム (あるいは式) の配列、または LIMIT 句のカウントやオフセットを取得できます。

返り値は、SQL の一部を抜き取った文字列ではありません。 オブジェクトでの内部表現で、通常は値と式を含む配列となります。 クエリの各部分によって、その構造は異なります。

getPart() メソッドの引数はひとつで、 Select クエリのどの部分を返すのかをここで指定します。 たとえば、文字列 'from' を指定すると、 Select オブジェクトが FROM 句として保持しているテーブルの情報を返します。 ここには結合している他のテーブルも含まれます。

Zend_Db_Select クラスでは、SQL クエリの各部分を指定するための定数を定義しています。 これらの定数、あるいはリテラル文字列のいずれかで指定できます。

$select = $db->select()
             ->from('products')
             ->order('product_id');

// 文字列リテラルを使用して指定できます
$orderData = $select->getPart( 'order' );

// 同じことを、定数を用いて指定することもできます
$orderData = $select->getPart( Zend_Db_Select::ORDER );

// 返り値は、文字列ではなく配列となります。
// 各部分が異なる構造になっています。
print_r( $orderData );

reset() メソッドを使用すると、 SQL クエリの指定した部分のみを消去できます。 引数を省略した場合は、すべての部分を消去します。

引数はひとつで、これは省略可能です。 消去したい SQL の部分を、getPart() メソッドの引数と同じ文字列で指定します。 クエリの指定した部分が、デフォルトの状態に戻ります。

パラメータを省略すると、reset() はクエリのすべての部分をデフォルトの状態に戻します。 これにより、Zend_Db_Select オブジェクトは初期状態と同等になります。 つまり、最初にインスタンスを作成したときと同じ状態ということです。

// できあがるクエリは、このようになります
//   SELECT p.*
//   FROM "products" AS p
//   ORDER BY "product_name"

$select = $db->select()
             ->from(array('p' => 'products')
             ->order('product_name');

// 条件を変更し、別のカラムで並べ替えます
//   SELECT p.*
//   FROM "products" AS p
//   ORDER BY "product_id"

// 再定義するため、いちどこの部分を消去します
$select->reset( Zend_Db_Select::ORDER );

// そして異なるカラムを指定します
$select->order('product_id');

// クエリ全体を消去します
$select->reset();