blob: e5c0f8068bcb17e8c45c2ffa47da4831272c5f64 [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 Andreev2caf2892012-01-27 00:12:03 +020063 $sql .= "\n\t".$this->db->protect_identifiers($field)
64 .( ! empty($attributes['NAME']) ? ' '.$this->db->protect_identifiers($attributes['NAME']).' ' : '');
Derek Allard2067d1a2008-11-13 22:59:24 +000065
Andrey Andreev2caf2892012-01-27 00:12:03 +020066 if ( ! empty($attributes['TYPE']))
Derek Allard2067d1a2008-11-13 22:59:24 +000067 {
Derek Jones37f4b9c2011-07-01 17:56:50 -050068 $sql .= ' '.$attributes['TYPE'];
Barry Mienydd671972010-10-04 16:33:58 +020069
Andrey Andreev2caf2892012-01-27 00:12:03 +020070 if ( ! empty($attributes['CONSTRAINT']))
Phil Sturgeon27324cd2011-01-05 16:32:57 +000071 {
Andrey Andreev2caf2892012-01-27 00:12:03 +020072 switch (strtolower($attributes['TYPE']))
Phil Sturgeon27324cd2011-01-05 16:32:57 +000073 {
74 case 'decimal':
75 case 'float':
76 case 'numeric':
77 $sql .= '('.implode(',', $attributes['CONSTRAINT']).')';
Andrey Andreev2caf2892012-01-27 00:12:03 +020078 break;
Phil Sturgeon27324cd2011-01-05 16:32:57 +000079 case 'enum':
80 case 'set':
81 $sql .= '("'.implode('","', $attributes['CONSTRAINT']).'")';
Andrey Andreev2caf2892012-01-27 00:12:03 +020082 break;
Phil Sturgeon27324cd2011-01-05 16:32:57 +000083 default:
84 $sql .= '('.$attributes['CONSTRAINT'].')';
85 }
86 }
Derek Allard2067d1a2008-11-13 22:59:24 +000087 }
Barry Mienydd671972010-10-04 16:33:58 +020088
Andrey Andreev2caf2892012-01-27 00:12:03 +020089 $sql .= (( ! empty($attributes['UNSIGNED']) && $attributes['UNSIGNED'] === TRUE) ? ' UNSIGNED' : '')
90 .(isset($attributes['DEFAULT']) ? " DEFAULT '".$attributes['DEFAULT']."'" : '')
91 .(( ! empty($attributes['NULL']) && $attributes['NULL'] === TRUE) ? ' NULL' : ' NOT NULL')
92 .(( ! empty($attributes['AUTO_INCREMENT']) && $attributes['AUTO_INCREMENT'] === TRUE) ? ' AUTO_INCREMENT' : '');
Derek Allard2067d1a2008-11-13 22:59:24 +000093 }
Barry Mienydd671972010-10-04 16:33:58 +020094
Derek Allard2067d1a2008-11-13 22:59:24 +000095 // don't add a comma on the end of the last field
96 if (++$current_field_count < count($fields))
97 {
98 $sql .= ',';
99 }
100 }
Barry Mienydd671972010-10-04 16:33:58 +0200101
Derek Allard2067d1a2008-11-13 22:59:24 +0000102 return $sql;
103 }
104
105 // --------------------------------------------------------------------
106
107 /**
108 * Create Table
109 *
Derek Allard2067d1a2008-11-13 22:59:24 +0000110 * @param string the table name
111 * @param mixed the fields
112 * @param mixed primary key(s)
113 * @param mixed key(s)
Andrey Andreev2caf2892012-01-27 00:12:03 +0200114 * @param bool should 'IF NOT EXISTS' be added to the SQL
Derek Allard2067d1a2008-11-13 22:59:24 +0000115 * @return bool
116 */
Andrey Andreev2caf2892012-01-27 00:12:03 +0200117 public function _create_table($table, $fields, $primary_keys, $keys, $if_not_exists)
Derek Allard2067d1a2008-11-13 22:59:24 +0000118 {
119 $sql = 'CREATE TABLE ';
Barry Mienydd671972010-10-04 16:33:58 +0200120
Derek Allard2067d1a2008-11-13 22:59:24 +0000121 if ($if_not_exists === TRUE)
122 {
123 $sql .= 'IF NOT EXISTS ';
124 }
Barry Mienydd671972010-10-04 16:33:58 +0200125
Andrey Andreev93cac5c2012-02-14 14:45:02 +0200126 $sql .= $this->db->protect_identifiers($table).' ('.$this->_process_fields($fields);
Derek Allard2067d1a2008-11-13 22:59:24 +0000127
128 if (count($primary_keys) > 0)
129 {
Andrey Andreev032e7ea2012-03-06 19:48:35 +0200130 $key_name = $this->db->protect_identifiers(implode('_', $primary_keys));
Andrey Andreev2caf2892012-01-27 00:12:03 +0200131 $sql .= ",\n\tPRIMARY KEY ".$key_name.' ('.implode(', ', $this->db->protect_identifiers($primary_keys)).')';
Derek Allard2067d1a2008-11-13 22:59:24 +0000132 }
133
134 if (is_array($keys) && count($keys) > 0)
135 {
136 foreach ($keys as $key)
137 {
138 if (is_array($key))
139 {
Andrey Andreev032e7ea2012-03-06 19:48:35 +0200140 $key_name = $this->db->protect_identifiers(implode('_', $key));
141 $key = $this->db->protect_identifiers($key);
Derek Allard2067d1a2008-11-13 22:59:24 +0000142 }
143 else
144 {
Andrey Andreev032e7ea2012-03-06 19:48:35 +0200145 $key_name = $this->db->protect_identifiers($key);
Derek Allard2067d1a2008-11-13 22:59:24 +0000146 $key = array($key_name);
147 }
Barry Mienydd671972010-10-04 16:33:58 +0200148
Andrey Andreev2caf2892012-01-27 00:12:03 +0200149 $sql .= ",\n\tKEY ".$key_name.' ('.implode(', ', $key).')';
Derek Allard2067d1a2008-11-13 22:59:24 +0000150 }
151 }
152
Andrey Andreev2caf2892012-01-27 00:12:03 +0200153 return $sql."\n) DEFAULT CHARACTER SET ".$this->db->char_set.' COLLATE '.$this->db->dbcollat.';';
Derek Allard2067d1a2008-11-13 22:59:24 +0000154 }
155
156 // --------------------------------------------------------------------
157
158 /**
Derek Allard2067d1a2008-11-13 22:59:24 +0000159 * Alter table query
160 *
161 * Generates a platform-specific query so that a table can be altered
Andrey Andreev2caf2892012-01-27 00:12:03 +0200162 * Called by add_column(), drop_column() and column_alter()
Derek Allard2067d1a2008-11-13 22:59:24 +0000163 *
Derek Allard2067d1a2008-11-13 22:59:24 +0000164 * @param string the ALTER type (ADD, DROP, CHANGE)
165 * @param string the column name
166 * @param array fields
167 * @param string the field after which we should add the new field
Andrey Andreev2caf2892012-01-27 00:12:03 +0200168 * @return string
Derek Allard2067d1a2008-11-13 22:59:24 +0000169 */
Andrey Andreev2caf2892012-01-27 00:12:03 +0200170 public function _alter_table($alter_type, $table, $fields, $after_field = '')
Derek Allard2067d1a2008-11-13 22:59:24 +0000171 {
Andrey Andreev2caf2892012-01-27 00:12:03 +0200172 $sql = 'ALTER TABLE '.$this->db->protect_identifiers($table).' '.$alter_type.' ';
Derek Allard2067d1a2008-11-13 22:59:24 +0000173
174 // DROP has everything it needs now.
Andrey Andreev2caf2892012-01-27 00:12:03 +0200175 if ($alter_type === 'DROP')
Derek Allard2067d1a2008-11-13 22:59:24 +0000176 {
Andrey Andreev2caf2892012-01-27 00:12:03 +0200177 return $sql.$this->db->protect_identifiers($fields);
Derek Allard2067d1a2008-11-13 22:59:24 +0000178 }
179
Andrey Andreev2caf2892012-01-27 00:12:03 +0200180 return $sql.$this->_process_fields($fields)
181 .($after_field != '' ? ' AFTER '.$this->db->protect_identifiers($after_field) : '');
Derek Allard2067d1a2008-11-13 22:59:24 +0000182 }
183
Derek Allard2067d1a2008-11-13 22:59:24 +0000184}
185
186/* End of file mysql_forge.php */
Timothy Warren215890b2012-03-20 09:38:16 -0400187/* Location: ./system/database/drivers/mysql/mysql_forge.php */