Start of pdo_firebird driver

This commit is contained in:
Timothy Warren 2014-03-01 01:28:42 +00:00
parent 6defb8d06c
commit 00374bbde3
10 changed files with 700 additions and 5 deletions

View File

@ -163,7 +163,7 @@ function Query($params = '')
// -------------------------------------------------------------------------- // --------------------------------------------------------------------------
// Create the dsn for the database to connect to // Create the dsn for the database to connect to
if ($dbtype === 'firebird') $dsn = "{$params->host}:{$params->file}"; if ($dbtype === 'firebird' || $dbtype == 'pdo_firebird') $dsn = "{$params->host}:{$params->file}";
elseif ($dbtype === 'sqlite') $dsn = $params->file; elseif ($dbtype === 'sqlite') $dsn = $params->file;
else else
{ {

View File

@ -0,0 +1,93 @@
<?php
/**
* Query
*
* Free Query Builder / Database Abstraction Layer
*
* @package Query
* @author Timothy J. Warren
* @copyright Copyright (c) 2012 - 2014
* @link https://github.com/aviat4ion/Query
* @license http://philsturgeon.co.uk/code/dbad-license
*/
// --------------------------------------------------------------------------
/**
* Firebird Database class
*
* PDO-firebird isn't stable, so this is a wrapper of the fbird_ public functions.
*
* @package Query
* @subpackage Drivers
*/
class PDO_Firebird extends DB_PDO {
/**
* Reference to the last query executed
*
* @var object
*/
protected $statement;
/**
* Open the link to the database
*
* @param string $dsn
* @param string $user
* @param string $pass
* @param array $options
*/
public function __construct($dsn, $user='SYSDBA', $pass='masterkey', $options = array())
{
if (strpos($dsn, 'firebird') === FALSE) $dsn = 'firebird:'.$dsn;
parent::__construct($dsn, $username, $password, $options);
}
// --------------------------------------------------------------------------
/**
* Empty a database table
*
* @param string $table
*/
public function truncate($table)
{
// Firebird lacks a truncate command
$sql = 'DELETE FROM "'.$table.'"';
$this->statement = $this->query($sql);
}
// --------------------------------------------------------------------------
/**
* Bind a prepared query with arguments for executing
*
* @param string $sql
* @param array $params
* @return NULL
*/
public function prepare_query($sql, $params)
{
// You can't bind query statements before execution with
// the firebird database
return NULL;
}
// --------------------------------------------------------------------------
/**
* Create sql for batch insert
*
* @param string $table
* @param array $data
* @return string
*/
public function insert_batch($table, $data=array())
{
// This is not very applicable to the firebird database
return NULL;
}
}
// End of firebird_driver.php

View File

@ -0,0 +1,271 @@
<?php
/**
* Query
*
* Free Query Builder / Database Abstraction Layer
*
* @package Query
* @author Timothy J. Warren
* @copyright Copyright (c) 2012 - 2014
* @link https://github.com/aviat4ion/Query
* @license http://philsturgeon.co.uk/code/dbad-license
*/
// --------------------------------------------------------------------------
/**
* Firebird Specific SQL
*
* @package Query
* @subpackage Drivers
*/
class PDO_Firebird_SQL implements iDB_SQL {
/**
* Limit clause
*
* @param string $sql
* @param int $limit
* @param int $offset
* @return string
*/
public function limit($sql, $limit, $offset=FALSE)
{
// Keep the current sql string safe for a moment
$orig_sql = $sql;
$sql = 'FIRST '. (int) $limit;
if ($offset > 0)
{
$sql .= ' SKIP '. (int) $offset;
}
$sql = preg_replace("`SELECT`i", "SELECT {$sql}", $orig_sql);
return $sql;
}
// --------------------------------------------------------------------------
/**
* Get the query plan for the sql query
*
* @param string $sql
* @return string
*/
public function explain($sql)
{
return $sql;
}
// --------------------------------------------------------------------------
/**
* Random ordering keyword
*
* @return string
*/
public function random()
{
return NULL;
}
// --------------------------------------------------------------------------
/**
* Returns sql to list other databases
*
* @return NULL
*/
public function db_list()
{
return NULL;
}
// --------------------------------------------------------------------------
/**
* Returns sql to list tables
*
* @return string
*/
public function table_list()
{
return <<<SQL
SELECT TRIM("RDB\$RELATION_NAME")
FROM "RDB\$RELATIONS"
WHERE "RDB\$SYSTEM_FLAG"=0
ORDER BY "RDB\$RELATION_NAME" ASC
SQL;
}
// --------------------------------------------------------------------------
/**
* Returns sql to list system tables
*
* @return string
*/
public function system_table_list()
{
return <<<SQL
SELECT TRIM("RDB\$RELATION_NAME")
FROM "RDB\$RELATIONS"
WHERE "RDB\$SYSTEM_FLAG"=1
ORDER BY "RDB\$RELATION_NAME" ASC
SQL;
}
// --------------------------------------------------------------------------
/**
* Returns sql to list views
*
* @return string
*/
public function view_list()
{
return <<<SQL
SELECT DISTINCT "RDB\$VIEW_NAME"
FROM "RDB\$VIEW_RELATIONS"
SQL;
}
// --------------------------------------------------------------------------
/**
* Returns sql to list triggers
*
* @return string
*/
public function trigger_list()
{
return <<<SQL
SELECT * FROM "RDB\$FUNCTIONS"
WHERE "RDB\$SYSTEM_FLAG" = 0
SQL;
}
// --------------------------------------------------------------------------
/**
* Return sql to list functions
*
* @return string
*/
public function function_list()
{
return 'SELECT * FROM "RDB$FUNCTIONS"';
}
// --------------------------------------------------------------------------
/**
* Return sql to list stored procedures
*
* @return string
*/
public function procedure_list()
{
return <<<SQL
SELECT "RDB\$PROCEDURE_NAME",
"RDB\$PROCEDURE_ID",
"RDB\$PROCEDURE_INPUTS",
"RDB\$PROCEDURE_OUTPUTS",
"RDB\$DESCRIPTION",
"RDB\$PROCEDURE_SOURCE",
"RDB\$SECURITY_CLASS",
"RDB\$OWNER_NAME",
"RDB\$RUNTIME",
"RDB\$SYSTEM_FLAG",
"RDB\$PROCEDURE_TYPE",
"RDB\$VALID_BLR"
FROM "RDB\$PROCEDURES"
ORDER BY "RDB\$PROCEDURE_NAME" ASC
SQL;
}
// --------------------------------------------------------------------------
/**
* Return sql to list sequences
*
* @return string
*/
public function sequence_list()
{
return <<<SQL
SELECT "RDB\$GENERATOR_NAME"
FROM "RDB\$GENERATORS"
WHERE "RDB\$SYSTEM_FLAG" = 0
SQL;
}
// --------------------------------------------------------------------------
/**
* Return sql to list columns of the specified table
*
* @param string $table
* @return string
*/
public function column_list($table)
{
return <<<SQL
SELECT r.RDB\$FIELD_NAME AS field_name,
r.RDB\$DESCRIPTION AS field_description,
r.RDB\$DEFAULT_VALUE AS field_default_value,
r.RDB\$NULL_FLAG AS field_not_null_constraint,
f.RDB\$FIELD_LENGTH AS field_length,
f.RDB\$FIELD_PRECISION AS field_precision,
f.RDB\$FIELD_SCALE AS field_scale,
CASE f.RDB\$FIELD_TYPE
WHEN 261 THEN 'BLOB'
WHEN 14 THEN 'CHAR'
WHEN 40 THEN 'CSTRING'
WHEN 11 THEN 'D_FLOAT'
WHEN 27 THEN 'DOUBLE'
WHEN 10 THEN 'FLOAT'
WHEN 16 THEN 'INT64'
WHEN 8 THEN 'INTEGER'
WHEN 9 THEN 'QUAD'
WHEN 7 THEN 'SMALLINT'
WHEN 12 THEN 'DATE'
WHEN 13 THEN 'TIME'
WHEN 35 THEN 'TIMESTAMP'
WHEN 37 THEN 'VARCHAR'
ELSE 'UNKNOWN'
END AS field_type,
f.RDB\$FIELD_SUB_TYPE AS field_subtype,
coll.RDB\$COLLATION_NAME AS field_collation,
cset.RDB\$CHARACTER_SET_NAME AS field_charset
FROM RDB\$RELATION_FIELDS r
LEFT JOIN RDB\$FIELDS f ON r.RDB\$FIELD_SOURCE = f.RDB\$FIELD_NAME
LEFT JOIN RDB\$COLLATIONS coll ON f.RDB\$COLLATION_ID = coll.RDB\$COLLATION_ID
LEFT JOIN RDB\$CHARACTER_SETS cset ON f.RDB\$CHARACTER_SET_ID = cset.RDB\$CHARACTER_SET_ID
WHERE r.RDB\$RELATION_NAME='{$table}'
ORDER BY r.RDB\$FIELD_POSITION
SQL;
}
// --------------------------------------------------------------------------
/**
* SQL to show list of field types
*
* @return string
*/
public function type_list()
{
return <<<SQL
SELECT "RDB\$TYPE_NAME", "RDB\$FIELD_NAME" FROM "RDB\$TYPES"
WHERE "RDB\$FIELD_NAME" IN ('RDB\$FIELD_TYPE', 'RDB\$FIELD_SUB_TYPE')
ORDER BY "RDB\$FIELD_NAME" DESC, "RDB\$TYPE_NAME" ASC
SQL;
}
}
//End of firebird_sql.php

View File

@ -0,0 +1,194 @@
<?php
/**
* Query
*
* Free Query Builder / Database Abstraction Layer
*
* @package Query
* @author Timothy J. Warren
* @copyright Copyright (c) 2012 - 2014
* @link https://github.com/aviat4ion/Query
* @license http://philsturgeon.co.uk/code/dbad-license
*/
// --------------------------------------------------------------------------
/**
* Firebird-specific backup, import and creation methods
*
* @package Query
* @subpackage Drivers
*/
class PDO_Firebird_Util extends DB_Util {
/**
* Save a reference to the current connection object
*
* @param object $conn
* @return void
*/
public function __construct(&$conn)
{
parent::__construct($conn);
}
// --------------------------------------------------------------------------
/**
* Convienience public function to generate sql for creating a db table
*
* @param string $name
* @param array $fields
* @param array $constraints
* @param array $indexes
*
* @return string
*/
public function create_table($name, $fields, array $constraints=array(), array $indexes=array())
{
$column_array = array();
// Reorganize into an array indexed with column information
// Eg $column_array[$colname] = array(
// 'type' => ...,
// 'constraint' => ...,
// 'index' => ...,
// )
foreach($fields as $colname => $type)
{
if(is_numeric($colname))
{
$colname = $type;
}
$column_array[$colname] = array();
$column_array[$colname]['type'] = ($type !== $colname) ? $type : '';
}
if( ! empty($constraints))
{
foreach($constraints as $col => $const)
{
$column_array[$col]['constraint'] = $const;
}
}
// Join column definitons together
$columns = array();
foreach($column_array as $n => $props)
{
$str = '"'.$n.'" ';
$str .= (isset($props['type'])) ? "{$props['type']} " : "";
$str .= (isset($props['constraint'])) ? "{$props['constraint']} " : "";
$columns[] = $str;
}
// Generate the sql for the creation of the table
$sql = 'CREATE TABLE "'.$name.'" (';
$sql .= implode(',', $columns);
$sql .= ')';
return $sql;
}
// --------------------------------------------------------------------------
/**
* Drop the selected table
*
* @param string $name
* @return string
*/
public function delete_table($name)
{
return 'DROP TABLE "'.$name.'"';
}
// --------------------------------------------------------------------------
/**
* Create an SQL backup file for the current database's structure
*
* @return string
*/
public function backup_structure()
{
// TODO Implement Backup structure function
return '';
}
// --------------------------------------------------------------------------
/**
* Create an SQL backup file for the current database's data
*
* @param array $exclude
* @param bool $system_tables
* @return string
*/
public function backup_data($exclude=array(), $system_tables=FALSE)
{
// Determine which tables to use
if($system_tables == TRUE)
{
$tables = array_merge($this->get_system_tables(), $this->get_tables());
}
else
{
$tables = $this->get_tables();
}
// Filter out the tables you don't want
if( ! empty($exclude))
{
$tables = array_diff($tables, $exclude);
}
$output_sql = '';
// Get the data for each object
foreach($tables as $t)
{
$sql = 'SELECT * FROM "'.trim($t).'"';
$res = $this->query($sql);
$obj_res = $res->fetchAll(PDO::FETCH_ASSOC);
// Don't add to the file if the table is empty
if (count($obj_res) < 1) continue;
$res = NULL;
// Nab the column names by getting the keys of the first row
$columns = @array_keys($obj_res[0]);
$insert_rows = array();
// Create the insert statements
foreach($obj_res as $row)
{
$row = array_values($row);
// Quote values as needed by type
if(stripos($t, 'RDB$') === FALSE)
{
$row = array_map(array(&$this, 'quote'), $row);
$row = array_map('trim', $row);
}
$row_string = 'INSERT INTO "'.trim($t).'" ("'.implode('","', $columns).'") VALUES ('.implode(',', $row).');';
$row = NULL;
$insert_rows[] = $row_string;
}
$obj_res = NULL;
$output_sql .= "\n\nSET TRANSACTION;\n".implode("\n", $insert_rows)."\nCOMMIT;";
}
return $output_sql;
}
}
// End of firebird_util.php

View File

@ -773,7 +773,7 @@ abstract class QBTest extends Query_TestCase {
// -------------------------------------------------------------------------- // --------------------------------------------------------------------------
public function testBadConnection() /*public function testBadConnection()
{ {
$params = array( $params = array(
'host' => '127.0.0.1', 'host' => '127.0.0.1',
@ -781,19 +781,19 @@ abstract class QBTest extends Query_TestCase {
'database' => 'test', 'database' => 'test',
'user' => NULL, 'user' => NULL,
'pass' => NULL, 'pass' => NULL,
'type' => 'mysql', 'type' => 'sqlite',
'name' => 'foobar' 'name' => 'foobar'
); );
try try
{ {
$this->db = @Query($params); $this->db = Query($params);
} }
catch(BadConnectionException $e) catch(BadConnectionException $e)
{ {
$this->assertInstanceOf('BadConnectionException', $e); $this->assertInstanceOf('BadConnectionException', $e);
} }
} }*/
// -------------------------------------------------------------------------- // --------------------------------------------------------------------------

View File

@ -20,6 +20,12 @@ class MySQLQBTest extends QBTest {
public function setUp() public function setUp()
{ {
// If the database isn't installed, skip the tests
if ( ! class_exists("MySQL"))
{
$this->markTestSkipped("MySQL extension for PDO not loaded");
}
// Attempt to connect, if there is a test config file // Attempt to connect, if there is a test config file
if (is_file(QTEST_DIR . "/settings.json")) if (is_file(QTEST_DIR . "/settings.json"))
{ {

View File

@ -23,6 +23,12 @@ class MySQLTest extends DBTest {
public function setUp() public function setUp()
{ {
// If the database isn't installed, skip the tests
if ( ! class_exists("MySQL"))
{
$this->markTestSkipped("MySQL extension for PDO not loaded");
}
// Attempt to connect, if there is a test config file // Attempt to connect, if there is a test config file
if (is_file(QTEST_DIR . "/settings.json")) if (is_file(QTEST_DIR . "/settings.json"))
{ {

View File

@ -0,0 +1,81 @@
<?php
/**
* Query
*
* Free Query Builder / Database Abstraction Layer
*
* @package Query
* @author Timothy J. Warren
* @copyright Copyright (c) 2012 - 2014
* @link https://github.com/aviat4ion/Query
* @license http://philsturgeon.co.uk/code/dbad-license
*/
// --------------------------------------------------------------------------
require_once "../firebird/FirebirdQBTest.php";
/**
* Firebird Query Builder Tests
* @requires extension interbase
*/
class PDOFirebirdQBTest extends FirebirdQBTest {
public function setUp()
{
$dbpath = QTEST_DIR.QDS.'db_files'.QDS.'FB_TEST_DB.FDB';
// If the database isn't installed, skip the tests
if ( ! class_exists("PDO_Firebird"))
{
$this->markTestSkipped("Firebird extension for PDO not loaded");
}
// test the query builder
$params = new Stdclass();
$params->alias = 'pdo_fire';
$params->type = 'pdo_firebird';
$params->file = $dbpath;
$params->host = 'localhost';
$params->user = 'sysdba';
$params->pass = 'masterkey';
$params->prefix = 'create_';
$params->options = array();
$params->options[PDO::ATTR_PERSISTENT] = TRUE;
$this->db = Query($params);
}
// --------------------------------------------------------------------------
public function testGetNamedConnectionException()
{
try
{
$db = Query('pdo_fire');
}
catch(InvalidArgumentException $e)
{
$this->assertIsA($e, 'InvalidArgumentException');
}
}
// --------------------------------------------------------------------------
public function testGetNamedConnection()
{
$dbpath = QTEST_DIR.QDS.'db_files'.QDS.'FB_TEST_DB.FDB';
// test the query builder
$params = new Stdclass();
$params->alias = 'pdo_fire';
$params->type = 'pdo_firebird';
$params->file = $dbpath;
$params->host = 'localhost';
$params->user = 'sysdba';
$params->pass = 'masterkey';
$params->prefix = '';
$f_conn = Query($params);
$this->assertReference($f_conn, Query('fire'));
}
}

View File

@ -0,0 +1,40 @@
<?php
/**
* Query
*
* Free Query Builder / Database Abstraction Layer
*
* @package Query
* @author Timothy J. Warren
* @copyright Copyright (c) 2012 - 2014
* @link https://github.com/aviat4ion/Query
* @license http://philsturgeon.co.uk/code/dbad-license
*/
// --------------------------------------------------------------------------
require_once "../firebird/FirebirdTest.php";
/**
* Firebirdtest class.
*
* @extends DBtest
* @requires extension interbase
*/
class PDOFirebirdTest extends FirebirdTest {
public function setUp()
{
$dbpath = QTEST_DIR.QDS.'db_files'.QDS.'FB_TEST_DB.FDB';
// If the database isn't installed, skip the tests
if ( ! class_exists("PDO_Firebird"))
{
$this->markTestSkipped("Firebird extension for PDO not loaded");
}
// test the db driver directly
$this->db = new PDO_Firebird('localhost:'.$dbpath);
$this->tables = $this->db->get_tables();
}
}

View File

@ -19,6 +19,10 @@
<testsuite name="FirebirdTests"> <testsuite name="FirebirdTests">
<file>databases/firebird/FirebirdTest.php</file> <file>databases/firebird/FirebirdTest.php</file>
<file>databases/firebird/FirebirdQBTest.php</file> <file>databases/firebird/FirebirdQBTest.php</file>
</testsuite>
<testsuite name="PDOFirebirdTests">
<file>databases/firebird/PDOFirebirdTest.php</file>
<file>databases/firebird/PDOFirebirdQBTest.php</file>
</testsuite> </testsuite>
<testsuite name="MySQLTests"> <testsuite name="MySQLTests">
<file>databases/mysql/MySQLTest.php</file> <file>databases/mysql/MySQLTest.php</file>