blob: 8c22eb33f77c54d94738931406b1531f29190d3e [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 Andreevd947eba2012-04-09 14:58:28 +030038 protected $_drop_table = 'DROP TABLE %s';
Timothy Warren80ab8162011-08-22 18:26:12 -040039
40 /**
41 * Create Table
42 *
Timothy Warren80ab8162011-08-22 18:26:12 -040043 * @param string the table name
44 * @param array the fields
45 * @param mixed primary key(s)
46 * @param mixed key(s)
Andrey Andreev9fd79f52012-03-20 23:04:13 +020047 * @param bool should 'IF NOT EXISTS' be added to the SQL
Timothy Warren80ab8162011-08-22 18:26:12 -040048 * @return bool
49 */
Andrey Andreeva0d4e412012-04-09 15:06:40 +030050 protected function _create_table($table, $fields, $primary_keys, $keys, $if_not_exists)
Timothy Warren80ab8162011-08-22 18:26:12 -040051 {
52 $sql = 'CREATE TABLE ';
53
54 if ($if_not_exists === TRUE)
55 {
56 $sql .= 'IF NOT EXISTS ';
57 }
58
Andrey Andreevea09a8a2012-04-06 20:50:07 +030059 $sql .= $this->db->escape_identifiers($table).' (';
Timothy Warren80ab8162011-08-22 18:26:12 -040060 $current_field_count = 0;
61
Andrey Andreevea09a8a2012-04-06 20:50:07 +030062 foreach ($fields as $field => $attributes)
Timothy Warren80ab8162011-08-22 18:26:12 -040063 {
64 // Numeric field names aren't allowed in databases, so if the key is
65 // numeric, we know it was assigned by PHP and the developer manually
66 // entered the field information, so we'll simply add it to the list
67 if (is_numeric($field))
68 {
Andrey Andreev5ef194d2012-06-08 01:12:54 +030069 $sql .= "\n\t".$attributes;
Timothy Warren80ab8162011-08-22 18:26:12 -040070 }
71 else
72 {
73 $attributes = array_change_key_case($attributes, CASE_UPPER);
Andrey Andreev5ef194d2012-06-08 01:12:54 +030074 $numeric = array('SERIAL', 'INTEGER');
Timothy Warren80ab8162011-08-22 18:26:12 -040075
Andrey Andreev5ef194d2012-06-08 01:12:54 +030076 $sql .= "\n\t".$this->db->escape_identifiers($field).' '.$attributes['TYPE'];
Timothy Warren80ab8162011-08-22 18:26:12 -040077
Andrey Andreev5ef194d2012-06-08 01:12:54 +030078 if ( ! empty($attributes['CONSTRAINT']))
Timothy Warren80ab8162011-08-22 18:26:12 -040079 {
Taufan Aditya18209332012-02-09 16:07:27 +070080 // Exception for Postgre numeric which not too happy with constraint within those type
Andrey Andreevfbba54e2012-06-23 20:26:31 +030081 if ( ! ($this->db->subdriver === 'pgsql' && in_array($attributes['TYPE'], $numeric)))
Taufan Aditya18209332012-02-09 16:07:27 +070082 {
83 $sql .= '('.$attributes['CONSTRAINT'].')';
84 }
Timothy Warren80ab8162011-08-22 18:26:12 -040085 }
86
Andrey Andreev5ef194d2012-06-08 01:12:54 +030087 if ( ! empty($attributes['UNSIGNED']) && $attributes['UNSIGNED'] === TRUE)
Timothy Warren80ab8162011-08-22 18:26:12 -040088 {
89 $sql .= ' UNSIGNED';
90 }
91
Andrey Andreev5ef194d2012-06-08 01:12:54 +030092 if (isset($attributes['DEFAULT']))
Timothy Warren80ab8162011-08-22 18:26:12 -040093 {
Andrey Andreev5ef194d2012-06-08 01:12:54 +030094 $sql .= " DEFAULT '".$attributes['DEFAULT']."'";
Timothy Warren80ab8162011-08-22 18:26:12 -040095 }
96
Andrey Andreev5ef194d2012-06-08 01:12:54 +030097 $sql .= ( ! empty($attributes['NULL']) && $attributes['NULL'] === TRUE)
98 ? ' NULL' : ' NOT NULL';
Timothy Warren80ab8162011-08-22 18:26:12 -040099
Andrey Andreev5ef194d2012-06-08 01:12:54 +0300100 if ( ! empty($attributes['AUTO_INCREMENT']) && $attributes['AUTO_INCREMENT'] === TRUE)
Timothy Warren80ab8162011-08-22 18:26:12 -0400101 {
102 $sql .= ' AUTO_INCREMENT';
103 }
104 }
105
106 // don't add a comma on the end of the last field
107 if (++$current_field_count < count($fields))
108 {
109 $sql .= ',';
110 }
111 }
112
113 if (count($primary_keys) > 0)
114 {
Andrey Andreev9637b402012-06-08 15:39:24 +0300115 $sql .= ",\n\tPRIMARY KEY (".implode(', ', $this->db->escape_identifiers($primary_keys)).')';
Timothy Warren80ab8162011-08-22 18:26:12 -0400116 }
117
118 if (is_array($keys) && count($keys) > 0)
119 {
120 foreach ($keys as $key)
121 {
Andrey Andreev5ef194d2012-06-08 01:12:54 +0300122 $key = is_array($key)
Andrey Andreev9637b402012-06-08 15:39:24 +0300123 ? $this->db->escape_identifiers($key)
Andrey Andreev5ef194d2012-06-08 01:12:54 +0300124 : array($this->db->escape_identifiers($key));
Timothy Warren80ab8162011-08-22 18:26:12 -0400125
Andrey Andreev5ef194d2012-06-08 01:12:54 +0300126 $sql .= ",\n\tFOREIGN KEY (".implode(', ', $key).')';
Timothy Warren80ab8162011-08-22 18:26:12 -0400127 }
128 }
129
Andrey Andreev5ef194d2012-06-08 01:12:54 +0300130 return $sql."\n)";
Timothy Warren80ab8162011-08-22 18:26:12 -0400131 }
132
133 // --------------------------------------------------------------------
134
135 /**
Timothy Warren80ab8162011-08-22 18:26:12 -0400136 * Alter table query
137 *
138 * Generates a platform-specific query so that a table can be altered
139 * Called by add_column(), drop_column(), and column_alter(),
140 *
Timothy Warren80ab8162011-08-22 18:26:12 -0400141 * @param string the ALTER type (ADD, DROP, CHANGE)
142 * @param string the column name
143 * @param string the table name
144 * @param string the column definition
145 * @param string the default value
Andrey Andreev9fd79f52012-03-20 23:04:13 +0200146 * @param bool should 'NOT NULL' be added
Timothy Warren80ab8162011-08-22 18:26:12 -0400147 * @param string the field after which we should add the new field
Andrey Andreev9fd79f52012-03-20 23:04:13 +0200148 * @return string
Timothy Warren80ab8162011-08-22 18:26:12 -0400149 */
Andrey Andreeva0d4e412012-04-09 15:06:40 +0300150 protected function _alter_table($alter_type, $table, $column_name, $column_definition = '', $default_value = '', $null = '', $after_field = '')
Timothy Warren80ab8162011-08-22 18:26:12 -0400151 {
Andrey Andreev5ef194d2012-06-08 01:12:54 +0300152 $sql = 'ALTER TABLE '.$this->db->escape_identifiers($table).' '.$alter_type.' '.$this->db->escape_identifiers($column_name);
Timothy Warren80ab8162011-08-22 18:26:12 -0400153
154 // DROP has everything it needs now.
Alex Bilbie48a2baf2012-06-02 11:09:54 +0100155 if ($alter_type === 'DROP')
Timothy Warren80ab8162011-08-22 18:26:12 -0400156 {
157 return $sql;
158 }
159
Andrey Andreev5ef194d2012-06-08 01:12:54 +0300160 return $sql .' '.$column_definition
161 .($default_value !== '' ? " DEFAULT '".$default_value."'" : '')
162 .($null === NULL ? ' NULL' : ' NOT NULL')
163 .($after_field !== '' ? ' AFTER '.$this->db->escape_identifiers($after_field) : '');
Timothy Warren80ab8162011-08-22 18:26:12 -0400164 }
165
Timothy Warren80ab8162011-08-22 18:26:12 -0400166}
167
168/* End of file pdo_forge.php */
Timothy Warren215890b2012-03-20 09:38:16 -0400169/* Location: ./system/database/drivers/pdo/pdo_forge.php */