From cbdb0f9792daa96f2c1fab3ac093b4d74d1a999b Mon Sep 17 00:00:00 2001
From: zYne <zYne@625475ce-881a-0410-a577-b389adb331d8>
Date: Thu, 14 Jun 2007 14:27:19 +0000
Subject: [PATCH] raw sql docs

---
 manual/new/docs/en/native-sql.txt | 94 ++++++++++++++++++++++++++++++-
 1 file changed, 92 insertions(+), 2 deletions(-)

diff --git a/manual/new/docs/en/native-sql.txt b/manual/new/docs/en/native-sql.txt
index a7bb4720e..67aebb114 100644
--- a/manual/new/docs/en/native-sql.txt
+++ b/manual/new/docs/en/native-sql.txt
@@ -1,3 +1,93 @@
-++ Scalar queries
+++ Introduction
+
+Doctrine_RawSql provides convient interface for building raw sql queries. Similar to Doctrine_Query, Doctrine_RawSql provides means for fetching arrays and objects, the way you prefer.
+
+Using raw sql for fetching might be useful when you want to utilize database specific features such as query hints or the CONNECT keyword in Oracle.
+
+Creating Doctrine_RawSql object is easy:
+
+<code type='php'>
+$q = new Doctrine_RawSql();
+</code>
+
+Optionally a connection parameter can be given:
+
+<code type='php'>
+$q = new Doctrine_RawSql($conn); // here $conn is an instance of Doctrine_Connection
+</code>
+
 ++ Component queries
-++ Fetching multiple components
+
+The first thing to notice when using Doctrine_RawSql is that you always have to place the fields you are selecting in curly brackets {}. Also for every selected component you have to call addComponent().
+
+The following example should clarify the usage of these:
+
+<code type='php'>
+$q = new Doctrine_RawSql();
+
+$q->select('{u.*}')
+  ->from('user')
+  ->addComponent('user', 'User'); // here we tell that user table is bound to class called 'User'
+
+$users = $q->execute();
+$user[0]; // User object
+</code>
+
+Pay attention to following things:
+1. Fields must be in curly brackets
+2. For every selected table there must be one addComponent call
+
+++ Fetching from multiple components
+
+When fetching from multiple components the addComponent calls become a bit more complicated as not only do we have to tell which tables are bound to which components, we also have to tell the parser which components belongs to which.
+
+Consider the following model:
+<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>
+
+In the following example we fetch all users and their phonenumbers:
+<code type='php'>
+$q = new Doctrine_RawSql();
+
+$q->select('{u.*}, {p.*}')
+  ->from('user u LEFT JOIN phonenumber p ON u.id = p.user_id')
+  // here we tell that user table is bound to class called 'User'
+  // we also add an alias for User class called 'u'
+  // this alias will be used when referencing to User class
+  ->addComponent('u', 'User u');
+  // here we add another component that is bound to table phonenumber
+  // notice how we reference that the Phonenumber class is "User's phonenumber"
+  ->addComponent('p', 'u.Phonenumber p');
+
+
+$users = $q->execute();
+$user[0]; // User object
+</code>