function SchemaIntrospectionTestTrait::assertIndexOnColumns

Same name and namespace in other branches
  1. 9 core/tests/Drupal/Tests/Core/Database/SchemaIntrospectionTestTrait.php \Drupal\Tests\Core\Database\SchemaIntrospectionTestTrait::assertIndexOnColumns()
  2. 8.9.x core/tests/Drupal/Tests/Core/Database/SchemaIntrospectionTestTrait.php \Drupal\Tests\Core\Database\SchemaIntrospectionTestTrait::assertIndexOnColumns()
  3. 10 core/tests/Drupal/Tests/Core/Database/SchemaIntrospectionTestTrait.php \Drupal\Tests\Core\Database\SchemaIntrospectionTestTrait::assertIndexOnColumns()

Checks that an index covering exactly the given column names exists.

Parameters

string $table_name: A non-prefixed table name.

array $column_names: An array of column names

string $index_type: (optional) The type of the index. Can be one of 'index', 'unique' or 'primary'. Defaults to 'index'.

1 call to SchemaIntrospectionTestTrait::assertIndexOnColumns()
DriverSpecificSchemaTestBase::testSchema in core/tests/Drupal/KernelTests/Core/Database/DriverSpecificSchemaTestBase.php
Tests database interactions.

File

core/tests/Drupal/Tests/Core/Database/SchemaIntrospectionTestTrait.php, line 23

Class

SchemaIntrospectionTestTrait
Provides methods for testing database schema characteristics.

Namespace

Drupal\Tests\Core\Database

Code

protected function assertIndexOnColumns($table_name, array $column_names, $index_type = 'index') {
    foreach ($this->getIndexColumnNames($table_name, $index_type) as $index_columns) {
        if ($column_names == $index_columns) {
            $this->assertTrue(TRUE);
            return;
        }
    }
    $this->assertTrue(FALSE);
}

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