blob: 9cb1a0c70cb6a54b5c520b815fc5bfdc06d71815 [file] [log] [blame]
Andrey Andreev1ff49e02012-01-27 11:30:41 +02001<?php if ( ! defined('BASEPATH')) exit('No direct script access allowed');
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 Andreev1ff49e02012-01-27 11:30:41 +02008 *
Derek Jonesf4a4bd82011-10-20 12:18:42 -05009 * Licensed under the Open Software License version 3.0
Andrey Andreev1ff49e02012-01-27 11:30:41 +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 * MySQLi 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_mysqli_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 Andreev1ff49e02012-01-27 11:30:41 +020041 * @return string
Derek Allard2067d1a2008-11-13 22:59:24 +000042 */
Andrey Andreev1ff49e02012-01-27 11:30:41 +020043 public function _create_database($name)
Derek Allard2067d1a2008-11-13 22:59:24 +000044 {
Andrey Andreev1ff49e02012-01-27 11:30:41 +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 Andreev1ff49e02012-01-27 11:30:41 +020054 * @return string
Derek Allard2067d1a2008-11-13 22:59:24 +000055 */
Andrey Andreev1ff49e02012-01-27 11:30:41 +020056 public function _drop_database($name)
Derek Allard2067d1a2008-11-13 22:59:24 +000057 {
Andrey Andreev1ff49e02012-01-27 11:30:41 +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 Andreeva3c5cfc2012-01-27 20:50:33 +020069 public function _process_fields($fields)
Derek Allard2067d1a2008-11-13 22:59:24 +000070 {
71 $current_field_count = 0;
72 $sql = '';
73
Andrey Andreev1ff49e02012-01-27 11:30:41 +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 Andreev1ff49e02012-01-27 11:30:41 +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 Andreev1ff49e02012-01-27 11:30:41 +020087 $sql .= "\n\t".$this->db->protect_identifiers($field)
88 .( ! empty($attributes['NAME']) ? ' '.$this->db->protect_identifiers($attributes['NAME']).' ' : '')
Phil Sturgeonca640472012-03-09 17:19:35 +000089 ;
90
91 if ( ! empty($attributes['TYPE']))
92 {
93 $sql .= ' '.$attributes['TYPE'];
94
95 if ( ! empty($attributes['CONSTRAINT']))
96 {
97 switch (strtolower($attributes['TYPE']))
98 {
99 case 'decimal':
100 case 'float':
101 case 'numeric':
102 $sql .= '('.implode(',', $attributes['CONSTRAINT']).')';
103 break;
104 case 'enum':
105 case 'set':
106 $sql .= '("'.implode('","', $attributes['CONSTRAINT']).'")';
107 break;
108 default:
109 $sql .= '('.$attributes['CONSTRAINT'].')';
110 }
111 }
112 }
113
114 $sql .= (( ! empty($attributes['UNSIGNED']) && $attributes['UNSIGNED'] === TRUE) ? ' UNSIGNED' : '')
Andrey Andreev1ff49e02012-01-27 11:30:41 +0200115 .(isset($attributes['DEFAULT']) ? " DEFAULT '".$attributes['DEFAULT']."'" : '')
116 .(( ! empty($attributes['NULL']) && $attributes['NULL'] === TRUE) ? ' NULL' : ' NOT NULL')
117 .(( ! empty($attributes['AUTO_INCREMENT']) && $attributes['AUTO_INCREMENT'] === TRUE) ? ' AUTO_INCREMENT' : '');
Derek Allard2067d1a2008-11-13 22:59:24 +0000118 }
Barry Mienydd671972010-10-04 16:33:58 +0200119
Derek Allard2067d1a2008-11-13 22:59:24 +0000120 // don't add a comma on the end of the last field
121 if (++$current_field_count < count($fields))
122 {
123 $sql .= ',';
124 }
125 }
Barry Mienydd671972010-10-04 16:33:58 +0200126
Derek Allard2067d1a2008-11-13 22:59:24 +0000127 return $sql;
128 }
129
130 // --------------------------------------------------------------------
131
132 /**
133 * Create Table
134 *
Derek Allard2067d1a2008-11-13 22:59:24 +0000135 * @param string the table name
136 * @param mixed the fields
137 * @param mixed primary key(s)
138 * @param mixed key(s)
Andrey Andreev1ff49e02012-01-27 11:30:41 +0200139 * @param bool should 'IF NOT EXISTS' be added to the SQL
Derek Allard2067d1a2008-11-13 22:59:24 +0000140 * @return bool
141 */
Andrey Andreev1ff49e02012-01-27 11:30:41 +0200142 public function _create_table($table, $fields, $primary_keys, $keys, $if_not_exists)
Derek Allard2067d1a2008-11-13 22:59:24 +0000143 {
144 $sql = 'CREATE TABLE ';
Barry Mienydd671972010-10-04 16:33:58 +0200145
Derek Allard2067d1a2008-11-13 22:59:24 +0000146 if ($if_not_exists === TRUE)
147 {
148 $sql .= 'IF NOT EXISTS ';
149 }
Barry Mienydd671972010-10-04 16:33:58 +0200150
Andrey Andreev1ff49e02012-01-27 11:30:41 +0200151 $sql .= $this->db->_escape_identifiers($table).' ('.$this->_process_fields($fields);
Derek Allard2067d1a2008-11-13 22:59:24 +0000152
153 if (count($primary_keys) > 0)
154 {
Andrey Andreev1ff49e02012-01-27 11:30:41 +0200155 $key_name = $this->db->protect_identifiers(implode('_', $primary_keys));
156 $sql .= ",\n\tPRIMARY KEY ".$key_name.' ('.implode(', ', $this->db->protect_identifiers($primary_keys)).')';
Derek Allard2067d1a2008-11-13 22:59:24 +0000157 }
158
159 if (is_array($keys) && count($keys) > 0)
160 {
161 foreach ($keys as $key)
162 {
163 if (is_array($key))
164 {
Andrey Andreev1ff49e02012-01-27 11:30:41 +0200165 $key_name = $this->db->protect_identifiers(implode('_', $key));
166 $key = $this->db->protect_identifiers($key);
Derek Allard2067d1a2008-11-13 22:59:24 +0000167 }
168 else
169 {
Andrey Andreev1ff49e02012-01-27 11:30:41 +0200170 $key_name = $this->db->protect_identifiers($key);
Derek Allard2067d1a2008-11-13 22:59:24 +0000171 $key = array($key_name);
172 }
Barry Mienydd671972010-10-04 16:33:58 +0200173
Andrey Andreev1ff49e02012-01-27 11:30:41 +0200174 $sql .= ",\n\tKEY ".$key_name.' ('.implode(', ', $key).')';
Derek Allard2067d1a2008-11-13 22:59:24 +0000175 }
176 }
177
Andrey Andreev1ff49e02012-01-27 11:30:41 +0200178 return $sql."\n) DEFAULT CHARACTER SET ".$this->db->char_set.' COLLATE '.$this->db->dbcollat.';';
Derek Allard2067d1a2008-11-13 22:59:24 +0000179 }
180
181 // --------------------------------------------------------------------
182
183 /**
184 * Drop Table
185 *
Derek Allard2067d1a2008-11-13 22:59:24 +0000186 * @return string
187 */
Andrey Andreev1ff49e02012-01-27 11:30:41 +0200188 public function _drop_table($table)
Derek Allard2067d1a2008-11-13 22:59:24 +0000189 {
Andrey Andreev1ff49e02012-01-27 11:30:41 +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
199 * Called by add_column(), drop_column(), and column_alter(),
200 *
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 Andreev1ff49e02012-01-27 11:30:41 +0200205 * @return string
Derek Allard2067d1a2008-11-13 22:59:24 +0000206 */
Andrey Andreev1ff49e02012-01-27 11:30:41 +0200207 public function _alter_table($alter_type, $table, $fields, $after_field = '')
Derek Allard2067d1a2008-11-13 22:59:24 +0000208 {
Andrey Andreev032e7ea2012-03-06 19:48:35 +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 Andreev1ff49e02012-01-27 11:30:41 +0200212 if ($alter_type === 'DROP')
Derek Allard2067d1a2008-11-13 22:59:24 +0000213 {
Andrey Andreev1ff49e02012-01-27 11:30:41 +0200214 return $sql.$this->db->protect_identifiers($fields);
Derek Allard2067d1a2008-11-13 22:59:24 +0000215 }
216
Andrey Andreev1ff49e02012-01-27 11:30:41 +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 Andreev1ff49e02012-01-27 11:30:41 +0200232 public function _rename_table($table_name, $new_table_name)
Derek Allard2067d1a2008-11-13 22:59:24 +0000233 {
Andrey Andreev1ff49e02012-01-27 11:30:41 +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 mysqli_forge.php */
Andrey Andreev1ff49e02012-01-27 11:30:41 +0200240/* Location: ./system/database/drivers/mysqli/mysqli_forge.php */