blob: d3107134e5ce4e1955c9d0c07ac673220de88f19 [file] [log] [blame]
Andrey Andreev2caf2892012-01-27 00:12:03 +02001<?php if ( ! defined('BASEPATH')) exit('No direct script access allowed');
Derek Allard2067d1a2008-11-13 22:59:24 +00002/**
3 * CodeIgniter
4 *
Greg Aker741de1c2010-11-10 14:52:57 -06005 * An open source application development framework for PHP 5.1.6 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 */
27
Derek Allard2067d1a2008-11-13 22:59:24 +000028/**
29 * MySQL Forge Class
30 *
31 * @category Database
Derek Jonesf4a4bd82011-10-20 12:18:42 -050032 * @author EllisLab Dev Team
Derek Allard2067d1a2008-11-13 22:59:24 +000033 * @link http://codeigniter.com/user_guide/database/
34 */
35class CI_DB_mysql_forge extends CI_DB_forge {
Barry Mienydd671972010-10-04 16:33:58 +020036
Derek Allard2067d1a2008-11-13 22:59:24 +000037 /**
38 * Create database
39 *
Derek Allard2067d1a2008-11-13 22:59:24 +000040 * @param string the database name
Andrey Andreev2caf2892012-01-27 00:12:03 +020041 * @return string
Derek Allard2067d1a2008-11-13 22:59:24 +000042 */
Andrey Andreev2caf2892012-01-27 00:12:03 +020043 public function _create_database($name)
Derek Allard2067d1a2008-11-13 22:59:24 +000044 {
Andrey Andreev2caf2892012-01-27 00:12:03 +020045 return 'CREATE DATABASE '.$name;
Derek Allard2067d1a2008-11-13 22:59:24 +000046 }
47
48 // --------------------------------------------------------------------
49
50 /**
51 * Drop database
52 *
Derek Allard2067d1a2008-11-13 22:59:24 +000053 * @param string the database name
Andrey Andreev2caf2892012-01-27 00:12:03 +020054 * @return string
Derek Allard2067d1a2008-11-13 22:59:24 +000055 */
Andrey Andreev2caf2892012-01-27 00:12:03 +020056 public function _drop_database($name)
Derek Allard2067d1a2008-11-13 22:59:24 +000057 {
Andrey Andreev2caf2892012-01-27 00:12:03 +020058 return 'DROP DATABASE '.$name;
Derek Allard2067d1a2008-11-13 22:59:24 +000059 }
60
61 // --------------------------------------------------------------------
62
63 /**
64 * Process Fields
65 *
Derek Allard2067d1a2008-11-13 22:59:24 +000066 * @param mixed the fields
67 * @return string
68 */
Andrey Andreev2caf2892012-01-27 00:12:03 +020069 private function _process_fields($fields)
Derek Allard2067d1a2008-11-13 22:59:24 +000070 {
71 $current_field_count = 0;
72 $sql = '';
73
Andrey Andreev2caf2892012-01-27 00:12:03 +020074 foreach ($fields as $field => $attributes)
Derek Allard2067d1a2008-11-13 22:59:24 +000075 {
76 // Numeric field names aren't allowed in databases, so if the key is
77 // numeric, we know it was assigned by PHP and the developer manually
78 // entered the field information, so we'll simply add it to the list
79 if (is_numeric($field))
80 {
Andrey Andreev2caf2892012-01-27 00:12:03 +020081 $sql .= "\n\t".$attributes;
Derek Allard2067d1a2008-11-13 22:59:24 +000082 }
83 else
84 {
85 $attributes = array_change_key_case($attributes, CASE_UPPER);
Barry Mienydd671972010-10-04 16:33:58 +020086
Andrey Andreev2caf2892012-01-27 00:12:03 +020087 $sql .= "\n\t".$this->db->protect_identifiers($field)
88 .( ! empty($attributes['NAME']) ? ' '.$this->db->protect_identifiers($attributes['NAME']).' ' : '');
Derek Allard2067d1a2008-11-13 22:59:24 +000089
Andrey Andreev2caf2892012-01-27 00:12:03 +020090 if ( ! empty($attributes['TYPE']))
Derek Allard2067d1a2008-11-13 22:59:24 +000091 {
Derek Jones37f4b9c2011-07-01 17:56:50 -050092 $sql .= ' '.$attributes['TYPE'];
Barry Mienydd671972010-10-04 16:33:58 +020093
Andrey Andreev2caf2892012-01-27 00:12:03 +020094 if ( ! empty($attributes['CONSTRAINT']))
Phil Sturgeon27324cd2011-01-05 16:32:57 +000095 {
Andrey Andreev2caf2892012-01-27 00:12:03 +020096 switch (strtolower($attributes['TYPE']))
Phil Sturgeon27324cd2011-01-05 16:32:57 +000097 {
98 case 'decimal':
99 case 'float':
100 case 'numeric':
101 $sql .= '('.implode(',', $attributes['CONSTRAINT']).')';
Andrey Andreev2caf2892012-01-27 00:12:03 +0200102 break;
Phil Sturgeon27324cd2011-01-05 16:32:57 +0000103 case 'enum':
104 case 'set':
105 $sql .= '("'.implode('","', $attributes['CONSTRAINT']).'")';
Andrey Andreev2caf2892012-01-27 00:12:03 +0200106 break;
Phil Sturgeon27324cd2011-01-05 16:32:57 +0000107 default:
108 $sql .= '('.$attributes['CONSTRAINT'].')';
109 }
110 }
Derek Allard2067d1a2008-11-13 22:59:24 +0000111 }
Barry Mienydd671972010-10-04 16:33:58 +0200112
Andrey Andreev2caf2892012-01-27 00:12:03 +0200113 $sql .= (( ! empty($attributes['UNSIGNED']) && $attributes['UNSIGNED'] === TRUE) ? ' UNSIGNED' : '')
114 .(isset($attributes['DEFAULT']) ? " DEFAULT '".$attributes['DEFAULT']."'" : '')
115 .(( ! empty($attributes['NULL']) && $attributes['NULL'] === TRUE) ? ' NULL' : ' NOT NULL')
116 .(( ! empty($attributes['AUTO_INCREMENT']) && $attributes['AUTO_INCREMENT'] === TRUE) ? ' AUTO_INCREMENT' : '');
Derek Allard2067d1a2008-11-13 22:59:24 +0000117 }
Barry Mienydd671972010-10-04 16:33:58 +0200118
Derek Allard2067d1a2008-11-13 22:59:24 +0000119 // don't add a comma on the end of the last field
120 if (++$current_field_count < count($fields))
121 {
122 $sql .= ',';
123 }
124 }
Barry Mienydd671972010-10-04 16:33:58 +0200125
Derek Allard2067d1a2008-11-13 22:59:24 +0000126 return $sql;
127 }
128
129 // --------------------------------------------------------------------
130
131 /**
132 * Create Table
133 *
Derek Allard2067d1a2008-11-13 22:59:24 +0000134 * @param string the table name
135 * @param mixed the fields
136 * @param mixed primary key(s)
137 * @param mixed key(s)
Andrey Andreev2caf2892012-01-27 00:12:03 +0200138 * @param bool should 'IF NOT EXISTS' be added to the SQL
Derek Allard2067d1a2008-11-13 22:59:24 +0000139 * @return bool
140 */
Andrey Andreev2caf2892012-01-27 00:12:03 +0200141 public function _create_table($table, $fields, $primary_keys, $keys, $if_not_exists)
Derek Allard2067d1a2008-11-13 22:59:24 +0000142 {
143 $sql = 'CREATE TABLE ';
Barry Mienydd671972010-10-04 16:33:58 +0200144
Derek Allard2067d1a2008-11-13 22:59:24 +0000145 if ($if_not_exists === TRUE)
146 {
147 $sql .= 'IF NOT EXISTS ';
148 }
Barry Mienydd671972010-10-04 16:33:58 +0200149
Andrey Andreev2caf2892012-01-27 00:12:03 +0200150 $sql .= $this->db->_escape_identifiers($table).' ('.$this->_process_fields($fields);
Derek Allard2067d1a2008-11-13 22:59:24 +0000151
152 if (count($primary_keys) > 0)
153 {
154 $key_name = $this->db->_protect_identifiers(implode('_', $primary_keys));
Andrey Andreev2caf2892012-01-27 00:12:03 +0200155 $sql .= ",\n\tPRIMARY KEY ".$key_name.' ('.implode(', ', $this->db->protect_identifiers($primary_keys)).')';
Derek Allard2067d1a2008-11-13 22:59:24 +0000156 }
157
158 if (is_array($keys) && count($keys) > 0)
159 {
160 foreach ($keys as $key)
161 {
162 if (is_array($key))
163 {
164 $key_name = $this->db->_protect_identifiers(implode('_', $key));
Barry Mienydd671972010-10-04 16:33:58 +0200165 $key = $this->db->_protect_identifiers($key);
Derek Allard2067d1a2008-11-13 22:59:24 +0000166 }
167 else
168 {
169 $key_name = $this->db->_protect_identifiers($key);
170 $key = array($key_name);
171 }
Barry Mienydd671972010-10-04 16:33:58 +0200172
Andrey Andreev2caf2892012-01-27 00:12:03 +0200173 $sql .= ",\n\tKEY ".$key_name.' ('.implode(', ', $key).')';
Derek Allard2067d1a2008-11-13 22:59:24 +0000174 }
175 }
176
Andrey Andreev2caf2892012-01-27 00:12:03 +0200177 return $sql."\n) DEFAULT CHARACTER SET ".$this->db->char_set.' COLLATE '.$this->db->dbcollat.';';
Derek Allard2067d1a2008-11-13 22:59:24 +0000178 }
179
180 // --------------------------------------------------------------------
181
182 /**
183 * Drop Table
184 *
Andrey Andreev2caf2892012-01-27 00:12:03 +0200185 * @param string table name
Derek Allard2067d1a2008-11-13 22:59:24 +0000186 * @return string
187 */
Andrey Andreev2caf2892012-01-27 00:12:03 +0200188 public function _drop_table($table)
Derek Allard2067d1a2008-11-13 22:59:24 +0000189 {
Andrey Andreev2caf2892012-01-27 00:12:03 +0200190 return 'DROP TABLE IF EXISTS '.$this->db->_escape_identifiers($table);
Derek Allard2067d1a2008-11-13 22:59:24 +0000191 }
192
193 // --------------------------------------------------------------------
194
195 /**
196 * Alter table query
197 *
198 * Generates a platform-specific query so that a table can be altered
Andrey Andreev2caf2892012-01-27 00:12:03 +0200199 * Called by add_column(), drop_column() and column_alter()
Derek Allard2067d1a2008-11-13 22:59:24 +0000200 *
Derek Allard2067d1a2008-11-13 22:59:24 +0000201 * @param string the ALTER type (ADD, DROP, CHANGE)
202 * @param string the column name
203 * @param array fields
204 * @param string the field after which we should add the new field
Andrey Andreev2caf2892012-01-27 00:12:03 +0200205 * @return string
Derek Allard2067d1a2008-11-13 22:59:24 +0000206 */
Andrey Andreev2caf2892012-01-27 00:12:03 +0200207 public function _alter_table($alter_type, $table, $fields, $after_field = '')
Derek Allard2067d1a2008-11-13 22:59:24 +0000208 {
Andrey Andreev2caf2892012-01-27 00:12:03 +0200209 $sql = 'ALTER TABLE '.$this->db->protect_identifiers($table).' '.$alter_type.' ';
Derek Allard2067d1a2008-11-13 22:59:24 +0000210
211 // DROP has everything it needs now.
Andrey Andreev2caf2892012-01-27 00:12:03 +0200212 if ($alter_type === 'DROP')
Derek Allard2067d1a2008-11-13 22:59:24 +0000213 {
Andrey Andreev2caf2892012-01-27 00:12:03 +0200214 return $sql.$this->db->protect_identifiers($fields);
Derek Allard2067d1a2008-11-13 22:59:24 +0000215 }
216
Andrey Andreev2caf2892012-01-27 00:12:03 +0200217 return $sql.$this->_process_fields($fields)
218 .($after_field != '' ? ' AFTER '.$this->db->protect_identifiers($after_field) : '');
Derek Allard2067d1a2008-11-13 22:59:24 +0000219 }
220
221 // --------------------------------------------------------------------
222
223 /**
224 * Rename a table
225 *
226 * Generates a platform-specific query so that a table can be renamed
227 *
Derek Allard2067d1a2008-11-13 22:59:24 +0000228 * @param string the old table name
229 * @param string the new table name
230 * @return string
231 */
Andrey Andreev2caf2892012-01-27 00:12:03 +0200232 public function _rename_table($table_name, $new_table_name)
Derek Allard2067d1a2008-11-13 22:59:24 +0000233 {
Andrey Andreev2caf2892012-01-27 00:12:03 +0200234 return 'ALTER TABLE '.$this->db->protect_identifiers($table_name).' RENAME TO '.$this->db->protect_identifiers($new_table_name);
Derek Allard2067d1a2008-11-13 22:59:24 +0000235 }
236
237}
238
239/* End of file mysql_forge.php */
Andrey Andreev2caf2892012-01-27 00:12:03 +0200240/* Location: ./system/database/drivers/mysql/mysql_forge.php */