blob: 48c5efc977489c0108e916dd10fc83a83e608738 [file] [log] [blame]
Andrey Andreevc5536aa2012-11-01 17:33:58 +02001<?php
Andrey Andreev8ae24c52012-01-16 13:05:23 +02002/**
3 * CodeIgniter
4 *
Andrey Andreevfe9309d2015-01-09 17:48:58 +02005 * An open source application development framework for PHP
Andrey Andreev8ae24c52012-01-16 13:05:23 +02006 *
Andrey Andreevbdb96ca2014-10-28 00:13:31 +02007 * This content is released under the MIT License (MIT)
Andrey Andreev8ae24c52012-01-16 13:05:23 +02008 *
Andrey Andreevcce6bd12018-01-09 11:32:02 +02009 * Copyright (c) 2014 - 2018, British Columbia Institute of Technology
Andrey Andreev8ae24c52012-01-16 13:05:23 +020010 *
Andrey Andreevbdb96ca2014-10-28 00:13:31 +020011 * Permission is hereby granted, free of charge, to any person obtaining a copy
12 * of this software and associated documentation files (the "Software"), to deal
13 * in the Software without restriction, including without limitation the rights
14 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
15 * copies of the Software, and to permit persons to whom the Software is
16 * furnished to do so, subject to the following conditions:
Andrey Andreev8ae24c52012-01-16 13:05:23 +020017 *
Andrey Andreevbdb96ca2014-10-28 00:13:31 +020018 * The above copyright notice and this permission notice shall be included in
19 * all copies or substantial portions of the Software.
20 *
21 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
22 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
23 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
24 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
25 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
26 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
27 * THE SOFTWARE.
28 *
29 * @package CodeIgniter
30 * @author EllisLab Dev Team
Andrey Andreev1924e872016-01-11 12:55:34 +020031 * @copyright Copyright (c) 2008 - 2014, EllisLab, Inc. (https://ellislab.com/)
Andrey Andreevcce6bd12018-01-09 11:32:02 +020032 * @copyright Copyright (c) 2014 - 2018, British Columbia Institute of Technology (http://bcit.ca/)
Andrey Andreevbdb96ca2014-10-28 00:13:31 +020033 * @license http://opensource.org/licenses/MIT MIT License
Andrey Andreevbd202c92016-01-11 12:50:18 +020034 * @link https://codeigniter.com
Andrey Andreevbdb96ca2014-10-28 00:13:31 +020035 * @since Version 3.0.0
Andrey Andreev8ae24c52012-01-16 13:05:23 +020036 * @filesource
37 */
Andrey Andreevc5536aa2012-11-01 17:33:58 +020038defined('BASEPATH') OR exit('No direct script access allowed');
Andrey Andreev8ae24c52012-01-16 13:05:23 +020039
40/**
41 * SQLite3 Forge Class
42 *
43 * @category Database
44 * @author Andrey Andreev
Andrey Andreevbd202c92016-01-11 12:50:18 +020045 * @link https://codeigniter.com/user_guide/database/
Andrey Andreev8ae24c52012-01-16 13:05:23 +020046 */
47class CI_DB_sqlite3_forge extends CI_DB_forge {
48
49 /**
Andrey Andreeva287a342012-11-05 23:19:59 +020050 * UNSIGNED support
51 *
52 * @var bool|array
53 */
54 protected $_unsigned = FALSE;
55
56 /**
57 * NULL value representation in CREATE/ALTER TABLE statements
58 *
59 * @var string
60 */
61 protected $_null = 'NULL';
62
63 // --------------------------------------------------------------------
64
65 /**
66 * Class constructor
67 *
Andrey Andreeveaa60c72012-11-06 01:11:22 +020068 * @param object &$db Database object
Andrey Andreeva287a342012-11-05 23:19:59 +020069 * @return void
70 */
Andrey Andreeveaa60c72012-11-06 01:11:22 +020071 public function __construct(&$db)
Andrey Andreeva287a342012-11-05 23:19:59 +020072 {
Andrey Andreeveaa60c72012-11-06 01:11:22 +020073 parent::__construct($db);
Andrey Andreeva287a342012-11-05 23:19:59 +020074
75 if (version_compare($this->db->version(), '3.3', '<'))
76 {
Andrey Andreev40780c22015-07-02 11:33:02 +030077 $this->_create_table_if = FALSE;
78 $this->_drop_table_if = FALSE;
Andrey Andreeva287a342012-11-05 23:19:59 +020079 }
80 }
81
82 // --------------------------------------------------------------------
83
84 /**
Andrey Andreev8ae24c52012-01-16 13:05:23 +020085 * Create database
86 *
Andrey Andreeva287a342012-11-05 23:19:59 +020087 * @param string $db_name
Andrey Andreev8ae24c52012-01-16 13:05:23 +020088 * @return bool
89 */
Andrey Andreevda270b22016-10-17 18:22:43 +030090 public function create_database($db_name)
Andrey Andreev8ae24c52012-01-16 13:05:23 +020091 {
92 // In SQLite, a database is created when you connect to the database.
93 // We'll return TRUE so that an error isn't generated
94 return TRUE;
95 }
96
97 // --------------------------------------------------------------------
98
99 /**
100 * Drop database
101 *
Andrey Andreeva287a342012-11-05 23:19:59 +0200102 * @param string $db_name (ignored)
Andrey Andreev8ae24c52012-01-16 13:05:23 +0200103 * @return bool
104 */
Andrey Andreevda270b22016-10-17 18:22:43 +0300105 public function drop_database($db_name)
Andrey Andreev8ae24c52012-01-16 13:05:23 +0200106 {
107 // In SQLite, a database is dropped when we delete a file
Andrey Andreev382b5132014-02-26 18:41:59 +0200108 if (file_exists($this->db->database))
Andrey Andreev8ae24c52012-01-16 13:05:23 +0200109 {
110 // We need to close the pseudo-connection first
111 $this->db->close();
112 if ( ! @unlink($this->db->database))
113 {
114 return $this->db->db_debug ? $this->db->display_error('db_unable_to_drop') : FALSE;
115 }
Andrey Andreev5d281762012-06-11 22:05:40 +0300116 elseif ( ! empty($this->db->data_cache['db_names']))
117 {
118 $key = array_search(strtolower($this->db->database), array_map('strtolower', $this->db->data_cache['db_names']), TRUE);
119 if ($key !== FALSE)
120 {
121 unset($this->db->data_cache['db_names'][$key]);
122 }
123 }
Andrey Andreev8ae24c52012-01-16 13:05:23 +0200124
125 return TRUE;
126 }
127
128 return $this->db->db_debug ? $this->db->display_error('db_unable_to_drop') : FALSE;
129 }
130
131 // --------------------------------------------------------------------
132
133 /**
Andrey Andreeva287a342012-11-05 23:19:59 +0200134 * ALTER TABLE
Andrey Andreev8ae24c52012-01-16 13:05:23 +0200135 *
Andrey Andreeva287a342012-11-05 23:19:59 +0200136 * @todo implement drop_column(), modify_column()
137 * @param string $alter_type ALTER type
138 * @param string $table Table name
139 * @param mixed $field Column definition
140 * @return string|string[]
Andrey Andreev8ae24c52012-01-16 13:05:23 +0200141 */
Andrey Andreeva287a342012-11-05 23:19:59 +0200142 protected function _alter_table($alter_type, $table, $field)
Andrey Andreev8ae24c52012-01-16 13:05:23 +0200143 {
Andrey Andreeva287a342012-11-05 23:19:59 +0200144 if ($alter_type === 'DROP' OR $alter_type === 'CHANGE')
Andrey Andreev8ae24c52012-01-16 13:05:23 +0200145 {
Andrey Andreeva287a342012-11-05 23:19:59 +0200146 // drop_column():
147 // BEGIN TRANSACTION;
148 // CREATE TEMPORARY TABLE t1_backup(a,b);
149 // INSERT INTO t1_backup SELECT a,b FROM t1;
150 // DROP TABLE t1;
151 // CREATE TABLE t1(a,b);
152 // INSERT INTO t1 SELECT a,b FROM t1_backup;
153 // DROP TABLE t1_backup;
154 // COMMIT;
155
156 return FALSE;
Andrey Andreev8ae24c52012-01-16 13:05:23 +0200157 }
158
Andrey Andreeva287a342012-11-05 23:19:59 +0200159 return parent::_alter_table($alter_type, $table, $field);
Andrey Andreev8ae24c52012-01-16 13:05:23 +0200160 }
161
162 // --------------------------------------------------------------------
163
164 /**
Andrey Andreeva287a342012-11-05 23:19:59 +0200165 * Process column
Andrey Andreev8ae24c52012-01-16 13:05:23 +0200166 *
Andrey Andreeva287a342012-11-05 23:19:59 +0200167 * @param array $field
Andrey Andreev8ae24c52012-01-16 13:05:23 +0200168 * @return string
169 */
Andrey Andreeva287a342012-11-05 23:19:59 +0200170 protected function _process_column($field)
Andrey Andreev8ae24c52012-01-16 13:05:23 +0200171 {
Andrey Andreeva287a342012-11-05 23:19:59 +0200172 return $this->db->escape_identifiers($field['name'])
173 .' '.$field['type']
174 .$field['auto_increment']
175 .$field['null']
176 .$field['unique']
177 .$field['default'];
178 }
Andrey Andreev8ae24c52012-01-16 13:05:23 +0200179
Andrey Andreeva287a342012-11-05 23:19:59 +0200180 // --------------------------------------------------------------------
181
182 /**
183 * Field attribute TYPE
184 *
185 * Performs a data type mapping between different databases.
186 *
187 * @param array &$attributes
188 * @return void
189 */
190 protected function _attr_type(&$attributes)
191 {
192 switch (strtoupper($attributes['TYPE']))
193 {
194 case 'ENUM':
195 case 'SET':
196 $attributes['TYPE'] = 'TEXT';
197 return;
198 default: return;
199 }
200 }
201
202 // --------------------------------------------------------------------
203
204 /**
205 * Field attribute AUTO_INCREMENT
206 *
207 * @param array &$attributes
208 * @param array &$field
209 * @return void
210 */
211 protected function _attr_auto_increment(&$attributes, &$field)
212 {
213 if ( ! empty($attributes['AUTO_INCREMENT']) && $attributes['AUTO_INCREMENT'] === TRUE && stripos($field['type'], 'int') !== FALSE)
214 {
215 $field['type'] = 'INTEGER PRIMARY KEY';
216 $field['default'] = '';
217 $field['null'] = '';
218 $field['unique'] = '';
219 $field['auto_increment'] = ' AUTOINCREMENT';
220
221 $this->primary_keys = array();
222 }
Andrey Andreev8ae24c52012-01-16 13:05:23 +0200223 }
224
Andrey Andreev8ae24c52012-01-16 13:05:23 +0200225}