blob: dd6f0f78dea0933703599f7965a8bf9ae9fe23dc [file] [log] [blame]
Andrey Andreev8480f7c2012-03-20 16:55:05 +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 Andreev8480f7c2012-03-20 16:55:05 +02008 *
Derek Jonesf4a4bd82011-10-20 12:18:42 -05009 * Licensed under the Open Software License version 3.0
Andrey Andreev8480f7c2012-03-20 16:55:05 +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 * SQLite 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_sqlite_forge extends CI_DB_forge {
36
37 /**
38 * Create database
39 *
Derek Allard2067d1a2008-11-13 22:59:24 +000040 * @param string the database name
41 * @return bool
42 */
Andrey Andreevd947eba2012-04-09 14:58:28 +030043 public function create_database($db_name = '')
Derek Allard2067d1a2008-11-13 22:59:24 +000044 {
45 // In SQLite, a database is created when you connect to the database.
46 // We'll return TRUE so that an error isn't generated
47 return TRUE;
48 }
49
50 // --------------------------------------------------------------------
51
52 /**
53 * Drop database
54 *
Andrey Andreevd947eba2012-04-09 14:58:28 +030055 * @param string the database name (ignored)
Derek Allard2067d1a2008-11-13 22:59:24 +000056 * @return bool
57 */
Andrey Andreevd947eba2012-04-09 14:58:28 +030058 public function drop_database($db_name = '')
Derek Allard2067d1a2008-11-13 22:59:24 +000059 {
60 if ( ! @file_exists($this->db->database) OR ! @unlink($this->db->database))
61 {
Andrey Andreevd947eba2012-04-09 14:58:28 +030062 return ($this->db->db_debug) ? $this->db->display_error('db_unable_to_drop') : FALSE;
Derek Allard2067d1a2008-11-13 22:59:24 +000063 }
Andrey Andreevd947eba2012-04-09 14:58:28 +030064
Derek Allard2067d1a2008-11-13 22:59:24 +000065 return TRUE;
66 }
Andrey Andreev8480f7c2012-03-20 16:55:05 +020067
Derek Allard2067d1a2008-11-13 22:59:24 +000068 // --------------------------------------------------------------------
69
70 /**
71 * Create Table
72 *
Derek Allard2067d1a2008-11-13 22:59:24 +000073 * @param string the table name
74 * @param array the fields
75 * @param mixed primary key(s)
76 * @param mixed key(s)
Andrey Andreev8480f7c2012-03-20 16:55:05 +020077 * @param bool should 'IF NOT EXISTS' be added to the SQL
Derek Allard2067d1a2008-11-13 22:59:24 +000078 * @return bool
79 */
Andrey Andreeva0d4e412012-04-09 15:06:40 +030080 protected function _create_table($table, $fields, $primary_keys, $keys, $if_not_exists)
Derek Allard2067d1a2008-11-13 22:59:24 +000081 {
82 $sql = 'CREATE TABLE ';
Barry Mienydd671972010-10-04 16:33:58 +020083
Derek Allard2067d1a2008-11-13 22:59:24 +000084 // IF NOT EXISTS added to SQLite in 3.3.0
Andrey Andreev08856b82012-03-03 03:19:28 +020085 if ($if_not_exists === TRUE && version_compare($this->db->version(), '3.3.0', '>=') === TRUE)
Derek Allard2067d1a2008-11-13 22:59:24 +000086 {
87 $sql .= 'IF NOT EXISTS ';
88 }
Barry Mienydd671972010-10-04 16:33:58 +020089
Andrey Andreevea09a8a2012-04-06 20:50:07 +030090 $sql .= $this->db->escape_identifiers($table).' (';
Derek Allard2067d1a2008-11-13 22:59:24 +000091 $current_field_count = 0;
92
Andrey Andreevea09a8a2012-04-06 20:50:07 +030093 foreach ($fields as $field => $attributes)
Derek Allard2067d1a2008-11-13 22:59:24 +000094 {
95 // Numeric field names aren't allowed in databases, so if the key is
96 // numeric, we know it was assigned by PHP and the developer manually
97 // entered the field information, so we'll simply add it to the list
98 if (is_numeric($field))
99 {
100 $sql .= "\n\t$attributes";
101 }
102 else
103 {
104 $attributes = array_change_key_case($attributes, CASE_UPPER);
Barry Mienydd671972010-10-04 16:33:58 +0200105
Andrey Andreev032e7ea2012-03-06 19:48:35 +0200106 $sql .= "\n\t".$this->db->protect_identifiers($field);
Barry Mienydd671972010-10-04 16:33:58 +0200107
Derek Jones37f4b9c2011-07-01 17:56:50 -0500108 $sql .= ' '.$attributes['TYPE'];
Barry Mienydd671972010-10-04 16:33:58 +0200109
Derek Allard2067d1a2008-11-13 22:59:24 +0000110 if (array_key_exists('CONSTRAINT', $attributes))
111 {
112 $sql .= '('.$attributes['CONSTRAINT'].')';
113 }
Barry Mienydd671972010-10-04 16:33:58 +0200114
Derek Allard2067d1a2008-11-13 22:59:24 +0000115 if (array_key_exists('UNSIGNED', $attributes) && $attributes['UNSIGNED'] === TRUE)
116 {
117 $sql .= ' UNSIGNED';
118 }
Barry Mienydd671972010-10-04 16:33:58 +0200119
Derek Allard2067d1a2008-11-13 22:59:24 +0000120 if (array_key_exists('DEFAULT', $attributes))
121 {
122 $sql .= ' DEFAULT \''.$attributes['DEFAULT'].'\'';
123 }
Barry Mienydd671972010-10-04 16:33:58 +0200124
Derek Allard2067d1a2008-11-13 22:59:24 +0000125 if (array_key_exists('NULL', $attributes) && $attributes['NULL'] === TRUE)
126 {
127 $sql .= ' NULL';
128 }
129 else
130 {
Barry Mienydd671972010-10-04 16:33:58 +0200131 $sql .= ' NOT NULL';
Derek Allard2067d1a2008-11-13 22:59:24 +0000132 }
Barry Mienydd671972010-10-04 16:33:58 +0200133
Derek Allard2067d1a2008-11-13 22:59:24 +0000134 if (array_key_exists('AUTO_INCREMENT', $attributes) && $attributes['AUTO_INCREMENT'] === TRUE)
135 {
136 $sql .= ' AUTO_INCREMENT';
137 }
138 }
Barry Mienydd671972010-10-04 16:33:58 +0200139
Derek Allard2067d1a2008-11-13 22:59:24 +0000140 // don't add a comma on the end of the last field
141 if (++$current_field_count < count($fields))
142 {
143 $sql .= ',';
144 }
145 }
146
147 if (count($primary_keys) > 0)
148 {
Andrey Andreev032e7ea2012-03-06 19:48:35 +0200149 $primary_keys = $this->db->protect_identifiers($primary_keys);
Derek Allard2067d1a2008-11-13 22:59:24 +0000150 $sql .= ",\n\tPRIMARY KEY (" . implode(', ', $primary_keys) . ")";
151 }
152
153 if (is_array($keys) && count($keys) > 0)
154 {
155 foreach ($keys as $key)
156 {
157 if (is_array($key))
158 {
Andrey Andreev032e7ea2012-03-06 19:48:35 +0200159 $key = $this->db->protect_identifiers($key);
Derek Allard2067d1a2008-11-13 22:59:24 +0000160 }
161 else
162 {
Andrey Andreev032e7ea2012-03-06 19:48:35 +0200163 $key = array($this->db->protect_identifiers($key));
Derek Allard2067d1a2008-11-13 22:59:24 +0000164 }
Barry Mienydd671972010-10-04 16:33:58 +0200165
Derek Allard2067d1a2008-11-13 22:59:24 +0000166 $sql .= ",\n\tUNIQUE (" . implode(', ', $key) . ")";
167 }
168 }
169
170 $sql .= "\n)";
171
172 return $sql;
173 }
174
175 // --------------------------------------------------------------------
176
177 /**
Derek Allard2067d1a2008-11-13 22:59:24 +0000178 * Alter table query
179 *
180 * Generates a platform-specific query so that a table can be altered
181 * Called by add_column(), drop_column(), and column_alter(),
182 *
Derek Allard2067d1a2008-11-13 22:59:24 +0000183 * @param string the ALTER type (ADD, DROP, CHANGE)
184 * @param string the column name
185 * @param string the table name
186 * @param string the column definition
187 * @param string the default value
Andrey Andreev8480f7c2012-03-20 16:55:05 +0200188 * @param bool should 'NOT NULL' be added
Derek Allard2067d1a2008-11-13 22:59:24 +0000189 * @param string the field after which we should add the new field
Andrey Andreev8480f7c2012-03-20 16:55:05 +0200190 * @return string
Derek Allard2067d1a2008-11-13 22:59:24 +0000191 */
Andrey Andreeva0d4e412012-04-09 15:06:40 +0300192 protected function _alter_table($alter_type, $table, $column_name, $column_definition = '', $default_value = '', $null = '', $after_field = '')
Derek Allard2067d1a2008-11-13 22:59:24 +0000193 {
Andrey Andreev032e7ea2012-03-06 19:48:35 +0200194 $sql = 'ALTER TABLE '.$this->db->protect_identifiers($table).' '.$alter_type.' '.$this->db->protect_identifiers($column_name);
Derek Allard2067d1a2008-11-13 22:59:24 +0000195
196 // DROP has everything it needs now.
197 if ($alter_type == 'DROP')
198 {
199 // SQLite does not support dropping columns
200 // http://www.sqlite.org/omitted.html
201 // http://www.sqlite.org/faq.html#q11
202 return FALSE;
203 }
204
205 $sql .= " $column_definition";
206
207 if ($default_value != '')
208 {
209 $sql .= " DEFAULT \"$default_value\"";
210 }
211
212 if ($null === NULL)
213 {
214 $sql .= ' NULL';
215 }
216 else
217 {
218 $sql .= ' NOT NULL';
219 }
220
221 if ($after_field != '')
222 {
Andrey Andreev032e7ea2012-03-06 19:48:35 +0200223 return $sql.' AFTER '.$this->db->protect_identifiers($after_field);
Derek Allard2067d1a2008-11-13 22:59:24 +0000224 }
Barry Mienydd671972010-10-04 16:33:58 +0200225
Derek Allard2067d1a2008-11-13 22:59:24 +0000226 return $sql;
Barry Mienydd671972010-10-04 16:33:58 +0200227
Derek Allard2067d1a2008-11-13 22:59:24 +0000228 }
229
Derek Allard2067d1a2008-11-13 22:59:24 +0000230}
231
232/* End of file sqlite_forge.php */
Timothy Warren215890b2012-03-20 09:38:16 -0400233/* Location: ./system/database/drivers/sqlite/sqlite_forge.php */