blob: 0279b9dfacea75843009cf0358f022a6defe5182 [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 *
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 */
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
Andrey Andreevd947eba2012-04-09 14:58:28 +030037 protected $_create_database = 'CREATE DATABASE %s CHARACTER SET %s COLLATE %s';
Derek Allard2067d1a2008-11-13 22:59:24 +000038
39 /**
40 * Process Fields
41 *
Derek Allard2067d1a2008-11-13 22:59:24 +000042 * @param mixed the fields
43 * @return string
44 */
Andrey Andreev820999c2012-03-20 15:15:57 +020045 protected function _process_fields($fields)
Derek Allard2067d1a2008-11-13 22:59:24 +000046 {
47 $current_field_count = 0;
48 $sql = '';
49
Andrey Andreev2caf2892012-01-27 00:12:03 +020050 foreach ($fields as $field => $attributes)
Derek Allard2067d1a2008-11-13 22:59:24 +000051 {
52 // Numeric field names aren't allowed in databases, so if the key is
53 // numeric, we know it was assigned by PHP and the developer manually
54 // entered the field information, so we'll simply add it to the list
55 if (is_numeric($field))
56 {
Andrey Andreev2caf2892012-01-27 00:12:03 +020057 $sql .= "\n\t".$attributes;
Derek Allard2067d1a2008-11-13 22:59:24 +000058 }
59 else
60 {
61 $attributes = array_change_key_case($attributes, CASE_UPPER);
Barry Mienydd671972010-10-04 16:33:58 +020062
Andrey Andreev5ef194d2012-06-08 01:12:54 +030063 $sql .= "\n\t".$this->db->escape_identifiers($field);
64
65 empty($attributes['NAME']) OR ' '.$this->db->protect_identifiers($attributes['NAME']).' ';
Derek Allard2067d1a2008-11-13 22:59:24 +000066
Andrey Andreev2caf2892012-01-27 00:12:03 +020067 if ( ! empty($attributes['TYPE']))
Derek Allard2067d1a2008-11-13 22:59:24 +000068 {
Derek Jones37f4b9c2011-07-01 17:56:50 -050069 $sql .= ' '.$attributes['TYPE'];
Barry Mienydd671972010-10-04 16:33:58 +020070
Andrey Andreev2caf2892012-01-27 00:12:03 +020071 if ( ! empty($attributes['CONSTRAINT']))
Phil Sturgeon27324cd2011-01-05 16:32:57 +000072 {
Andrey Andreev2caf2892012-01-27 00:12:03 +020073 switch (strtolower($attributes['TYPE']))
Phil Sturgeon27324cd2011-01-05 16:32:57 +000074 {
75 case 'decimal':
76 case 'float':
77 case 'numeric':
78 $sql .= '('.implode(',', $attributes['CONSTRAINT']).')';
Andrey Andreev2caf2892012-01-27 00:12:03 +020079 break;
Phil Sturgeon27324cd2011-01-05 16:32:57 +000080 case 'enum':
81 case 'set':
82 $sql .= '("'.implode('","', $attributes['CONSTRAINT']).'")';
Andrey Andreev2caf2892012-01-27 00:12:03 +020083 break;
Phil Sturgeon27324cd2011-01-05 16:32:57 +000084 default:
85 $sql .= '('.$attributes['CONSTRAINT'].')';
86 }
87 }
Derek Allard2067d1a2008-11-13 22:59:24 +000088 }
Barry Mienydd671972010-10-04 16:33:58 +020089
Andrey Andreev5ef194d2012-06-08 01:12:54 +030090 if ( ! empty($attributes['UNSIGNED']) && $attributes['UNSIGNED'] === TRUE)
91 {
92 $sql .= ' UNSIGNED';
93 }
94
95 if (isset($attributes['DEFAULT']))
96 {
97 $sql .= " DEFAULT '".$attributes['DEFAULT']."'";
98 }
99
100 $sql .= ( ! empty($attributes['NULL']) && $attributes['NULL'] === TRUE)
101 ? ' NULL' : ' NOT NULL';
102
103 if ( ! empty($attributes['AUTO_INCREMENT']) && $attributes['AUTO_INCREMENT'] === TRUE)
104 {
105 $sql .= ' AUTO_INCREMENT';
106 }
Derek Allard2067d1a2008-11-13 22:59:24 +0000107 }
Barry Mienydd671972010-10-04 16:33:58 +0200108
Derek Allard2067d1a2008-11-13 22:59:24 +0000109 // don't add a comma on the end of the last field
110 if (++$current_field_count < count($fields))
111 {
112 $sql .= ',';
113 }
114 }
Barry Mienydd671972010-10-04 16:33:58 +0200115
Derek Allard2067d1a2008-11-13 22:59:24 +0000116 return $sql;
117 }
118
119 // --------------------------------------------------------------------
120
121 /**
122 * Create Table
123 *
Derek Allard2067d1a2008-11-13 22:59:24 +0000124 * @param string the table name
125 * @param mixed the fields
126 * @param mixed primary key(s)
127 * @param mixed key(s)
Andrey Andreev2caf2892012-01-27 00:12:03 +0200128 * @param bool should 'IF NOT EXISTS' be added to the SQL
Derek Allard2067d1a2008-11-13 22:59:24 +0000129 * @return bool
130 */
Andrey Andreeva0d4e412012-04-09 15:06:40 +0300131 protected function _create_table($table, $fields, $primary_keys, $keys, $if_not_exists)
Derek Allard2067d1a2008-11-13 22:59:24 +0000132 {
133 $sql = 'CREATE TABLE ';
Barry Mienydd671972010-10-04 16:33:58 +0200134
Derek Allard2067d1a2008-11-13 22:59:24 +0000135 if ($if_not_exists === TRUE)
136 {
137 $sql .= 'IF NOT EXISTS ';
138 }
Barry Mienydd671972010-10-04 16:33:58 +0200139
Andrey Andreev5ef194d2012-06-08 01:12:54 +0300140 $sql .= $this->db->escape_identifiers($table).' ('.$this->_process_fields($fields);
Derek Allard2067d1a2008-11-13 22:59:24 +0000141
142 if (count($primary_keys) > 0)
143 {
Andrey Andreev5ef194d2012-06-08 01:12:54 +0300144 $key_name = $this->db->escape_identifiers(implode('_', $primary_keys));
145 $sql .= ",\n\tPRIMARY KEY ".$key_name.' ('.implode(', ', $this->db->escape_identifiers($primary_keys)).')';
Derek Allard2067d1a2008-11-13 22:59:24 +0000146 }
147
148 if (is_array($keys) && count($keys) > 0)
149 {
150 foreach ($keys as $key)
151 {
152 if (is_array($key))
153 {
Andrey Andreev5ef194d2012-06-08 01:12:54 +0300154 $key_name = $this->db->escape_identifiers(implode('_', $key));
155 $key = $this->db->escape_identifiers($key);
Derek Allard2067d1a2008-11-13 22:59:24 +0000156 }
157 else
158 {
Andrey Andreev5ef194d2012-06-08 01:12:54 +0300159 $key_name = $this->db->escape_identifiers($key);
Derek Allard2067d1a2008-11-13 22:59:24 +0000160 $key = array($key_name);
161 }
Barry Mienydd671972010-10-04 16:33:58 +0200162
Andrey Andreev2caf2892012-01-27 00:12:03 +0200163 $sql .= ",\n\tKEY ".$key_name.' ('.implode(', ', $key).')';
Derek Allard2067d1a2008-11-13 22:59:24 +0000164 }
165 }
166
Andrey Andreev2caf2892012-01-27 00:12:03 +0200167 return $sql."\n) DEFAULT CHARACTER SET ".$this->db->char_set.' COLLATE '.$this->db->dbcollat.';';
Derek Allard2067d1a2008-11-13 22:59:24 +0000168 }
169
170 // --------------------------------------------------------------------
171
172 /**
Derek Allard2067d1a2008-11-13 22:59:24 +0000173 * Alter table query
174 *
175 * Generates a platform-specific query so that a table can be altered
Andrey Andreev2caf2892012-01-27 00:12:03 +0200176 * Called by add_column(), drop_column() and column_alter()
Derek Allard2067d1a2008-11-13 22:59:24 +0000177 *
Derek Allard2067d1a2008-11-13 22:59:24 +0000178 * @param string the ALTER type (ADD, DROP, CHANGE)
179 * @param string the column name
180 * @param array fields
181 * @param string the field after which we should add the new field
Andrey Andreev2caf2892012-01-27 00:12:03 +0200182 * @return string
Derek Allard2067d1a2008-11-13 22:59:24 +0000183 */
Andrey Andreeva0d4e412012-04-09 15:06:40 +0300184 protected function _alter_table($alter_type, $table, $fields, $after_field = '')
Derek Allard2067d1a2008-11-13 22:59:24 +0000185 {
Andrey Andreev5ef194d2012-06-08 01:12:54 +0300186 $sql = 'ALTER TABLE '.$this->db->escape_identifiers($table).' '.$alter_type.' ';
Derek Allard2067d1a2008-11-13 22:59:24 +0000187
188 // DROP has everything it needs now.
Andrey Andreev2caf2892012-01-27 00:12:03 +0200189 if ($alter_type === 'DROP')
Derek Allard2067d1a2008-11-13 22:59:24 +0000190 {
Andrey Andreev5ef194d2012-06-08 01:12:54 +0300191 return $sql.$this->db->escape_identifiers($fields);
Derek Allard2067d1a2008-11-13 22:59:24 +0000192 }
193
Andrey Andreev2caf2892012-01-27 00:12:03 +0200194 return $sql.$this->_process_fields($fields)
Andrey Andreev5ef194d2012-06-08 01:12:54 +0300195 .($after_field !== '' ? ' AFTER '.$this->db->escape_identifiers($after_field) : '');
Derek Allard2067d1a2008-11-13 22:59:24 +0000196 }
197
Derek Allard2067d1a2008-11-13 22:59:24 +0000198}
199
200/* End of file mysql_forge.php */
Timothy Warren215890b2012-03-20 09:38:16 -0400201/* Location: ./system/database/drivers/mysql/mysql_forge.php */