blob: e77970cf25a4fed07b5e3cf51d9e7c87f5a643e0 [file] [log] [blame]
Andrey Andreevc5536aa2012-11-01 17:33:58 +02001<?php
Timothy Warren80ab8162011-08-22 18:26:12 -04002/**
3 * CodeIgniter
4 *
Phil Sturgeon07c1ac82012-03-09 17:03:37 +00005 * An open source application development framework for PHP 5.2.4 or newer
Timothy Warren80ab8162011-08-22 18:26:12 -04006 *
Derek Jonesf4a4bd82011-10-20 12:18:42 -05007 * NOTICE OF LICENSE
Andrey Andreev9fd79f52012-03-20 23:04:13 +02008 *
Derek Jonesf4a4bd82011-10-20 12:18:42 -05009 * Licensed under the Open Software License version 3.0
Andrey Andreev9fd79f52012-03-20 23:04:13 +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 *
Timothy Warren80ab8162011-08-22 18:26:12 -040019 * @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)
Timothy Warren80ab8162011-08-22 18:26:12 -040023 * @link http://codeigniter.com
Timothy Warren018af7a2011-09-07 12:07:35 -040024 * @since Version 2.1.0
Timothy Warren80ab8162011-08-22 18:26:12 -040025 * @filesource
26 */
Andrey Andreevc5536aa2012-11-01 17:33:58 +020027defined('BASEPATH') OR exit('No direct script access allowed');
Timothy Warren80ab8162011-08-22 18:26:12 -040028
Timothy Warren80ab8162011-08-22 18:26:12 -040029/**
30 * PDO Forge Class
31 *
32 * @category Database
Derek Jonesf4a4bd82011-10-20 12:18:42 -050033 * @author EllisLab Dev Team
Timothy Warren80ab8162011-08-22 18:26:12 -040034 * @link http://codeigniter.com/database/
35 */
36class CI_DB_pdo_forge extends CI_DB_forge {
37
Andrey Andreevc98e93a2012-11-02 02:04:59 +020038 /**
39 * DROP TABLE statement
40 *
41 * @var string
42 */
Andrey Andreevd947eba2012-04-09 14:58:28 +030043 protected $_drop_table = 'DROP TABLE %s';
Timothy Warren80ab8162011-08-22 18:26:12 -040044
Andrey Andreevc98e93a2012-11-02 02:04:59 +020045 // --------------------------------------------------------------------
46
Timothy Warren80ab8162011-08-22 18:26:12 -040047 /**
48 * Create Table
49 *
Timothy Warren80ab8162011-08-22 18:26:12 -040050 * @param string the table name
51 * @param array the fields
52 * @param mixed primary key(s)
53 * @param mixed key(s)
Andrey Andreev9fd79f52012-03-20 23:04:13 +020054 * @param bool should 'IF NOT EXISTS' be added to the SQL
Timothy Warren80ab8162011-08-22 18:26:12 -040055 * @return bool
56 */
Andrey Andreeva0d4e412012-04-09 15:06:40 +030057 protected function _create_table($table, $fields, $primary_keys, $keys, $if_not_exists)
Timothy Warren80ab8162011-08-22 18:26:12 -040058 {
59 $sql = 'CREATE TABLE ';
60
61 if ($if_not_exists === TRUE)
62 {
63 $sql .= 'IF NOT EXISTS ';
64 }
65
Andrey Andreevea09a8a2012-04-06 20:50:07 +030066 $sql .= $this->db->escape_identifiers($table).' (';
Timothy Warren80ab8162011-08-22 18:26:12 -040067 $current_field_count = 0;
68
Andrey Andreevea09a8a2012-04-06 20:50:07 +030069 foreach ($fields as $field => $attributes)
Timothy Warren80ab8162011-08-22 18:26:12 -040070 {
71 // Numeric field names aren't allowed in databases, so if the key is
72 // numeric, we know it was assigned by PHP and the developer manually
73 // entered the field information, so we'll simply add it to the list
74 if (is_numeric($field))
75 {
Andrey Andreev5ef194d2012-06-08 01:12:54 +030076 $sql .= "\n\t".$attributes;
Timothy Warren80ab8162011-08-22 18:26:12 -040077 }
78 else
79 {
80 $attributes = array_change_key_case($attributes, CASE_UPPER);
Andrey Andreev5ef194d2012-06-08 01:12:54 +030081 $numeric = array('SERIAL', 'INTEGER');
Timothy Warren80ab8162011-08-22 18:26:12 -040082
Andrey Andreev5ef194d2012-06-08 01:12:54 +030083 $sql .= "\n\t".$this->db->escape_identifiers($field).' '.$attributes['TYPE'];
Timothy Warren80ab8162011-08-22 18:26:12 -040084
Andrey Andreev5ef194d2012-06-08 01:12:54 +030085 if ( ! empty($attributes['CONSTRAINT']))
Timothy Warren80ab8162011-08-22 18:26:12 -040086 {
Taufan Aditya18209332012-02-09 16:07:27 +070087 // Exception for Postgre numeric which not too happy with constraint within those type
Andrey Andreevfbba54e2012-06-23 20:26:31 +030088 if ( ! ($this->db->subdriver === 'pgsql' && in_array($attributes['TYPE'], $numeric)))
Taufan Aditya18209332012-02-09 16:07:27 +070089 {
90 $sql .= '('.$attributes['CONSTRAINT'].')';
91 }
Timothy Warren80ab8162011-08-22 18:26:12 -040092 }
93
Andrey Andreev5ef194d2012-06-08 01:12:54 +030094 if ( ! empty($attributes['UNSIGNED']) && $attributes['UNSIGNED'] === TRUE)
Timothy Warren80ab8162011-08-22 18:26:12 -040095 {
96 $sql .= ' UNSIGNED';
97 }
98
Andrey Andreev5ef194d2012-06-08 01:12:54 +030099 if (isset($attributes['DEFAULT']))
Timothy Warren80ab8162011-08-22 18:26:12 -0400100 {
Andrey Andreev5ef194d2012-06-08 01:12:54 +0300101 $sql .= " DEFAULT '".$attributes['DEFAULT']."'";
Timothy Warren80ab8162011-08-22 18:26:12 -0400102 }
103
Andrey Andreev5ef194d2012-06-08 01:12:54 +0300104 $sql .= ( ! empty($attributes['NULL']) && $attributes['NULL'] === TRUE)
105 ? ' NULL' : ' NOT NULL';
Timothy Warren80ab8162011-08-22 18:26:12 -0400106
Andrey Andreev5ef194d2012-06-08 01:12:54 +0300107 if ( ! empty($attributes['AUTO_INCREMENT']) && $attributes['AUTO_INCREMENT'] === TRUE)
Timothy Warren80ab8162011-08-22 18:26:12 -0400108 {
109 $sql .= ' AUTO_INCREMENT';
110 }
111 }
112
113 // don't add a comma on the end of the last field
114 if (++$current_field_count < count($fields))
115 {
116 $sql .= ',';
117 }
118 }
119
120 if (count($primary_keys) > 0)
121 {
Andrey Andreev9637b402012-06-08 15:39:24 +0300122 $sql .= ",\n\tPRIMARY KEY (".implode(', ', $this->db->escape_identifiers($primary_keys)).')';
Timothy Warren80ab8162011-08-22 18:26:12 -0400123 }
124
125 if (is_array($keys) && count($keys) > 0)
126 {
127 foreach ($keys as $key)
128 {
Andrey Andreev5ef194d2012-06-08 01:12:54 +0300129 $key = is_array($key)
Andrey Andreev9637b402012-06-08 15:39:24 +0300130 ? $this->db->escape_identifiers($key)
Andrey Andreev5ef194d2012-06-08 01:12:54 +0300131 : array($this->db->escape_identifiers($key));
Timothy Warren80ab8162011-08-22 18:26:12 -0400132
Andrey Andreev5ef194d2012-06-08 01:12:54 +0300133 $sql .= ",\n\tFOREIGN KEY (".implode(', ', $key).')';
Timothy Warren80ab8162011-08-22 18:26:12 -0400134 }
135 }
136
Andrey Andreev5ef194d2012-06-08 01:12:54 +0300137 return $sql."\n)";
Timothy Warren80ab8162011-08-22 18:26:12 -0400138 }
139
140 // --------------------------------------------------------------------
141
142 /**
Timothy Warren80ab8162011-08-22 18:26:12 -0400143 * Alter table query
144 *
145 * Generates a platform-specific query so that a table can be altered
146 * Called by add_column(), drop_column(), and column_alter(),
147 *
Timothy Warren80ab8162011-08-22 18:26:12 -0400148 * @param string the ALTER type (ADD, DROP, CHANGE)
149 * @param string the column name
150 * @param string the table name
151 * @param string the column definition
152 * @param string the default value
Andrey Andreev9fd79f52012-03-20 23:04:13 +0200153 * @param bool should 'NOT NULL' be added
Timothy Warren80ab8162011-08-22 18:26:12 -0400154 * @param string the field after which we should add the new field
Andrey Andreev9fd79f52012-03-20 23:04:13 +0200155 * @return string
Timothy Warren80ab8162011-08-22 18:26:12 -0400156 */
Andrey Andreeva0d4e412012-04-09 15:06:40 +0300157 protected function _alter_table($alter_type, $table, $column_name, $column_definition = '', $default_value = '', $null = '', $after_field = '')
Timothy Warren80ab8162011-08-22 18:26:12 -0400158 {
Andrey Andreev5ef194d2012-06-08 01:12:54 +0300159 $sql = 'ALTER TABLE '.$this->db->escape_identifiers($table).' '.$alter_type.' '.$this->db->escape_identifiers($column_name);
Timothy Warren80ab8162011-08-22 18:26:12 -0400160
161 // DROP has everything it needs now.
Alex Bilbie48a2baf2012-06-02 11:09:54 +0100162 if ($alter_type === 'DROP')
Timothy Warren80ab8162011-08-22 18:26:12 -0400163 {
164 return $sql;
165 }
166
Andrey Andreev5ef194d2012-06-08 01:12:54 +0300167 return $sql .' '.$column_definition
168 .($default_value !== '' ? " DEFAULT '".$default_value."'" : '')
169 .($null === NULL ? ' NULL' : ' NOT NULL')
170 .($after_field !== '' ? ' AFTER '.$this->db->escape_identifiers($after_field) : '');
Timothy Warren80ab8162011-08-22 18:26:12 -0400171 }
172
Timothy Warren80ab8162011-08-22 18:26:12 -0400173}
174
175/* End of file pdo_forge.php */
Timothy Warren215890b2012-03-20 09:38:16 -0400176/* Location: ./system/database/drivers/pdo/pdo_forge.php */