blob: ce8eac91e0bd42a8b91fc770ca1bd8b5e76a0d30 [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 *
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 */
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 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 }
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 Andreevd9038782012-01-26 12:38:49 +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 Andreevd9038782012-01-26 12:38:49 +020093 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 {
Andrey Andreevd9038782012-01-26 12:38:49 +0200100 $sql .= "\n\t".$attributes;
Derek Allard2067d1a2008-11-13 22:59:24 +0000101 }
102 else
103 {
104 $attributes = array_change_key_case($attributes, CASE_UPPER);
Barry Mienydd671972010-10-04 16:33:58 +0200105
Andrey Andreevd9038782012-01-26 12:38:49 +0200106 $sql .= "\n\t".$this->db->protect_identifiers($field)
107 .' '.$attributes['TYPE']
Andrey Andreevb537c4d2012-01-26 14:45:45 +0200108 .( ! empty($attributes['CONSTRAINT']) ? '('.$attributes['CONSTRAINT'].')' : '')
109 .(( ! empty($attributes['UNSIGNED']) && $attributes['UNSIGNED'] === TRUE) ? ' UNSIGNED' : '')
Andrey Andreev20ebf142012-01-26 14:14:02 +0200110 .(isset($attributes['DEFAULT']) ? ' DEFAULT \''.$attributes['DEFAULT'].'\'' : '')
Andrey Andreevb537c4d2012-01-26 14:45:45 +0200111 .(( ! empty($attributes['NULL']) && $attributes['NULL'] === TRUE) ? ' NULL' : ' NOT NULL')
112 .(( ! empty($attributes['AUTO_INCREMENT']) && $attributes['AUTO_INCREMENT'] === TRUE) ? ' AUTO_INCREMENT' : '');
Derek Allard2067d1a2008-11-13 22:59:24 +0000113 }
Barry Mienydd671972010-10-04 16:33:58 +0200114
Derek Allard2067d1a2008-11-13 22:59:24 +0000115 // don't add a comma on the end of the last field
116 if (++$current_field_count < count($fields))
117 {
118 $sql .= ',';
119 }
120 }
121
122 if (count($primary_keys) > 0)
123 {
Andrey Andreevd9038782012-01-26 12:38:49 +0200124 $sql .= ",\n\tPRIMARY KEY (".implode(', ', $this->db->protect_identifiers($primary_keys)).')';
Derek Allard2067d1a2008-11-13 22:59:24 +0000125 }
126
127 if (is_array($keys) && count($keys) > 0)
128 {
129 foreach ($keys as $key)
130 {
131 if (is_array($key))
132 {
Andrey Andreevd9038782012-01-26 12:38:49 +0200133 $key = $this->db->protect_identifiers($key);
Derek Allard2067d1a2008-11-13 22:59:24 +0000134 }
135 else
136 {
Andrey Andreevd9038782012-01-26 12:38:49 +0200137 $key = array($this->db->protect_identifiers($key));
Derek Allard2067d1a2008-11-13 22:59:24 +0000138 }
Barry Mienydd671972010-10-04 16:33:58 +0200139
Andrey Andreevd9038782012-01-26 12:38:49 +0200140 $sql .= ",\n\tUNIQUE (".implode(', ', $key).')';
Derek Allard2067d1a2008-11-13 22:59:24 +0000141 }
142 }
143
Andrey Andreevd9038782012-01-26 12:38:49 +0200144 return $sql."\n)";
Derek Allard2067d1a2008-11-13 22:59:24 +0000145 }
146
147 // --------------------------------------------------------------------
148
149 /**
Derek Allard2067d1a2008-11-13 22:59:24 +0000150 * Alter table query
151 *
152 * Generates a platform-specific query so that a table can be altered
153 * Called by add_column(), drop_column(), and column_alter(),
154 *
Derek Allard2067d1a2008-11-13 22:59:24 +0000155 * @param string the ALTER type (ADD, DROP, CHANGE)
156 * @param string the column name
157 * @param string the table name
158 * @param string the column definition
159 * @param string the default value
Andrey Andreev8480f7c2012-03-20 16:55:05 +0200160 * @param bool should 'NOT NULL' be added
Derek Allard2067d1a2008-11-13 22:59:24 +0000161 * @param string the field after which we should add the new field
Andrey Andreevd9038782012-01-26 12:38:49 +0200162 * @return string
Derek Allard2067d1a2008-11-13 22:59:24 +0000163 */
Andrey Andreeva0d4e412012-04-09 15:06:40 +0300164 protected function _alter_table($alter_type, $table, $column_name, $column_definition = '', $default_value = '', $null = '', $after_field = '')
Derek Allard2067d1a2008-11-13 22:59:24 +0000165 {
Andrey Andreevd9038782012-01-26 12:38:49 +0200166 /* SQLite only supports adding new columns and it does
167 * NOT support the AFTER statement. Each new column will
168 * be added as the last one in the table.
169 */
170 if ($alter_type !== 'ADD COLUMN')
Derek Allard2067d1a2008-11-13 22:59:24 +0000171 {
Andrey Andreevd9038782012-01-26 12:38:49 +0200172 // Not supported
Derek Allard2067d1a2008-11-13 22:59:24 +0000173 return FALSE;
174 }
175
Andrey Andreevd9038782012-01-26 12:38:49 +0200176 return 'ALTER TABLE '.$this->db->protect_identifiers($table).' '.$alter_type.' '.$this->db->protect_identifiers($column_name)
177 .' '.$column_definition
178 .($default_value != '' ? ' DEFAULT "'.$default_value.'"' : '')
179 // If NOT NULL is specified, the field must have a DEFAULT value other than NULL
180 .(($null !== NULL && $default_value !== 'NULL') ? ' NOT NULL' : ' NULL');
Derek Allard2067d1a2008-11-13 22:59:24 +0000181 }
182
Derek Allard2067d1a2008-11-13 22:59:24 +0000183}
184
185/* End of file sqlite_forge.php */
Timothy Warren215890b2012-03-20 09:38:16 -0400186/* Location: ./system/database/drivers/sqlite/sqlite_forge.php */