/station-games/vendor/cakephp/cakephp/src/Database/Schema/SqliteSchema.php
PHP | 451 lines | 325 code | 40 blank | 86 comment | 46 complexity | 25e6948cb7448fa55879407310064ec2 MD5 | raw file
- <?php
- /**
- * CakePHP(tm) : Rapid Development Framework (http://cakephp.org)
- * Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
- *
- * Licensed under The MIT License
- * For full copyright and license information, please see the LICENSE.txt
- * Redistributions of files must retain the above copyright notice.
- *
- * @copyright Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
- * @link http://cakephp.org CakePHP(tm) Project
- * @since 3.0.0
- * @license http://www.opensource.org/licenses/mit-license.php MIT License
- */
- namespace Cake\Database\Schema;
- use Cake\Database\Exception;
- /**
- * Schema management/reflection features for Sqlite
- */
- class SqliteSchema extends BaseSchema
- {
- /**
- * Array containing the foreign keys constraints names
- * Necessary for composite foreign keys to be handled
- *
- * @var array
- */
- protected $_constraintsIdMap = [];
- /**
- * Convert a column definition to the abstract types.
- *
- * The returned type will be a type that
- * Cake\Database\Type can handle.
- *
- * @param string $column The column type + length
- * @throws \Cake\Database\Exception when unable to parse column type
- * @return array Array of column information.
- */
- protected function _convertColumn($column)
- {
- preg_match('/(unsigned)?\s*([a-z]+)(?:\(([0-9,]+)\))?/i', $column, $matches);
- if (empty($matches)) {
- throw new Exception(sprintf('Unable to parse column type from "%s"', $column));
- }
- $unsigned = false;
- if (strtolower($matches[1]) === 'unsigned') {
- $unsigned = true;
- }
- $col = strtolower($matches[2]);
- $length = null;
- if (isset($matches[3])) {
- $length = (int)$matches[3];
- }
- if ($col === 'bigint') {
- return ['type' => 'biginteger', 'length' => $length, 'unsigned' => $unsigned];
- }
- if (strpos($col, 'decimal') !== false) {
- return ['type' => 'decimal', 'length' => null, 'unsigned' => $unsigned];
- }
- if (strpos($col, 'int') !== false) {
- return ['type' => 'integer', 'length' => $length, 'unsigned' => $unsigned];
- }
- if (in_array($col, ['float', 'real', 'double'])) {
- return ['type' => 'float', 'length' => null, 'unsigned' => $unsigned];
- }
- if (strpos($col, 'boolean') !== false) {
- return ['type' => 'boolean', 'length' => null];
- }
- if ($col === 'char' && $length === 36) {
- return ['type' => 'uuid', 'length' => null];
- }
- if ($col === 'char') {
- return ['type' => 'string', 'fixed' => true, 'length' => $length];
- }
- if (strpos($col, 'char') !== false) {
- return ['type' => 'string', 'length' => $length];
- }
- if (in_array($col, ['blob', 'clob'])) {
- return ['type' => 'binary', 'length' => null];
- }
- if (in_array($col, ['date', 'time', 'timestamp', 'datetime'])) {
- return ['type' => $col, 'length' => null];
- }
- return ['type' => 'text', 'length' => null];
- }
- /**
- * {@inheritDoc}
- */
- public function listTablesSql($config)
- {
- return [
- 'SELECT name FROM sqlite_master WHERE type="table" ' .
- 'AND name != "sqlite_sequence" ORDER BY name',
- []
- ];
- }
- /**
- * {@inheritDoc}
- */
- public function describeColumnSql($tableName, $config)
- {
- $sql = sprintf(
- 'PRAGMA table_info(%s)',
- $this->_driver->quoteIdentifier($tableName)
- );
- return [$sql, []];
- }
- /**
- * {@inheritDoc}
- */
- public function convertColumnDescription(Table $table, $row)
- {
- $field = $this->_convertColumn($row['type']);
- $field += [
- 'null' => !$row['notnull'],
- 'default' => $row['dflt_value'] === null ? null : trim($row['dflt_value'], "'"),
- ];
- $primary = $table->constraint('primary');
- if ($row['pk'] && empty($primary)) {
- $field['null'] = false;
- $field['autoIncrement'] = true;
- }
- // SQLite does not support autoincrement on composite keys.
- if ($row['pk'] && !empty($primary)) {
- $existingColumn = $primary['columns'][0];
- $table->addColumn($existingColumn, ['autoIncrement' => null] + $table->column($existingColumn));
- }
- $table->addColumn($row['name'], $field);
- if ($row['pk']) {
- $constraint = (array)$table->constraint('primary') + [
- 'type' => Table::CONSTRAINT_PRIMARY,
- 'columns' => []
- ];
- $constraint['columns'] = array_merge($constraint['columns'], [$row['name']]);
- $table->addConstraint('primary', $constraint);
- }
- }
- /**
- * {@inheritDoc}
- */
- public function describeIndexSql($tableName, $config)
- {
- $sql = sprintf(
- 'PRAGMA index_list(%s)',
- $this->_driver->quoteIdentifier($tableName)
- );
- return [$sql, []];
- }
- /**
- * {@inheritDoc}
- *
- * Since SQLite does not have a way to get metadata about all indexes at once,
- * additional queries are done here. Sqlite constraint names are not
- * stable, and the names for constraints will not match those used to create
- * the table. This is a limitation in Sqlite's metadata features.
- *
- */
- public function convertIndexDescription(Table $table, $row)
- {
- $sql = sprintf(
- 'PRAGMA index_info(%s)',
- $this->_driver->quoteIdentifier($row['name'])
- );
- $statement = $this->_driver->prepare($sql);
- $statement->execute();
- $columns = [];
- foreach ($statement->fetchAll('assoc') as $column) {
- $columns[] = $column['name'];
- }
- $statement->closeCursor();
- if ($row['unique']) {
- $table->addConstraint($row['name'], [
- 'type' => Table::CONSTRAINT_UNIQUE,
- 'columns' => $columns
- ]);
- } else {
- $table->addIndex($row['name'], [
- 'type' => Table::INDEX_INDEX,
- 'columns' => $columns
- ]);
- }
- }
- /**
- * {@inheritDoc}
- */
- public function describeForeignKeySql($tableName, $config)
- {
- $sql = sprintf('PRAGMA foreign_key_list(%s)', $this->_driver->quoteIdentifier($tableName));
- return [$sql, []];
- }
- /**
- * {@inheritDoc}
- */
- public function convertForeignKeyDescription(Table $table, $row)
- {
- $name = $row['from'] . '_fk';
- $update = isset($row['on_update']) ? $row['on_update'] : '';
- $delete = isset($row['on_delete']) ? $row['on_delete'] : '';
- $data = [
- 'type' => Table::CONSTRAINT_FOREIGN,
- 'columns' => [$row['from']],
- 'references' => [$row['table'], $row['to']],
- 'update' => $this->_convertOnClause($update),
- 'delete' => $this->_convertOnClause($delete),
- ];
- if (isset($this->_constraintsIdMap[$table->name()][$row['id']])) {
- $name = $this->_constraintsIdMap[$table->name()][$row['id']];
- } else {
- $this->_constraintsIdMap[$table->name()][$row['id']] = $name;
- }
- $table->addConstraint($name, $data);
- }
- /**
- * {@inheritDoc}
- *
- * @throws \Cake\Database\Exception when the column type is unknown
- */
- public function columnSql(Table $table, $name)
- {
- $data = $table->column($name);
- $typeMap = [
- 'uuid' => ' CHAR(36)',
- 'biginteger' => ' BIGINT',
- 'boolean' => ' BOOLEAN',
- 'binary' => ' BLOB',
- 'float' => ' FLOAT',
- 'decimal' => ' DECIMAL',
- 'date' => ' DATE',
- 'time' => ' TIME',
- 'datetime' => ' DATETIME',
- 'timestamp' => ' TIMESTAMP',
- ];
- $out = $this->_driver->quoteIdentifier($name);
- $hasUnsigned = ['biginteger', 'integer', 'float', 'decimal'];
- if (in_array($data['type'], $hasUnsigned, true) &&
- isset($data['unsigned']) && $data['unsigned'] === true
- ) {
- if ($data['type'] !== 'integer' || [$name] !== (array)$table->primaryKey()) {
- $out .= ' UNSIGNED';
- }
- }
- if (isset($typeMap[$data['type']])) {
- $out .= $typeMap[$data['type']];
- }
- if ($data['type'] === 'text' && $data['length'] !== Table::LENGTH_TINY) {
- $out .= ' TEXT';
- }
- if ($data['type'] === 'string' || ($data['type'] === 'text' && $data['length'] === Table::LENGTH_TINY)) {
- $out .= ' VARCHAR';
- if (isset($data['length'])) {
- $out .= '(' . (int)$data['length'] . ')';
- }
- }
- if ($data['type'] === 'integer') {
- $out .= ' INTEGER';
- if (isset($data['length']) && [$name] !== (array)$table->primaryKey()) {
- $out .= '(' . (int)$data['length'] . ')';
- }
- }
- $hasPrecision = ['float', 'decimal'];
- if (in_array($data['type'], $hasPrecision, true) &&
- (isset($data['length']) || isset($data['precision']))
- ) {
- $out .= '(' . (int)$data['length'] . ',' . (int)$data['precision'] . ')';
- }
- if (isset($data['null']) && $data['null'] === false) {
- $out .= ' NOT NULL';
- }
- if ($data['type'] === 'integer' && [$name] === (array)$table->primaryKey()) {
- $out .= ' PRIMARY KEY AUTOINCREMENT';
- }
- if (isset($data['null']) && $data['null'] === true) {
- $out .= ' DEFAULT NULL';
- unset($data['default']);
- }
- if (isset($data['default'])) {
- $out .= ' DEFAULT ' . $this->_driver->schemaValue($data['default']);
- }
- return $out;
- }
- /**
- * {@inheritDoc}
- *
- * Note integer primary keys will return ''. This is intentional as Sqlite requires
- * that integer primary keys be defined in the column definition.
- *
- */
- public function constraintSql(Table $table, $name)
- {
- $data = $table->constraint($name);
- if ($data['type'] === Table::CONSTRAINT_PRIMARY &&
- count($data['columns']) === 1 &&
- $table->column($data['columns'][0])['type'] === 'integer'
- ) {
- return '';
- }
- $clause = '';
- if ($data['type'] === Table::CONSTRAINT_PRIMARY) {
- $type = 'PRIMARY KEY';
- }
- if ($data['type'] === Table::CONSTRAINT_UNIQUE) {
- $type = 'UNIQUE';
- }
- if ($data['type'] === Table::CONSTRAINT_FOREIGN) {
- $type = 'FOREIGN KEY';
- $clause = sprintf(
- ' REFERENCES %s (%s) ON UPDATE %s ON DELETE %s',
- $this->_driver->quoteIdentifier($data['references'][0]),
- $this->_convertConstraintColumns($data['references'][1]),
- $this->_foreignOnClause($data['update']),
- $this->_foreignOnClause($data['delete'])
- );
- }
- $columns = array_map(
- [$this->_driver, 'quoteIdentifier'],
- $data['columns']
- );
- return sprintf(
- 'CONSTRAINT %s %s (%s)%s',
- $this->_driver->quoteIdentifier($name),
- $type,
- implode(', ', $columns),
- $clause
- );
- }
- /**
- * {@inheritDoc}
- *
- * SQLite can not properly handle adding a constraint to an existing table.
- * This method is no-op
- */
- public function addConstraintSql(Table $table)
- {
- return [];
- }
- /**
- * {@inheritDoc}
- *
- * SQLite can not properly handle dropping a constraint to an existing table.
- * This method is no-op
- */
- public function dropConstraintSql(Table $table)
- {
- return [];
- }
- /**
- * {@inheritDoc}
- */
- public function indexSql(Table $table, $name)
- {
- $data = $table->index($name);
- $columns = array_map(
- [$this->_driver, 'quoteIdentifier'],
- $data['columns']
- );
- return sprintf(
- 'CREATE INDEX %s ON %s (%s)',
- $this->_driver->quoteIdentifier($name),
- $this->_driver->quoteIdentifier($table->name()),
- implode(', ', $columns)
- );
- }
- /**
- * {@inheritDoc}
- */
- public function createTableSql(Table $table, $columns, $constraints, $indexes)
- {
- $lines = array_merge($columns, $constraints);
- $content = implode(",\n", array_filter($lines));
- $temporary = $table->temporary() ? ' TEMPORARY ' : ' ';
- $table = sprintf("CREATE%sTABLE \"%s\" (\n%s\n)", $temporary, $table->name(), $content);
- $out = [$table];
- foreach ($indexes as $index) {
- $out[] = $index;
- }
- return $out;
- }
- /**
- * {@inheritDoc}
- */
- public function truncateTableSql(Table $table)
- {
- $name = $table->name();
- $sql = [];
- if ($this->hasSequences()) {
- $sql[] = sprintf('DELETE FROM sqlite_sequence WHERE name="%s"', $name);
- }
- $sql[] = sprintf('DELETE FROM "%s"', $name);
- return $sql;
- }
- /**
- * Returns whether there is any table in this connection to SQLite containing
- * sequences
- *
- * @return bool
- */
- public function hasSequences()
- {
- $result = $this->_driver
- ->prepare('SELECT 1 FROM sqlite_master WHERE name = "sqlite_sequence"');
- $result->execute();
- $this->_hasSequences = (bool)$result->rowCount();
- $result->closeCursor();
- return $this->_hasSequences;
- }
- }