blob: 8bf1f25956ed968e889c65ce15e262a94e550991 [file] [log] [blame]
Andrey Andreevd9038782012-01-26 12:38:49 +02001<?php if ( ! defined('BASEPATH')) exit('No direct script access allowed');
Derek Allard2067d1a2008-11-13 22:59:24 +00002/**
3 * CodeIgniter
4 *
Greg Aker741de1c2010-11-10 14:52:57 -06005 * An open source application development framework for PHP 5.1.6 or newer
Derek Allard2067d1a2008-11-13 22:59:24 +00006 *
Derek Jonesf4a4bd82011-10-20 12:18:42 -05007 * NOTICE OF LICENSE
Andrey Andreevd9038782012-01-26 12:38:49 +02008 *
Derek Jonesf4a4bd82011-10-20 12:18:42 -05009 * Licensed under the Open Software License version 3.0
Andrey Andreevd9038782012-01-26 12:38:49 +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 Andreevd9038782012-01-26 12:38:49 +020043 public function _create_database()
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 *
Derek Allard2067d1a2008-11-13 22:59:24 +000055 * @param string the database name
56 * @return bool
57 */
Andrey Andreevd9038782012-01-26 12:38:49 +020058 public function _drop_database($name)
Derek Allard2067d1a2008-11-13 22:59:24 +000059 {
60 if ( ! @file_exists($this->db->database) OR ! @unlink($this->db->database))
61 {
Andrey Andreevd9038782012-01-26 12:38:49 +020062 return ($this->db->db_debug) ? $this->db->display_error('db_unable_to_drop') : FALSE;
Derek Allard2067d1a2008-11-13 22:59:24 +000063 }
Andrey Andreevd9038782012-01-26 12:38:49 +020064
Derek Allard2067d1a2008-11-13 22:59:24 +000065 return TRUE;
66 }
67 // --------------------------------------------------------------------
68
69 /**
70 * Create Table
71 *
Derek Allard2067d1a2008-11-13 22:59:24 +000072 * @param string the table name
73 * @param array the fields
74 * @param mixed primary key(s)
75 * @param mixed key(s)
Andrey Andreevd9038782012-01-26 12:38:49 +020076 * @param bool should 'IF NOT EXISTS' be added to the SQL
Derek Allard2067d1a2008-11-13 22:59:24 +000077 * @return bool
78 */
Andrey Andreevd9038782012-01-26 12:38:49 +020079 public function _create_table($table, $fields, $primary_keys, $keys, $if_not_exists)
Derek Allard2067d1a2008-11-13 22:59:24 +000080 {
81 $sql = 'CREATE TABLE ';
Barry Mienydd671972010-10-04 16:33:58 +020082
Derek Allard2067d1a2008-11-13 22:59:24 +000083 // IF NOT EXISTS added to SQLite in 3.3.0
Derek Jones4bde1102010-03-30 08:56:53 -050084 if ($if_not_exists === TRUE && version_compare($this->db->_version(), '3.3.0', '>=') === TRUE)
Derek Allard2067d1a2008-11-13 22:59:24 +000085 {
86 $sql .= 'IF NOT EXISTS ';
87 }
Barry Mienydd671972010-10-04 16:33:58 +020088
Andrey Andreevd9038782012-01-26 12:38:49 +020089 $sql .= $this->db->_escape_identifiers($table).'(';
Derek Allard2067d1a2008-11-13 22:59:24 +000090 $current_field_count = 0;
91
Andrey Andreevd9038782012-01-26 12:38:49 +020092 foreach ($fields as $field => $attributes)
Derek Allard2067d1a2008-11-13 22:59:24 +000093 {
94 // Numeric field names aren't allowed in databases, so if the key is
95 // numeric, we know it was assigned by PHP and the developer manually
96 // entered the field information, so we'll simply add it to the list
97 if (is_numeric($field))
98 {
Andrey Andreevd9038782012-01-26 12:38:49 +020099 $sql .= "\n\t".$attributes;
Derek Allard2067d1a2008-11-13 22:59:24 +0000100 }
101 else
102 {
103 $attributes = array_change_key_case($attributes, CASE_UPPER);
Barry Mienydd671972010-10-04 16:33:58 +0200104
Andrey Andreevd9038782012-01-26 12:38:49 +0200105 $sql .= "\n\t".$this->db->protect_identifiers($field)
106 .' '.$attributes['TYPE']
107 .(array_key_exists('CONSTRAINT', $attributes) ? '('.$attributes['CONSTRAINT'].')' : '')
108 .((array_key_exists('UNSIGNED', $attributes) && $attributes['UNSIGNED'] === TRUE) ? ' UNSIGNED' : '')
109 .(array_key_exists('DEFAULT', $attributes) ? ' DEFAULT \''.$attributes['DEFAULT'].'\'' : '')
110 .((array_key_exists('NULL', $attributes) && $attributes['NULL'] === TRUE) ? ' NULL' : ' NOT NULL')
111 .((array_key_exists('AUTO_INCREMENT', $attributes) && $attributes['AUTO_INCREMENT'] === TRUE) ? ' AUTO_INCREMENT' : '');
Derek Allard2067d1a2008-11-13 22:59:24 +0000112 }
Barry Mienydd671972010-10-04 16:33:58 +0200113
Derek Allard2067d1a2008-11-13 22:59:24 +0000114 // don't add a comma on the end of the last field
115 if (++$current_field_count < count($fields))
116 {
117 $sql .= ',';
118 }
119 }
120
121 if (count($primary_keys) > 0)
122 {
Andrey Andreevd9038782012-01-26 12:38:49 +0200123 $sql .= ",\n\tPRIMARY KEY (".implode(', ', $this->db->protect_identifiers($primary_keys)).')';
Derek Allard2067d1a2008-11-13 22:59:24 +0000124 }
125
126 if (is_array($keys) && count($keys) > 0)
127 {
128 foreach ($keys as $key)
129 {
130 if (is_array($key))
131 {
Andrey Andreevd9038782012-01-26 12:38:49 +0200132 $key = $this->db->protect_identifiers($key);
Derek Allard2067d1a2008-11-13 22:59:24 +0000133 }
134 else
135 {
Andrey Andreevd9038782012-01-26 12:38:49 +0200136 $key = array($this->db->protect_identifiers($key));
Derek Allard2067d1a2008-11-13 22:59:24 +0000137 }
Barry Mienydd671972010-10-04 16:33:58 +0200138
Andrey Andreevd9038782012-01-26 12:38:49 +0200139 $sql .= ",\n\tUNIQUE (".implode(', ', $key).')';
Derek Allard2067d1a2008-11-13 22:59:24 +0000140 }
141 }
142
Andrey Andreevd9038782012-01-26 12:38:49 +0200143 return $sql."\n)";
Derek Allard2067d1a2008-11-13 22:59:24 +0000144 }
145
146 // --------------------------------------------------------------------
147
148 /**
149 * Drop Table
150 *
Andrey Andreevd9038782012-01-26 12:38:49 +0200151 * @return string
Derek Allard2067d1a2008-11-13 22:59:24 +0000152 */
Andrey Andreevd9038782012-01-26 12:38:49 +0200153 public function _drop_table($table)
Derek Allard2067d1a2008-11-13 22:59:24 +0000154 {
Andrey Andreevd9038782012-01-26 12:38:49 +0200155 return 'DROP TABLE '.$table.' IF EXISTS';
Derek Allard2067d1a2008-11-13 22:59:24 +0000156 }
157
158 // --------------------------------------------------------------------
159
160 /**
161 * Alter table query
162 *
163 * Generates a platform-specific query so that a table can be altered
164 * Called by add_column(), drop_column(), and column_alter(),
165 *
Derek Allard2067d1a2008-11-13 22:59:24 +0000166 * @param string the ALTER type (ADD, DROP, CHANGE)
167 * @param string the column name
168 * @param string the table name
169 * @param string the column definition
170 * @param string the default value
171 * @param boolean should 'NOT NULL' be added
172 * @param string the field after which we should add the new field
Andrey Andreevd9038782012-01-26 12:38:49 +0200173 * @return string
Derek Allard2067d1a2008-11-13 22:59:24 +0000174 */
Andrey Andreevd9038782012-01-26 12:38:49 +0200175 public function _alter_table($alter_type, $table, $column_name, $column_definition = '', $default_value = '', $null = '', $after_field = '')
Derek Allard2067d1a2008-11-13 22:59:24 +0000176 {
Andrey Andreevd9038782012-01-26 12:38:49 +0200177 /* SQLite only supports adding new columns and it does
178 * NOT support the AFTER statement. Each new column will
179 * be added as the last one in the table.
180 */
181 if ($alter_type !== 'ADD COLUMN')
Derek Allard2067d1a2008-11-13 22:59:24 +0000182 {
Andrey Andreevd9038782012-01-26 12:38:49 +0200183 // Not supported
Derek Allard2067d1a2008-11-13 22:59:24 +0000184 return FALSE;
185 }
186
Andrey Andreevd9038782012-01-26 12:38:49 +0200187 return 'ALTER TABLE '.$this->db->protect_identifiers($table).' '.$alter_type.' '.$this->db->protect_identifiers($column_name)
188 .' '.$column_definition
189 .($default_value != '' ? ' DEFAULT "'.$default_value.'"' : '')
190 // If NOT NULL is specified, the field must have a DEFAULT value other than NULL
191 .(($null !== NULL && $default_value !== 'NULL') ? ' NOT NULL' : ' NULL');
Derek Allard2067d1a2008-11-13 22:59:24 +0000192 }
193
194 // --------------------------------------------------------------------
195
196 /**
197 * Rename a table
198 *
199 * Generates a platform-specific query so that a table can be renamed
200 *
Derek Allard2067d1a2008-11-13 22:59:24 +0000201 * @param string the old table name
202 * @param string the new table name
203 * @return string
204 */
Andrey Andreevd9038782012-01-26 12:38:49 +0200205 public function _rename_table($table_name, $new_table_name)
Derek Allard2067d1a2008-11-13 22:59:24 +0000206 {
Andrey Andreevd9038782012-01-26 12:38:49 +0200207 return 'ALTER TABLE '.$this->db->protect_identifiers($table_name).' RENAME TO '.$this->db->protect_identifiers($new_table_name);
Derek Allard2067d1a2008-11-13 22:59:24 +0000208 }
209}
210
211/* End of file sqlite_forge.php */
Andrey Andreevd9038782012-01-26 12:38:49 +0200212/* Location: ./system/database/drivers/sqlite/sqlite_forge.php */