1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371 |
- <?php
- /*
- * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
- * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
- * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
- * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
- * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
- * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
- * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
- * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
- * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
- * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
- * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
- *
- * This software consists of voluntary contributions made by many individuals
- * and is licensed under the LGPL. For more information, see
- * <http://www.doctrine-project.org>.
- */
-
- namespace Doctrine\DBAL\Platforms;
-
- use Doctrine\DBAL\DBALException,
- Doctrine\DBAL\Connection,
- Doctrine\DBAL\Types,
- Doctrine\DBAL\Schema\Table,
- Doctrine\DBAL\Schema\Index,
- Doctrine\DBAL\Schema\ForeignKeyConstraint,
- Doctrine\DBAL\Schema\TableDiff,
- Doctrine\DBAL\Schema\Column,
- Doctrine\DBAL\Types\Type;
-
- /**
- * Base class for all DatabasePlatforms. The DatabasePlatforms are the central
- * point of abstraction of platform-specific behaviors, features and SQL dialects.
- * They are a passive source of information.
- *
- * @license http://www.opensource.org/licenses/lgpl-license.php LGPL
- * @link www.doctrine-project.org
- * @since 2.0
- * @version $Revision: 3938 $
- * @author Guilherme Blanco <guilhermeblanco@hotmail.com>
- * @author Jonathan Wage <jonwage@gmail.com>
- * @author Roman Borschel <roman@code-factory.org>
- * @author Lukas Smith <smith@pooteeweet.org> (PEAR MDB2 library)
- * @author Benjamin Eberlei <kontakt@beberlei.de>
- * @todo Remove any unnecessary methods.
- */
- abstract class AbstractPlatform
- {
- /**
- * @var int
- */
- const CREATE_INDEXES = 1;
-
- /**
- * @var int
- */
- const CREATE_FOREIGNKEYS = 2;
-
- /**
- * @var int
- */
- const TRIM_UNSPECIFIED = 0;
-
- /**
- * @var int
- */
- const TRIM_LEADING = 1;
-
- /**
- * @var int
- */
- const TRIM_TRAILING = 2;
-
- /**
- * @var int
- */
- const TRIM_BOTH = 3;
-
- /**
- * @var array
- */
- protected $doctrineTypeMapping = null;
-
- /**
- * Contains a list of all columns that should generate parseable column comments for type-detection
- * in reverse engineering scenarios.
- *
- * @var array
- */
- protected $doctrineTypeComments = null;
-
- /**
- * Constructor.
- */
- public function __construct() {}
-
- /**
- * Gets the SQL snippet that declares a boolean column.
- *
- * @param array $columnDef
- * @return string
- */
- abstract public function getBooleanTypeDeclarationSQL(array $columnDef);
-
- /**
- * Gets the SQL snippet that declares a 4 byte integer column.
- *
- * @param array $columnDef
- * @return string
- */
- abstract public function getIntegerTypeDeclarationSQL(array $columnDef);
-
- /**
- * Gets the SQL snippet that declares an 8 byte integer column.
- *
- * @param array $columnDef
- * @return string
- */
- abstract public function getBigIntTypeDeclarationSQL(array $columnDef);
-
- /**
- * Gets the SQL snippet that declares a 2 byte integer column.
- *
- * @param array $columnDef
- * @return string
- */
- abstract public function getSmallIntTypeDeclarationSQL(array $columnDef);
-
- /**
- * Gets the SQL snippet that declares common properties of an integer column.
- *
- * @param array $columnDef
- * @return string
- */
- abstract protected function _getCommonIntegerTypeDeclarationSQL(array $columnDef);
-
- /**
- * Lazy load Doctrine Type Mappings
- *
- * @return void
- */
- abstract protected function initializeDoctrineTypeMappings();
-
- /**
- * Gets the SQL snippet used to declare a VARCHAR column type.
- *
- * @param array $field
- */
- public function getVarcharTypeDeclarationSQL(array $field)
- {
- if ( !isset($field['length'])) {
- $field['length'] = $this->getVarcharDefaultLength();
- }
-
- $fixed = (isset($field['fixed'])) ? $field['fixed'] : false;
-
- if ($field['length'] > $this->getVarcharMaxLength()) {
- return $this->getClobTypeDeclarationSQL($field);
- } else {
- return $this->getVarcharTypeDeclarationSQLSnippet($field['length'], $fixed);
- }
- }
-
- protected function getVarcharTypeDeclarationSQLSnippet($length, $fixed)
- {
- throw DBALException::notSupported('VARCHARs not supported by Platform.');
- }
-
- /**
- * Gets the SQL snippet used to declare a CLOB column type.
- *
- * @param array $field
- */
- abstract public function getClobTypeDeclarationSQL(array $field);
-
- /**
- * Gets the name of the platform.
- *
- * @return string
- */
- abstract public function getName();
-
- /**
- * Register a doctrine type to be used in conjunction with a column type of this platform.
- *
- * @param string $dbType
- * @param string $doctrineType
- */
- public function registerDoctrineTypeMapping($dbType, $doctrineType)
- {
- if ($this->doctrineTypeMapping === null) {
- $this->initializeDoctrineTypeMappings();
- }
-
- if (!Types\Type::hasType($doctrineType)) {
- throw DBALException::typeNotFound($doctrineType);
- }
-
- $dbType = strtolower($dbType);
- $this->doctrineTypeMapping[$dbType] = $doctrineType;
- }
-
- /**
- * Get the Doctrine type that is mapped for the given database column type.
- *
- * @param string $dbType
- * @return string
- */
- public function getDoctrineTypeMapping($dbType)
- {
- if ($this->doctrineTypeMapping === null) {
- $this->initializeDoctrineTypeMappings();
- }
-
- $dbType = strtolower($dbType);
- if (isset($this->doctrineTypeMapping[$dbType])) {
- return $this->doctrineTypeMapping[$dbType];
- } else {
- throw new \Doctrine\DBAL\DBALException("Unknown database type ".$dbType." requested, " . get_class($this) . " may not support it.");
- }
- }
-
- /**
- * Check if a database type is currently supported by this platform.
- *
- * @param string $dbType
- * @return bool
- */
- public function hasDoctrineTypeMappingFor($dbType)
- {
- if ($this->doctrineTypeMapping === null) {
- $this->initializeDoctrineTypeMappings();
- }
-
- $dbType = strtolower($dbType);
- return isset($this->doctrineTypeMapping[$dbType]);
- }
-
- /**
- * Initialize the Doctrine Type comments instance variable for in_array() checks.
- *
- * @return void
- */
- protected function initializeCommentedDoctrineTypes()
- {
- $this->doctrineTypeComments = array(Type::TARRAY, Type::OBJECT);
- }
-
- /**
- * Is it necessary for the platform to add a parsable type comment to allow reverse engineering the given type?
- *
- * @param Type $doctrineType
- * @return bool
- */
- public function isCommentedDoctrineType(Type $doctrineType)
- {
- if ($this->doctrineTypeComments === null) {
- $this->initializeCommentedDoctrineTypes();
- }
-
- return in_array($doctrineType->getName(), $this->doctrineTypeComments);
- }
-
- /**
- * Mark this type as to be commented in ALTER TABLE and CREATE TABLE statements.
- *
- * @param Type $doctrineType
- * @return void
- */
- public function markDoctrineTypeCommented(Type $doctrineType)
- {
- if ($this->doctrineTypeComments === null) {
- $this->initializeCommentedDoctrineTypes();
- }
- $this->doctrineTypeComments[] = $doctrineType->getName();
- }
-
- /**
- * Get the comment to append to a column comment that helps parsing this type in reverse engineering.
- *
- * @param Type $doctrineType
- * @return string
- */
- public function getDoctrineTypeComment(Type $doctrineType)
- {
- return '(DC2Type:' . $doctrineType->getName() . ')';
- }
-
- /**
- * Return the comment of a passed column modified by potential doctrine type comment hints.
- *
- * @param Column $column
- * @return string
- */
- protected function getColumnComment(Column $column)
- {
- $comment = $column->getComment();
- if ($this->isCommentedDoctrineType($column->getType())) {
- $comment .= $this->getDoctrineTypeComment($column->getType());
- }
- return $comment;
- }
-
- /**
- * Gets the character used for identifier quoting.
- *
- * @return string
- */
- public function getIdentifierQuoteCharacter()
- {
- return '"';
- }
-
- /**
- * Gets the string portion that starts an SQL comment.
- *
- * @return string
- */
- public function getSqlCommentStartString()
- {
- return "--";
- }
-
- /**
- * Gets the string portion that ends an SQL comment.
- *
- * @return string
- */
- public function getSqlCommentEndString()
- {
- return "\n";
- }
-
- /**
- * Gets the maximum length of a varchar field.
- *
- * @return integer
- */
- public function getVarcharMaxLength()
- {
- return 4000;
- }
-
- /**
- * Gets the default length of a varchar field.
- *
- * @return integer
- */
- public function getVarcharDefaultLength()
- {
- return 255;
- }
-
- /**
- * Gets all SQL wildcard characters of the platform.
- *
- * @return array
- */
- public function getWildcards()
- {
- return array('%', '_');
- }
-
- /**
- * Returns the regular expression operator.
- *
- * @return string
- */
- public function getRegexpExpression()
- {
- throw DBALException::notSupported(__METHOD__);
- }
-
- /**
- * Returns the average value of a column
- *
- * @param string $column the column to use
- * @return string generated sql including an AVG aggregate function
- */
- public function getAvgExpression($column)
- {
- return 'AVG(' . $column . ')';
- }
-
- /**
- * Returns the number of rows (without a NULL value) of a column
- *
- * If a '*' is used instead of a column the number of selected rows
- * is returned.
- *
- * @param string|integer $column the column to use
- * @return string generated sql including a COUNT aggregate function
- */
- public function getCountExpression($column)
- {
- return 'COUNT(' . $column . ')';
- }
-
- /**
- * Returns the highest value of a column
- *
- * @param string $column the column to use
- * @return string generated sql including a MAX aggregate function
- */
- public function getMaxExpression($column)
- {
- return 'MAX(' . $column . ')';
- }
-
- /**
- * Returns the lowest value of a column
- *
- * @param string $column the column to use
- * @return string
- */
- public function getMinExpression($column)
- {
- return 'MIN(' . $column . ')';
- }
-
- /**
- * Returns the total sum of a column
- *
- * @param string $column the column to use
- * @return string
- */
- public function getSumExpression($column)
- {
- return 'SUM(' . $column . ')';
- }
-
- // scalar functions
-
- /**
- * Returns the md5 sum of a field.
- *
- * Note: Not SQL92, but common functionality
- *
- * @return string
- */
- public function getMd5Expression($column)
- {
- return 'MD5(' . $column . ')';
- }
-
- /**
- * Returns the length of a text field.
- *
- * @param string $expression1
- * @param string $expression2
- * @return string
- */
- public function getLengthExpression($column)
- {
- return 'LENGTH(' . $column . ')';
- }
-
- /**
- * Rounds a numeric field to the number of decimals specified.
- *
- * @param string $expression1
- * @param string $expression2
- * @return string
- */
- public function getRoundExpression($column, $decimals = 0)
- {
- return 'ROUND(' . $column . ', ' . $decimals . ')';
- }
-
- /**
- * Returns the remainder of the division operation
- * $expression1 / $expression2.
- *
- * @param string $expression1
- * @param string $expression2
- * @return string
- */
- public function getModExpression($expression1, $expression2)
- {
- return 'MOD(' . $expression1 . ', ' . $expression2 . ')';
- }
-
- /**
- * Trim a string, leading/trailing/both and with a given char which defaults to space.
- *
- * @param string $str
- * @param int $pos
- * @param string $char has to be quoted already
- * @return string
- */
- public function getTrimExpression($str, $pos = self::TRIM_UNSPECIFIED, $char = false)
- {
- $posStr = '';
- $trimChar = ($char != false) ? $char . ' FROM ' : '';
-
- if ($pos == self::TRIM_LEADING) {
- $posStr = 'LEADING '.$trimChar;
- } else if($pos == self::TRIM_TRAILING) {
- $posStr = 'TRAILING '.$trimChar;
- } else if($pos == self::TRIM_BOTH) {
- $posStr = 'BOTH '.$trimChar;
- }
-
- return 'TRIM(' . $posStr . $str . ')';
- }
-
- /**
- * rtrim
- * returns the string $str with proceeding space characters removed
- *
- * @param string $str literal string or column name
- * @return string
- */
- public function getRtrimExpression($str)
- {
- return 'RTRIM(' . $str . ')';
- }
-
- /**
- * ltrim
- * returns the string $str with leading space characters removed
- *
- * @param string $str literal string or column name
- * @return string
- */
- public function getLtrimExpression($str)
- {
- return 'LTRIM(' . $str . ')';
- }
-
- /**
- * upper
- * Returns the string $str with all characters changed to
- * uppercase according to the current character set mapping.
- *
- * @param string $str literal string or column name
- * @return string
- */
- public function getUpperExpression($str)
- {
- return 'UPPER(' . $str . ')';
- }
-
- /**
- * lower
- * Returns the string $str with all characters changed to
- * lowercase according to the current character set mapping.
- *
- * @param string $str literal string or column name
- * @return string
- */
- public function getLowerExpression($str)
- {
- return 'LOWER(' . $str . ')';
- }
-
- /**
- * returns the position of the first occurrence of substring $substr in string $str
- *
- * @param string $substr literal string to find
- * @param string $str literal string
- * @param int $pos position to start at, beginning of string by default
- * @return integer
- */
- public function getLocateExpression($str, $substr, $startPos = false)
- {
- throw DBALException::notSupported(__METHOD__);
- }
-
- /**
- * Returns the current system date.
- *
- * @return string
- */
- public function getNowExpression()
- {
- return 'NOW()';
- }
-
- /**
- * return string to call a function to get a substring inside an SQL statement
- *
- * Note: Not SQL92, but common functionality.
- *
- * SQLite only supports the 2 parameter variant of this function
- *
- * @param string $value an sql string literal or column name/alias
- * @param integer $from where to start the substring portion
- * @param integer $len the substring portion length
- * @return string
- */
- public function getSubstringExpression($value, $from, $len = null)
- {
- if ($len === null)
- return 'SUBSTRING(' . $value . ' FROM ' . $from . ')';
- else {
- return 'SUBSTRING(' . $value . ' FROM ' . $from . ' FOR ' . $len . ')';
- }
- }
-
- /**
- * Returns a series of strings concatinated
- *
- * concat() accepts an arbitrary number of parameters. Each parameter
- * must contain an expression
- *
- * @param string $arg1, $arg2 ... $argN strings that will be concatinated.
- * @return string
- */
- public function getConcatExpression()
- {
- return join(' || ' , func_get_args());
- }
-
- /**
- * Returns the SQL for a logical not.
- *
- * Example:
- * <code>
- * $q = new Doctrine_Query();
- * $e = $q->expr;
- * $q->select('*')->from('table')
- * ->where($e->eq('id', $e->not('null'));
- * </code>
- *
- * @return string a logical expression
- */
- public function getNotExpression($expression)
- {
- return 'NOT(' . $expression . ')';
- }
-
- /**
- * Returns the SQL to check if a value is one in a set of
- * given values.
- *
- * in() accepts an arbitrary number of parameters. The first parameter
- * must always specify the value that should be matched against. Successive
- * must contain a logical expression or an array with logical expressions.
- * These expressions will be matched against the first parameter.
- *
- * @param string $column the value that should be matched against
- * @param string|array(string) values that will be matched against $column
- * @return string logical expression
- */
- public function getInExpression($column, $values)
- {
- if ( ! is_array($values)) {
- $values = array($values);
- }
- $values = $this->getIdentifiers($values);
-
- if (count($values) == 0) {
- throw \InvalidArgumentException('Values must not be empty.');
- }
- return $column . ' IN (' . implode(', ', $values) . ')';
- }
-
- /**
- * Returns SQL that checks if a expression is null.
- *
- * @param string $expression the expression that should be compared to null
- * @return string logical expression
- */
- public function getIsNullExpression($expression)
- {
- return $expression . ' IS NULL';
- }
-
- /**
- * Returns SQL that checks if a expression is not null.
- *
- * @param string $expression the expression that should be compared to null
- * @return string logical expression
- */
- public function getIsNotNullExpression($expression)
- {
- return $expression . ' IS NOT NULL';
- }
-
- /**
- * Returns SQL that checks if an expression evaluates to a value between
- * two values.
- *
- * The parameter $expression is checked if it is between $value1 and $value2.
- *
- * Note: There is a slight difference in the way BETWEEN works on some databases.
- * http://www.w3schools.com/sql/sql_between.asp. If you want complete database
- * independence you should avoid using between().
- *
- * @param string $expression the value to compare to
- * @param string $value1 the lower value to compare with
- * @param string $value2 the higher value to compare with
- * @return string logical expression
- */
- public function getBetweenExpression($expression, $value1, $value2)
- {
- return $expression . ' BETWEEN ' .$value1 . ' AND ' . $value2;
- }
-
- public function getAcosExpression($value)
- {
- return 'ACOS(' . $value . ')';
- }
-
- public function getSinExpression($value)
- {
- return 'SIN(' . $value . ')';
- }
-
- public function getPiExpression()
- {
- return 'PI()';
- }
-
- public function getCosExpression($value)
- {
- return 'COS(' . $value . ')';
- }
-
- /**
- * Calculate the difference in days between the two passed dates.
- *
- * Computes diff = date1 - date2
- *
- * @param string $date1
- * @param string $date2
- * @return string
- */
- public function getDateDiffExpression($date1, $date2)
- {
- throw DBALException::notSupported(__METHOD__);
- }
-
- /**
- * Add the number of given days to a date.
- *
- * @param string $date
- * @param int $days
- * @return string
- */
- public function getDateAddDaysExpression($date, $days)
- {
- throw DBALException::notSupported(__METHOD__);
- }
-
- /**
- * Substract the number of given days to a date.
- *
- * @param string $date
- * @param int $days
- * @return string
- */
- public function getDateSubDaysExpression($date, $days)
- {
- throw DBALException::notSupported(__METHOD__);
- }
-
- /**
- * Add the number of given months to a date.
- *
- * @param string $date
- * @param int $months
- * @return string
- */
- public function getDateAddMonthExpression($date, $months)
- {
- throw DBALException::notSupported(__METHOD__);
- }
-
- /**
- * Substract the number of given months to a date.
- *
- * @param string $date
- * @param int $months
- * @return string
- */
- public function getDateSubMonthExpression($date, $months)
- {
- throw DBALException::notSupported(__METHOD__);
- }
-
- public function getForUpdateSQL()
- {
- return 'FOR UPDATE';
- }
-
- /**
- * Honors that some SQL vendors such as MsSql use table hints for locking instead of the ANSI SQL FOR UPDATE specification.
- *
- * @param string $fromClause
- * @param int $lockMode
- * @return string
- */
- public function appendLockHint($fromClause, $lockMode)
- {
- return $fromClause;
- }
-
- /**
- * Get the sql snippet to append to any SELECT statement which locks rows in shared read lock.
- *
- * This defaults to the ASNI SQL "FOR UPDATE", which is an exclusive lock (Write). Some database
- * vendors allow to lighten this constraint up to be a real read lock.
- *
- * @return string
- */
- public function getReadLockSQL()
- {
- return $this->getForUpdateSQL();
- }
-
- /**
- * Get the SQL snippet to append to any SELECT statement which obtains an exclusive lock on the rows.
- *
- * The semantics of this lock mode should equal the SELECT .. FOR UPDATE of the ASNI SQL standard.
- *
- * @return string
- */
- public function getWriteLockSQL()
- {
- return $this->getForUpdateSQL();
- }
-
- public function getDropDatabaseSQL($database)
- {
- return 'DROP DATABASE ' . $database;
- }
-
- /**
- * Drop a Table
- *
- * @throws \InvalidArgumentException
- * @param Table|string $table
- * @return string
- */
- public function getDropTableSQL($table)
- {
- if ($table instanceof \Doctrine\DBAL\Schema\Table) {
- $table = $table->getQuotedName($this);
- } else if(!is_string($table)) {
- throw new \InvalidArgumentException('getDropTableSQL() expects $table parameter to be string or \Doctrine\DBAL\Schema\Table.');
- }
-
- return 'DROP TABLE ' . $table;
- }
-
- /**
- * Get SQL to safely drop a temporary table WITHOUT implicitly committing an open transaction.
- *
- * @param Table|string $table
- * @return string
- */
- public function getDropTemporaryTableSQL($table)
- {
- return $this->getDropTableSQL($table);
- }
-
- /**
- * Drop index from a table
- *
- * @param Index|string $name
- * @param string|Table $table
- * @return string
- */
- public function getDropIndexSQL($index, $table=null)
- {
- if($index instanceof \Doctrine\DBAL\Schema\Index) {
- $index = $index->getQuotedName($this);
- } else if(!is_string($index)) {
- throw new \InvalidArgumentException('AbstractPlatform::getDropIndexSQL() expects $index parameter to be string or \Doctrine\DBAL\Schema\Index.');
- }
-
- return 'DROP INDEX ' . $index;
- }
-
- /**
- * Get drop constraint sql
- *
- * @param \Doctrine\DBAL\Schema\Constraint $constraint
- * @param string|Table $table
- * @return string
- */
- public function getDropConstraintSQL($constraint, $table)
- {
- if ($constraint instanceof \Doctrine\DBAL\Schema\Constraint) {
- $constraint = $constraint->getQuotedName($this);
- }
-
- if ($table instanceof \Doctrine\DBAL\Schema\Table) {
- $table = $table->getQuotedName($this);
- }
-
- return 'ALTER TABLE ' . $table . ' DROP CONSTRAINT ' . $constraint;
- }
-
- /**
- * @param ForeignKeyConstraint|string $foreignKey
- * @param Table|string $table
- * @return string
- */
- public function getDropForeignKeySQL($foreignKey, $table)
- {
- if ($foreignKey instanceof \Doctrine\DBAL\Schema\ForeignKeyConstraint) {
- $foreignKey = $foreignKey->getQuotedName($this);
- }
-
- if ($table instanceof \Doctrine\DBAL\Schema\Table) {
- $table = $table->getQuotedName($this);
- }
-
- return 'ALTER TABLE ' . $table . ' DROP FOREIGN KEY ' . $foreignKey;
- }
-
- /**
- * Gets the SQL statement(s) to create a table with the specified name, columns and constraints
- * on this platform.
- *
- * @param string $table The name of the table.
- * @param int $createFlags
- * @return array The sequence of SQL statements.
- */
- public function getCreateTableSQL(Table $table, $createFlags=self::CREATE_INDEXES)
- {
- if ( ! is_int($createFlags)) {
- throw new \InvalidArgumentException("Second argument of AbstractPlatform::getCreateTableSQL() has to be integer.");
- }
-
- if (count($table->getColumns()) == 0) {
- throw DBALException::noColumnsSpecifiedForTable($table->getName());
- }
-
- $tableName = $table->getQuotedName($this);
- $options = $table->getOptions();
- $options['uniqueConstraints'] = array();
- $options['indexes'] = array();
- $options['primary'] = array();
-
- if (($createFlags&self::CREATE_INDEXES) > 0) {
- foreach ($table->getIndexes() AS $index) {
- /* @var $index Index */
- if ($index->isPrimary()) {
- $options['primary'] = $index->getColumns();
- } else {
- $options['indexes'][$index->getName()] = $index;
- }
- }
- }
-
- $columns = array();
- foreach ($table->getColumns() AS $column) {
- /* @var \Doctrine\DBAL\Schema\Column $column */
- $columnData = array();
- $columnData['name'] = $column->getQuotedName($this);
- $columnData['type'] = $column->getType();
- $columnData['length'] = $column->getLength();
- $columnData['notnull'] = $column->getNotNull();
- $columnData['fixed'] = $column->getFixed();
- $columnData['unique'] = false; // TODO: what do we do about this?
- $columnData['version'] = ($column->hasPlatformOption("version"))?$column->getPlatformOption('version'):false;
- if(strtolower($columnData['type']) == "string" && $columnData['length'] === null) {
- $columnData['length'] = 255;
- }
- $columnData['unsigned'] = $column->getUnsigned();
- $columnData['precision'] = $column->getPrecision();
- $columnData['scale'] = $column->getScale();
- $columnData['default'] = $column->getDefault();
- $columnData['columnDefinition'] = $column->getColumnDefinition();
- $columnData['autoincrement'] = $column->getAutoincrement();
- $columnData['comment'] = $this->getColumnComment($column);
-
- if(in_array($column->getName(), $options['primary'])) {
- $columnData['primary'] = true;
- }
-
- $columns[$columnData['name']] = $columnData;
- }
-
- if (($createFlags&self::CREATE_FOREIGNKEYS) > 0) {
- $options['foreignKeys'] = array();
- foreach ($table->getForeignKeys() AS $fkConstraint) {
- $options['foreignKeys'][] = $fkConstraint;
- }
- }
-
- $sql = $this->_getCreateTableSQL($tableName, $columns, $options);
- if ($this->supportsCommentOnStatement()) {
- foreach ($table->getColumns() AS $column) {
- if ($this->getColumnComment($column)) {
- $sql[] = $this->getCommentOnColumnSQL($tableName, $column->getName(), $this->getColumnComment($column));
- }
- }
- }
- return $sql;
- }
-
- public function getCommentOnColumnSQL($tableName, $columnName, $comment)
- {
- return "COMMENT ON COLUMN " . $tableName . "." . $columnName . " IS '" . $comment . "'";
- }
-
- /**
- * @param string $tableName
- * @param array $columns
- * @param array $options
- * @return array
- */
- protected function _getCreateTableSQL($tableName, array $columns, array $options = array())
- {
- $columnListSql = $this->getColumnDeclarationListSQL($columns);
-
- if (isset($options['uniqueConstraints']) && ! empty($options['uniqueConstraints'])) {
- foreach ($options['uniqueConstraints'] as $name => $definition) {
- $columnListSql .= ', ' . $this->getUniqueConstraintDeclarationSQL($name, $definition);
- }
- }
-
- if (isset($options['primary']) && ! empty($options['primary'])) {
- $columnListSql .= ', PRIMARY KEY(' . implode(', ', array_unique(array_values($options['primary']))) . ')';
- }
-
- if (isset($options['indexes']) && ! empty($options['indexes'])) {
- foreach($options['indexes'] as $index => $definition) {
- $columnListSql .= ', ' . $this->getIndexDeclarationSQL($index, $definition);
- }
- }
-
- $query = 'CREATE TABLE ' . $tableName . ' (' . $columnListSql;
-
- $check = $this->getCheckDeclarationSQL($columns);
- if ( ! empty($check)) {
- $query .= ', ' . $check;
- }
- $query .= ')';
-
- $sql[] = $query;
-
- if (isset($options['foreignKeys'])) {
- foreach ((array) $options['foreignKeys'] AS $definition) {
- $sql[] = $this->getCreateForeignKeySQL($definition, $tableName);
- }
- }
-
- return $sql;
- }
-
- public function getCreateTemporaryTableSnippetSQL()
- {
- return "CREATE TEMPORARY TABLE";
- }
-
- /**
- * Gets the SQL to create a sequence on this platform.
- *
- * @param \Doctrine\DBAL\Schema\Sequence $sequence
- * @throws DBALException
- */
- public function getCreateSequenceSQL(\Doctrine\DBAL\Schema\Sequence $sequence)
- {
- throw DBALException::notSupported(__METHOD__);
- }
-
- /**
- * Gets the SQL statement to change a sequence on this platform.
- *
- * @param \Doctrine\DBAL\Schema\Sequence $sequence
- * @return string
- */
- public function getAlterSequenceSQL(\Doctrine\DBAL\Schema\Sequence $sequence)
- {
- throw DBALException::notSupported(__METHOD__);
- }
-
- /**
- * Gets the SQL to create a constraint on a table on this platform.
- *
- * @param Constraint $constraint
- * @param string|Table $table
- * @return string
- */
- public function getCreateConstraintSQL(\Doctrine\DBAL\Schema\Constraint $constraint, $table)
- {
- if ($table instanceof \Doctrine\DBAL\Schema\Table) {
- $table = $table->getQuotedName($this);
- }
-
- $query = 'ALTER TABLE ' . $table . ' ADD CONSTRAINT ' . $constraint->getQuotedName($this);
-
- $columns = array();
- foreach ($constraint->getColumns() as $column) {
- $columns[] = $column;
- }
- $columnList = '('. implode(', ', $columns) . ')';
-
- $referencesClause = '';
- if ($constraint instanceof \Doctrine\DBAL\Schema\Index) {
- if($constraint->isPrimary()) {
- $query .= ' PRIMARY KEY';
- } elseif ($constraint->isUnique()) {
- $query .= ' UNIQUE';
- } else {
- throw new \InvalidArgumentException(
- 'Can only create primary or unique constraints, no common indexes with getCreateConstraintSQL().'
- );
- }
- } else if ($constraint instanceof \Doctrine\DBAL\Schema\ForeignKeyConstraint) {
- $query .= ' FOREIGN KEY';
-
- $foreignColumns = array();
- foreach ($constraint->getForeignColumns() AS $column) {
- $foreignColumns[] = $column;
- }
-
- $referencesClause = ' REFERENCES '.$constraint->getForeignTableName(). ' ('.implode(', ', $foreignColumns).')';
- }
- $query .= ' '.$columnList.$referencesClause;
-
- return $query;
- }
-
- /**
- * Gets the SQL to create an index on a table on this platform.
- *
- * @param Index $index
- * @param string|Table $table name of the table on which the index is to be created
- * @return string
- */
- public function getCreateIndexSQL(Index $index, $table)
- {
- if ($table instanceof Table) {
- $table = $table->getQuotedName($this);
- }
- $name = $index->getQuotedName($this);
- $columns = $index->getColumns();
-
- if (count($columns) == 0) {
- throw new \InvalidArgumentException("Incomplete definition. 'columns' required.");
- }
-
- if ($index->isPrimary()) {
- return $this->getCreatePrimaryKeySQL($index, $table);
- } else {
- $type = '';
- if ($index->isUnique()) {
- $type = 'UNIQUE ';
- }
-
- $query = 'CREATE ' . $type . 'INDEX ' . $name . ' ON ' . $table;
- $query .= ' (' . $this->getIndexFieldDeclarationListSQL($columns) . ')';
- }
-
- return $query;
- }
-
- /**
- * Get SQL to create an unnamed primary key constraint.
- *
- * @param Index $index
- * @param string|Table $table
- * @return string
- */
- public function getCreatePrimaryKeySQL(Index $index, $table)
- {
- return 'ALTER TABLE ' . $table . ' ADD PRIMARY KEY (' . $this->getIndexFieldDeclarationListSQL($index->getColumns()) . ')';
- }
-
- /**
- * Quotes a string so that it can be safely used as a table or column name,
- * even if it is a reserved word of the platform.
- *
- * NOTE: Just because you CAN use quoted identifiers doesn't mean
- * you SHOULD use them. In general, they end up causing way more
- * problems than they solve.
- *
- * @param string $str identifier name to be quoted
- * @return string quoted identifier string
- */
- public function quoteIdentifier($str)
- {
- $c = $this->getIdentifierQuoteCharacter();
-
- return $c . str_replace($c, $c.$c, $str) . $c;
- }
-
- /**
- * Create a new foreign key
- *
- * @param ForeignKeyConstraint $foreignKey ForeignKey instance
- * @param string|Table $table name of the table on which the foreign key is to be created
- * @return string
- */
- public function getCreateForeignKeySQL(ForeignKeyConstraint $foreignKey, $table)
- {
- if ($table instanceof \Doctrine\DBAL\Schema\Table) {
- $table = $table->getQuotedName($this);
- }
-
- $query = 'ALTER TABLE ' . $table . ' ADD ' . $this->getForeignKeyDeclarationSQL($foreignKey);
-
- return $query;
- }
-
- /**
- * Gets the sql statements for altering an existing table.
- *
- * The method returns an array of sql statements, since some platforms need several statements.
- *
- * @param TableDiff $diff
- * @return array
- */
- public function getAlterTableSQL(TableDiff $diff)
- {
- throw DBALException::notSupported(__METHOD__);
- }
-
- protected function getPreAlterTableIndexForeignKeySQL(TableDiff $diff)
- {
- $tableName = $diff->name;
-
- $sql = array();
- if ($this->supportsForeignKeyConstraints()) {
- foreach ($diff->removedForeignKeys AS $foreignKey) {
- $sql[] = $this->getDropForeignKeySQL($foreignKey, $tableName);
- }
- foreach ($diff->changedForeignKeys AS $foreignKey) {
- $sql[] = $this->getDropForeignKeySQL($foreignKey, $tableName);
- }
- }
-
- foreach ($diff->removedIndexes AS $index) {
- $sql[] = $this->getDropIndexSQL($index, $tableName);
- }
- foreach ($diff->changedIndexes AS $index) {
- $sql[] = $this->getDropIndexSQL($index, $tableName);
- }
-
- return $sql;
- }
-
- protected function getPostAlterTableIndexForeignKeySQL(TableDiff $diff)
- {
- if ($diff->newName !== false) {
- $tableName = $diff->newName;
- } else {
- $tableName = $diff->name;
- }
-
- $sql = array();
- if ($this->supportsForeignKeyConstraints()) {
- foreach ($diff->addedForeignKeys AS $foreignKey) {
- $sql[] = $this->getCreateForeignKeySQL($foreignKey, $tableName);
- }
- foreach ($diff->changedForeignKeys AS $foreignKey) {
- $sql[] = $this->getCreateForeignKeySQL($foreignKey, $tableName);
- }
- }
-
- foreach ($diff->addedIndexes AS $index) {
- $sql[] = $this->getCreateIndexSQL($index, $tableName);
- }
- foreach ($diff->changedIndexes AS $index) {
- $sql[] = $this->getCreateIndexSQL($index, $tableName);
- }
-
- return $sql;
- }
-
- /**
- * Common code for alter table statement generation that updates the changed Index and Foreign Key definitions.
- *
- * @param TableDiff $diff
- * @return array
- */
- protected function _getAlterTableIndexForeignKeySQL(TableDiff $diff)
- {
- return array_merge($this->getPreAlterTableIndexForeignKeySQL($diff), $this->getPostAlterTableIndexForeignKeySQL($diff));
- }
-
- /**
- * Get declaration of a number of fields in bulk
- *
- * @param array $fields a multidimensional associative array.
- * The first dimension determines the field name, while the second
- * dimension is keyed with the name of the properties
- * of the field being declared as array indexes. Currently, the types
- * of supported field properties are as follows:
- *
- * length
- * Integer value that determines the maximum length of the text
- * field. If this argument is missing the field should be
- * declared to have the longest length allowed by the DBMS.
- *
- * default
- * Text value to be used as default for this field.
- *
- * notnull
- * Boolean flag that indicates whether this field is constrained
- * to not be set to null.
- * charset
- * Text value with the default CHARACTER SET for this field.
- * collation
- * Text value with the default COLLATION for this field.
- * unique
- * unique constraint
- *
- * @return string
- */
- public function getColumnDeclarationListSQL(array $fields)
- {
- $queryFields = array();
- foreach ($fields as $fieldName => $field) {
- $query = $this->getColumnDeclarationSQL($fieldName, $field);
- $queryFields[] = $query;
- }
- return implode(', ', $queryFields);
- }
-
- /**
- * Obtain DBMS specific SQL code portion needed to declare a generic type
- * field to be used in statements like CREATE TABLE.
- *
- * @param string $name name the field to be declared.
- * @param array $field associative array with the name of the properties
- * of the field being declared as array indexes. Currently, the types
- * of supported field properties are as follows:
- *
- * length
- * Integer value that determines the maximum length of the text
- * field. If this argument is missing the field should be
- * declared to have the longest length allowed by the DBMS.
- *
- * default
- * Text value to be used as default for this field.
- *
- * notnull
- * Boolean flag that indicates whether this field is constrained
- * to not be set to null.
- * charset
- * Text value with the default CHARACTER SET for this field.
- * collation
- * Text value with the default COLLATION for this field.
- * unique
- * unique constraint
- * check
- * column check constraint
- * columnDefinition
- * a string that defines the complete column
- *
- * @return string DBMS specific SQL code portion that should be used to declare the column.
- */
- public function getColumnDeclarationSQL($name, array $field)
- {
- if (isset($field['columnDefinition'])) {
- $columnDef = $this->getCustomTypeDeclarationSQL($field);
- } else {
- $default = $this->getDefaultValueDeclarationSQL($field);
-
- $charset = (isset($field['charset']) && $field['charset']) ?
- ' ' . $this->getColumnCharsetDeclarationSQL($field['charset']) : '';
-
- $collation = (isset($field['collation']) && $field['collation']) ?
- ' ' . $this->getColumnCollationDeclarationSQL($field['collation']) : '';
-
- $notnull = (isset($field['notnull']) && $field['notnull']) ? ' NOT NULL' : '';
-
- $unique = (isset($field['unique']) && $field['unique']) ?
- ' ' . $this->getUniqueFieldDeclarationSQL() : '';
-
- $check = (isset($field['check']) && $field['check']) ?
- ' ' . $field['check'] : '';
-
- $typeDecl = $field['type']->getSqlDeclaration($field, $this);
- $columnDef = $typeDecl . $charset . $default . $notnull . $unique . $check . $collation;
- }
-
- if ($this->supportsInlineColumnComments() && isset($field['comment']) && $field['comment']) {
- $columnDef .= " COMMENT '" . $field['comment'] . "'";
- }
-
- return $name . ' ' . $columnDef;
- }
-
- /**
- * Gets the SQL snippet that declares a floating point column of arbitrary precision.
- *
- * @param array $columnDef
- * @return string
- */
- public function getDecimalTypeDeclarationSQL(array $columnDef)
- {
- $columnDef['precision'] = ( ! isset($columnDef['precision']) || empty($columnDef['precision']))
- ? 10 : $columnDef['precision'];
- $columnDef['scale'] = ( ! isset($columnDef['scale']) || empty($columnDef['scale']))
- ? 0 : $columnDef['scale'];
-
- return 'NUMERIC(' . $columnDef['precision'] . ', ' . $columnDef['scale'] . ')';
- }
-
- /**
- * Obtain DBMS specific SQL code portion needed to set a default value
- * declaration to be used in statements like CREATE TABLE.
- *
- * @param array $field field definition array
- * @return string DBMS specific SQL code portion needed to set a default value
- */
- public function getDefaultValueDeclarationSQL($field)
- {
- $default = empty($field['notnull']) ? ' DEFAULT NULL' : '';
-
- if (isset($field['default'])) {
- $default = " DEFAULT '".$field['default']."'";
- if (isset($field['type'])) {
- if (in_array((string)$field['type'], array("Integer", "BigInteger", "SmallInteger"))) {
- $default = " DEFAULT ".$field['default'];
- } else if ((string)$field['type'] == 'DateTime' && $field['default'] == $this->getCurrentTimestampSQL()) {
- $default = " DEFAULT ".$this->getCurrentTimestampSQL();
- }
- }
- }
- return $default;
- }
-
- /**
- * Obtain DBMS specific SQL code portion needed to set a CHECK constraint
- * declaration to be used in statements like CREATE TABLE.
- *
- * @param array $definition check definition
- * @return string DBMS specific SQL code portion needed to set a CHECK constraint
- */
- public function getCheckDeclarationSQL(array $definition)
- {
- $constraints = array();
- foreach ($definition as $field => $def) {
- if (is_string($def)) {
- $constraints[] = 'CHECK (' . $def . ')';
- } else {
- if (isset($def['min'])) {
- $constraints[] = 'CHECK (' . $field . ' >= ' . $def['min'] . ')';
- }
-
- if (isset($def['max'])) {
- $constraints[] = 'CHECK (' . $field . ' <= ' . $def['max'] . ')';
- }
- }
- }
-
- return implode(', ', $constraints);
- }
-
- /**
- * Obtain DBMS specific SQL code portion needed to set a unique
- * constraint declaration to be used in statements like CREATE TABLE.
- *
- * @param string $name name of the unique constraint
- * @param Index $index index definition
- * @return string DBMS specific SQL code portion needed
- * to set a constraint
- */
- public function getUniqueConstraintDeclarationSQL($name, Index $index)
- {
- if (count($index->getColumns()) == 0) {
- throw \InvalidArgumentException("Incomplete definition. 'columns' required.");
- }
-
- return 'CONSTRAINT ' . $name . ' UNIQUE ('
- . $this->getIndexFieldDeclarationListSQL($index->getColumns())
- . ')';
- }
-
- /**
- * Obtain DBMS specific SQL code portion needed to set an index
- * declaration to be used in statements like CREATE TABLE.
- *
- * @param string $name name of the index
- * @param Index $index index definition
- * @return string DBMS specific SQL code portion needed to set an index
- */
- public function getIndexDeclarationSQL($name, Index $index)
- {
- $type = '';
-
- if($index->isUnique()) {
- $type = 'UNIQUE ';
- }
-
- if (count($index->getColumns()) == 0) {
- throw \InvalidArgumentException("Incomplete definition. 'columns' required.");
- }
-
- return $type . 'INDEX ' . $name . ' ('
- . $this->getIndexFieldDeclarationListSQL($index->getColumns())
- . ')';
- }
-
- /**
- * getCustomTypeDeclarationSql
- * Obtail SQL code portion needed to create a custom column,
- * e.g. when a field has the "columnDefinition" keyword.
- * Only "AUTOINCREMENT" and "PRIMARY KEY" are added if appropriate.
- *
- * @return string
- */
- public function getCustomTypeDeclarationSQL(array $columnDef)
- {
- return $columnDef['columnDefinition'];
- }
-
- /**
- * getIndexFieldDeclarationList
- * Obtain DBMS specific SQL code portion needed to set an index
- * declaration to be used in statements like CREATE TABLE.
- *
- * @return string
- */
- public function getIndexFieldDeclarationListSQL(array $fields)
- {
- $ret = array();
- foreach ($fields as $field => $definition) {
- if (is_array($definition)) {
- $ret[] = $field;
- } else {
- $ret[] = $definition;
- }
- }
- return implode(', ', $ret);
- }
-
- /**
- * A method to return the required SQL string that fits between CREATE ... TABLE
- * to create the table as a temporary table.
- *
- * Should be overridden in driver classes to return the correct string for the
- * specific database type.
- *
- * The default is to return the string "TEMPORARY" - this will result in a
- * SQL error for any database that does not support temporary tables, or that
- * requires a different SQL command from "CREATE TEMPORARY TABLE".
- *
- * @return string The string required to be placed between "CREATE" and "TABLE"
- * to generate a temporary table, if possible.
- */
- public function getTemporaryTableSQL()
- {
- return 'TEMPORARY';
- }
-
- /**
- * Some vendors require temporary table names to be qualified specially.
- *
- * @param string $tableName
- * @return string
- */
- public function getTemporaryTableName($tableName)
- {
- return $tableName;
- }
-
- /**
- * Get sql query to show a list of database.
- *
- * @return string
- */
- public function getShowDatabasesSQL()
- {
- throw DBALException::notSupported(__METHOD__);
- }
-
- /**
- * Obtain DBMS specific SQL code portion needed to set the FOREIGN KEY constraint
- * of a field declaration to be used in statements like CREATE TABLE.
- *
- * @param array $definition an associative array with the following structure:
- * name optional constraint name
- *
- * local the local field(s)
- *
- * foreign the foreign reference field(s)
- *
- * foreignTable the name of the foreign table
- *
- * onDelete referential delete action
- *
- * onUpdate referential update action
- *
- * deferred deferred constraint checking
- *
- * The onDelete and onUpdate keys accept the following values:
- *
- * CASCADE: Delete or update the row from the parent table and automatically delete or
- * update the matching rows in the child table. Both ON DELETE CASCADE and ON UPDATE CASCADE are supported.
- * Between two tables, you should not define several ON UPDATE CASCADE clauses that act on the same column
- * in the parent table or in the child table.
- *
- * SET NULL: Delete or update the row from the parent table and set the foreign key column or columns in the
- * child table to NULL. This is valid only if the foreign key columns do not have the NOT NULL qualifier
- * specified. Both ON DELETE SET NULL and ON UPDATE SET NULL clauses are supported.
- *
- * NO ACTION: In standard SQL, NO ACTION means no action in the sense that an attempt to delete or update a primary
- * key value is not allowed to proceed if there is a related foreign key value in the referenced table.
- *
- * RESTRICT: Rejects the delete or update operation for the parent table. NO ACTION and RESTRICT are the same as
- * omitting the ON DELETE or ON UPDATE clause.
- *
- * SET DEFAULT
- *
- * @return string DBMS specific SQL code portion needed to set the FOREIGN KEY constraint
- * of a field declaration.
- */
- public function getForeignKeyDeclarationSQL(ForeignKeyConstraint $foreignKey)
- {
- $sql = $this->getForeignKeyBaseDeclarationSQL($foreignKey);
- $sql .= $this->getAdvancedForeignKeyOptionsSQL($foreignKey);
-
- return $sql;
- }
-
- /**
- * Return the FOREIGN KEY query section dealing with non-standard options
- * as MATCH, INITIALLY DEFERRED, ON UPDATE, ...
- *
- * @param ForeignKeyConstraint $foreignKey foreign key definition
- * @return string
- */
- public function getAdvancedForeignKeyOptionsSQL(ForeignKeyConstraint $foreignKey)
- {
- $query = '';
- if ($this->supportsForeignKeyOnUpdate() && $foreignKey->hasOption('onUpdate')) {
- $query .= ' ON UPDATE ' . $this->getForeignKeyReferentialActionSQL($foreignKey->getOption('onUpdate'));
- }
- if ($foreignKey->hasOption('onDelete')) {
- $query .= ' ON DELETE ' . $this->getForeignKeyReferentialActionSQL($foreignKey->getOption('onDelete'));
- }
- return $query;
- }
-
- /**
- * returns given referential action in uppercase if valid, otherwise throws
- * an exception
- *
- * @throws Doctrine_Exception_Exception if unknown referential action given
- * @param string $action foreign key referential action
- * @param string foreign key referential action in uppercase
- */
- public function getForeignKeyReferentialActionSQL($action)
- {
- $upper = strtoupper($action);
- switch ($upper) {
- case 'CASCADE':
- case 'SET NULL':
- case 'NO ACTION':
- case 'RESTRICT':
- case 'SET DEFAULT':
- return $upper;
- break;
- default:
- throw new \InvalidArgumentException('Invalid foreign key action: ' . $upper);
- }
- }
-
- /**
- * Obtain DBMS specific SQL code portion needed to set the FOREIGN KEY constraint
- * of a field declaration to be used in statements like CREATE TABLE.
- *
- * @param ForeignKeyConstraint $foreignKey
- * @return string
- */
- public function getForeignKeyBaseDeclarationSQL(ForeignKeyConstraint $foreignKey)
- {
- $sql = '';
- if (strlen($foreignKey->getName())) {
- $sql .= 'CONSTRAINT ' . $foreignKey->getQuotedName($this) . ' ';
- }
- $sql .= 'FOREIGN KEY (';
-
- if (count($foreignKey->getLocalColumns()) == 0) {
- throw new \InvalidArgumentException("Incomplete definition. 'local' required.");
- }
- if (count($foreignKey->getForeignColumns()) == 0) {
- throw new \InvalidArgumentException("Incomplete definition. 'foreign' required.");
- }
- if (strlen($foreignKey->getForeignTableName()) == 0) {
- throw new \InvalidArgumentException("Incomplete definition. 'foreignTable' required.");
- }
-
- $sql .= implode(', ', $foreignKey->getLocalColumns())
- . ') REFERENCES '
- . $foreignKey->getForeignTableName() . '('
- . implode(', ', $foreignKey->getForeignColumns()) . ')';
-
- return $sql;
- }
-
- /**
- * Obtain DBMS specific SQL code portion needed to set the UNIQUE constraint
- * of a field declaration to be used in statements like CREATE TABLE.
- *
- * @return string DBMS specific SQL code portion needed to set the UNIQUE constraint
- * of a field declaration.
- */
- public function getUniqueFieldDeclarationSQL()
- {
- return 'UNIQUE';
- }
-
- /**
- * Obtain DBMS specific SQL code portion needed to set the CHARACTER SET
- * of a field declaration to be used in statements like CREATE TABLE.
- *
- * @param string $charset name of the charset
- * @return string DBMS specific SQL code portion needed to set the CHARACTER SET
- * of a field declaration.
- */
- public function getColumnCharsetDeclarationSQL($charset)
- {
- return '';
- }
-
- /**
- * Obtain DBMS specific SQL code portion needed to set the COLLATION
- * of a field declaration to be used in statements like CREATE TABLE.
- *
- * @param string $collation name of the collation
- * @return string DBMS specific SQL code portion needed to set the COLLATION
- * of a field declaration.
- */
- public function getColumnCollationDeclarationSQL($collation)
- {
- return '';
- }
-
- /**
- * Whether the platform prefers sequences for ID generation.
- * Subclasses should override this method to return TRUE if they prefer sequences.
- *
- * @return boolean
- */
- public function prefersSequences()
- {
- return false;
- }
-
- /**
- * Whether the platform prefers identity columns (eg. autoincrement) for ID generation.
- * Subclasses should override this method to return TRUE if they prefer identity columns.
- *
- * @return boolean
- */
- public function prefersIdentityColumns()
- {
- return false;
- }
-
- /**
- * Some platforms need the boolean values to be converted.
- *
- * The default conversion in this implementation converts to integers (false => 0, true => 1).
- *
- * @param mixed $item
- */
- public function convertBooleans($item)
- {
- if (is_array($item)) {
- foreach ($item as $k => $value) {
- if (is_bool($value)) {
- $item[$k] = (int) $value;
- }
- }
- } else if (is_bool($item)) {
- $item = (int) $item;
- }
- return $item;
- }
-
- /**
- * Gets the SQL statement specific for the platform to set the charset.
- *
- * This function is MySQL specific and required by
- * {@see \Doctrine\DBAL\Connection::setCharset($charset)}
- *
- * @param string $charset
- * @return string
- */
- public function getSetCharsetSQL($charset)
- {
- return "SET NAMES '".$charset."'";
- }
-
- /**
- * Gets the SQL specific for the platform to get the current date.
- *
- * @return string
- */
- public function getCurrentDateSQL()
- {
- return 'CURRENT_DATE';
- }
-
- /**
- * Gets the SQL specific for the platform to get the current time.
- *
- * @return string
- */
- public function getCurrentTimeSQL()
- {
- return 'CURRENT_TIME';
- }
-
- /**
- * Gets the SQL specific for the platform to get the current timestamp
- *
- * @return string
- */
- public function getCurrentTimestampSQL()
- {
- return 'CURRENT_TIMESTAMP';
- }
-
- /**
- * Get sql for transaction isolation level Connection constant
- *
- * @param integer $level
- */
- protected function _getTransactionIsolationLevelSQL($level)
- {
- switch ($level) {
- case Connection::TRANSACTION_READ_UNCOMMITTED:
- return 'READ UNCOMMITTED';
- case Connection::TRANSACTION_READ_COMMITTED:
- return 'READ COMMITTED';
- case Connection::TRANSACTION_REPEATABLE_READ:
- return 'REPEATABLE READ';
- case Connection::TRANSACTION_SERIALIZABLE:
- return 'SERIALIZABLE';
- default:
- throw new \InvalidArgumentException('Invalid isolation level:' . $level);
- }
- }
-
- public function getListDatabasesSQL()
- {
- throw DBALException::notSupported(__METHOD__);
- }
-
- public function getListSequencesSQL($database)
- {
- throw DBALException::notSupported(__METHOD__);
- }
-
- public function getListTableConstraintsSQL($table)
- {
- throw DBALException::notSupported(__METHOD__);
- }
-
- public function getListTableColumnsSQL($table, $database = null)
- {
- throw DBALException::notSupported(__METHOD__);
- }
-
- public function getListTablesSQL()
- {
- throw DBALException::notSupported(__METHOD__);
- }
-
- public function getListUsersSQL()
- {
- throw DBALException::notSupported(__METHOD__);
- }
-
- /**
- * Get the SQL to list all views of a database or user.
- *
- * @param string $database
- * @return string
- */
- public function getListViewsSQL($database)
- {
- throw DBALException::notSupported(__METHOD__);
- }
-
- /**
- * Get the list of indexes for the current database.
- *
- * The current database parameter is optional but will always be passed
- * when using the SchemaManager API and is the database the given table is in.
- *
- * Attention: Some platforms only support currentDatabase when they
- * are connected with that database. Cross-database information schema
- * requests may be impossible.
- *
- * @param string $table
- * @param string $currentDatabase
- */
- public function getListTableIndexesSQL($table, $currentDatabase = null)
- {
- throw DBALException::notSupported(__METHOD__);
- }
-
- public function getListTableForeignKeysSQL($table)
- {
- throw DBALException::notSupported(__METHOD__);
- }
-
- public function getCreateViewSQL($name, $sql)
- {
- throw DBALException::notSupported(__METHOD__);
- }
-
- public function getDropViewSQL($name)
- {
- throw DBALException::notSupported(__METHOD__);
- }
-
- public function getDropSequenceSQL($sequence)
- {
- throw DBALException::notSupported(__METHOD__);
- }
-
- public function getSequenceNextValSQL($sequenceName)
- {
- throw DBALException::notSupported(__METHOD__);
- }
-
- public function getCreateDatabaseSQL($database)
- {
- throw DBALException::notSupported(__METHOD__);
- }
-
- /**
- * Get sql to set the transaction isolation level
- *
- * @param integer $level
- */
- public function getSetTransactionIsolationSQL($level)
- {
- throw DBALException::notSupported(__METHOD__);
- }
-
- /**
- * Obtain DBMS specific SQL to be used to create datetime fields in
- * statements like CREATE TABLE
- *
- * @param array $fieldDeclaration
- * @return string
- */
- public function getDateTimeTypeDeclarationSQL(array $fieldDeclaration)
- {
- throw DBALException::notSupported(__METHOD__);
- }
-
- /**
- * Obtain DBMS specific SQL to be used to create datetime with timezone offset fields.
- *
- * @param array $fieldDeclaration
- */
- public function getDateTimeTzTypeDeclarationSQL(array $fieldDeclaration)
- {
- return $this->getDateTimeTypeDeclarationSQL($fieldDeclaration);
- }
-
-
- /**
- * Obtain DBMS specific SQL to be used to create date fields in statements
- * like CREATE TABLE.
- *
- * @param array $fieldDeclaration
- * @return string
- */
- public function getDateTypeDeclarationSQL(array $fieldDeclaration)
- {
- throw DBALException::notSupported(__METHOD__);
- }
-
- /**
- * Obtain DBMS specific SQL to be used to create time fields in statements
- * like CREATE TABLE.
- *
- * @param array $fieldDeclaration
- * @return string
- */
- public function getTimeTypeDeclarationSQL(array $fieldDeclaration)
- {
- throw DBALException::notSupported(__METHOD__);
- }
-
- public function getFloatDeclarationSQL(array $fieldDeclaration)
- {
- return 'DOUBLE PRECISION';
- }
-
- /**
- * Gets the default transaction isolation level of the platform.
- *
- * @return integer The default isolation level.
- * @see Doctrine\DBAL\Connection\TRANSACTION_* constants.
- */
- public function getDefaultTransactionIsolationLevel()
- {
- return Connection::TRANSACTION_READ_COMMITTED;
- }
-
- /* supports*() metods */
-
- /**
- * Whether the platform supports sequences.
- *
- * @return boolean
- */
- public function supportsSequences()
- {
- return false;
- }
-
- /**
- * Whether the platform supports identity columns.
- * Identity columns are columns that recieve an auto-generated value from the
- * database on insert of a row.
- *
- * @return boolean
- */
- public function supportsIdentityColumns()
- {
- return false;
- }
-
- /**
- * Whether the platform supports indexes.
- *
- * @return boolean
- */
- public function supportsIndexes()
- {
- return true;
- }
-
- public function supportsAlterTable()
- {
- return true;
- }
-
- /**
- * Whether the platform supports transactions.
- *
- * @return boolean
- */
- public function supportsTransactions()
- {
- return true;
- }
-
- /**
- * Whether the platform supports savepoints.
- *
- * @return boolean
- */
- public function supportsSavepoints()
- {
- return true;
- }
-
- /**
- * Whether the platform supports releasing savepoints.
- *
- * @return boolean
- */
- public function supportsReleaseSavepoints()
- {
- return $this->supportsSavepoints();
- }
-
- /**
- * Whether the platform supports primary key constraints.
- *
- * @return boolean
- */
- public function supportsPrimaryConstraints()
- {
- return true;
- }
-
- /**
- * Does the platform supports foreign key constraints?
- *
- * @return boolean
- */
- public function supportsForeignKeyConstraints()
- {
- return true;
- }
-
- /**
- * Does this platform supports onUpdate in foreign key constraints?
- *
- * @return bool
- */
- public function supportsForeignKeyOnUpdate()
- {
- return ($this->supportsForeignKeyConstraints() && true);
- }
-
- /**
- * Whether the platform supports database schemas.
- *
- * @return boolean
- */
- public function supportsSchemas()
- {
- return false;
- }
-
- /**
- * Some databases don't allow to create and drop databases at all or only with certain tools.
- *
- * @return bool
- */
- public function supportsCreateDropDatabase()
- {
- return true;
- }
-
- /**
- * Whether the platform supports getting the affected rows of a recent
- * update/delete type query.
- *
- * @return boolean
- */
- public function supportsGettingAffectedRows()
- {
- return true;
- }
-
- /**
- * Does this plaform support to add inline column comments as postfix.
- *
- * @return bool
- */
- public function supportsInlineColumnComments()
- {
- return false;
- }
-
- /**
- * Does this platform support the propriortary synatx "COMMENT ON asset"
- *
- * @return bool
- */
- public function supportsCommentOnStatement()
- {
- return false;
- }
-
- public function getIdentityColumnNullInsertSQL()
- {
- return "";
- }
-
- /**
- * Gets the format string, as accepted by the date() function, that describes
- * the format of a stored datetime value of this platform.
- *
- * @return string The format string.
- */
- public function getDateTimeFormatString()
- {
- return 'Y-m-d H:i:s';
- }
-
- /**
- * Gets the format string, as accepted by the date() function, that describes
- * the format of a stored datetime with timezone value of this platform.
- *
- * @return string The format string.
- */
- public function getDateTimeTzFormatString()
- {
- return 'Y-m-d H:i:s';
- }
-
- /**
- * Gets the format string, as accepted by the date() function, that describes
- * the format of a stored date value of this platform.
- *
- * @return string The format string.
- */
- public function getDateFormatString()
- {
- return 'Y-m-d';
- }
-
- /**
- * Gets the format string, as accepted by the date() function, that describes
- * the format of a stored time value of this platform.
- *
- * @return string The format string.
- */
- public function getTimeFormatString()
- {
- return 'H:i:s';
- }
-
- /**
- * Modify limit query
- *
- * @param string $query
- * @param int $limit
- * @param int $offset
- * @return string
- */
- final public function modifyLimitQuery($query, $limit, $offset = null)
- {
- if ( $limit !== null) {
- $limit = (int)$limit;
- }
-
- if ( $offset !== null) {
- $offset = (int)$offset;
- }
-
- return $this->doModifyLimitQuery($query, $limit, $offset);
- }
-
- /**
- * @param string $query
- * @param int $limit
- * @param int $offset
- * @return string
- */
- protected function doModifyLimitQuery($query, $limit, $offset)
- {
- if ( $limit !== null) {
- $query .= ' LIMIT ' . $limit;
- }
-
- if ( $offset !== null) {
- $query .= ' OFFSET ' . $offset;
- }
-
- return $query;
- }
-
- /**
- * Gets the character casing of a column in an SQL result set of this platform.
- *
- * @param string $column The column name for which to get the correct character casing.
- * @return string The column name in the character casing used in SQL result sets.
- */
- public function getSQLResultCasing($column)
- {
- return $column;
- }
-
- /**
- * Makes any fixes to a name of a schema element (table, sequence, ...) that are required
- * by restrictions of the platform, like a maximum length.
- *
- * @param string $schemaName
- * @return string
- */
- public function fixSchemaElementName($schemaElementName)
- {
- return $schemaElementName;
- }
-
- /**
- * Maximum length of any given databse identifier, like tables or column names.
- *
- * @return int
- */
- public function getMaxIdentifierLength()
- {
- return 63;
- }
-
- /**
- * Get the insert sql for an empty insert statement
- *
- * @param string $tableName
- * @param string $identifierColumnName
- * @return string $sql
- */
- public function getEmptyIdentityInsertSQL($tableName, $identifierColumnName)
- {
- return 'INSERT INTO ' . $tableName . ' (' . $identifierColumnName . ') VALUES (null)';
- }
-
- /**
- * Generate a Truncate Table SQL statement for a given table.
- *
- * Cascade is not supported on many platforms but would optionally cascade the truncate by
- * following the foreign keys.
- *
- * @param string $tableName
- * @param bool $cascade
- * @return string
- */
- public function getTruncateTableSQL($tableName, $cascade = false)
- {
- return 'TRUNCATE '.$tableName;
- }
-
- /**
- * This is for test reasons, many vendors have special requirements for dummy statements.
- *
- * @return string
- */
- public function getDummySelectSQL()
- {
- return 'SELECT 1';
- }
-
- /**
- * Generate SQL to create a new savepoint
- *
- * @param string $savepoint
- * @return string
- */
- public function createSavePoint($savepoint)
- {
- return 'SAVEPOINT ' . $savepoint;
- }
-
- /**
- * Generate SQL to release a savepoint
- *
- * @param string $savepoint
- * @return string
- */
- public function releaseSavePoint($savepoint)
- {
- return 'RELEASE SAVEPOINT ' . $savepoint;
- }
-
- /**
- * Generate SQL to rollback a savepoint
- *
- * @param string $savepoint
- * @return string
- */
- public function rollbackSavePoint($savepoint)
- {
- return 'ROLLBACK TO SAVEPOINT ' . $savepoint;
- }
-
- /**
- * Return the keyword list instance of this platform.
- *
- * Throws exception if no keyword list is specified.
- *
- * @throws DBALException
- * @return KeywordList
- */
- final public function getReservedKeywordsList()
- {
- $class = $this->getReservedKeywordsClass();
- $keywords = new $class;
- if (!$keywords instanceof \Doctrine\DBAL\Platforms\Keywords\KeywordList) {
- throw DBALException::notSupported(__METHOD__);
- }
- return $keywords;
- }
-
- /**
- * The class name of the reserved keywords list.
- *
- * @return string
- */
- protected function getReservedKeywordsClass()
- {
- throw DBALException::notSupported(__METHOD__);
- }
- }
|