Класс Database Forge
Forge в переводе с английского означает «ковать».Класс Database Forge содержит функции, которая помогут вам управлять вашей БД.
Содержание
- Инициализация класса
- Создание БД
- Удаление БД
- Добавление полей
- Добавление ключей
- Создание таблиц
- Удаление таблиц
- Переименование таблиц
- Изменение таблиц
Инициализация класса
Важно: Перед тем, как инициализировать класс Database Forge, драйвер БД должен быть уже запущен, так как класс Database 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 'База данных создана!';
}
$this->dbforge->drop_database('db_name')
Позволяет вам удалить базу данных, указанную в первом параметре. Вернет TRUE или FALSE, в зависимости от успеха или неудачи:
if ($this->dbforge->drop_database('my_db'))
{
echo 'База данных удалена!';
}
Создание и удаление таблиц
Есть несколько вещей, которые вы можете пожелать делать с таблицами. Добавление полей, добавление ключей, изменение столбцов. 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()
$this->dbforge->add_field("label varchar(100) NOT NULL DEFAULT 'default label'");
Примечание: Множественные вызовы add_field() кумулятивны.
Создание поля с первичным идентификатором
Есть специальное исключение для создания полей с идентификаторами. Тип поля автоматически установится в 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`)
Создание таблицы
После того, как поля и ключи продекларированы, вы можете создать таблицу с ними.
$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
Удаление таблицы
Выполнение DROP TABLE
$this->dbforge->drop_table('table_name');
// сделает DROP TABLE IF EXISTS table_name
Переименование таблицы
Выполнит переименование ALTER TABLE RENAME TO
$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(), за исключением того, что она изменяет существующие столбцы, а не добавляет новые. Для того, чтобы изменить имя, вы можете добавить массив с определениями.
$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