A Query Builder and Database abstraction layer
Go to file
Timothy Warren bf6d7bcbd1 Merge pull request #1 from BlindGenius/master
Fixed Parser crash when column identifier contained 'as'
2012-09-25 04:33:58 -07:00
classes Fixed AS issue when field names contain 'as' e.g. taskid 2012-09-25 12:52:28 +08:00
docs Updated generated docs 2012-09-13 15:45:27 +00:00
drivers Make mysql/postgres drivers compatible with Quercus 2012-07-05 14:19:49 -04:00
tests Update readme and added 'get_compiled_' methods to query builder 2012-09-13 15:44:57 +00:00
.gitignore Rearrange tests, add Settings class tests 2012-04-13 13:48:38 -04:00
.php_cs Add composer.json file 2012-07-17 14:45:52 -04:00
.travis.yml Multiple php version tests? 2012-03-23 09:34:29 -04:00
README.md Update readme and added 'get_compiled_' methods to query builder 2012-09-13 15:44:57 +00:00
autoload.php Fixed issue with multiple fields in order_by, removed extranious spaces in SQL generation 2012-08-23 01:17:27 +00:00
composer.json Beginning of query parser 2012-08-02 15:59:11 +00:00
phpdoc.dist.xml Simplifiy select_ methods 2012-04-30 15:29:45 -04:00

README.md

Query

A query builder/abstraction layer, using prepared queries for security.

Build Status

Requirements

  • Pdo extensions for the databases you wish to use (unless it's Firebird, in which case, the interbase extension is required)
  • PHP 5.2+

Databases Supported

  • Firebird (via interbase extension)
  • MySQL
  • PostgreSQL
  • SQLite
  • Others, via ODBC

Including Query in your application

To include Query in your PHP project, just include the autoload.php file. This will automatically load the classes that are supported by the current PHP installation.

Connecting

Create a connection array or object similar to this:

<?php

$params = array(
	'type' => 'mysql',
	'host' => 'localhost',
	'user' => 'root',
	'pass' => '',
	'port' => '3306',
	'database' => 'test_db',
	
	// Only required
	// SQLite or Firebird
	'file' => '/path/to/db/file',
);

$db = new Query_Builder($params);

The parameters required depend on the database.

Running Queries

Query uses the same interface as CodeIgniter's Active Record class. However, it does not implement the insert_batch, update_batch or caching methods.

####You can also run queries manually.

To run a prepared statement, call $db->prepare_execute($sql, $params).

To run a plain query, $db->query($sql)

Retrieving Results:

An example of a moderately complex query:

$query = $db->select('id, key as k, val')
	->from('table t')
	->where('k >', 3)
	->or_where('id !=' 5)
	->order_by('val', 'DESC')
	->limit(3, 1)
	->get();

This will generate a query similar to (with this being the output for a Postgres database):

SELECT "id", "key" AS "k", "val"
FROM "table" "t"
WHERE "k" > ?
OR "id" != ?
ORDER BY "val" DESC
LIMIT 3 OFFSET 1

To retreive the results of a query, use the PDO method fetch and/or fetchAll.

$query = $db->get('table_name');

$results = $query->fetchAll(PDO::FETCH_ASSOC);