pgsql.install

Same filename in other branches
  1. 11.x core/modules/pgsql/pgsql.install

Install, update and uninstall functions for the pgsql module.

File

core/modules/pgsql/pgsql.install

View source
<?php


/**
 * @file
 * Install, update and uninstall functions for the pgsql module.
 */
use Drupal\Core\Database\Database;
use Drupal\pgsql\Update10101;

/**
 * Implements hook_requirements().
 */
function pgsql_requirements() {
    $requirements = [];
    // Test with PostgreSQL databases for the status of the pg_trgm extension.
    if (Database::isActiveConnection()) {
        $connection = Database::getConnection();
        // Set the requirement just for postgres.
        if ($connection->driver() == 'pgsql') {
            $requirements['pgsql_extension_pg_trgm'] = [
                'severity' => REQUIREMENT_OK,
                'title' => t('PostgreSQL pg_trgm extension'),
                'value' => t('Available'),
                'description' => 'The pg_trgm PostgreSQL extension is present.',
            ];
            // If the extension is not available, set the requirement error.
            if (!$connection->schema()
                ->extensionExists('pg_trgm')) {
                $requirements['pgsql_extension_pg_trgm']['severity'] = REQUIREMENT_ERROR;
                $requirements['pgsql_extension_pg_trgm']['value'] = t('Not created');
                $requirements['pgsql_extension_pg_trgm']['description'] = t('The <a href=":pg_trgm">pg_trgm</a> PostgreSQL extension is not present. The extension is required by Drupal 10 to improve performance when using PostgreSQL. See <a href=":requirements">Drupal database server requirements</a> for more information.', [
                    ':pg_trgm' => 'https://www.postgresql.org/docs/current/pgtrgm.html',
                    ':requirements' => 'https://www.drupal.org/docs/system-requirements/database-server-requirements',
                ]);
            }
        }
    }
    return $requirements;
}

/**
 * Update sequences' owner created from serial columns in PostgreSQL.
 */
function pgsql_update_10101(&$sandbox) {
    \Drupal::classResolver(Update10101::class)->update($sandbox);
}

Functions

Title Deprecated Summary
pgsql_requirements Implements hook_requirements().
pgsql_update_10101 Update sequences' owner created from serial columns in PostgreSQL.

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.