blob: 7ce4e8b00b3b7f7ea2fbf09b4cbbb98271125345 [file] [log] [blame]
Andrey Andreevc5536aa2012-11-01 17:33:58 +02001<?php
Derek Allard2067d1a2008-11-13 22:59:24 +00002/**
3 * CodeIgniter
4 *
Phil Sturgeon07c1ac82012-03-09 17:03:37 +00005 * An open source application development framework for PHP 5.2.4 or newer
Derek Allard2067d1a2008-11-13 22:59:24 +00006 *
Derek Jonesf4a4bd82011-10-20 12:18:42 -05007 * NOTICE OF LICENSE
Andrey Andreev2caf2892012-01-27 00:12:03 +02008 *
Derek Jonesf4a4bd82011-10-20 12:18:42 -05009 * Licensed under the Open Software License version 3.0
Andrey Andreev2caf2892012-01-27 00:12:03 +020010 *
Derek Jonesf4a4bd82011-10-20 12:18:42 -050011 * This source file is subject to the Open Software License (OSL 3.0) that is
12 * bundled with this package in the files license.txt / license.rst. It is
13 * also available through the world wide web at this URL:
14 * http://opensource.org/licenses/OSL-3.0
15 * If you did not receive a copy of the license and are unable to obtain it
16 * through the world wide web, please send an email to
17 * licensing@ellislab.com so we can send you a copy immediately.
18 *
Derek Allard2067d1a2008-11-13 22:59:24 +000019 * @package CodeIgniter
Derek Jonesf4a4bd82011-10-20 12:18:42 -050020 * @author EllisLab Dev Team
Greg Aker0defe5d2012-01-01 18:46:41 -060021 * @copyright Copyright (c) 2008 - 2012, EllisLab, Inc. (http://ellislab.com/)
Derek Jonesf4a4bd82011-10-20 12:18:42 -050022 * @license http://opensource.org/licenses/OSL-3.0 Open Software License (OSL 3.0)
Derek Allard2067d1a2008-11-13 22:59:24 +000023 * @link http://codeigniter.com
24 * @since Version 1.0
25 * @filesource
26 */
Andrey Andreevc5536aa2012-11-01 17:33:58 +020027defined('BASEPATH') OR exit('No direct script access allowed');
Derek Allard2067d1a2008-11-13 22:59:24 +000028
Derek Allard2067d1a2008-11-13 22:59:24 +000029/**
30 * MySQL Forge Class
31 *
32 * @category Database
Derek Jonesf4a4bd82011-10-20 12:18:42 -050033 * @author EllisLab Dev Team
Derek Allard2067d1a2008-11-13 22:59:24 +000034 * @link http://codeigniter.com/user_guide/database/
35 */
36class CI_DB_mysql_forge extends CI_DB_forge {
Barry Mienydd671972010-10-04 16:33:58 +020037
Andrey Andreevc98e93a2012-11-02 02:04:59 +020038 /**
39 * CREATE DATABASE statement
40 *
41 * @var string
42 */
Andrey Andreevd947eba2012-04-09 14:58:28 +030043 protected $_create_database = 'CREATE DATABASE %s CHARACTER SET %s COLLATE %s';
Derek Allard2067d1a2008-11-13 22:59:24 +000044
Andrey Andreevc98e93a2012-11-02 02:04:59 +020045 // --------------------------------------------------------------------
46
Derek Allard2067d1a2008-11-13 22:59:24 +000047 /**
48 * Process Fields
49 *
Andrey Andreevc98e93a2012-11-02 02:04:59 +020050 * @param mixed $fields
Derek Allard2067d1a2008-11-13 22:59:24 +000051 * @return string
52 */
Andrey Andreev820999c2012-03-20 15:15:57 +020053 protected function _process_fields($fields)
Derek Allard2067d1a2008-11-13 22:59:24 +000054 {
55 $current_field_count = 0;
56 $sql = '';
57
Andrey Andreev2caf2892012-01-27 00:12:03 +020058 foreach ($fields as $field => $attributes)
Derek Allard2067d1a2008-11-13 22:59:24 +000059 {
60 // Numeric field names aren't allowed in databases, so if the key is
61 // numeric, we know it was assigned by PHP and the developer manually
62 // entered the field information, so we'll simply add it to the list
63 if (is_numeric($field))
64 {
Andrey Andreev2caf2892012-01-27 00:12:03 +020065 $sql .= "\n\t".$attributes;
Derek Allard2067d1a2008-11-13 22:59:24 +000066 }
67 else
68 {
69 $attributes = array_change_key_case($attributes, CASE_UPPER);
Barry Mienydd671972010-10-04 16:33:58 +020070
Andrey Andreev5ef194d2012-06-08 01:12:54 +030071 $sql .= "\n\t".$this->db->escape_identifiers($field);
72
Phil Sturgeone389b0e2012-06-14 17:37:18 -050073 empty($attributes['NAME']) OR $sql .= ' '.$this->db->escape_identifiers($attributes['NAME']).' ';
Derek Allard2067d1a2008-11-13 22:59:24 +000074
Andrey Andreev2caf2892012-01-27 00:12:03 +020075 if ( ! empty($attributes['TYPE']))
Derek Allard2067d1a2008-11-13 22:59:24 +000076 {
Derek Jones37f4b9c2011-07-01 17:56:50 -050077 $sql .= ' '.$attributes['TYPE'];
Barry Mienydd671972010-10-04 16:33:58 +020078
Andrey Andreev2caf2892012-01-27 00:12:03 +020079 if ( ! empty($attributes['CONSTRAINT']))
Phil Sturgeon27324cd2011-01-05 16:32:57 +000080 {
Andrey Andreev2caf2892012-01-27 00:12:03 +020081 switch (strtolower($attributes['TYPE']))
Phil Sturgeon27324cd2011-01-05 16:32:57 +000082 {
83 case 'decimal':
84 case 'float':
85 case 'numeric':
86 $sql .= '('.implode(',', $attributes['CONSTRAINT']).')';
Andrey Andreev2caf2892012-01-27 00:12:03 +020087 break;
Phil Sturgeon27324cd2011-01-05 16:32:57 +000088 case 'enum':
89 case 'set':
90 $sql .= '("'.implode('","', $attributes['CONSTRAINT']).'")';
Andrey Andreev2caf2892012-01-27 00:12:03 +020091 break;
Phil Sturgeon27324cd2011-01-05 16:32:57 +000092 default:
93 $sql .= '('.$attributes['CONSTRAINT'].')';
94 }
95 }
Derek Allard2067d1a2008-11-13 22:59:24 +000096 }
Barry Mienydd671972010-10-04 16:33:58 +020097
Andrey Andreev5ef194d2012-06-08 01:12:54 +030098 if ( ! empty($attributes['UNSIGNED']) && $attributes['UNSIGNED'] === TRUE)
99 {
100 $sql .= ' UNSIGNED';
101 }
102
103 if (isset($attributes['DEFAULT']))
104 {
105 $sql .= " DEFAULT '".$attributes['DEFAULT']."'";
106 }
107
108 $sql .= ( ! empty($attributes['NULL']) && $attributes['NULL'] === TRUE)
109 ? ' NULL' : ' NOT NULL';
110
111 if ( ! empty($attributes['AUTO_INCREMENT']) && $attributes['AUTO_INCREMENT'] === TRUE)
112 {
113 $sql .= ' AUTO_INCREMENT';
114 }
Derek Allard2067d1a2008-11-13 22:59:24 +0000115 }
Barry Mienydd671972010-10-04 16:33:58 +0200116
Derek Allard2067d1a2008-11-13 22:59:24 +0000117 // don't add a comma on the end of the last field
118 if (++$current_field_count < count($fields))
119 {
120 $sql .= ',';
121 }
122 }
Barry Mienydd671972010-10-04 16:33:58 +0200123
Derek Allard2067d1a2008-11-13 22:59:24 +0000124 return $sql;
125 }
126
127 // --------------------------------------------------------------------
128
129 /**
130 * Create Table
131 *
Derek Allard2067d1a2008-11-13 22:59:24 +0000132 * @param string the table name
133 * @param mixed the fields
134 * @param mixed primary key(s)
135 * @param mixed key(s)
Andrey Andreev2caf2892012-01-27 00:12:03 +0200136 * @param bool should 'IF NOT EXISTS' be added to the SQL
Derek Allard2067d1a2008-11-13 22:59:24 +0000137 * @return bool
138 */
Andrey Andreeva0d4e412012-04-09 15:06:40 +0300139 protected function _create_table($table, $fields, $primary_keys, $keys, $if_not_exists)
Derek Allard2067d1a2008-11-13 22:59:24 +0000140 {
141 $sql = 'CREATE TABLE ';
Barry Mienydd671972010-10-04 16:33:58 +0200142
Derek Allard2067d1a2008-11-13 22:59:24 +0000143 if ($if_not_exists === TRUE)
144 {
145 $sql .= 'IF NOT EXISTS ';
146 }
Barry Mienydd671972010-10-04 16:33:58 +0200147
Andrey Andreev5ef194d2012-06-08 01:12:54 +0300148 $sql .= $this->db->escape_identifiers($table).' ('.$this->_process_fields($fields);
Derek Allard2067d1a2008-11-13 22:59:24 +0000149
150 if (count($primary_keys) > 0)
151 {
Andrey Andreev5ef194d2012-06-08 01:12:54 +0300152 $key_name = $this->db->escape_identifiers(implode('_', $primary_keys));
Andrey Andreev9637b402012-06-08 15:39:24 +0300153 $sql .= ",\n\tPRIMARY KEY ".$key_name.' ('.implode(', ', $this->db->escape_identifiers($primary_keys)).')';
Derek Allard2067d1a2008-11-13 22:59:24 +0000154 }
155
156 if (is_array($keys) && count($keys) > 0)
157 {
158 foreach ($keys as $key)
159 {
160 if (is_array($key))
161 {
Andrey Andreev5ef194d2012-06-08 01:12:54 +0300162 $key_name = $this->db->escape_identifiers(implode('_', $key));
Andrey Andreev9637b402012-06-08 15:39:24 +0300163 $key = $this->db->escape_identifiers($key);
Derek Allard2067d1a2008-11-13 22:59:24 +0000164 }
165 else
166 {
Andrey Andreev5ef194d2012-06-08 01:12:54 +0300167 $key_name = $this->db->escape_identifiers($key);
Derek Allard2067d1a2008-11-13 22:59:24 +0000168 $key = array($key_name);
169 }
Barry Mienydd671972010-10-04 16:33:58 +0200170
Andrey Andreev2caf2892012-01-27 00:12:03 +0200171 $sql .= ",\n\tKEY ".$key_name.' ('.implode(', ', $key).')';
Derek Allard2067d1a2008-11-13 22:59:24 +0000172 }
173 }
174
Andrey Andreev2caf2892012-01-27 00:12:03 +0200175 return $sql."\n) DEFAULT CHARACTER SET ".$this->db->char_set.' COLLATE '.$this->db->dbcollat.';';
Derek Allard2067d1a2008-11-13 22:59:24 +0000176 }
177
178 // --------------------------------------------------------------------
179
180 /**
Derek Allard2067d1a2008-11-13 22:59:24 +0000181 * Alter table query
182 *
183 * Generates a platform-specific query so that a table can be altered
Andrey Andreev2caf2892012-01-27 00:12:03 +0200184 * Called by add_column(), drop_column() and column_alter()
Derek Allard2067d1a2008-11-13 22:59:24 +0000185 *
Derek Allard2067d1a2008-11-13 22:59:24 +0000186 * @param string the ALTER type (ADD, DROP, CHANGE)
187 * @param string the column name
188 * @param array fields
189 * @param string the field after which we should add the new field
Andrey Andreev2caf2892012-01-27 00:12:03 +0200190 * @return string
Derek Allard2067d1a2008-11-13 22:59:24 +0000191 */
Andrey Andreeva0d4e412012-04-09 15:06:40 +0300192 protected function _alter_table($alter_type, $table, $fields, $after_field = '')
Derek Allard2067d1a2008-11-13 22:59:24 +0000193 {
Andrey Andreev5ef194d2012-06-08 01:12:54 +0300194 $sql = 'ALTER TABLE '.$this->db->escape_identifiers($table).' '.$alter_type.' ';
Derek Allard2067d1a2008-11-13 22:59:24 +0000195
196 // DROP has everything it needs now.
Andrey Andreev2caf2892012-01-27 00:12:03 +0200197 if ($alter_type === 'DROP')
Derek Allard2067d1a2008-11-13 22:59:24 +0000198 {
Andrey Andreev5ef194d2012-06-08 01:12:54 +0300199 return $sql.$this->db->escape_identifiers($fields);
Derek Allard2067d1a2008-11-13 22:59:24 +0000200 }
201
Andrey Andreev2caf2892012-01-27 00:12:03 +0200202 return $sql.$this->_process_fields($fields)
Andrey Andreev5ef194d2012-06-08 01:12:54 +0300203 .($after_field !== '' ? ' AFTER '.$this->db->escape_identifiers($after_field) : '');
Derek Allard2067d1a2008-11-13 22:59:24 +0000204 }
205
Derek Allard2067d1a2008-11-13 22:59:24 +0000206}
207
208/* End of file mysql_forge.php */
Timothy Warren215890b2012-03-20 09:38:16 -0400209/* Location: ./system/database/drivers/mysql/mysql_forge.php */