mirror of
https://github.com/silverstripe/silverstripe-framework
synced 2024-09-09 03:01:18 +02:00
d8e9af8af8
Database abstraction broken up into controller, connector, query builder, and schema manager, each independently configurable via YAML / Injector Creation of new DBQueryGenerator for database specific generation of SQL Support for parameterised queries, move of code base to use these over escaped conditions Refactor of SQLQuery into separate query classes for each of INSERT UPDATE DELETE and SELECT Support for PDO Installation process upgraded to use new ORM SS_DatabaseException created to handle database errors, maintaining details of raw sql and parameter details for user code designed interested in that data. Renamed DB static methods to conform correctly to naming conventions (e.g. DB::getConn -> DB::get_conn) 3.2 upgrade docs Performance Optimisation and simplification of code to use more concise API API Ability for database adapters to register extensions to ConfigureFromEnv.php
72 lines
2.6 KiB
PHP
72 lines
2.6 KiB
PHP
<?php
|
|
|
|
/**
|
|
* Interface for database helper classes.
|
|
*
|
|
* @package framework
|
|
*/
|
|
interface DatabaseConfigurationHelper {
|
|
|
|
/**
|
|
* Ensure that the database function for connectivity is available.
|
|
* If it is, we assume the PHP module for this database has been setup correctly.
|
|
*
|
|
* @param array $databaseConfig Associative array of db configuration, e.g. "server", "username" etc
|
|
* @return boolean
|
|
*/
|
|
public function requireDatabaseFunctions($databaseConfig);
|
|
|
|
/**
|
|
* Ensure that the database server exists.
|
|
*
|
|
* @param array $databaseConfig Associative array of db configuration, e.g. "server", "username" etc
|
|
* @return array Result - e.g. array('okay' => true, 'error' => 'details of error')
|
|
*/
|
|
public function requireDatabaseServer($databaseConfig);
|
|
|
|
/**
|
|
* Ensure a database connection is possible using credentials provided.
|
|
* The established connection resource is returned with the results as well.
|
|
*
|
|
* @param array $databaseConfig Associative array of db configuration, e.g. "server", "username" etc
|
|
* @return array Result - e.g. array('okay' => true, 'connection' => mysql link, 'error' => 'details of error')
|
|
*/
|
|
public function requireDatabaseConnection($databaseConfig);
|
|
|
|
/**
|
|
* Determines the version of the database server
|
|
*
|
|
* @param array $databaseConfig Associative array of db configuration, e.g. "server", "username" etc
|
|
* @return string Version of database server or false on failure
|
|
*/
|
|
public function getDatabaseVersion($databaseConfig);
|
|
|
|
/**
|
|
* Check database version is greater than the minimum supported
|
|
*
|
|
* @param array $databaseConfig Associative array of db configuration, e.g. "server", "username" etc
|
|
* @return array Result - e.g. array('success' => true, 'error' => 'details of error')
|
|
*/
|
|
public function requireDatabaseVersion($databaseConfig);
|
|
|
|
/**
|
|
* Ensure that the database connection is able to use an existing database,
|
|
* or be able to create one if it doesn't exist.
|
|
*
|
|
* @param array $databaseConfig Associative array of db configuration, e.g. "server", "username" etc
|
|
* @return array Result - e.g. array('okay' => true, 'existsAlready' => 'true')
|
|
*/
|
|
public function requireDatabaseOrCreatePermissions($databaseConfig);
|
|
|
|
|
|
/**
|
|
* Ensure we have permissions to alter tables.
|
|
*
|
|
* @param array $databaseConfig Associative array of db configuration, e.g. "server", "username" etc
|
|
* @return array Result - e.g. array('okay' => true, 'applies' => true), where applies is whether
|
|
* the test is relevant for the database
|
|
*/
|
|
public function requireDatabaseAlterPermissions($databaseConfig);
|
|
|
|
}
|