Database Explorer
Explorerは、データベースを扱うための直感的で効率的な方法を提供します。テーブル間のリレーションやクエリの最適化を自動的に処理するため、アプリケーションに集中できます。設定なしですぐに機能します。SQLクエリを完全に制御する必要がある場合は、SQLアクセス を利用できます。
- データの操作は自然で理解しやすい
- 必要なデータのみを読み込む最適化されたSQLクエリを生成
- JOINクエリを記述することなく、関連データに簡単にアクセス可能
- 設定やエンティティの生成なしで即座に機能
Explorerの使用は、Nette\Database\Explorer
オブジェクトの table()
メソッドを呼び出すことから始めます(接続の詳細については、接続と設定 の章を参照してください):
このメソッドは、SQLクエリを表す Selection
オブジェクトを返します。このオブジェクトにさらにメソッドを連鎖させて、結果をフィルタリングおよびソートできます。クエリは、データを要求し始めたときにのみ構築および実行されます。たとえば、foreach
ループで反復処理する場合です。各行は ActiveRow
オブジェクトによって表されます:
Explorerは、テーブル間のリレーション の操作を大幅に簡素化します。次の例は、関連するテーブル(書籍とその著者)からデータを簡単に表示する方法を示しています。JOINクエリを記述する必要がないことに注意してください。Netteがそれらを自動的に作成します:
Nette Database Explorerは、クエリを可能な限り効率的に最適化します。上記の例では、処理する書籍が10冊であろうと10,000冊であろうと、2つのSELECTクエリのみを実行します。
さらに、Explorerはコード内で使用されているカラムを追跡し、データベースからそれらのみを読み込むことで、さらなるパフォーマンスを節約します。この動作は完全に自動的で適応的です。後でコードを変更して追加のカラムを使用し始めると、Explorerは自動的にクエリを調整します。何も設定する必要はなく、どのカラムが必要になるかを考える必要もありません – それはNetteに任せてください。
フィルタリングとソート
Selection
クラスは、データ選択のフィルタリングとソートのためのメソッドを提供します。
where($condition, ...$params) |
WHERE条件を追加します。複数の条件はAND演算子で結合されます |
whereOr(array $conditions) |
OR演算子で結合されたWHERE条件のグループを追加します |
wherePrimary($value) |
主キーに基づいてWHERE条件を追加します |
order($columns, ...$params) |
ORDER BYソートを設定します |
select($columns, ...$params) |
読み込むカラムを指定します |
limit($limit, $offset = null) |
行数を制限し(LIMIT)、オプションでOFFSETを設定します |
page($page, $itemsPerPage, &$total = null) |
ページネーションを設定します |
group($columns, ...$params) |
行をグループ化します(GROUP BY) |
having($condition, ...$params) |
グループ化された行をフィルタリングするためのHAVING条件を追加します |
メソッドは連鎖させることができます(いわゆる fluent
interface):$table->where(...)->order(...)->limit(...)
。
これらのメソッドでは、関連テーブルのデータ にアクセスするための特別な表記法を使用することもできます。
エスケープと識別子
メソッドはパラメータを自動的にエスケープし、識別子(テーブル名とカラム名)を引用符で囲むことで、SQLインジェクションを防ぎます。正しく機能させるためには、いくつかのルールに従う必要があります:
- キーワード、関数名、プロシージャ名などは 大文字 で記述します。
- カラム名とテーブル名は 小文字 で記述します。
- 文字列は常に パラメータ を介して代入します。
where(string|array $condition, …$parameters): static
WHERE条件を使用して結果をフィルタリングします。その強力な点は、さまざまなタイプの値をインテリジェントに処理し、SQL演算子を自動的に選択することです。
基本的な使用法:
適切な演算子の自動検出のおかげで、さまざまな特殊なケースに対処する必要はありません。Netteがそれらを処理します:
メソッドは、否定条件や空の配列も正しく処理します:
別のテーブルからの結果をパラメータとして渡すこともできます – サブクエリが作成されます:
条件を配列として渡すこともでき、その要素はANDで結合されます:
配列では、キー ⇒ 値のペアを使用でき、Netteは再び正しい演算子を自動的に選択します:
配列では、プレースホルダー疑問符と複数のパラメータを持つSQL式を組み合わせることができます。これは、正確に定義された演算子を持つ複雑な条件に適しています:
where()
の複数回の呼び出しは、条件を自動的にANDで結合します。
whereOr(array $parameters): static
where()
と同様に条件を追加しますが、ORで結合する点が異なります:
ここでも、より複雑な式を使用できます:
wherePrimary(mixed $key): static
テーブルの主キーの条件を追加します:
テーブルに複合主キー(例:foo_id
,
bar_id
)がある場合は、配列として渡します:
order(string $columns, …$parameters): static
行が返される順序を指定します。1つまたは複数のカラム、昇順または降順、またはカスタム式でソートできます:
select(string $columns, …$parameters): static
データベースから返すカラムを指定します。デフォルトでは、Nette Database
Explorerはコードで実際に使用されるカラムのみを返します。select()
メソッドは、特定の式を返す必要がある場合に使用します:
AS
で定義されたエイリアスは、ActiveRowオブジェクトのプロパティとして利用できます:
limit(?int $limit, ?int $offset = null): static
返される行数を制限し(LIMIT)、オプションでオフセットを設定できます:
ページネーションには、page()
メソッドを使用する方が適しています。
page(int $page, int $itemsPerPage, &$numOfPages = null): static
結果のページネーションを容易にします。ページ番号(1から数える)とページあたりの項目数を受け取ります。オプションで、合計ページ数が格納される変数への参照を渡すことができます:
group(string $columns, …$parameters): static
指定されたカラムに基づいて行をグループ化します(GROUP BY)。通常、集計関数と組み合わせて使用されます:
having(string $having, …$parameters): static
グループ化された行をフィルタリングするための条件(HAVING)を設定します。group()
メソッドと集計関数と組み合わせて使用できます:
データの読み取り
データベースからデータを読み取るために、いくつかの便利なメソッドが利用可能です:
foreach ($table as $key => $row) |
全行を反復処理します。$key は主キーの値、$row はActiveRowオブジェクトです |
$row = $table->get($key) |
主キーに基づいて1行を返します |
$row = $table->fetch() |
現在の行を返し、ポインタを次に進めます |
$array = $table->fetchPairs() |
結果から連想配列を作成します |
$array = $table->fetchAll() |
全行を配列として返します |
count($table) |
Selectionオブジェクト内の行数を返します |
ActiveRow オブジェクトは読み取り専用です。つまり、そのプロパティの値を変更することはできません。この制限により、データの整合性が保証され、予期しない副作用が防止されます。データはデータベースから読み込まれ、変更は明示的かつ制御された方法で行われるべきです。
foreach
– 全行の反復処理
クエリを実行して行を取得する最も簡単な方法は、foreach
ループで反復処理することです。SQLクエリを自動的に実行します。
get($key): ?ActiveRow
SQLクエリを実行し、主キーに基づいて行を返します。存在しない場合は
null
を返します。
fetch(): ?ActiveRow
行を返し、内部ポインタを次に進めます。これ以上行がない場合は null
を返します。
fetchPairs(string|int|null $key = null, string|int|null $value = null): array
結果を連想配列として返します。最初の引数は配列のキーとして使用されるカラム名を指定し、2番目の引数は値として使用されるカラム名を指定します:
最初のパラメータのみを指定した場合、値は行全体、つまり ActiveRow
オブジェクトになります:
キーが重複する場合、最後の行の値が使用されます。キーとして null
を使用すると、配列はゼロから始まる数値インデックスになります(この場合、衝突は発生しません):
fetchPairs(Closure $callback): array
あるいは、パラメータとしてコールバックを指定することもできます。これは、各行に対して値自体、またはキーと値のペアのいずれかを返します。
fetchAll(): array
すべての行を ActiveRow
オブジェクトの連想配列として返します。キーは主キーの値です。
count(): int
パラメータなしの count()
メソッドは、Selection
オブジェクト内の行数を返します:
注意:パラメータ付きの count()
は、データベースで集計関数COUNTを実行します。下記参照。
ActiveRow::toArray(): array
ActiveRow
オブジェクトを連想配列に変換します。キーはカラム名、値は対応するデータです。
集計
Selection
クラスは、集計関数(COUNT、SUM、MIN、MAX、AVGなど)を簡単に実行するためのメソッドを提供します。
count($expr) |
行数をカウントします |
min($expr) |
カラム内の最小値を返します |
max($expr) |
カラム内の最大値を返します |
sum($expr) |
カラム内の値の合計を返します |
aggregation($function) |
任意の集計関数を実行できます。例: AVG() , GROUP_CONCAT() |
count(string $expr): int
COUNT関数を使用してSQLクエリを実行し、結果を返します。このメソッドは、特定の条件に一致する行数を調べるために使用されます:
注意:パラメータなしの count() は、Selection
オブジェクト内の行数を返すだけです。
min(string $expr) a max(string $expr)
min()
および max()
メソッドは、指定されたカラムまたは式の最小値と最大値を返します:
sum(string $expr)
指定されたカラムまたは式の値の合計を返します:
aggregation(string $function, ?string $groupFunction = null)
任意の集計関数を実行できます。
既に何らかの集計関数とグループ化から生じた結果(例:グループ化された行に対する
SUM(値)
)を集計する必要がある場合、2番目の引数として、これらの中間結果に適用する集計関数を指定します:
この例では、まず各カテゴリの製品の合計価格(SUM(price * stock) AS category_total
)を計算し、category_id
で結果をグループ化します。次に、aggregation('SUM(category_total)', 'SUM')
を使用して、これらの中間合計 category_total
を合計します。2番目の引数 'SUM'
は、中間結果にSUM関数を適用することを示します。
Insert, Update & Delete
Nette Database
Explorerは、データの挿入、更新、削除を簡素化します。記載されているすべてのメソッドは、Nette\Database\DriverException
例外をスローします。
Selection::insert(iterable $data)
テーブルに新しいレコードを挿入します。
単一レコードの挿入:
新しいレコードを連想配列またはiterableオブジェクト(たとえば フォーム で使用されるArrayHash)として渡します。キーはテーブルのカラム名に対応します。
テーブルに主キーが定義されている場合、メソッドはデータベースから再読み込みされた
ActiveRow
オブジェクトを返します。これにより、データベースレベルで行われた変更(トリガー、カラムのデフォルト値、自動インクリメントカラムの計算)が反映されます。これにより、データの整合性が保証され、オブジェクトは常にデータベースからの最新データを含みます。一意の主キーがない場合は、渡されたデータを配列形式で返します。
複数のレコードを一度に挿入:
insert()
メソッドを使用すると、単一のSQLクエリで複数のレコードを挿入できます。この場合、挿入された行数を返します。
パラメータとして、データ選択を持つ Selection
オブジェクトを渡すこともできます。
特殊な値の挿入:
値として、ファイル、DateTimeオブジェクト、またはSQLリテラルを渡すこともできます:
Selection::update(iterable $data): int
指定されたフィルタに従ってテーブル内の行を更新します。実際に変更された行数を返します。
変更するカラムを連想配列またはiterableオブジェクト(たとえば フォーム で使用されるArrayHash)として渡します。キーはテーブルのカラム名に対応します:
数値の値を変更するには、+=
および -=
演算子を使用できます:
Selection::delete(): int
指定されたフィルタに従ってテーブルから行を削除します。削除された行数を返します。
update()
および delete()
を呼び出すときは、where()
を使用して変更/削除する行を指定することを忘れないでください。where()
を使用しない場合、操作はテーブル全体に対して実行されます!
ActiveRow::update(iterable $data): bool
ActiveRow
オブジェクトによって表されるデータベース行のデータを更新します。パラメータとして、更新するデータを含むiterable(キーはカラム名)を受け取ります。数値の値を変更するには、+=
および -=
演算子を使用できます:
更新を実行した後、ActiveRow
はデータベースから自動的に再読み込みされ、データベースレベルで行われた変更(例:トリガー)が反映されます。メソッドは、データが実際に変更された場合にのみtrueを返します。
このメソッドは、データベース内の特定の1行のみを更新します。複数の行を一括更新するには、Selection::update() メソッドを使用します。
ActiveRow::delete()
ActiveRow
オブジェクトによって表されるデータベースから行を削除します。
このメソッドは、データベース内の特定の1行のみを削除します。複数の行を一括削除するには、Selection::delete() メソッドを使用します。
テーブル間のリレーション
リレーショナルデータベースでは、データは複数のテーブルに分割され、外部キーを使用して相互にリンクされています。Nette Database Explorerは、これらのリレーションを操作するための革新的な方法を提供します – JOINクエリを記述したり、何かを設定したり生成したりする必要はありません。
リレーションの操作を説明するために、書籍データベースの例を使用します(GitHubで見つけることができます)。データベースには次のテーブルがあります:
author
– 作家と翻訳者(カラムid
,name
,web
,born
)book
– 書籍(カラムid
,author_id
,translator_id
,title
,sequel_id
)tag
– タグ(カラムid
,name
)book_tag
– 書籍とタグ間の関連テーブル(カラムbook_id
,tag_id
)

データベース構造
書籍データベースの例では、いくつかのタイプの関係が見つかります(モデルは現実よりも単純化されていますが):
- One-to-many 1:N – 各書籍には 1人の 著者がおり、著者は 複数の 書籍を書くことができます
- Zero-to-many 0:N – 書籍には翻訳者が いる場合があり、翻訳者は 複数の 書籍を翻訳できます
- Zero-to-one 0:1 – 書籍には続編が ある場合があります
- Many-to-many M:N – 書籍には 複数の タグがあり、タグは 複数の 書籍に割り当てることができます
これらの関係では、常に親テーブルと子テーブルが存在します。たとえば、著者と書籍の関係では、author
テーブルが親で、book
テーブルが子です –
書籍は常に何らかの著者に「属している」と考えることができます。これはデータベースの構造にも反映されています:子テーブル
book
には、親テーブル author
を参照する外部キー author_id
が含まれています。
著者名を含む書籍をリストする必要がある場合、2つの選択肢があります。JOINを使用して単一のSQLクエリでデータを取得する:
または、データを2段階で読み込む – まず書籍、次にその著者 – そしてPHPでそれらを組み立てる:
2番目のアプローチは、驚くべきかもしれませんが、実際にはより効率的です。データは一度だけ読み込まれ、キャッシュでより良く利用できます。Nette Database Explorerはこの方法で動作します – すべてを内部で処理し、エレガントなAPIを提供します:
親テーブルへのアクセス
親テーブルへのアクセスは簡単です。これは 書籍には著者がいる または
書籍には翻訳者がいる場合がある
のような関係です。関連するレコードは、ActiveRowオブジェクトのプロパティを介して取得します –
その名前は、id
を除いた外部キーのカラム名に対応します:
プロパティ $book->author
にアクセスすると、Explorerは book
テーブルで文字列
author
を含むカラム(つまり
author_id
)を探します。このカラムの値に基づいて、対応するレコードを author
テーブルから読み込み、ActiveRow
として返します。同様に、$book->translator
も機能し、translator_id
カラムを使用します。translator_id
カラムは null
を含む可能性があるため、コードで ?->
演算子を使用します。
代替の方法として、ref()
メソッドがあります。これは、ターゲットテーブルの名前と結合カラムの名前の2つの引数を受け取り、ActiveRow
インスタンスまたは null
を返します:
ref()
メソッドは、テーブルに同じ名前のカラム(つまり
author
)が含まれているためにプロパティアクセスを使用できない場合に便利です。その他の場合、読みやすいプロパティアクセスを使用することをお勧めします。
Explorerはデータベースクエリを自動的に最適化します。ループで書籍を反復処理し、それらの関連レコード(著者、翻訳者)にアクセスする場合、Explorerは各書籍に対して個別にクエリを生成しません。代わりに、各リレーションタイプに対して1つのSELECTのみを実行し、データベースの負荷を大幅に削減します。たとえば:
このコードは、データベースに対してこれら3つの高速なクエリのみを呼び出します:
結合カラムの検索ロジックは、Conventions の実装によって決定されます。DiscoveredConventions の使用をお勧めします。これは外部キーを分析し、テーブル間の既存のリレーションを簡単に操作できます。
子テーブルへのアクセス
子テーブルへのアクセスは逆方向に機能します。今度は この著者が書いた書籍は何か
または この翻訳者が翻訳した書籍は何か
を尋ねます。このタイプのクエリには、関連レコードを持つ Selection
を返す
related()
メソッドを使用します。例を見てみましょう:
related()
メソッドは、ドット表記の単一引数として、または2つの個別の引数として結合の説明を受け入れます:
Explorerは、親テーブルの名前に基づいて正しい結合カラムを自動的に検出できます。この場合、ソーステーブルの名前が
author
であるため、book.author_id
カラムを介して結合されます:
複数の可能な結合が存在する場合、Explorerは AmbiguousReferenceKeyException 例外をスローします。
related()
メソッドは、もちろん、ループで複数のレコードを反復処理する場合にも使用でき、Explorerはこの場合でもクエリを自動的に最適化します:
このコードは、2つの高速なSQLクエリのみを生成します:
多対多リレーション
多対多(M:N)リレーションには、2つの外部キーカラム(book_id
、tag_id
)を含む関連テーブル(この場合は
book_tag
)が必要です。これらのカラムのそれぞれは、リンクされたテーブルの1つの主キーを参照します。関連データを取得するには、まず
related('book_tag')
を使用して関連テーブルからレコードを取得し、次にターゲットデータに進みます:
Explorerは再びSQLクエリを効率的な形式に最適化します:
関連テーブルを介したクエリ
where()
、select()
、order()
、group()
メソッドでは、他のテーブルのカラムにアクセスするための特別な表記法を使用できます。Explorerは必要なJOINを自動的に作成します。
ドット表記 (親テーブル.カラム
)
は、子テーブルの観点からの1:N関係に使用されます:
コロン表記 (:子テーブル.カラム
)
は、親テーブルの観点からの1:N関係に使用されます:
上記のコロン表記(:book.title
)の例では、外部キーのカラムが指定されていません。Explorerは、親テーブルの名前に基づいて正しいカラムを自動的に検出します。この場合、ソーステーブルの名前が
author
であるため、book.author_id
カラムを介して結合されます。複数の可能な結合が存在する場合、Explorerは AmbiguousReferenceKeyException
例外をスローします。
結合カラムは括弧内に明示的に指定できます:
表記法は、複数のテーブルを介してアクセスするために連鎖させることができます:
JOIN条件の拡張
joinWhere()
メソッドは、SQLでテーブルを結合する際に ON
キーワードの後に指定される条件を拡張します。
特定の翻訳者によって翻訳された書籍を見つけたいとしましょう:
joinWhere()
条件では、where()
メソッドと同じ構文を使用できます –
演算子、プレースホルダー疑問符、値の配列、またはSQL式。
複数のJOINを持つより複雑なクエリの場合、テーブルエイリアスを定義できます:
where()
メソッドが WHERE
句に条件を追加するのに対し、joinWhere()
メソッドはテーブルを結合する際の ON
句の条件を拡張することに注意してください。