function Tasks::checkExtensions

Generic function to check postgresql extensions.

File

core/modules/pgsql/src/Driver/Database/pgsql/Install/Tasks.php, line 250

Class

Tasks

Specifies installation tasks for PostgreSQL databases.

Namespace

Code

public function checkExtensions() {
  $connection = Database::getConnection();
  try {
    // Enable pg_trgm for PostgreSQL 13 or higher.
    // @todo Remove this if-statement in D11 when the minimum required version
    // for PostgreSQL becomes 13 or higher. https://www.drupal.org/i/3357409
    if (version_compare($connection->version(), '13.0', '>=')) {
      $connection->query('CREATE EXTENSION IF NOT EXISTS pg_trgm');
    }
    if ($connection->schema()
      ->extensionExists('pg_trgm')) {
      $this->pass(t('PostgreSQL has the pg_trgm extension enabled.'));
    }
    else {
      $this->fail(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',
      ]));
    }
  } catch (\Exception $e) {
    $this->fail(t('Drupal could not check for the pg_trgm extension: @error.', [
      '@error' => $e->getMessage(),
    ]));
  }
}