aviat
/
Query
1
1
Fork 0
Code Issues 1 Pull Requests Releases 2 Activity

Update README

This commit is contained in:
Timothy Warren 2016-02-01 20:53:54 -05:00
parent 4814f5f787
commit 7c48eecb1a
1 changed files with 59 additions and 44 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

103
README.md
View File

@ -31,26 +31,28 @@ To include Query in your PHP project, just include the `autoload.php` file. This
Create a connection array or object similar to this: Create a connection array or object similar to this:
<?php ```php
<?php
$params = array( $params = array(
'type' => 'mysql', 'type' => 'mysql',
'host' => 'localhost', 'host' => 'localhost',
'user' => 'root', 'user' => 'root',
'pass' => '', 'pass' => '',
'port' => '3306', 'port' => '3306',
'database' => 'test_db', 'database' => 'test_db',
// Only required // Only required
// SQLite or Firebird // SQLite or Firebird
'file' => '/path/to/db/file', 'file' => '/path/to/db/file',
// Optional paramaters // Optional paramaters
'prefix' => 'tbl_', // Database table prefix 'prefix' => 'tbl_', // Database table prefix
'alias' => 'old' // Connection name for the Query function 'alias' => 'old' // Connection name for the Query function
); );
$db = Query($params); $db = Query($params);
```
The parameters required depend on the database. The parameters required depend on the database.
@ -58,19 +60,25 @@ The parameters required depend on the database.
You can use the `Query()` function as a reference to the last connected database. E.g. You can use the `Query()` function as a reference to the last connected database. E.g.
Query()->get('table_name'); ```php
Query()->get('table_name');
```
or or
$result = Query()->query($sql); ```php
$result = Query()->query($sql);
```
If the `alias` key is set in the parameters, you can refer to a specific database connection If the `alias` key is set in the parameters, you can refer to a specific database connection
// Set the alias in the connection parameters ```php
$params['alias'] = 'old'; // Set the alias in the connection parameters
$params['alias'] = 'old';
// Connect to the legacy database // Connect to the legacy database
Query('old')->query($sql); Query('old')->query($sql);
```
### Running Queries ### Running Queries
Query uses the same interface as CodeIgniter's [Active Record class](http://ellislab.com/codeigniter/user-guide/database/active_record.html). However, it does not implement the `update_batch` or caching methods. Query uses the same interface as CodeIgniter's [Active Record class](http://ellislab.com/codeigniter/user-guide/database/active_record.html). However, it does not implement the `update_batch` or caching methods.
@ -86,22 +94,26 @@ To run a plain query, `$db->query($sql)`
An example of a moderately complex query: An example of a moderately complex query:
$query = $db->select('id, key as k, val') ```php
->from('table t') $query = $db->select('id, key as k, val')
->where('k >', 3) ->from('table t')
->or_where('id !=' 5) ->where('k >', 3)
->order_by('val', 'DESC') ->or_where('id !=' 5)
->limit(3, 1) ->order_by('val', 'DESC')
->get(); ->limit(3, 1)
->get();
```
This will generate a query similar to (with this being the output for a Postgres database): This will generate a query similar to (with this being the output for a Postgres database):
SELECT "id", "key" AS "k", "val" ```sql
FROM "table" "t" SELECT "id", "key" AS "k", "val"
WHERE "k" > ? FROM "table" "t"
OR "id" != ? WHERE "k" > ?
ORDER BY "val" DESC OR "id" != ?
LIMIT 3 OFFSET 1 ORDER BY "val" DESC
LIMIT 3 OFFSET 1
```
To retreive the results of a query, use the PDO method [fetch](http://php.net/manual/en/pdostatement.fetch.php) and/or [fetchAll](http://php.net/manual/en/pdostatement.fetchall.php). To retreive the results of a query, use the PDO method [fetch](http://php.net/manual/en/pdostatement.fetch.php) and/or [fetchAll](http://php.net/manual/en/pdostatement.fetchall.php).
@ -114,18 +126,21 @@ To retreive the results of a query, use the PDO method [fetch](http://php.net/ma
### Inserting / Updating ### Inserting / Updating
An example of an insert query: An example of an insert query:
```php
$query = $db->set('foo', 'bar') $query = $db->set('foo', 'bar')
->set('foobar', 'baz') ->set('foobar', 'baz')
->where('foo !=', 'bar') ->where('foo !=', 'bar')
->insert('table'); ->insert('table');
```
An example of an update query: An example of an update query:
$query = $db->set('foo', 'bar') ```php
->set('foobar', 'baz') $query = $db->set('foo', 'bar')
->where('foo !=', 'bar') ->set('foobar', 'baz')
->update('table'); ->where('foo !=', 'bar')
->update('table');
```
The `set` method can also take an array as a paramater, instead of setting individual values. The `set` method can also take an array as a paramater, instead of setting individual values.