A Query Builder and Database abstraction layer
Go to file
Timothy Warren ebe1b1a647 Rearrange tests, add Settings class tests 2012-04-13 13:48:38 -04:00
classes Implement select_max, select_min, select_avg, and select_sum methods in query builder 2012-04-13 12:49:13 -04:00
drivers Added 'get_where' method to query builder 2012-04-13 11:53:11 -04:00
tests Rearrange tests, add Settings class tests 2012-04-13 13:48:38 -04:00
.gitignore Rearrange tests, add Settings class tests 2012-04-13 13:48:38 -04:00
.travis.yml Multiple php version tests? 2012-03-23 09:34:29 -04:00
README.md Implement select_max, select_min, select_avg, and select_sum methods in query builder 2012-04-13 12:49:13 -04:00
autoload.php Fix autoloader for later inclusion 2012-04-12 14:00:42 -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
  • 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 count_all_results, distinct, having, or_having, insert_batch, update_batch, or count_all methods.

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);