はじめに

Exportモジュールでメソッドを変更するすべてのスキーマはalterオペレーションのために使われるSQLを返す同等物を持ちます。例えばcreateTable()はcreateTableSql()によって返されるクエリを実行します。

この章ではevents_dbという名前のデータベースで、次のテーブルが作成され、変更され最後には削除されます:

events

|

people

|

event_participants

|

データベースを作成する

Doctrineで新しいデータベースを作成するのはシンプルです。作成するデータベースの名前を引数にしてcreateDatabase()メソッドを呼び出すだけです。

// test.php

// ... $conn->export->createDatabase('events_db');

新しいevents_dbに接続するためにbootstrap.phpファイルの接続を変更してみましょう:

// bootstrap.php

/* Bootstrap Doctrine.php, register autoloader and specify configuration attributes /

// ...

$conn = Doctrine_Manager::connection('mysql://root:@localhost/events\_db', 'doctrine');

// ...

テーブルを作成する

データベースは作成され接続を再設定しました。テーブルに追加に移ります。createTable()メソッドは3つのパラメータ: テーブルの名前、フィールド定義の配列、と追加オプション(オプションでRDBMS固有)を受けとります。

eventsテーブルを作成しましょう:

// test.php

// $definition = array( 'id' => array( 'type' => 'integer', 'primary' => true, 'autoincrement' => true ), 'name' => array( 'type' => 'string', 'length' => 255 ), 'datetime' => array( 'type' => 'timestamp' ) );

$conn->export->createTable('events', $definition);

定義配列のキーはテーブルのフィールド名です。値は他のキーと同じように必須キーのtypeを格納する配列で、typeの値によって、typeキーの値はDoctrineのデータ型と同じものが可能です。データ型によって、他のオプションが変わることがあります。

|

peopleテーブルを作ることができます:

// test.php

// ... $definition = array( 'id' => array( 'type' => 'integer', 'primary' => true, 'autoincrement' => true ), 'name' => array( 'type' => 'string', 'length' => 255 ) );

$conn->export->createTable('people', $definition);

createTable()メソッドの3番目の引数としてオプションの配列を指定することもできます:

// test.php

// ... $options = array( 'comment' => 'Repository of people', 'character_set' => 'utf8', 'collate' => 'utf8_unicode_ci', 'type' => 'innodb', );

// ...

$conn->export->createTable('people', $definition, $options);

外部キーを作成する

外部キーでevent_participantsテーブルを作成します:

// test.php

// ... $options = array( 'foreignKeys' => array( 'events_id_fk' => array( 'local' => 'event_id', 'foreign' => 'id', 'foreignTable' => 'events', 'onDelete' => 'CASCADE', ) ), 'primary' => array('event_id', 'person_id'), );

$definition = array( 'event_id' => array( 'type' => 'integer', 'primary' => true ), 'person_id' => array( 'type' => 'integer', 'primary' => true ), );

$conn->export->createTable('event_participants', $definition, $options);

TIP 上記の例でperson_idに対して外部キーを省略していることに注目してください。この例では次の例で個別の外部キーをテーブルに追加する方法を示すために省略しました。通常はforeignKeysで定義された両方の外部キーがあることがベストです。

person\_idカラムのevent_participantsテーブルに見つからない外部キーを追加してみましょう:

// test.php

// ... $definition = array('local' => 'person_id', 'foreign' => 'id', 'foreignTable' => 'people', 'onDelete' => 'CASCADE');

$conn->export->createForeignKey('event_participants', $definition);

テーブルを変更する

Doctrine_Exportドライバはデータベースがポータブルでありながら既存のデータベーステーブルを簡単に変更する方法を提供します。

// test.php

// ... $alter = array( 'add' => array( 'new_column' => array( 'type' => 'string', 'length' => 255 ), 'new_column2' => array( 'type' => 'string', 'length' => 255 ) ) );

echo $conn->export->alterTableSql('events', $alter);

alterTableSql()への呼び出しは次のSQLクエリを出力します:

ALTER TABLE events ADD new_column VARCHAR(255), ADD new_column2

VARCHAR(255)

NOTE

生成SQLのみを実行しこれを返したくない場合、alterTable()メソッドを使います。

// test.php

// ...

$conn->export->alterTable('events', $alter);

alterTable()メソッドは2つのパラメータを必須とし3番目のパラメータはオプションです:

|

オプションの3番目のパラメータ(デフォルト: false):

|

現在サポートされる変更のタイプは次のように定義されます:

|

配列のそれぞれのエントリの値はフィールドのプロパティを格納する別の連想配列に設定されます。これは配列エントリとして変更されることを意味します。これらのエントリはそれぞれのプロパティの新しい値に割り当てられます。フィールドのプロパティはDoctrineパーサーが定義するものと同じです。

// test.php

// ... $alter = array('name' => 'event', 'add' => array( 'quota' => array( 'type' => 'integer', 'unsigned' => 1 ) ), 'remove' => array( 'new_column2' => array() ), 'change' => array( 'name' => array( 'length' => '20', 'definition' => array( 'type' => 'string', 'length' => 20 ) ) ), 'rename' => array( 'new_column' => array( 'name' => 'gender', 'definition' => array( 'type' => 'string', 'length' => 1, 'default' => 'M' ) ) )

$ );

$conn->export->alterTable('events', $alter);

NOTE

テーブルをeventにリネームしたことに注目してください。テーブルをeventsにリネームし直しましょう。機能を示すためだけにテーブルをリネームしたので次の例のためにテーブルをeventsと名づける必要があります。

// test.php

// ... $alter = array( 'name' => 'events' );

$conn->export->alterTable('event', $alter);

インデックスを作成する

インデックスを作成するために、createIndex()メソッドが使われます。このメソッドはcreateConstraint()と似たシグニチャを持ち、テーブルの名前、インデックスの名前と定義配列を受け取ります。定義配列はfieldsという名前の1つのキーを持ち、その値はインデックスの一部であるフィールドを格納する別の連想配列です。フィールドは次のキーを持つ配列として定義されます: ソート、昇順と降順の長さを持つ値、整数値

すべてのRDBMSはインデックスソートもしくは長さをサポートしないので、これらの場合ドライバはこれらを無視します。テストのeventデータベースでは、アプリケーションが固有のtimeframeで起きるイベントを表示することを前提とすることができます。selectはWHERE条件でdatatimeフィールドを使います。このフィールドにインデックスが存在する場合に手助けになります。

// test.php

// ... $definition = array( 'fields' => array( 'datetime' => array() ) );

$conn->export->createIndex('events', 'datetime', $definition);

データベースの要素を削除する

上記で示されたそれぞれのcreate*()メソッドに対して、データベース、テーブル、フィールド、インデックスもしくは制約を削除するために対応するdrop*()メソッドが存在します。drop\*()メソッドは削除されるアイテムの存在をチェックしません。try-catchブロックを使用して例外をチェックするのは開発者の責務です:

// test.php

// ... try { $conn->export->dropSequence('nonexisting'); } catch(Doctrine_Exception $e) {

}

次のコードで制約を簡単に削除できます:

// test.php

// ... $conn->export->dropConstraint('events', 'PRIMARY', true);

NOTE 3番目の引数はこれが主キーであることのヒントを与えます。

// test.php

// ... $conn->export->dropConstraint('event_participants', 'event_id');

次のコードでインデックスを簡単に削除できます:

$conn->export->dropIndex('events', 'event_timestamp');

TIP 次の2つの例を実際に実行するのは推奨されません。次のセクションで我々の例が無傷で動作できるようにevents_dbが必要です。

次のコードでデータベースからテーブルを削除します:

// test.php

// ... $conn->export->dropTable('events');

次のコードでデータベースを削除できます:

// test.php

// ... $conn->export->dropDatabase('events_db');

紹介

データベースに何があるのか見るために、Importモジュールのlist\*()ファミリーのメソッドを使うことができます。

|

下記において上記のメソッドの使い方の例が見つかります:

データベースの一覧を表示する

// test.php

// ... $databases = `conn->import->listDatabases(); print_r(` databases);

シーケンスの一覧を表示する

// test.php

`conn->import->listSequences('events_db'); print_r(` sequences);

制約の一覧を表示する

// test.php

`conn->import->listTableConstraints('event_participants'); print_r(` constraints);

テーブルカラムの一覧を表示する

// test.php

`conn->import->listTableColumns('events'); print_r(` columns);

テーブルインデックスの一覧を表示する

// test.php

`conn->import->listTableIndexes('events'); print_r(` indexes);

テーブルの一覧を表示する

$tables = `conn->import->listTables(); print_r(` tables);

ビューの一覧を表示する

NOTE

現在、ビューを作成するメソッドは存在しないので、手動で作成してください。

$sql = CREATE VIEW names_only AS SELECT name FROM people;

`conn->exec(` sql); $sql = CREATE VIEW last_ten_events AS SELECT * FROM events ORDER BY id DESC LIMIT 0,10; `conn->exec(` sql); 先ほど作成したビューの一覧を表示できます:

$views = `conn->import->listViews(); print_r(` views);

はじめに

ネイティブのRDBMの型をDoctrineの型に変換するもしくはその逆を行うためにDoctrineは内部でDataDictモジュールを使用します。DataDictモジュールは変換のために2つのメソッドを使用します:

• getPortableDeclaration()はネイティブなRDBMSの型宣言をポータブルなDoctrine宣言に変換するために使われる
• getNativeDeclaration()はDoctrine宣言をドライバ固有の型宣言に変換するために使われる

ポータブルな宣言を取得する

// test.php

// ... $declaration = $conn->dataDict->getPortableDeclaration('VARCHAR(255)');

print_r($declaration);

上記の例は次の内容を出力します:

$ php test.php Array ( [type] => Array ( [0] => string )

[length] => 255
[unsigned] => 
[fixed] => 

)

ネイティブな宣言を取得する

// test.php

// ... $portableDeclaration = array( 'type' => 'string', 'length' => 20, 'fixed' => true );

$nativeDeclaration = `conn->dataDict->getNativeDeclaration(` portableDeclaration); echo $nativeDeclaration;

上記の例は次の内容を出力します:

$ php test.php CHAR(20)

Mysql