mirror of
https://github.com/silverstripe/silverstripe-mssql
synced 2024-10-22 08:05:53 +02:00
1178 lines
36 KiB
PHP
1178 lines
36 KiB
PHP
<?php
|
|
|
|
/**
|
|
* @package sapphire
|
|
* @subpackage model
|
|
*/
|
|
|
|
/**
|
|
* MS SQL connector class.
|
|
* @package sapphire
|
|
* @subpackage model
|
|
*/
|
|
class MSSQLDatabase extends Database {
|
|
/**
|
|
* Connection to the DBMS.
|
|
* @var resource
|
|
*/
|
|
private $dbConn;
|
|
|
|
/**
|
|
* True if we are connected to a database.
|
|
* @var boolean
|
|
*/
|
|
private $active;
|
|
|
|
/**
|
|
* The name of the database.
|
|
* @var string
|
|
*/
|
|
private $database;
|
|
|
|
/**
|
|
* Does this database have full-text index supprt
|
|
*/
|
|
protected $fullTextEnabled = false;
|
|
|
|
/**
|
|
* Connect to a MS SQL database.
|
|
* @param array $parameters An map of parameters, which should include:
|
|
* - server: The server, eg, localhost
|
|
* - username: The username to log on with
|
|
* - password: The password to log on with
|
|
* - database: The database to connect to
|
|
*/
|
|
public function __construct($parameters) {
|
|
$this->dbConn = mssql_connect($parameters['server'], $parameters['username'], $parameters['password']);
|
|
$this->active = mssql_select_db($parameters['database'], $this->dbConn);
|
|
|
|
$this->database = $parameters['database'];
|
|
|
|
if(!$this->dbConn) {
|
|
$this->databaseError("Couldn't connect to MS SQL database");
|
|
} else {
|
|
$this->active=true;
|
|
$this->database = $parameters['database'];
|
|
mssql_select_db($parameters['database'], $this->dbConn);
|
|
}
|
|
|
|
parent::__construct();
|
|
|
|
// Configure the connection
|
|
$this->query('SET QUOTED_IDENTIFIER ON');
|
|
}
|
|
|
|
/**
|
|
* This will set up the full text search capabilities.
|
|
* Theoretically, you don't need to 'enable' it every time...
|
|
*
|
|
* TODO: make this a _config.php setting
|
|
* TODO: VERY IMPORTANT: move this so it only gets called upon a dev/build action
|
|
*/
|
|
function createFullTextCatalog(){
|
|
if($this->fullTextEnabled) {
|
|
$this->query("exec sp_fulltext_database 'enable';");
|
|
$result = $this->query("SELECT name FROM sys.fulltext_catalogs WHERE name = 'ftCatalog';")->value();
|
|
if(!$result) $this->query("CREATE FULLTEXT CATALOG ftCatalog AS DEFAULT;");
|
|
}
|
|
}
|
|
/**
|
|
* Not implemented, needed for PDO
|
|
*/
|
|
public function getConnect($parameters) {
|
|
return null;
|
|
}
|
|
|
|
/**
|
|
* Returns true if this database supports collations
|
|
* @return boolean
|
|
*/
|
|
public function supportsCollations() {
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* The version of MSSQL
|
|
* @var float
|
|
*/
|
|
private $mssqlVersion;
|
|
|
|
/**
|
|
* Get the version of MSSQL.
|
|
* NOTE: not yet implemented for MSSQL, we just return 2008; the minimum supported version
|
|
* @return float
|
|
*/
|
|
public function getVersion() {
|
|
user_error("getVersion not implemented", E_USER_WARNING);
|
|
return 2008;
|
|
}
|
|
|
|
/**
|
|
* Get the database server, namely mssql.
|
|
* @return string
|
|
*/
|
|
public function getDatabaseServer() {
|
|
return "mssql";
|
|
}
|
|
|
|
public function query($sql, $errorLevel = E_USER_ERROR) {
|
|
if(isset($_REQUEST['previewwrite']) && in_array(strtolower(substr($sql,0,strpos($sql,' '))), array('insert','update','delete','replace'))) {
|
|
Debug::message("Will execute: $sql");
|
|
return;
|
|
}
|
|
|
|
if(isset($_REQUEST['showqueries'])) {
|
|
$starttime = microtime(true);
|
|
}
|
|
|
|
//echo 'sql: ' . $sql . '<br>';
|
|
//Debug::backtrace();
|
|
|
|
//$this->lastQueryRun=$sql;
|
|
|
|
$handle = mssql_query($sql, $this->dbConn);
|
|
|
|
if(isset($_REQUEST['showqueries'])) {
|
|
$endtime = round(microtime(true) - $starttime,4);
|
|
Debug::message("\n$sql\n{$endtime}ms\n", false);
|
|
}
|
|
|
|
DB::$lastQuery=$handle;
|
|
|
|
if(!$handle && $errorLevel) $this->databaseError("Couldn't run query: $sql", $errorLevel);
|
|
return new MSSQLQuery($this, $handle);
|
|
}
|
|
|
|
public function getGeneratedID($table) {
|
|
//return $this->query("SELECT @@IDENTITY FROM \"$table\"")->value();
|
|
return $this->query("SELECT IDENT_CURRENT('$table')")->value();
|
|
}
|
|
|
|
/*
|
|
* This is a handy helper function which will return the primary key for any paricular table
|
|
* In MSSQL, the primary key is often an internal identifier, NOT the standard name (ie, 'ID'),
|
|
* so we need to do a lookup for it.
|
|
*/
|
|
function getPrimaryKey($tableName){
|
|
$indexes=DB::query("EXEC sp_helpindex '$tableName';");
|
|
$primary_key='';
|
|
foreach($indexes as $this_index){
|
|
if($this_index['index_keys']=='ID'){
|
|
$primary_key=$this_index['index_name'];
|
|
break;
|
|
}
|
|
}
|
|
|
|
return $primary_key;
|
|
}
|
|
|
|
/**
|
|
* OBSOLETE: Get the ID for the next new record for the table.
|
|
*
|
|
* @var string $table The name od the table.
|
|
*
|
|
* @return int
|
|
*/
|
|
public function getNextID($table) {
|
|
user_error('getNextID is OBSOLETE (and will no longer work properly)', E_USER_WARNING);
|
|
$result = $this->query("SELECT MAX(ID)+1 FROM \"$table\"")->value();
|
|
return $result ? $result : 1;
|
|
}
|
|
|
|
public function isActive() {
|
|
return $this->active ? true : false;
|
|
}
|
|
|
|
/*
|
|
* TODO: test this, as far as I know we haven't got the create method working...
|
|
*/
|
|
public function createDatabase() {
|
|
$this->query("CREATE DATABASE $this->database");
|
|
if(mssql_select_db($this->database, $this->dbConn)) {
|
|
$this->active = true;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Drop the database that this object is currently connected to.
|
|
* Use with caution.
|
|
*/
|
|
public function dropDatabase() {
|
|
mssql_select_db('master', $this->dbConn);
|
|
$this->query("DROP DATABASE $this->database");
|
|
}
|
|
|
|
/**
|
|
* Returns the name of the currently selected database
|
|
*/
|
|
public function currentDatabase() {
|
|
return $this->database;
|
|
}
|
|
|
|
/**
|
|
* Switches to the given database.
|
|
* If the database doesn't exist, you should call createDatabase() after calling selectDatabase()
|
|
*/
|
|
public function selectDatabase($dbname) {
|
|
$this->database = $dbname;
|
|
|
|
if($this->databaseExists($this->database)) {
|
|
if(mssql_select_db($this->database, $this->dbConn)) {
|
|
$this->active = true;
|
|
}
|
|
}
|
|
|
|
$this->tableList = $this->fieldList = $this->indexList = null;
|
|
}
|
|
|
|
/**
|
|
* Returns true if the named database exists.
|
|
* @return boolean
|
|
*/
|
|
public function databaseExists($name) {
|
|
$listDBs = $this->query('SELECT NAME FROM sys.sysdatabases');
|
|
if($listDBs) {
|
|
foreach($listDBs as $listedDB) {
|
|
if($listedDB['NAME'] == $name) return true;
|
|
}
|
|
}
|
|
return false;
|
|
}
|
|
|
|
/**
|
|
* Create a new table.
|
|
* @param $tableName The name of the table
|
|
* @param $fields A map of field names to field types
|
|
* @param $indexes A map of indexes
|
|
* @param $options An map of additional options. The available keys are as follows:
|
|
* - 'MSSQLDatabase'/'MySQLDatabase'/'PostgreSQLDatabase' - database-specific options such as "engine" for MySQL.
|
|
* - 'temporary' - If true, then a temporary table will be created
|
|
* @return The table name generated. This may be different from the table name, for example with temporary tables.
|
|
*/
|
|
public function createTable($tableName, $fields = null, $indexes = null, $options = null) {
|
|
$fieldSchemas = $indexSchemas = "";
|
|
if($fields) foreach($fields as $k => $v) $fieldSchemas .= "\"$k\" $v,\n";
|
|
|
|
// Temporary tables start with "#" in MSSQL-land
|
|
if(!empty($options['temporary'])) $tableName = "#$tableName";
|
|
|
|
$this->query("CREATE TABLE \"$tableName\" (
|
|
$fieldSchemas
|
|
primary key (\"ID\")
|
|
);");
|
|
|
|
//we need to generate indexes like this: CREATE INDEX IX_vault_to_export ON vault (to_export);
|
|
//This needs to be done AFTER the table creation, so we can set up the fulltext indexes correctly
|
|
if($indexes) foreach($indexes as $k => $v) {
|
|
$indexSchemas .= $this->getIndexSqlDefinition($tableName, $k, $v) . "\n";
|
|
}
|
|
|
|
if($indexSchemas) $this->query($indexSchemas);
|
|
|
|
return $tableName;
|
|
}
|
|
|
|
/**
|
|
* Alter a table's schema.
|
|
* @param $table The name of the table to alter
|
|
* @param $newFields New fields, a map of field name => field schema
|
|
* @param $newIndexes New indexes, a map of index name => index type
|
|
* @param $alteredFields Updated fields, a map of field name => field schema
|
|
* @param $alteredIndexes Updated indexes, a map of index name => index type
|
|
*/
|
|
public function alterTable($tableName, $newFields = null, $newIndexes = null, $alteredFields = null, $alteredIndexes = null) {
|
|
$fieldSchemas = $indexSchemas = "";
|
|
|
|
$alterList = array();
|
|
if($newFields) foreach($newFields as $k => $v) $alterList[] .= "ALTER TABLE \"$tableName\" ADD \"$k\" $v";
|
|
|
|
$indexList=$this->IndexList($tableName);
|
|
|
|
if($alteredFields) {
|
|
foreach($alteredFields as $k => $v) {
|
|
|
|
$val=$this->alterTableAlterColumn($tableName, $k, $v, $indexList);
|
|
if($val!='')
|
|
$alterList[] .= $val;
|
|
}
|
|
}
|
|
|
|
//DB ABSTRACTION: we need to change the constraints to be a separate 'add' command,
|
|
$alterIndexList=Array();
|
|
if($alteredIndexes) foreach($alteredIndexes as $v) {
|
|
//TODO: I don't think that these drop index commands will work:
|
|
if($v['type']!='fulltext'){
|
|
if(is_array($v))
|
|
$alterIndexList[] = 'DROP INDEX ix_' . strtolower($tableName) . '_' . strtolower($v['value']) . ' ON ' . $tableName . ';';
|
|
else
|
|
$alterIndexList[] = 'DROP INDEX ix_' . strtolower($tableName) . '_' . strtolower(trim($v, '()')) . ' ON ' . $tableName . ';';
|
|
|
|
if(is_array($v))
|
|
$k=$v['value'];
|
|
else $k=trim($v, '()');
|
|
|
|
$alterIndexList[] = $this->getIndexSqlDefinition($tableName, $k, $v);
|
|
}
|
|
}
|
|
|
|
//Add the new indexes:
|
|
if($newIndexes) foreach($newIndexes as $k=>$v){
|
|
$alterIndexList[] = $this->getIndexSqlDefinition($tableName, $k, $v);
|
|
}
|
|
|
|
if($alterList) {
|
|
foreach($alterList as $this_alteration){
|
|
if($this_alteration!=''){
|
|
$this->query($this_alteration);
|
|
}
|
|
}
|
|
}
|
|
|
|
foreach($alterIndexList as $alteration) {
|
|
if($alteration!='') $this->query($alteration);
|
|
}
|
|
}
|
|
|
|
/*
|
|
* This is a private MSSQL-only function which returns specific details about a column's constraints (if any)
|
|
*/
|
|
private function ColumnConstraints($tableName, $columnName){
|
|
$constraint=$this->query("SELECT CC.CONSTRAINT_NAME, CAST(CHECK_CLAUSE AS TEXT) AS CHECK_CLAUSE, COLUMN_NAME FROM INFORMATION_SCHEMA.CHECK_CONSTRAINTS AS CC INNER JOIN INFORMATION_SCHEMA.CONSTRAINT_COLUMN_USAGE AS CCU ON CCU.CONSTRAINT_NAME=CC.CONSTRAINT_NAME WHERE TABLE_NAME='$tableName' AND COLUMN_NAME='" . $columnName . "';")->first();
|
|
|
|
return $constraint;
|
|
}
|
|
|
|
/*
|
|
* Get the actual enum fields from the constraint value:
|
|
*/
|
|
private function EnumValuesFromConstraint($constraint){
|
|
$segments=explode(' OR [', $constraint);
|
|
$constraints=Array();
|
|
foreach($segments as $this_segment){
|
|
$bits=explode(' = ', $this_segment);
|
|
|
|
for($i=1; $i<sizeof($bits); $i+=2)
|
|
array_unshift($constraints, substr(rtrim($bits[$i], ')'), 1, -1));
|
|
|
|
}
|
|
|
|
return $constraints;
|
|
}
|
|
|
|
/*
|
|
* Creates an ALTER expression for a column in MS SQL
|
|
*
|
|
* @param $tableName Name of the table to be altered
|
|
* @param $colName Name of the column to be altered
|
|
* @param $colSpec String which contains conditions for a column
|
|
* @return string
|
|
*/
|
|
private function alterTableAlterColumn($tableName, $colName, $colSpec, $indexList){
|
|
|
|
// First, we split the column specifications into parts
|
|
// TODO: this returns an empty array for the following string: int(11) not null auto_increment
|
|
// on second thoughts, why is an auto_increment field being passed through?
|
|
|
|
$pattern = '/^([\w()]+)\s?((?:not\s)?null)?\s?(default\s[\w\']+)?\s?(check\s?[\w()\'",\s]+)?$/i';
|
|
$matches=Array();
|
|
preg_match($pattern, $colSpec, $matches);
|
|
|
|
//if($matches[1]=='serial8')
|
|
// return '';
|
|
|
|
//drop the index if it exists:
|
|
$alterCol='';
|
|
if(isset($indexList[$colName])){
|
|
$alterCol = "\nDROP INDEX \"$tableName\".ix_{$tableName}_{$colName};";
|
|
}
|
|
|
|
$prefix="ALTER TABLE \"" . $tableName . "\" ";
|
|
if(isset($matches[1])) {
|
|
$alterCol .= "\n$prefix ALTER COLUMN \"$colName\" $matches[1]\n";
|
|
|
|
// SET null / not null
|
|
if(!empty($matches[2])) $alterCol .= ";\n$prefix ALTER COLUMN \"$colName\" $matches[1] $matches[2]";
|
|
|
|
// SET default (we drop it first, for reasons of precaution)
|
|
//TODO: changing default values not implemented yet:
|
|
if(!empty($matches[3])) {
|
|
$constraint_name="{$tableName}_{$colName}_default";
|
|
//$alterCol .= ";\n$prefix ALTER COLUMN \"$colName\" DROP DEFAULT";
|
|
//$alterCol .= ";\n$prefix ALTER COLUMN \"$colName\" SET $matches[3]";
|
|
/*$constraint_query="
|
|
SELECT OBJECT_NAME(OBJECT_ID) AS NameofConstraint,
|
|
SCHEMA_NAME(schema_id) AS SchemaName,
|
|
OBJECT_NAME(parent_object_id) AS TableName,
|
|
type_desc AS ConstraintType
|
|
FROM sys.objects
|
|
WHERE type_desc LIKE '%CONSTRAINT' AND OBJECT_NAME(parent_object_id)='{$tableName}' AND type_desc='DEFAULT_CONSTRAINT' AND OBJECT_NAME(OBJECT_ID)='$constraint_name'";
|
|
|
|
$constraint_result=$this->query($constraint_query)->first();
|
|
|
|
if($constraint_result){
|
|
//$alterCol.= ";\n$prefix DROP DEFAULT";
|
|
$alterCol .= ";\n$prefix DROP CONSTRAINT $constraint_name";
|
|
}
|
|
$alterCol .= ";\n$prefix ADD CONSTRAINT \"$constraint_name\" {$matches[3]} FOR $colName";*/
|
|
}
|
|
|
|
// SET check constraint (The constraint HAS to be dropped)
|
|
if(!empty($matches[4])) {
|
|
$constraint=$this->ColumnConstraints($tableName, $colName);
|
|
if($constraint)
|
|
$alterCol .= ";\n$prefix DROP CONSTRAINT {$constraint['CONSTRAINT_NAME']}";
|
|
|
|
//NOTE: 'with nocheck' seems to solve a few problems I've been having for modifying existing tables.
|
|
$alterCol .= ";\n$prefix WITH NOCHECK ADD CONSTRAINT \"{$tableName}_{$colName}_check\" $matches[4]";
|
|
|
|
|
|
}
|
|
}
|
|
return isset($alterCol) ? $alterCol : '';
|
|
}
|
|
|
|
public function renameTable($oldTableName, $newTableName) {
|
|
$this->query("ALTER TABLE \"$oldTableName\" RENAME \"$newTableName\"");
|
|
}
|
|
|
|
/**
|
|
* Checks a table's integrity and repairs it if necessary.
|
|
* NOTE: MSSQL does not appear to support any vacuum or optimise commands
|
|
*
|
|
* @var string $tableName The name of the table.
|
|
* @return boolean Return true if the table has integrity after the method is complete.
|
|
*/
|
|
public function checkAndRepairTable($tableName) {
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* Helper function used by checkAndRepairTable.
|
|
* @param string $sql Query to run.
|
|
* @return boolean Returns if the query returns a successful result.
|
|
*/
|
|
protected function runTableCheckCommand($sql) {
|
|
$testResults = $this->query($sql);
|
|
foreach($testResults as $testRecord) {
|
|
if(strtolower($testRecord['Msg_text']) != 'ok') {
|
|
return false;
|
|
}
|
|
}
|
|
return true;
|
|
}
|
|
|
|
public function createField($tableName, $fieldName, $fieldSpec) {
|
|
$this->query("ALTER TABLE \"$tableName\" ADD \"$fieldName\" $fieldSpec");
|
|
}
|
|
|
|
/**
|
|
* Change the database type of the given field.
|
|
* @param string $tableName The name of the tbale the field is in.
|
|
* @param string $fieldName The name of the field to change.
|
|
* @param string $fieldSpec The new field specification
|
|
*/
|
|
public function alterField($tableName, $fieldName, $fieldSpec) {
|
|
$this->query("ALTER TABLE \"$tableName\" CHANGE \"$fieldName\" \"$fieldName\" $fieldSpec");
|
|
}
|
|
|
|
/**
|
|
* Change the database column name of the given field.
|
|
*
|
|
* @param string $tableName The name of the tbale the field is in.
|
|
* @param string $oldName The name of the field to change.
|
|
* @param string $newName The new name of the field
|
|
*/
|
|
public function renameField($tableName, $oldName, $newName) {
|
|
$fieldList = $this->fieldList($tableName);
|
|
if(array_key_exists($oldName, $fieldList)) {
|
|
$this->query("EXEC sp_rename @objname = '$tableName.$oldName', @newname = '$newName', @objtype = 'COLUMN'");
|
|
}
|
|
}
|
|
|
|
public function fieldList($table) {
|
|
//This gets us more information than we need, but I've included it all for the moment....
|
|
$fields = $this->query("SELECT ordinal_position, column_name, data_type, column_default, is_nullable, character_maximum_length, numeric_precision FROM information_schema.columns WHERE table_name = '$table' ORDER BY ordinal_position;");
|
|
|
|
$output = array();
|
|
if($fields) foreach($fields as $field) {
|
|
switch($field['data_type']){
|
|
case 'varchar':
|
|
//Check to see if there's a constraint attached to this column:
|
|
$constraint=$this->ColumnConstraints($table, $field['column_name']);
|
|
if($constraint){
|
|
$constraints=$this->EnumValuesFromConstraint($constraint['CHECK_CLAUSE']);
|
|
$default=substr($field['column_default'], 2, -2);
|
|
$field['data_type']=$this->enum(Array('default'=>$default, 'name'=>$field['column_name'], 'enums'=>$constraints, 'table'=>$table));
|
|
}
|
|
|
|
$output[$field['column_name']]=$field;
|
|
break;
|
|
default:
|
|
$output[$field['column_name']] = $field;
|
|
}
|
|
|
|
}
|
|
|
|
return $output;
|
|
}
|
|
|
|
/**
|
|
* Create an index on a table.
|
|
* @param string $tableName The name of the table.
|
|
* @param string $indexName The name of the index.
|
|
* @param string $indexSpec The specification of the index, see Database::requireIndex() for more details.
|
|
*/
|
|
public function createIndex($tableName, $indexName, $indexSpec) {
|
|
$this->query($this->getIndexSqlDefinition($tableName, $indexName, $indexSpec));
|
|
}
|
|
|
|
/*
|
|
* This takes the index spec which has been provided by a class (ie static $indexes = blah blah)
|
|
* and turns it into a proper string.
|
|
* Some indexes may be arrays, such as fulltext and unique indexes, and this allows database-specific
|
|
* arrays to be created.
|
|
*/
|
|
public function convertIndexSpec($indexSpec){
|
|
if(is_array($indexSpec)){
|
|
//Here we create a db-specific version of whatever index we need to create.
|
|
switch($indexSpec['type']){
|
|
case 'fulltext':
|
|
$indexSpec='fulltext (' . str_replace(' ', '', $indexSpec['value']) . ')';
|
|
break;
|
|
case 'unique':
|
|
$indexSpec='unique (' . $indexSpec['value'] . ')';
|
|
break;
|
|
}
|
|
}
|
|
|
|
return $indexSpec;
|
|
}
|
|
|
|
protected function getIndexSqlDefinition($tableName, $indexName, $indexSpec) {
|
|
|
|
if(!is_array($indexSpec)){
|
|
$indexSpec=trim($indexSpec, '()');
|
|
$bits=explode(',', $indexSpec);
|
|
$indexes="\"" . implode("\",\"", $bits) . "\"";
|
|
|
|
return 'create index ix_' . $tableName . '_' . $indexName . " ON \"" . $tableName . "\" (" . $indexes . ");";
|
|
} else {
|
|
//create a type-specific index
|
|
if($indexSpec['type']=='fulltext'){
|
|
if($this->fullTextEnabled) {
|
|
//Enable full text search.
|
|
$this->createFullTextCatalog();
|
|
|
|
$primary_key=$this->getPrimaryKey($tableName);
|
|
|
|
//First, we need to see if a full text search already exists:
|
|
$result=$this->query("SELECT object_id FROM sys.fulltext_indexes WHERE object_id=object_id('$tableName');")->first();
|
|
|
|
$drop='';
|
|
if($result)
|
|
$drop="DROP FULLTEXT INDEX ON \"" . $tableName . "\";";
|
|
|
|
return $drop . "CREATE FULLTEXT INDEX ON \"$tableName\" ({$indexSpec['value']}) " .
|
|
"KEY INDEX $primary_key WITH CHANGE_TRACKING AUTO;";
|
|
}
|
|
|
|
}
|
|
|
|
if($indexSpec['type']=='unique')
|
|
return 'create unique index ix_' . $tableName . '_' . $indexName . " ON \"" . $tableName . "\" (\"" . $indexSpec['value'] . "\");";
|
|
}
|
|
|
|
}
|
|
|
|
function getDbSqlDefinition($tableName, $indexName, $indexSpec){
|
|
return $indexName;
|
|
}
|
|
|
|
/**
|
|
* Alter an index on a table.
|
|
* @param string $tableName The name of the table.
|
|
* @param string $indexName The name of the index.
|
|
* @param string $indexSpec The specification of the index, see Database::requireIndex() for more details.
|
|
*/
|
|
public function alterIndex($tableName, $indexName, $indexSpec) {
|
|
$indexSpec = trim($indexSpec);
|
|
if($indexSpec[0] != '(') {
|
|
list($indexType, $indexFields) = explode(' ',$indexSpec,2);
|
|
} else {
|
|
$indexFields = $indexSpec;
|
|
}
|
|
|
|
if(!$indexType) {
|
|
$indexType = "index";
|
|
}
|
|
|
|
$this->query("DROP INDEX $indexName ON $tableName;");
|
|
$this->query("ALTER TABLE \"$tableName\" ADD $indexType \"$indexName\" $indexFields");
|
|
}
|
|
|
|
/**
|
|
* Return the list of indexes in a table.
|
|
* @param string $table The table name.
|
|
* @return array
|
|
*/
|
|
public function indexList($table) {
|
|
$indexes=DB::query("EXEC sp_helpindex '$table';");
|
|
$prefix = '';
|
|
|
|
|
|
foreach($indexes as $index) {
|
|
|
|
//Check for uniques:
|
|
if(strpos($index['index_description'], 'unique')!==false)
|
|
$prefix='unique ';
|
|
|
|
$key=str_replace(', ', ',', $index['index_keys']);
|
|
$indexList[$key]['indexname']=$index['index_name'];
|
|
$indexList[$key]['spec']=$prefix . '(' . $key . ')';
|
|
|
|
}
|
|
|
|
//Now we need to check to see if we have any fulltext indexes attached to this table:
|
|
if($this->fullTextEnabled) {
|
|
$result=DB::query('EXEC sp_help_fulltext_columns;');
|
|
$columns='';
|
|
foreach($result as $row){
|
|
|
|
if($row['TABLE_NAME']==$table)
|
|
$columns.=$row['FULLTEXT_COLUMN_NAME'] . ',';
|
|
|
|
}
|
|
|
|
if($columns!=''){
|
|
$columns=trim($columns, ',');
|
|
$indexList['SearchFields']['indexname']='SearchFields';
|
|
$indexList['SearchFields']['spec']='fulltext (' . $columns . ')';
|
|
}
|
|
}
|
|
|
|
return isset($indexList) ? $indexList : null;
|
|
|
|
}
|
|
|
|
/**
|
|
* Returns a list of all the tables in the database.
|
|
* Table names will all be in lowercase.
|
|
* @return array
|
|
*/
|
|
public function tableList() {
|
|
$tables = array();
|
|
foreach($this->query("EXEC sp_tables @table_owner = 'dbo';") as $record) {
|
|
$table = strtolower($record['TABLE_NAME']);
|
|
$tables[$table] = $table;
|
|
}
|
|
return $tables;
|
|
}
|
|
|
|
/**
|
|
* Empty the given table of call contentTR
|
|
*/
|
|
public function clearTable($table) {
|
|
$this->query("TRUNCATE TABLE \"$table\"");
|
|
}
|
|
|
|
/**
|
|
* Return the number of rows affected by the previous operation.
|
|
* @return int
|
|
*/
|
|
public function affectedRows() {
|
|
return mssql_rows_affected($this->dbConn);
|
|
}
|
|
|
|
/**
|
|
* A function to return the field names and datatypes for the particular table
|
|
*/
|
|
public function tableDetails($tableName){
|
|
user_error("tableDetails not implemented", E_USER_WARNING);
|
|
return array();
|
|
/*
|
|
$query="SELECT a.attname as \"Column\", pg_catalog.format_type(a.atttypid, a.atttypmod) as \"Datatype\" FROM pg_catalog.pg_attribute a WHERE a.attnum > 0 AND NOT a.attisdropped AND a.attrelid = ( SELECT c.oid FROM pg_catalog.pg_class c LEFT JOIN pg_catalog.pg_namespace n ON n.oid = c.relnamespace WHERE c.relname ~ '^($tableName)$' AND pg_catalog.pg_table_is_visible(c.oid));";
|
|
$result=DB::query($query);
|
|
|
|
$table=Array();
|
|
while($row=pg_fetch_assoc($result)){
|
|
$table[]=Array('Column'=>$row['Column'], 'DataType'=>$row['DataType']);
|
|
}
|
|
|
|
return $table;
|
|
*/
|
|
}
|
|
|
|
/**
|
|
* Return a boolean type-formatted string
|
|
* We use 'bit' so that we can do numeric-based comparisons
|
|
*
|
|
* @params array $values Contains a tokenised list of info about this data type
|
|
* @return string
|
|
*/
|
|
public function boolean($values, $asDbValue=false){
|
|
//Annoyingly, we need to do a good ol' fashioned switch here:
|
|
($values['default']) ? $default='1' : $default='0';
|
|
|
|
if($asDbValue)
|
|
return 'bit';
|
|
else
|
|
return 'bit not null default ' . $default;
|
|
}
|
|
|
|
/**
|
|
* Return a date type-formatted string.
|
|
*
|
|
* @params array $values Contains a tokenised list of info about this data type
|
|
* @return string
|
|
*/
|
|
public function date($values, $asDbValue=false){
|
|
if($asDbValue)
|
|
return 'date';
|
|
else
|
|
return 'date null';
|
|
}
|
|
|
|
/**
|
|
* Return a decimal type-formatted string
|
|
*
|
|
* @params array $values Contains a tokenised list of info about this data type
|
|
* @return string
|
|
*/
|
|
public function decimal($values, $asDbValue=false){
|
|
// Avoid empty strings being put in the db
|
|
if($values['precision'] == '') {
|
|
$precision = 1;
|
|
} else {
|
|
$precision = $values['precision'];
|
|
}
|
|
|
|
if($asDbValue)
|
|
return Array('data_type'=>'decimal', 'numeric_precision'=>'9,2');
|
|
else return 'decimal(' . $precision . ') not null default 0';
|
|
}
|
|
|
|
/**
|
|
* Return a enum type-formatted string
|
|
*
|
|
* @params array $values Contains a tokenised list of info about this data type
|
|
* @return string
|
|
*/
|
|
public function enum($values){
|
|
//Enums are a bit different. We'll be creating a varchar(255) with a constraint of all the usual enum options.
|
|
//NOTE: In this one instance, we are including the table name in the values array
|
|
|
|
return "varchar(255) not null default '" . $values['default'] . "' check(\"" . $values['name'] . "\" in ('" . implode('\', \'', $values['enums']) . "'))";
|
|
//return "varchar(255) not null check(\"" . $values['name'] . "\" in ('" . implode('\', \'', $values['enums']) . "')); add constraint \"" . $values['table'] . '_' . $values['name'] . "_default\" default '" . $values['default'] . "' for \"" . $values['name'] . "\"";
|
|
|
|
}
|
|
|
|
/**
|
|
* Return a float type-formatted string.
|
|
*
|
|
* @params array $values Contains a tokenised list of info about this data type
|
|
* @return string
|
|
*/
|
|
public function float($values, $asDbValue=false){
|
|
if($asDbValue)
|
|
return Array('data_type'=>'float');
|
|
else return 'float';
|
|
}
|
|
|
|
/**
|
|
* Return a int type-formatted string
|
|
*
|
|
* @params array $values Contains a tokenised list of info about this data type
|
|
* @return string
|
|
*/
|
|
public function int($values, $asDbValue=false){
|
|
//We'll be using an 8 digit precision to keep it in line with the serial8 datatype for ID columns
|
|
if($asDbValue)
|
|
return Array('data_type'=>'numeric', 'numeric_precision'=>'8');
|
|
else
|
|
return 'numeric(8) not null default ' . (int)$values['default'];
|
|
}
|
|
|
|
/**
|
|
* Return a datetime type-formatted string
|
|
* For MS SQL, we simply return the word 'timestamp', no other parameters are necessary
|
|
*
|
|
* @params array $values Contains a tokenised list of info about this data type
|
|
* @return string
|
|
*/
|
|
public function ssdatetime($values, $asDbValue=false){
|
|
if($asDbValue)
|
|
return Array('data_type'=>'datetime');
|
|
else
|
|
return 'datetime null';
|
|
}
|
|
|
|
/**
|
|
* Return a text type-formatted string
|
|
*
|
|
* @params array $values Contains a tokenised list of info about this data type
|
|
* @return string
|
|
*/
|
|
public function text($values, $asDbValue=false){
|
|
if($asDbValue)
|
|
return Array('data_type'=>'text');
|
|
else
|
|
return 'text null';
|
|
}
|
|
|
|
/**
|
|
* Return a time type-formatted string.
|
|
*
|
|
* @params array $values Contains a tokenised list of info about this data type
|
|
* @return string
|
|
*/
|
|
public function time($values){
|
|
return 'time null';
|
|
}
|
|
|
|
/**
|
|
* Return a varchar type-formatted string
|
|
*
|
|
* @params array $values Contains a tokenised list of info about this data type
|
|
* @return string
|
|
*/
|
|
public function varchar($values, $asDbValue=false){
|
|
if($asDbValue)
|
|
return Array('data_type'=>'varchar', 'character_maximum_length'=>'255');
|
|
else
|
|
return 'varchar(' . $values['precision'] . ') null';
|
|
}
|
|
|
|
/**
|
|
* Return a 4 digit numeric type.
|
|
* @return string
|
|
*/
|
|
public function year($values, $asDbValue=false){
|
|
if($asDbValue)
|
|
return Array('data_type'=>'numeric', 'numeric_precision'=>'4');
|
|
else return 'numeric(4)';
|
|
}
|
|
|
|
function escape_character($escape=false){
|
|
if($escape)
|
|
return "\\\"";
|
|
else
|
|
return "\"";
|
|
}
|
|
|
|
/**
|
|
* Create a fulltext search datatype for MSSQL.
|
|
*
|
|
* @param array $spec
|
|
*/
|
|
function fulltext($table, $spec){
|
|
//$spec['name'] is the column we've created that holds all the words we want to index.
|
|
//This is a coalesced collection of multiple columns if necessary
|
|
//$spec='create index ix_' . $table . '_' . $spec['name'] . ' on ' . $table . ' using gist(' . $spec['name'] . ');';
|
|
|
|
//return $spec;
|
|
echo '<span style="color: Red">full text just got called!</span><br>';
|
|
return '';
|
|
}
|
|
|
|
/**
|
|
* This returns the column which is the primary key for each table
|
|
* In Postgres, it is a SERIAL8, which is the equivalent of an auto_increment
|
|
*
|
|
* @return string
|
|
*/
|
|
function IdColumn($asDbValue=false, $hasAutoIncPK=true){
|
|
|
|
if($asDbValue)
|
|
return 'bigint';
|
|
else {
|
|
if($hasAutoIncPK)
|
|
return 'bigint identity(1,1)';
|
|
else return 'bigint';
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Returns the SQL command to get all the tables in this database
|
|
*/
|
|
function allTablesSQL(){
|
|
return "SELECT name FROM {$this->database}..sysobjects WHERE xtype = 'U';";
|
|
}
|
|
|
|
/**
|
|
* Returns true if this table exists
|
|
* @todo Make a proper implementation
|
|
*/
|
|
function hasTable($tableName) {
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* Returns the values of the given enum field
|
|
* NOTE: Experimental; introduced for db-abstraction and may changed before 2.4 is released.
|
|
*/
|
|
public function enumValuesForField($tableName, $fieldName) {
|
|
// Get the enum of all page types from the SiteTree table
|
|
|
|
$constraints=$this->ColumnConstraints($tableName, $fieldName);
|
|
$classes=Array();
|
|
if($constraints){
|
|
$constraints=$this->EnumValuesFromConstraint($constraints['CHECK_CLAUSE']);
|
|
$classes=$constraints;
|
|
}
|
|
return $classes;
|
|
}
|
|
|
|
/**
|
|
* Because NOW() doesn't always work...
|
|
* MSSQL, I'm looking at you
|
|
*
|
|
*/
|
|
function now(){
|
|
return 'CURRENT_TIMESTAMP';
|
|
}
|
|
|
|
/**
|
|
* Convert a SQLQuery object into a SQL statement.
|
|
*/
|
|
public function sqlQueryToString(SQLQuery $sqlQuery) {
|
|
if (!$sqlQuery->from) return '';
|
|
|
|
if($sqlQuery->orderby && strtoupper(trim($sqlQuery->orderby)) == 'RAND()') $sqlQuery->orderby = "NEWID()";
|
|
|
|
//TODO: remove me when the limit function supposedly works
|
|
$sqlQuery->limit='';
|
|
|
|
//Get the limit and offset
|
|
$limit='';
|
|
$offset='0';
|
|
if(is_array($sqlQuery->limit)){
|
|
$limit=$sqlQuery->limit['limit'];
|
|
if(isset($sqlQuery->limit['start']))
|
|
$offset=$sqlQuery->limit['start'];
|
|
|
|
} else {
|
|
//could be a comma delimited string
|
|
$bits=explode(',', $sqlQuery->limit);
|
|
$limit=trim($bits[0]);
|
|
if(isset($bits[1]))
|
|
$offset=trim($bits[1]);
|
|
}
|
|
|
|
$text='';
|
|
$limitText='';
|
|
if($sqlQuery->limit) {
|
|
$text='SELECT * FROM ( SELECT ROW_NUMBER() OVER (';
|
|
$limitText=' ORDER BY ' . $sqlQuery->orderby . ') AS Number,';
|
|
}
|
|
|
|
$distinct = $sqlQuery->distinct ? "DISTINCT " : "";
|
|
|
|
//NOTE: Assumes that deletes don't have limit/offset clauses
|
|
if($sqlQuery->delete)
|
|
$text = 'DELETE ';
|
|
else if($sqlQuery->select) {
|
|
if($limitText=='')
|
|
$text.='SELECT';
|
|
$text .= "$limitText $distinct" . implode(", ", $sqlQuery->select);
|
|
}
|
|
$text .= " FROM " . implode(" ", $sqlQuery->from);
|
|
|
|
if($sqlQuery->where) $text .= " WHERE (" . $sqlQuery->getFilter(). ")";
|
|
if($sqlQuery->groupby) $text .= " GROUP BY " . implode(", ", $sqlQuery->groupby);
|
|
if($sqlQuery->having) $text .= " HAVING ( " . implode(" ) AND ( ", $sqlQuery->having) . " )";
|
|
if($limitText=='')
|
|
if($sqlQuery->orderby) $text .= " ORDER BY " . $sqlQuery->orderby;
|
|
|
|
// Limit not implemented
|
|
if($sqlQuery->limit){
|
|
$text.=') AS Numbered WHERE Number BETWEEN ' . $offset . ' AND ' . ($offset+$limit) . ';';
|
|
}
|
|
//if($sqlQuery->limit) {
|
|
|
|
/*
|
|
* For MSSQL, we need to do something different since it doesn't support LIMIT OFFSET as most normal
|
|
* databases do
|
|
*
|
|
* This is our preferred method, but we need to know the primary key name:
|
|
*
|
|
select * from (
|
|
select row_number() over (order by $this->orderby) as number, * from MyTable
|
|
) as numbered
|
|
where number between 21 and 30
|
|
|
|
SELECT * FROM (
|
|
SELECT ROW_NUMBER() OVER (SELECT ORDER BY "Sort") AS Number, "SiteTree".*, "GhostPage".*, "ErrorPage".*, "RedirectorPage".*, "VirtualPage".*, "ExamplePage".*, "SiteTree"."ID", CASE WHEN "SiteTree"."ClassName" IS NOT NULL THEN "SiteTree"."ClassName" ELSE 'SiteTree' END AS "RecordClassName" FROM "SiteTree" LEFT JOIN "GhostPage" ON "GhostPage"."ID" = "SiteTree"."ID" LEFT JOIN "ErrorPage" ON "ErrorPage"."ID" = "SiteTree"."ID" LEFT JOIN "RedirectorPage" ON "RedirectorPage"."ID" = "SiteTree"."ID" LEFT JOIN "VirtualPage" ON "VirtualPage"."ID" = "SiteTree"."ID" LEFT JOIN "ExamplePage" ON "ExamplePage"."ID" = "SiteTree"."ID" WHERE ("URLSegment" = 'home') ORDER BY "Sort"
|
|
) AS Numbered WHERE Number BETWEEN 0 AND 1;
|
|
|
|
SELECT * FROM (
|
|
select ROW_NUMBER() over (order by SiteTree.Title) AS RowNum, *
|
|
FROM SiteTree) as Numbered
|
|
WHERE RowNum Between 0 And 1;
|
|
*/
|
|
|
|
|
|
//}
|
|
|
|
|
|
return $text;
|
|
}
|
|
|
|
/*
|
|
* This will return text which has been escaped in a database-friendly manner
|
|
* Using PHP's addslashes method won't work in MSSQL
|
|
*/
|
|
function addslashes($value){
|
|
$value=stripslashes($value);
|
|
$value=str_replace("'","''",$value);
|
|
$value=str_replace("\0","[NULL]",$value);
|
|
|
|
return $value;
|
|
}
|
|
|
|
/*
|
|
* This changes the index name depending on database requirements.
|
|
* MSSQL requires commas to be replaced with underscores
|
|
*/
|
|
function modifyIndex($index){
|
|
return str_replace('_', ',', $index);
|
|
}
|
|
|
|
/**
|
|
* The core search engine, used by this class and its subclasses to do fun stuff.
|
|
* Searches both SiteTree and File.
|
|
*
|
|
* TODO: This is a really basic search system, provided purely so we have something...
|
|
*
|
|
* @param string $keywords Keywords as a string.
|
|
*/
|
|
public function searchEngine($classesToSearch, $keywords, $pageLength = null, $sortBy = "Relevance DESC", $extraFilter = "", $booleanSearch = false, $alternativeFileFilter = "", $invertedMatch = false) {
|
|
if($this->fullTextEnabled) {
|
|
$result=DB::query('EXEC sp_help_fulltext_columns;');
|
|
|
|
//Get a list of all the tables and columns we'll be searching on:
|
|
$tables=Array();
|
|
foreach($result as $row){
|
|
if(substr($row['TABLE_NAME'], -5)!='_Live' && substr($row['TABLE_NAME'], -9)!='_versions')
|
|
$tables[]="SELECT ID, '{$row['TABLE_NAME']}' AS Source FROM \"{$row['TABLE_NAME']}\" WHERE CONTAINS(\"{$row['FULLTEXT_COLUMN_NAME']}\", N'$keywords')";
|
|
}
|
|
|
|
//We'll do a union query on all of these tables... it's easeier!
|
|
$query=implode(' UNION ', $tables);
|
|
|
|
$result=DB::query($query);
|
|
|
|
$searchResults=new DataObjectSet();
|
|
foreach($result as $row){
|
|
$row_result=DataObject::get_by_id($row['Source'], $row['ID']);
|
|
$searchResults->push($row_result);
|
|
}
|
|
|
|
$searchResults->setPageLimits($start, $pageLength, $totalCount);
|
|
}
|
|
|
|
return $searchResults;
|
|
}
|
|
|
|
/**
|
|
* Allow auto-increment primary key editing on the given table.
|
|
* Some databases need to enable this specially.
|
|
* @param $table The name of the table to have PK editing allowed on
|
|
* @param $allow True to start, false to finish
|
|
*/
|
|
function allowPrimaryKeyEditing($table, $allow = true) {
|
|
$this->query("SET IDENTITY_INSERT \"$table\" " . ($allow ? "ON" : "OFF"));
|
|
}
|
|
|
|
/**
|
|
* Returns a SQL fragment for querying a fulltext search index
|
|
* @param $fields array The list of field names to search on
|
|
* @param $keywords string The search query
|
|
* @param $booleanSearch A MySQL-specific flag to switch to boolean search
|
|
*/
|
|
function fullTextSearchSQL($fields, $keywords, $booleanSearch = false) {
|
|
$fieldNames = '"' . implode('", "', $fields) . '"';
|
|
|
|
$SQL_keywords = Convert::raw2sql($keywords);
|
|
|
|
return "FREETEXT (($fieldNames), '$SQL_keywords')";
|
|
}
|
|
|
|
}
|
|
|
|
/**
|
|
* A result-set from a MSSQL database.
|
|
* @package sapphire
|
|
* @subpackage model
|
|
*/
|
|
class MSSQLQuery extends Query {
|
|
/**
|
|
* The MSSQLDatabase object that created this result set.
|
|
* @var MSSQLDatabase
|
|
*/
|
|
private $database;
|
|
|
|
/**
|
|
* The internal MSSQL handle that points to the result set.
|
|
* @var resource
|
|
*/
|
|
private $handle;
|
|
|
|
/**
|
|
* Hook the result-set given into a Query class, suitable for use by sapphire.
|
|
* @param database The database object that created this query.
|
|
* @param handle the internal mssql handle that is points to the resultset.
|
|
*/
|
|
public function __construct(MSSQLDatabase $database, $handle) {
|
|
|
|
$this->database = $database;
|
|
$this->handle = $handle;
|
|
parent::__construct();
|
|
}
|
|
|
|
public function __destroy() {
|
|
mssql_free_result($this->handle);
|
|
}
|
|
|
|
/*
|
|
* Please see the comments below for numRecords
|
|
*
|
|
*/
|
|
public function seek($row) {
|
|
return mssql_data_seek($this->handle, $row);
|
|
}
|
|
|
|
/*
|
|
* If we're running the sqlsrv set of functions, then the dataobject set is a forward-only curser
|
|
* Therefore, we do not have access to the number of rows that this result contains
|
|
* This is (usually) called from Database::rewind(), which in turn seems to be called when a foreach...
|
|
* is started on a recordset
|
|
*
|
|
* For this function, and seek() (above), we will be returning false.
|
|
*
|
|
*/
|
|
public function numRecords() {
|
|
return mssql_num_rows($this->handle);
|
|
}
|
|
|
|
public function nextRecord() {
|
|
// Coalesce rather than replace common fields.
|
|
if($data = mssql_fetch_row($this->handle)) {
|
|
foreach($data as $columnIdx => $value) {
|
|
$columnName = mssql_field_name($this->handle, $columnIdx);
|
|
// $value || !$ouput[$columnName] means that the *last* occurring value is shown
|
|
// !$ouput[$columnName] means that the *first* occurring value is shown
|
|
if(isset($value) || !isset($output[$columnName])) {
|
|
$output[$columnName] = $value;
|
|
}
|
|
}
|
|
|
|
return $output;
|
|
} else {
|
|
return false;
|
|
}
|
|
}
|
|
|
|
|
|
}
|
|
|
|
?>
|