blob: 5650af7be0695e7f84a57c7a1e9a8af86f943df4 [file] [log] [blame]
Andrey Andreevc5536aa2012-11-01 17:33:58 +02001<?php
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 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 */
Andrey Andreevc5536aa2012-11-01 17:33:58 +020027defined('BASEPATH') OR exit('No direct script access allowed');
Derek Allard2067d1a2008-11-13 22:59:24 +000028
Derek Allard2067d1a2008-11-13 22:59:24 +000029/**
30 * SQLite Forge Class
31 *
32 * @category Database
Derek Jonesf4a4bd82011-10-20 12:18:42 -050033 * @author EllisLab Dev Team
Derek Allard2067d1a2008-11-13 22:59:24 +000034 * @link http://codeigniter.com/user_guide/database/
35 */
36class CI_DB_sqlite_forge extends CI_DB_forge {
37
38 /**
39 * Create database
40 *
Derek Allard2067d1a2008-11-13 22:59:24 +000041 * @param string the database name
42 * @return bool
43 */
Andrey Andreevd947eba2012-04-09 14:58:28 +030044 public function create_database($db_name = '')
Derek Allard2067d1a2008-11-13 22:59:24 +000045 {
46 // In SQLite, a database is created when you connect to the database.
47 // We'll return TRUE so that an error isn't generated
48 return TRUE;
49 }
50
51 // --------------------------------------------------------------------
52
53 /**
54 * Drop database
55 *
Andrey Andreevd947eba2012-04-09 14:58:28 +030056 * @param string the database name (ignored)
Derek Allard2067d1a2008-11-13 22:59:24 +000057 * @return bool
58 */
Andrey Andreevd947eba2012-04-09 14:58:28 +030059 public function drop_database($db_name = '')
Derek Allard2067d1a2008-11-13 22:59:24 +000060 {
61 if ( ! @file_exists($this->db->database) OR ! @unlink($this->db->database))
62 {
Andrey Andreevd9038782012-01-26 12:38:49 +020063 return ($this->db->db_debug) ? $this->db->display_error('db_unable_to_drop') : FALSE;
Derek Allard2067d1a2008-11-13 22:59:24 +000064 }
Andrey Andreev5d281762012-06-11 22:05:40 +030065 elseif ( ! empty($this->db->data_cache['db_names']))
66 {
67 $key = array_search(strtolower($this->db->database), array_map('strtolower', $this->db->data_cache['db_names']), TRUE);
68 if ($key !== FALSE)
69 {
70 unset($this->db->data_cache['db_names'][$key]);
71 }
72 }
Andrey Andreevd9038782012-01-26 12:38:49 +020073
Derek Allard2067d1a2008-11-13 22:59:24 +000074 return TRUE;
75 }
Andrey Andreev8480f7c2012-03-20 16:55:05 +020076
Derek Allard2067d1a2008-11-13 22:59:24 +000077 // --------------------------------------------------------------------
78
79 /**
80 * Create Table
81 *
Derek Allard2067d1a2008-11-13 22:59:24 +000082 * @param string the table name
83 * @param array the fields
84 * @param mixed primary key(s)
85 * @param mixed key(s)
Andrey Andreevd9038782012-01-26 12:38:49 +020086 * @param bool should 'IF NOT EXISTS' be added to the SQL
Derek Allard2067d1a2008-11-13 22:59:24 +000087 * @return bool
88 */
Andrey Andreeva0d4e412012-04-09 15:06:40 +030089 protected function _create_table($table, $fields, $primary_keys, $keys, $if_not_exists)
Derek Allard2067d1a2008-11-13 22:59:24 +000090 {
91 $sql = 'CREATE TABLE ';
Barry Mienydd671972010-10-04 16:33:58 +020092
Derek Allard2067d1a2008-11-13 22:59:24 +000093 // IF NOT EXISTS added to SQLite in 3.3.0
Andrey Andreev08856b82012-03-03 03:19:28 +020094 if ($if_not_exists === TRUE && version_compare($this->db->version(), '3.3.0', '>=') === TRUE)
Derek Allard2067d1a2008-11-13 22:59:24 +000095 {
96 $sql .= 'IF NOT EXISTS ';
97 }
Barry Mienydd671972010-10-04 16:33:58 +020098
Andrey Andreevea09a8a2012-04-06 20:50:07 +030099 $sql .= $this->db->escape_identifiers($table).' (';
Derek Allard2067d1a2008-11-13 22:59:24 +0000100 $current_field_count = 0;
101
Andrey Andreevd9038782012-01-26 12:38:49 +0200102 foreach ($fields as $field => $attributes)
Derek Allard2067d1a2008-11-13 22:59:24 +0000103 {
104 // Numeric field names aren't allowed in databases, so if the key is
105 // numeric, we know it was assigned by PHP and the developer manually
106 // entered the field information, so we'll simply add it to the list
107 if (is_numeric($field))
108 {
Andrey Andreevd9038782012-01-26 12:38:49 +0200109 $sql .= "\n\t".$attributes;
Derek Allard2067d1a2008-11-13 22:59:24 +0000110 }
111 else
112 {
113 $attributes = array_change_key_case($attributes, CASE_UPPER);
Barry Mienydd671972010-10-04 16:33:58 +0200114
Andrey Andreev94115572012-06-07 21:34:56 +0300115 $sql .= "\n\t".$this->db->escape_identifiers($field).' '.$attributes['TYPE'];
Andrey Andreev58dc7542012-05-02 13:24:19 +0300116
Andrey Andreev96869042012-06-06 14:12:15 +0300117 empty($attributes['CONSTRAINT']) OR $sql .= '('.$attributes['CONSTRAINT'].')';
Andrey Andreev58dc7542012-05-02 13:24:19 +0300118
Andrey Andreev96869042012-06-06 14:12:15 +0300119 if ( ! empty($attributes['UNSIGNED']) && $attributes['UNSIGNED'] === TRUE)
Derek Allard2067d1a2008-11-13 22:59:24 +0000120 {
121 $sql .= ' UNSIGNED';
122 }
Andrey Andreev58dc7542012-05-02 13:24:19 +0300123
Andrey Andreev96869042012-06-06 14:12:15 +0300124 if (isset($attributes['DEFAULT']))
Derek Allard2067d1a2008-11-13 22:59:24 +0000125 {
Andrey Andreev94115572012-06-07 21:34:56 +0300126 $sql .= " DEFAULT '".$attributes['DEFAULT']."'";
Derek Allard2067d1a2008-11-13 22:59:24 +0000127 }
Andrey Andreev58dc7542012-05-02 13:24:19 +0300128
Andrey Andreev58dc7542012-05-02 13:24:19 +0300129
Andrey Andreev96869042012-06-06 14:12:15 +0300130 $sql .= ( ! empty($attributes['NULL']) && $attributes['NULL'] === TRUE)
131 ? ' NULL' : ' NOT NULL';
132
133 if ( ! empty($attributes['AUTO_INCREMENT']) && $attributes['AUTO_INCREMENT'] === TRUE)
Derek Allard2067d1a2008-11-13 22:59:24 +0000134 {
135 $sql .= ' AUTO_INCREMENT';
136 }
137 }
Barry Mienydd671972010-10-04 16:33:58 +0200138
Derek Allard2067d1a2008-11-13 22:59:24 +0000139 // don't add a comma on the end of the last field
140 if (++$current_field_count < count($fields))
141 {
142 $sql .= ',';
143 }
144 }
145
146 if (count($primary_keys) > 0)
147 {
Andrey Andreev9637b402012-06-08 15:39:24 +0300148 $sql .= ",\n\tPRIMARY KEY (".implode(', ', $this->db->escape_identifiers($primary_keys)).')';
Derek Allard2067d1a2008-11-13 22:59:24 +0000149 }
150
151 if (is_array($keys) && count($keys) > 0)
152 {
153 foreach ($keys as $key)
154 {
Andrey Andreev94115572012-06-07 21:34:56 +0300155 $key = is_array($key)
Andrey Andreev9637b402012-06-08 15:39:24 +0300156 ? $this->db->escape_identifiers($key)
Andrey Andreevdf6aed22012-06-07 21:59:02 +0300157 : array($this->db->escape_identifiers($key));
Barry Mienydd671972010-10-04 16:33:58 +0200158
Andrey Andreevd9038782012-01-26 12:38:49 +0200159 $sql .= ",\n\tUNIQUE (".implode(', ', $key).')';
Derek Allard2067d1a2008-11-13 22:59:24 +0000160 }
161 }
162
Andrey Andreevd9038782012-01-26 12:38:49 +0200163 return $sql."\n)";
Derek Allard2067d1a2008-11-13 22:59:24 +0000164 }
165
166 // --------------------------------------------------------------------
167
168 /**
Derek Allard2067d1a2008-11-13 22:59:24 +0000169 * Alter table query
170 *
171 * Generates a platform-specific query so that a table can be altered
172 * Called by add_column(), drop_column(), and column_alter(),
173 *
Derek Allard2067d1a2008-11-13 22:59:24 +0000174 * @param string the ALTER type (ADD, DROP, CHANGE)
175 * @param string the column name
176 * @param string the table name
177 * @param string the column definition
178 * @param string the default value
Andrey Andreev8480f7c2012-03-20 16:55:05 +0200179 * @param bool should 'NOT NULL' be added
Derek Allard2067d1a2008-11-13 22:59:24 +0000180 * @param string the field after which we should add the new field
Andrey Andreevd9038782012-01-26 12:38:49 +0200181 * @return string
Derek Allard2067d1a2008-11-13 22:59:24 +0000182 */
Andrey Andreeva0d4e412012-04-09 15:06:40 +0300183 protected function _alter_table($alter_type, $table, $column_name, $column_definition = '', $default_value = '', $null = '', $after_field = '')
Derek Allard2067d1a2008-11-13 22:59:24 +0000184 {
Andrey Andreevd9038782012-01-26 12:38:49 +0200185 /* SQLite only supports adding new columns and it does
186 * NOT support the AFTER statement. Each new column will
187 * be added as the last one in the table.
188 */
189 if ($alter_type !== 'ADD COLUMN')
Derek Allard2067d1a2008-11-13 22:59:24 +0000190 {
Andrey Andreevd9038782012-01-26 12:38:49 +0200191 // Not supported
Derek Allard2067d1a2008-11-13 22:59:24 +0000192 return FALSE;
193 }
194
Andrey Andreev5ef194d2012-06-08 01:12:54 +0300195 return 'ALTER TABLE '.$this->db->escape_identifiers($table).' '.$alter_type.' '.$this->db->escape_identifiers($column_name)
Andrey Andreevd9038782012-01-26 12:38:49 +0200196 .' '.$column_definition
Andrey Andreev94115572012-06-07 21:34:56 +0300197 .($default_value != '' ? " DEFAULT '".$default_value."'" : '')
Andrey Andreevd9038782012-01-26 12:38:49 +0200198 // If NOT NULL is specified, the field must have a DEFAULT value other than NULL
199 .(($null !== NULL && $default_value !== 'NULL') ? ' NOT NULL' : ' NULL');
Derek Allard2067d1a2008-11-13 22:59:24 +0000200 }
201
Derek Allard2067d1a2008-11-13 22:59:24 +0000202}
203
204/* End of file sqlite_forge.php */
Timothy Warren215890b2012-03-20 09:38:16 -0400205/* Location: ./system/database/drivers/sqlite/sqlite_forge.php */