dbDelta

Создает или изменяет таблицы базы данных на основе переданного SQL запроса на создание таблицы.

В функцию предается SQL запрос на создание таблицы (CREATE TABLE) и если таблицы еще нет, то она будет создана, если она уже есть, то будет обновлена.

При обновлении таблицы, передаваемый запрос на создание таблицы разбирается на части и на его основе вносятся изменения в существующую таблицу.

Требования

Так как функция разбирает передаваемый запрос, он должен соответствовать требованиям:

  1. Каждое поле должно быть на новой строке.

  2. В запросе не должно быть двойных переносов строк, т.е. например нельзя отделять поля от индексов пустой строкой.

  3. После PRIMARY KEY должно стоять 2 пробела:

    PRIMARY KEY  (id) /* а не PRIMARY KEY (id) */

  4. После KEY до и после названия поля, должен быть только один пробел:

    KEY ip (ip) /* а не KEY  ip (ip) или KEY ip  (ip) */

  5. Для индексов нужно использовать KEY, а не аналог INDEX.

  6. При создании мультиндкесов разделять названия полей нужно только запятой без пробела: KEY field (field,field2), а не KEY field (field, field2)

  7. Нельзя использовать апострофы ( или `) или обратные кавычки для обрамления имен или полей таблиц: $wpdb->table, а не `$wpdb->table`
Заметки по работе функции
  1. При обновлении структуры не учитывается порядок полей. Т.е. если в запросе поле стоит на втором месте и оно добавляется в существующую таблицу, то оно будет добавлено в конец (проверял на WP 4.4).

  2. Также не получится добавить главное поле auto increment с PRIMARY KEY в уже существующую таблицу.

  3. Если индекса не будет в новой структуре, то он не удалиться из уже существующей таблицы. Тоже самое касается и полей.

  4. Если индекс изменен, например к нему добавилось еще одно поле, но название не поменялось, то функция вызовет ошибку (индекс уже существует). Вообще для обновления индексов, лучше делать отдельные запросы…
Когда стоит использовать dbDelta?

Подходит для создания новых таблиц, полей, индексов, для изменения структуры полей.

Не подходит для изменения структуры индексов, для удаления полей или индексов. Любое удаление в структуре полей, нужно делать отдельными запросами. Изменение структуры имеющихся индексов также нужно делать отдельно.

Функция не определена по умолчанию, поэтому чтобы она работала нужно подключить файл wp-admin/includes/upgrade.php:

require_once(ABSPATH . 'wp-admin/includes/upgrade.php');
Хуки из функции:
dbdelta_create_queries
dbdelta_insert_queries
dbdelta_queries
Возвращает

Массив. Строки, содержащие результаты различных SQL запросов.

Использование

dbDelta( $queries, $execute );
$queries(строка/массив)

SQL запрос.
Можно указать строку с несколькими запросами (разделяются точкой с запятой).
Можно указать массив где каждый элемент должен быть отдельным SQL запросом.

Внутреннее использование (обычно это вообще не нужно). Если установить в этот параметр одно из значение: ”, ‘all’, ‘blog’, ‘global’, ‘ms_global’. То $queries получит запросы на создание таблиц WordPress, где:

  • blog — SQL запросы для создания таблиц блога: $wpdb->posts, $wpdb->comments и т.д.
  • global — для создания глобальных таблиц, к ним относятся: $wpdb->users (отличается для мультисайтов) и $wpdb->usermeta.
  • ms_global — для создания глобальных таблиц в MU сборке.
  • all — запросы для создания всех возможных таблицы WordPress: включает blog и global.

По умолчанию: ”

$execute(логический)
Выполнять указанные в $queries запросы или нет. false — не выполнять.
По умолчанию: true

Примеры

#1 Создание произвольной таблицы в базе данных

Создаваемая таблица должна иметь префикс, который записан в wp-config.php получить его можно вот так из объекта класса $wpdb->get_blog_prefix() или так $wpdb->prefix. Так же можно получить кодировку по умолчанию указанную там же: $wpdb->charset и $wpdb->collate.

function create_table() {
	global $wpdb;

	require_once(ABSPATH . 'wp-admin/includes/upgrade.php');

	$table_name = $wpdb->get_blog_prefix() . 'test_table';
	$charset_collate = "DEFAULT CHARACTER SET {$wpdb->charset} COLLATE {$wpdb->collate}";

	$sql = "CREATE TABLE {$table_name} (
	id  bigint(20) unsigned NOT NULL auto_increment,
	address varchar(255) NOT NULL default '',
	alert varchar(20) NOT NULL default '',
	meta longtext NOT NULL default '',
	PRIMARY KEY  (id),
	KEY alert (alert)
	)
	{$charset_collate};";

	dbDelta($sql);
}

create_table();

Здесь функция создает таблицу {префикс}test_table содержащую колонки id, address, alert и meta. id — это первичный ключ с автоинкрементом. Поле alert устанавливается как индексируемое.

#2 Добавляем колонку в имеющуюся таблицу

В этом примере функция добавляет еще одну колонку в таблицу с названием ‘test_table’, функция dbDelta() позволяет сделать это наиболее удобно.

function update_table() {
	global $wpdb;

	require_once(ABSPATH . 'wp-admin/includes/upgrade.php');

	$table_name = $wpdb->get_blog_prefix() . 'test_table';
	$charset_collate = "DEFAULT CHARACTER SET {$wpdb->charset} COLLATE {$wpdb->collate}";

	$sql = "CREATE TABLE {$table_name} (
	id  bigint(20) unsigned NOT NULL auto_increment,
	address varchar(255) NOT NULL default '',
	alert varchar(20) NOT NULL default '',
	meta longtext NOT NULL default '',
	new_meta longtext NOT NULL default '',
	PRIMARY KEY  (id),
	KEY alert (alert)
	)
	{$charset_collate};";

	dbDelta($sql);
}

update_table();

Код из


wp-admin/includes/upgrade.php

WP 4.7.2

<?php
function dbDelta( $queries = '', $execute = true ) {
	global $wpdb;

	if ( in_array( $queries, array( '', 'all', 'blog', 'global', 'ms_global' ), true ) )
	    $queries = wp_get_db_schema( $queries );

	// Separate individual queries into an array
	if ( !is_array($queries) ) {
		$queries = explode( ';', $queries );
		$queries = array_filter( $queries );
	}

	/**
	 * Filters the dbDelta SQL queries.
	 *
	 * @since 3.3.0
	 *
	 * @param array $queries An array of dbDelta SQL queries.
	 */
	$queries = apply_filters( 'dbdelta_queries', $queries );

	$cqueries = array(); // Creation Queries
	$iqueries = array(); // Insertion Queries
	$for_update = array();

	// Create a tablename index for an array ($cqueries) of queries
	foreach ($queries as $qry) {
		if ( preg_match( "|CREATE TABLE ([^ ]*)|", $qry, $matches ) ) {
			$cqueries[ trim( $matches[1], '`' ) ] = $qry;
			$for_update[$matches[1]] = 'Created table '.$matches[1];
		} elseif ( preg_match( "|CREATE DATABASE ([^ ]*)|", $qry, $matches ) ) {
			array_unshift( $cqueries, $qry );
		} elseif ( preg_match( "|INSERT INTO ([^ ]*)|", $qry, $matches ) ) {
			$iqueries[] = $qry;
		} elseif ( preg_match( "|UPDATE ([^ ]*)|", $qry, $matches ) ) {
			$iqueries[] = $qry;
		} else {
			// Unrecognized query type
		}
	}

	/**
	 * Filters the dbDelta SQL queries for creating tables and/or databases.
	 *
	 * Queries filterable via this hook contain "CREATE TABLE" or "CREATE DATABASE".
	 *
	 * @since 3.3.0
	 *
	 * @param array $cqueries An array of dbDelta create SQL queries.
	 */
	$cqueries = apply_filters( 'dbdelta_create_queries', $cqueries );

	/**
	 * Filters the dbDelta SQL queries for inserting or updating.
	 *
	 * Queries filterable via this hook contain "INSERT INTO" or "UPDATE".
	 *
	 * @since 3.3.0
	 *
	 * @param array $iqueries An array of dbDelta insert or update SQL queries.
	 */
	$iqueries = apply_filters( 'dbdelta_insert_queries', $iqueries );

	$text_fields = array( 'tinytext', 'text', 'mediumtext', 'longtext' );
	$blob_fields = array( 'tinyblob', 'blob', 'mediumblob', 'longblob' );

	$global_tables = $wpdb->tables( 'global' );
	foreach ( $cqueries as $table => $qry ) {
		// Upgrade global tables only for the main site. Don't upgrade at all if conditions are not optimal.
		if ( in_array( $table, $global_tables ) && ! wp_should_upgrade_global_tables() ) {
			unset( $cqueries[ $table ], $for_update[ $table ] );
			continue;
		}

		// Fetch the table column structure from the database
		$suppress = $wpdb->suppress_errors();
		$tablefields = $wpdb->get_results("DESCRIBE {$table};");
		$wpdb->suppress_errors( $suppress );

		if ( ! $tablefields )
			continue;

		// Clear the field and index arrays.
		$cfields = $indices = array();

		// Get all of the field names in the query from between the parentheses.
		preg_match("|((.*))|ms", $qry, $match2);
		$qryline = trim($match2[1]);

		// Separate field lines into an array.
		$flds = explode("n", $qryline);

		// For every field line specified in the query.
		foreach ( $flds as $fld ) {
			$fld = trim( $fld, " tnr              

Комментарии:


Оставить комментарий

Your email address will not be published. Required fields are marked *