fixing some inconsitencies in the docs. Moved compile to optimization part
This commit is contained in:
meus
parent
75c630951c
commit
ea4561fb61
@ -42,6 +42,9 @@ Doctrine::generateModelsFromYaml('/path/to/schema.yml', '/path/to/generate/model
|
||||
// Create all your tables from an existing set of models
|
||||
Doctrine::createTablesFromModels('/path/to/models');
|
||||
|
||||
// Create the tables supplied in the array
|
||||
Doctrine::createTablesFromArray(array('User', 'Phoneumber'));
|
||||
|
||||
// Generate string of sql commands from an existing set of models
|
||||
Doctrine::generateSqlFromModels('/path/to/models');
|
||||
|
||||
|
||||
@ -1,121 +1,6 @@
|
||||
++ Requirements
|
||||
Doctrine requires PHP >= 5.2. it doesn't require any external libraries. For database function call abstraction Doctrine uses PDO which is bundled with php by default.
|
||||
|
||||
++ Installation
|
||||
++ Compiling
|
||||
Doctrine is quite big framework and usually dozens of files are being included on each request. This brings a lot of overhead. In fact these file operations are as time consuming as sending multiple queries to database server. The clean separation of class per file works well in developing environment, however when project goes commercial distribution the speed overcomes the clean separation of class per file -convention.
|
||||
|
||||
Doctrine offers method called {{compile()}} to solve this issue. The compile method makes a single file of most used Doctrine components which can then be included on top of your script. By default the file is created into Doctrine root by the name {{Doctrine.compiled.php}}.
|
||||
|
||||
Compiling is a method for making a single file of most used doctrine runtime components including the compiled file instead of multiple files (in worst cases dozens of files) can improve performance by an order of magnitude. In cases where this might fail, a {{Doctrine_Exception}} is throw detailing the error.
|
||||
|
||||
<code type="php">
|
||||
Doctrine::compile();
|
||||
// on some other script:
|
||||
require_once('path_to_doctrine/Doctrine.compiled.php');
|
||||
</code>
|
||||
++ Starting new project
|
||||
++ Working with existing databases
|
||||
++ Exporting classes
|
||||
+++ Introduction
|
||||
|
||||
Doctrine supports exporting record classes into database. This means that based on the definitions given in your record definitions Doctrine will alter your database schema.
|
||||
|
||||
Lets say we have a classes called User and Phonenumber with the following definitions:
|
||||
|
||||
<code type="php">
|
||||
// file User.php
|
||||
class User extends Doctrine_Record
|
||||
{
|
||||
public function setTableDefinition()
|
||||
{
|
||||
$this->hasColumn('name', 'string', 20);
|
||||
}
|
||||
public function setUp()
|
||||
{
|
||||
$this->hasMany('Phonenumber', array('local' => 'id',
|
||||
'foreign' => 'user_id'));
|
||||
}
|
||||
}
|
||||
// file Phonenumber.php
|
||||
class Phonenumber extends Doctrine_Record
|
||||
{
|
||||
public function setTableDefinition()
|
||||
{
|
||||
$this->hasColumn('phonenumber', 'string', 20);
|
||||
$this->hasColumn('user_id', 'integer');
|
||||
}
|
||||
public function setUp()
|
||||
{
|
||||
$this->hasOne('User', array('local' => 'user_id',
|
||||
'foreign' => 'id',
|
||||
'onDelete' => 'CASCADE'));
|
||||
}
|
||||
}
|
||||
</code>
|
||||
|
||||
Now lets say these classes are in directory 'models/'. We can make Doctrine to iterate through this directory and attach these classes into your database structure with the following script:
|
||||
|
||||
<code type="php">
|
||||
|
||||
require_once('path-to-doctrine/lib/Doctrine.php');
|
||||
|
||||
spl_autoload_register(array('Doctrine', 'autoload'));
|
||||
|
||||
// in order to export we need a database connection
|
||||
$manager = Doctrine_Manager::getInstance();
|
||||
$conn = $manager->openConnection('pgsql://user:pass@localhost/test');
|
||||
|
||||
Doctrine::createTablesFromModels('models');
|
||||
</code>
|
||||
|
||||
This would execute the following queries on mysql.
|
||||
|
||||
<code type="sql">
|
||||
CREATE TABLE user (id BIGINT AUTO_INCREMENT, name VARCHAR(20), PRIMARY KEY(id), INDEX(id));
|
||||
CREATE TABLE phonenumber (id INT AUTO_INCREMENT, phonenumber VARCHAR(20), user_id BIGINT, PRIMARY KEY(id), INDEX(user_id));
|
||||
ALTER TABLE phonenumber ADD CONSTRAINT FOREIGN KEY (user_id) REFERENCES user(id) ON DELETE CASCADE;
|
||||
</code>
|
||||
|
||||
Pay attention to the following things:
|
||||
|
||||
# The autoincrement primary key columns are auto-added since we didn't specify any primary key columns
|
||||
# Doctrine auto-adds indexes to the referenced relation columns (this is needed in mysql)
|
||||
|
||||
+++ Getting export queries
|
||||
|
||||
There might be situations where you don't want to execute the export queries immediately rather you want to get the query strings and maybe attach them to a build.sql file. This can be easily achieved as follows:
|
||||
|
||||
<code type="php">
|
||||
require_once('path-to-doctrine/lib/Doctrine.php');
|
||||
|
||||
spl_autoload_register(array('Doctrine', 'autoload'));
|
||||
|
||||
$manager = Doctrine_Manager::getInstance();
|
||||
$conn = $manager->openConnection('pgsql://user:pass@localhost/test');
|
||||
|
||||
$queries = Doctrine::generateSqlFromModels('models');
|
||||
|
||||
echo $queries;
|
||||
</code>
|
||||
|
||||
Consider the same situation and you want to get the string of sql queries needed to perform the exporting. It can be achieved with Doctrine::generateSqlFromModels().
|
||||
|
||||
+++ Export options
|
||||
|
||||
<code type="php">
|
||||
// export everything, table definitions and constraints
|
||||
|
||||
$manager->setAttribute(Doctrine::ATTR_EXPORT, Doctrine::EXPORT_ALL);
|
||||
|
||||
// export classes without constraints
|
||||
|
||||
$manager->setAttribute(Doctrine::ATTR_EXPORT, Doctrine::EXPORT_TABLES ^
|
||||
Doctrine::EXPORT_CONSTRAINTS);
|
||||
|
||||
// turn off exporting
|
||||
|
||||
$manager->setAttribute(Doctrine::ATTR_EXPORT, Doctrine::EXPORT_NONE);
|
||||
|
||||
$sql = Doctrine::generateSqlFromModels();
|
||||
</code>
|
||||
|
||||
101
manual/docs/en/getting-started/exporting-classes.txt
Normal file
101
manual/docs/en/getting-started/exporting-classes.txt
Normal file
@ -0,0 +1,101 @@
|
||||
+++ Introduction
|
||||
|
||||
Doctrine supports exporting record classes into database. This means that based on the definitions given in your record definitions Doctrine will alter your database schema.
|
||||
|
||||
Lets say we have a classes called User and Phonenumber with the following definitions:
|
||||
|
||||
<code type="php">
|
||||
// file User.php
|
||||
class User extends Doctrine_Record
|
||||
{
|
||||
public function setTableDefinition()
|
||||
{
|
||||
$this->hasColumn('name', 'string', 20);
|
||||
}
|
||||
public function setUp()
|
||||
{
|
||||
$this->hasMany('Phonenumber', array('local' => 'id',
|
||||
'foreign' => 'user_id'));
|
||||
}
|
||||
}
|
||||
// file Phonenumber.php
|
||||
class Phonenumber extends Doctrine_Record
|
||||
{
|
||||
public function setTableDefinition()
|
||||
{
|
||||
$this->hasColumn('phonenumber', 'string', 20);
|
||||
$this->hasColumn('user_id', 'integer');
|
||||
}
|
||||
public function setUp()
|
||||
{
|
||||
$this->hasOne('User', array('local' => 'user_id',
|
||||
'foreign' => 'id',
|
||||
'onDelete' => 'CASCADE'));
|
||||
}
|
||||
}
|
||||
</code>
|
||||
|
||||
Now lets say these classes are in directory 'models/'. We can make Doctrine to iterate through this directory and attach these classes into your database structure with the following script:
|
||||
|
||||
<code type="php">
|
||||
|
||||
require_once('path-to-doctrine/lib/Doctrine.php');
|
||||
|
||||
spl_autoload_register(array('Doctrine', 'autoload'));
|
||||
|
||||
//in order to export we need a database connection
|
||||
Doctrine_Manager::connection('mysql://user:pass@localhost/test');
|
||||
|
||||
Doctrine::createTablesFromModels('models');
|
||||
</code>
|
||||
|
||||
This would execute the following queries on mysql.
|
||||
|
||||
<code type="sql">
|
||||
CREATE TABLE user (id BIGINT AUTO_INCREMENT, name VARCHAR(20), PRIMARY KEY(id), INDEX(id));
|
||||
CREATE TABLE phonenumber (id INT AUTO_INCREMENT, phonenumber VARCHAR(20), user_id BIGINT, PRIMARY KEY(id), INDEX(user_id));
|
||||
ALTER TABLE phonenumber ADD CONSTRAINT FOREIGN KEY (user_id) REFERENCES user(id) ON DELETE CASCADE;
|
||||
</code>
|
||||
|
||||
Pay attention to the following things:
|
||||
|
||||
# The autoincrement primary key columns are auto-added since we didn't specify any primary key columns
|
||||
# Doctrine auto-adds indexes to the referenced relation columns (this is needed in mysql)
|
||||
|
||||
+++ Getting export queries
|
||||
|
||||
There might be situations where you don't want to execute the export queries immediately rather you want to get the query strings and maybe attach them to a build.sql file. This can be easily achieved as follows:
|
||||
|
||||
<code type="php">
|
||||
require_once('path-to-doctrine/lib/Doctrine.php');
|
||||
|
||||
spl_autoload_register(array('Doctrine', 'autoload'));
|
||||
|
||||
Doctrine_Manager::connection('mgsql://user:pass@localhost/test');
|
||||
|
||||
$queries = Doctrine::generateSqlFromModels('models');
|
||||
|
||||
echo $queries;
|
||||
</code>
|
||||
|
||||
Consider the same situation and you want to get the string of sql queries needed to perform the exporting. It can be achieved with Doctrine::generateSqlFromModels().
|
||||
|
||||
+++ Export options
|
||||
|
||||
<code type="php">
|
||||
// export everything, table definitions and constraints
|
||||
$manager = Doctrine_Manager::getInstance();
|
||||
|
||||
$manager->setAttribute(Doctrine::ATTR_EXPORT, Doctrine::EXPORT_ALL);
|
||||
|
||||
// export classes without constraints
|
||||
|
||||
$manager->setAttribute(Doctrine::ATTR_EXPORT, Doctrine::EXPORT_TABLES ^
|
||||
Doctrine::EXPORT_CONSTRAINTS);
|
||||
|
||||
// turn off exporting
|
||||
|
||||
$manager->setAttribute(Doctrine::ATTR_EXPORT, Doctrine::EXPORT_NONE);
|
||||
|
||||
$sql = Doctrine::generateSqlFromModels();
|
||||
</code>
|
||||
@ -13,27 +13,3 @@ If you do not have a SVN client, chose one from the list below. Find the **Check
|
||||
* [http://tortoisesvn.tigris.org/ TortoiseSVN] a Windows application that integrates into Windows Explorer
|
||||
* [http://www.apple.com/downloads/macosx/development_tools/svnx.html svnx] a Mac OS X GUI svn application
|
||||
* Eclipse has SVN integration through the [http://subclipse.tigris.org/ subeclipse] plugin
|
||||
|
||||
+++ Include and autoload
|
||||
|
||||
In order to use Doctrine in your project it must first be included.
|
||||
|
||||
<code type="php">
|
||||
require_once('path-to-doctrine/lib/Doctrine.php');
|
||||
</code>
|
||||
|
||||
Doctrine support [http://www.php.net/autoload Autoloading] for including files so that you do not have to include anything more then the base file. There are two different strategies that can be used to do this:
|
||||
|
||||
If you do use the **__autoload** function for your own logic you can use it.
|
||||
|
||||
<code type="php">
|
||||
function __autoload($class) {
|
||||
Doctrine::autoload($class);
|
||||
}
|
||||
</code>
|
||||
|
||||
If your project uses autoload and/or you have other libraries that use it you could use [http://www.php.net/manual/en/function.spl-autoload-register.php spl_autoload_register] to register more then one autoloading function.
|
||||
|
||||
<code type="php">
|
||||
spl_autoload_register(array('Doctrine', 'autoload'));
|
||||
</code>
|
||||
|
||||
@ -24,14 +24,18 @@ class User extends Doctrine_Record
|
||||
For exporting the user class into database we need a simple build script:
|
||||
|
||||
<code type="php">
|
||||
//require the base Doctrine class
|
||||
require_once('lib/Doctrine.php');
|
||||
require_once('User.php');
|
||||
|
||||
//register the autoloader
|
||||
spl_autoload_register(array('Doctrine', 'autoload'));
|
||||
|
||||
$conn = Doctrine_Manager::connection('pgsql://user:pass@localhost/test');
|
||||
require_once('User.php');
|
||||
|
||||
$conn->export->exportClasses(array('User'));
|
||||
//set up a connection
|
||||
Doctrine_Manager::connection('mysql://user:pass@localhost/test');
|
||||
|
||||
//export the classes
|
||||
Doctrine::createTablesFromArray(array('User'));
|
||||
</code>
|
||||
|
||||
We now have a user model that supports basic CRUD opperations!
|
||||
|
||||
@ -28,11 +28,11 @@ Now we would like to convert it into Doctrine record class. It can be achieved e
|
||||
require_once('lib/Doctrine.php');
|
||||
|
||||
spl_autoload_register(array('Doctrine', 'autoload'));
|
||||
$conn = Doctrine_Manager::connection('mysql://root:dc34@localhost/test');
|
||||
Doctrine_Manager::connection('mysql://root:dc34@localhost/test');
|
||||
|
||||
// import method takes one parameter: the import directory (the directory where
|
||||
// the generated record files will be put in
|
||||
$conn->import->importSchema('myrecords');
|
||||
Doctrine::generateModelsFromDb('myrecords');
|
||||
</code>
|
||||
|
||||
That's it! Now there should be a file called File.php in your myrecords directory. The file should look like:
|
||||
|
||||
@ -1,4 +1,5 @@
|
||||
++ Introduction
|
||||
++ Compile
|
||||
++ Fetch only what you need
|
||||
++ Bundle your class files
|
||||
++ Use a bytecode cache
|
||||
|
||||
11
manual/docs/en/improving-performance/compile.txt
Normal file
11
manual/docs/en/improving-performance/compile.txt
Normal file
@ -0,0 +1,11 @@
|
||||
Doctrine is quite big framework and usually dozens of files are being included on each request. This brings a lot of overhead. In fact these file operations are as time consuming as sending multiple queries to database server. The clean separation of class per file works well in developing environment, however when project goes commercial distribution the speed overcomes the clean separation of class per file -convention.
|
||||
|
||||
Doctrine offers method called {{compile()}} to solve this issue. The compile method makes a single file of most used Doctrine components which can then be included on top of your script. By default the file is created into Doctrine root by the name {{Doctrine.compiled.php}}.
|
||||
|
||||
Compiling is a method for making a single file of most used doctrine runtime components including the compiled file instead of multiple files (in worst cases dozens of files) can improve performance by an order of magnitude. In cases where this might fail, a {{Doctrine_Exception}} is throw detailing the error.
|
||||
|
||||
<code type="php">
|
||||
Doctrine::compile();
|
||||
// on some other script:
|
||||
require_once('path_to_doctrine/Doctrine.compiled.php');
|
||||
</code>
|
||||
Loading…
Reference in New Issue
Block a user