Класс Database Forge (управление базой данных)
Класс Database Forge содержит функции, которые помогут вам управлять вашей базой данных.
Содержание
- Инициализация класса Forge
- Создание базы данных
- Удаление базы данных
- Добавление полей
- Добавление ключей
- Создание таблицы
- Удаление таблицы
- Переименование таблицы
- Изменение таблицы
Инициализация класса Forge
Важно: для того, чтобы инициализировать класс Forge, ваш драйвер БД уже должен быть запущен, так как класс Forge зависит от него.
Загрузка класса Forge:
$this->load->dbforge()
После инициализации вы можете использовать функции класса через объект $this->dbforge:
$this->dbforge->some_function()
$this->dbforge->create_database('db_name')
Позволяет вам создать базу данных, указанную в первом параметре. Возвращает TRUE или FALSE, в зависимости от успеха или неудачи:
if ($this->dbforge->create_database('my_db'))
{
echo 'Database created!';
}
$this->dbforge->drop_database('db_name')
Позволяет вам удалить базу данных, указанную в первом параметре. Возвращает TRUE или FALSE, в зависимости от успеха или неудачи:
if ($this->dbforge->drop_database('my_db'))
{
echo 'Database deleted!';
}
Создание и удаление таблиц
Есть несоклько вещей, которые вы можете сделать при создании таблиц. Добавить поля, добавить ключи в таблицу, изменить столбцы. CodeIgniter предоставлет простой и удобный механизм для этого.
Добавление полей
Поля создаются посредством передачи ассоциативного массива. Вы должны включать в массив ключ 'type', который указывает на тип поля БД. Например, INT, VARCHAR, TEXT и так далее. Много типов данных (например VARCHAR) также требуют ключ 'constraint'.
$fields = array(
'users' => array(
'type' => 'VARCHAR',
'constraint' => '100',
),
);
// будет переведено в "users VARCHAR(100)" для добавления поля.
Дополнительно могут быть использованы следующие ключи и значения:
- unsigned/true : генерирует "UNSIGNED" в определении поля.
- default/value : генерирует значение по умолчанию в определении поля.
- null/true : генерирует "NULL" в определении поля. Без этого значение поля по умолчанию будет "NOT NULL".
- auto_increment/true : генерирует флаг автоинкремента поля. Обратите внимание, что тип поля должен поддерживать автоинкремент, к примеру integer.
$fields = array(
'blog_id' => array(
'type' => 'INT',
'constraint' => 5,
'unsigned' => TRUE,
'auto_increment' => TRUE
),
'blog_title' => array(
'type' => 'VARCHAR',
'constraint' => '100',
),
'blog_author' => array(
'type' =>'VARCHAR',
'constraint' => '100',
'default' => 'King of Town',
),
'blog_description' => array(
'type' => 'TEXT',
'null' => TRUE,
),
);
После того, как поля определены, они могут быть добавлены в таблицу посредством функции $this->dbforge->add_field($fields);, следующей за вызовом create_table().
$this->dbforge->add_field()
Функция add_field() принимает массив выше.
Передача описания поля строкой
Если вы знаете, какое поле необходимо создать, вы можете передать строку с определениями в add_field()
$this->dbforge->add_field("label varchar(100) NOT NULL DEFAULT 'default label'");
Примечание: Множественные вызовы add_field() кумулятивны (информация будет накапливаться).
Создание поля id
Есть специальное исключение для создания полей id. Поле с типом id будет автоматически установлено в INT(9) auto_incrementing Primary Key.
$this->dbforge->add_field('id');
// дает id INT(9) NOT NULL AUTO_INCREMENT
Добавление ключей
Вообще говоря, вы можете захотеть, чтобы таблица имела ключи. Это осуществляется функцией $this->dbforge->add_key('field'). Второй опциональный параметр, если его установить в TRUE, сделает первичный ключ. Обратите внимание, что add_key() должен следовать за вызовом create_table().
Множественный столбец непервичных ключей должен быть отправлен массивом. Представлены образцы вывода для MySQL.
$this->dbforge->add_key('blog_id', TRUE);
// дает PRIMARY KEY `blog_id` (`blog_id`)
$this->dbforge->add_key('blog_id', TRUE);
$this->dbforge->add_key('site_id', TRUE);
// дает PRIMARY KEY `blog_id_site_id` (`blog_id`, `site_id`)
$this->dbforge->add_key('blog_name');
// дает KEY `blog_name` (`blog_name`)
$this->dbforge->add_key(array('blog_name', 'blog_label'));
// дает KEY `blog_name_blog_label` (`blog_name`, `blog_label`)
Creating a table
После того, как поля и ключи декларированы, вы можете создать новую таблицу
$this->dbforge->create_table('table_name');
// дает CREATE TABLE table_name
Второй опциональный параметр, если он установлен в TRUE, добавит условие "IF NOT EXISTS" в определение.
$this->dbforge->create_table('table_name', TRUE);
// дает CREATE TABLE IF NOT EXISTS table_name
Удаление таблицы
Выполнение SQL DROP TABLE
$this->dbforge->drop_table('table_name');
// дает DROP TABLE IF EXISTS table_name
Переименование таблицы
Выполняет TABLE rename
$this->dbforge->rename_table('old_table_name', 'new_table_name');
// дает ALTER TABLE old_table_name RENAME TO new_table_name
Изменение таблиц
$this->dbforge->add_column()
Функция add_column() используется для изменения существующей таблицы. Оно принимает тот же массив поля, что и выше, и позволяет использовать неограниченное количество полей.
$fields = array(
'preferences' => array('type' => 'TEXT')
);
$this->dbforge->add_column('table_name', $fields);
// дает ALTER TABLE table_name ADD preferences TEXT
$this->dbforge->drop_column()
Используется для удаления столбца из таблицы.
$this->dbforge->drop_column('table_name', 'column_to_drop');
$this->dbforge->modify_column()
Использование этой функции идентично add_column(), за исключением того, что она изменяет существующие столбцы, а не создает новые. Для использования вы должны передать ключ "name" в массив, определяющий поле.
$fields = array(
'old_name' => array(
'name' => 'new_name',
'type' => 'TEXT',
),
);
$this->dbforge->modify_column('table_name', $fields);
// дает ALTER TABLE table_name CHANGE old_name new_name TEXT