class SelectSubqueryTest

Same name in other branches
  1. 9 core/tests/Drupal/KernelTests/Core/Database/SelectSubqueryTest.php \Drupal\KernelTests\Core\Database\SelectSubqueryTest
  2. 8.9.x core/tests/Drupal/KernelTests/Core/Database/SelectSubqueryTest.php \Drupal\KernelTests\Core\Database\SelectSubqueryTest
  3. 11.x core/tests/Drupal/KernelTests/Core/Database/SelectSubqueryTest.php \Drupal\KernelTests\Core\Database\SelectSubqueryTest

Tests the Select query builder.

@group Database

Hierarchy

Expanded class hierarchy of SelectSubqueryTest

File

core/tests/Drupal/KernelTests/Core/Database/SelectSubqueryTest.php, line 12

Namespace

Drupal\KernelTests\Core\Database
View source
class SelectSubqueryTest extends DatabaseTestBase {
    
    /**
     * Tests that we can use a subquery in a FROM clause.
     */
    public function testFromSubquerySelect() : void {
        // Create a subquery, which is just a normal query object.
        $subquery = $this->connection
            ->select('test_task', 'tt');
        $subquery->addField('tt', 'pid', 'pid');
        $subquery->addField('tt', 'task', 'task');
        $subquery->condition('priority', 1);
        for ($i = 0; $i < 2; $i++) {
            // Create another query that joins against the virtual table resulting
            // from the subquery.
            $select = $this->connection
                ->select($subquery, 'tt2');
            $select->join('test', 't', '[t].[id] = [tt2].[pid]');
            $select->addField('t', 'name');
            if ($i) {
                // Use a different number of conditions here to confuse the subquery
                // placeholder counter, testing https://www.drupal.org/node/1112854.
                $select->condition('name', 'John');
            }
            $select->condition('task', 'code');
            // The resulting query should be equivalent to:
            // @code
            // SELECT t.name
            // FROM (SELECT tt.pid AS pid, tt.task AS task FROM test_task tt WHERE priority=1) tt
            //   INNER JOIN test t ON t.id=tt.pid
            // WHERE tt.task = 'code'
            // @endcode
            $people = $select->execute()
                ->fetchCol();
            $this->assertCount(1, $people, 'Returned the correct number of rows.');
        }
    }
    
    /**
     * Tests that we can use a subquery in a FROM clause with a LIMIT.
     */
    public function testFromSubquerySelectWithLimit() : void {
        // Create a subquery, which is just a normal query object.
        $subquery = $this->connection
            ->select('test_task', 'tt');
        $subquery->addField('tt', 'pid', 'pid');
        $subquery->addField('tt', 'task', 'task');
        $subquery->orderBy('priority', 'DESC');
        $subquery->range(0, 1);
        // Create another query that joins against the virtual table resulting
        // from the subquery.
        $select = $this->connection
            ->select($subquery, 'tt2');
        $select->join('test', 't', '[t].[id] = [tt2].[pid]');
        $select->addField('t', 'name');
        // The resulting query should be equivalent to:
        // @code
        // SELECT t.name
        // FROM (SELECT tt.pid AS pid, tt.task AS task FROM test_task tt ORDER BY priority DESC LIMIT 1 OFFSET 0) tt
        //   INNER JOIN test t ON t.id=tt.pid
        // @endcode
        $people = $select->execute()
            ->fetchCol();
        $this->assertCount(1, $people, 'Returned the correct number of rows.');
    }
    
    /**
     * Tests that we can use a subquery with an IN operator in a WHERE clause.
     */
    public function testConditionSubquerySelect() : void {
        // Create a subquery, which is just a normal query object.
        $subquery = $this->connection
            ->select('test_task', 'tt');
        $subquery->addField('tt', 'pid', 'pid');
        $subquery->condition('tt.priority', 1);
        // Create another query that joins against the virtual table resulting
        // from the subquery.
        $select = $this->connection
            ->select('test_task', 'tt2');
        $select->addField('tt2', 'task');
        $select->condition('tt2.pid', $subquery, 'IN');
        // The resulting query should be equivalent to:
        // SELECT tt2.name
        // FROM test tt2
        // WHERE tt2.pid IN (SELECT tt.pid AS pid FROM test_task tt WHERE tt.priority=1)
        $people = $select->execute()
            ->fetchCol();
        $this->assertCount(5, $people, 'Returned the correct number of rows.');
    }
    
    /**
     * Tests we can use a subquery with a relational operator in a WHERE clause.
     */
    public function testConditionSubquerySelect2() : void {
        // Create a subquery, which is just a normal query object.
        $subquery = $this->connection
            ->select('test', 't2');
        $subquery->addExpression('AVG([t2].[age])');
        // Create another query that adds a clause using the subquery.
        $select = $this->connection
            ->select('test', 't');
        $select->addField('t', 'name');
        $select->condition('t.age', $subquery, '<');
        // The resulting query should be equivalent to:
        // SELECT t.name
        // FROM test t
        // WHERE t.age < (SELECT AVG(t2.age) FROM test t2)
        $people = $select->execute()
            ->fetchCol();
        $this->assertEqualsCanonicalizing([
            'John',
            'Paul',
        ], $people, 'Returned Paul and John.');
    }
    
    /**
     * Tests we can use 2 subqueries with a relational operator in a WHERE clause.
     */
    public function testConditionSubquerySelect3() : void {
        // Create subquery 1, which is just a normal query object.
        $subquery1 = $this->connection
            ->select('test_task', 'tt');
        $subquery1->addExpression('AVG([tt].[priority])');
        $subquery1->where('[tt].[pid] = [t].[id]');
        // Create subquery 2, which is just a normal query object.
        $subquery2 = $this->connection
            ->select('test_task', 'tt2');
        $subquery2->addExpression('AVG([tt2].[priority])');
        // Create another query that adds a clause using the subqueries.
        $select = $this->connection
            ->select('test', 't');
        $select->addField('t', 'name');
        $select->condition($subquery1, $subquery2, '>');
        // The resulting query should be equivalent to:
        // SELECT t.name
        // FROM test t
        // WHERE (SELECT AVG(tt.priority) FROM test_task tt WHERE tt.pid = t.id) > (SELECT AVG(tt2.priority) FROM test_task tt2)
        $people = $select->execute()
            ->fetchCol();
        $this->assertEqualsCanonicalizing([
            'John',
        ], $people, 'Returned John.');
    }
    
    /**
     * Tests that we can use multiple subqueries.
     *
     * This test uses a subquery at the left hand side and multiple subqueries at
     * the right hand side. The test query may not be that logical but that's due
     * to the limited amount of data and tables. 'Valid' use cases do exist :)
     */
    public function testConditionSubquerySelect4() : void {
        // Create subquery 1, which is just a normal query object.
        $subquery1 = $this->connection
            ->select('test_task', 'tt');
        $subquery1->addExpression('AVG([tt].[priority])');
        $subquery1->where('[tt].[pid] = [t].[id]');
        // Create subquery 2, which is just a normal query object.
        $subquery2 = $this->connection
            ->select('test_task', 'tt2');
        $subquery2->addExpression('MIN([tt2].[priority])');
        $subquery2->where('[tt2].[pid] <> [t].[id]');
        // Create subquery 3, which is just a normal query object.
        $subquery3 = $this->connection
            ->select('test_task', 'tt3');
        $subquery3->addExpression('AVG([tt3].[priority])');
        $subquery3->where('[tt3].[pid] <> [t].[id]');
        // Create another query that adds a clause using the subqueries.
        $select = $this->connection
            ->select('test', 't');
        $select->addField('t', 'name');
        $select->condition($subquery1, [
            $subquery2,
            $subquery3,
        ], 'BETWEEN');
        // The resulting query should be equivalent to:
        // @code
        // SELECT t.name AS name
        // FROM {test} t
        // WHERE (SELECT AVG(tt.priority) AS expression FROM {test_task} tt WHERE (tt.pid = t.id))
        //   BETWEEN (SELECT MIN(tt2.priority) AS expression FROM {test_task} tt2 WHERE (tt2.pid <> t.id))
        //       AND (SELECT AVG(tt3.priority) AS expression FROM {test_task} tt3 WHERE (tt3.pid <> t.id));
        // @endcode
        $people = $select->execute()
            ->fetchCol();
        $this->assertEqualsCanonicalizing([
            'George',
            'Paul',
        ], $people, 'Returned George and Paul.');
    }
    
    /**
     * Tests that we can use a subquery in a JOIN clause.
     */
    public function testJoinSubquerySelect() : void {
        // Create a subquery, which is just a normal query object.
        $subquery = $this->connection
            ->select('test_task', 'tt');
        $subquery->addField('tt', 'pid', 'pid');
        $subquery->condition('priority', 1);
        // Create another query that joins against the virtual table resulting
        // from the subquery.
        $select = $this->connection
            ->select('test', 't');
        $select->join($subquery, 'tt', '[t].[id] = [tt].[pid]');
        $select->addField('t', 'name');
        // The resulting query should be equivalent to:
        // @code
        // SELECT t.name
        // FROM test t
        //   INNER JOIN (SELECT tt.pid AS pid FROM test_task tt WHERE priority=1) tt ON t.id=tt.pid
        // @endcode
        $people = $select->execute()
            ->fetchCol();
        $this->assertCount(2, $people, 'Returned the correct number of rows.');
    }
    
    /**
     * Tests EXISTS subquery conditionals on SELECT statements.
     *
     * We essentially select all rows from the {test} table that have matching
     * rows in the {test_people} table based on the shared name column.
     */
    public function testExistsSubquerySelect() : void {
        // Put George into {test_people}.
        $this->connection
            ->insert('test_people')
            ->fields([
            'name' => 'George',
            'age' => 27,
            'job' => 'Singer',
        ])
            ->execute();
        // Base query to {test}.
        $query = $this->connection
            ->select('test', 't')
            ->fields('t', [
            'name',
        ]);
        // Subquery to {test_people}.
        $subquery = $this->connection
            ->select('test_people', 'tp')
            ->fields('tp', [
            'name',
        ])
            ->where('[tp].[age] = [t].[age]');
        $query->exists($subquery);
        $result = $query->execute();
        // Ensure that we got the right record.
        $record = $result->fetch();
        $this->assertEquals('George', $record->name, 'Fetched name is correct using EXISTS query.');
    }
    
    /**
     * Tests NOT EXISTS subquery conditionals on SELECT statements.
     *
     * We essentially select all rows from the {test} table that don't have
     * matching rows in the {test_people} table based on the shared name column.
     */
    public function testNotExistsSubquerySelect() : void {
        // Put George into {test_people}.
        $this->connection
            ->insert('test_people')
            ->fields([
            'name' => 'George',
            'age' => 27,
            'job' => 'Singer',
        ])
            ->execute();
        // Base query to {test}.
        $query = $this->connection
            ->select('test', 't')
            ->fields('t', [
            'name',
        ]);
        // Subquery to {test_people}.
        $subquery = $this->connection
            ->select('test_people', 'tp')
            ->fields('tp', [
            'name',
        ])
            ->where('[tp].[age] = [t].[age]');
        $query->notExists($subquery);
        // Ensure that we got the right number of records.
        $people = $query->execute()
            ->fetchCol();
        $this->assertCount(3, $people, 'NOT EXISTS query returned the correct results.');
    }

}

Members

Title Sort descending Deprecated Modifiers Object type Summary Overriden Title Overrides
AssertContentTrait::$content protected property The current raw content.
AssertContentTrait::$drupalSettings protected property The drupalSettings value from the current raw $content.
AssertContentTrait::$elements protected property The XML structure parsed from the current raw $content. 1
AssertContentTrait::$plainTextContent protected property The plain-text content of raw $content (text nodes).
AssertContentTrait::assertEscaped protected function Passes if the raw text IS found escaped on the loaded page, fail otherwise.
AssertContentTrait::assertField protected function Asserts that a field exists with the given name or ID.
AssertContentTrait::assertFieldById protected function Asserts that a field exists with the given ID and value.
AssertContentTrait::assertFieldByName protected function Asserts that a field exists with the given name and value.
AssertContentTrait::assertFieldByXPath protected function Asserts that a field exists in the current page by the given XPath.
AssertContentTrait::assertFieldChecked protected function Asserts that a checkbox field in the current page is checked.
AssertContentTrait::assertFieldsByValue protected function Asserts that a field exists in the current page with a given Xpath result.
AssertContentTrait::assertLink protected function Passes if a link with the specified label is found.
AssertContentTrait::assertLinkByHref protected function Passes if a link containing a given href (part) is found.
AssertContentTrait::assertNoDuplicateIds protected function Asserts that each HTML ID is used for just a single element.
AssertContentTrait::assertNoEscaped protected function Passes if raw text IS NOT found escaped on loaded page, fail otherwise.
AssertContentTrait::assertNoField protected function Asserts that a field does not exist with the given name or ID.
AssertContentTrait::assertNoFieldById protected function Asserts that a field does not exist with the given ID and value.
AssertContentTrait::assertNoFieldByName protected function Asserts that a field does not exist with the given name and value.
AssertContentTrait::assertNoFieldByXPath protected function Asserts that a field does not exist or its value does not match, by XPath.
AssertContentTrait::assertNoFieldChecked protected function Asserts that a checkbox field in the current page is not checked.
AssertContentTrait::assertNoLink protected function Passes if a link with the specified label is not found.
AssertContentTrait::assertNoLinkByHref protected function Passes if a link containing a given href (part) is not found.
AssertContentTrait::assertNoLinkByHrefInMainRegion protected function Passes if a link containing a given href is not found in the main region.
AssertContentTrait::assertNoOption protected function Asserts that a select option in the current page does not exist.
AssertContentTrait::assertNoOptionSelected protected function Asserts that a select option in the current page is not checked.
AssertContentTrait::assertNoPattern protected function Triggers a pass if the perl regex pattern is not found in raw content.
AssertContentTrait::assertNoRaw protected function Passes if the raw text is NOT found on the loaded page, fail otherwise.
AssertContentTrait::assertNoText protected function Passes if the page (with HTML stripped) does not contains the text.
AssertContentTrait::assertNoTitle protected function Pass if the page title is not the given string.
AssertContentTrait::assertNoUniqueText protected function Passes if the text is found MORE THAN ONCE on the text version of the page.
AssertContentTrait::assertOption protected function Asserts that a select option in the current page exists.
AssertContentTrait::assertOptionByText protected function Asserts that a select option with the visible text exists.
AssertContentTrait::assertOptionSelected protected function Asserts that a select option in the current page is checked.
AssertContentTrait::assertOptionSelectedWithDrupalSelector protected function Asserts that a select option in the current page is checked.
AssertContentTrait::assertOptionWithDrupalSelector protected function Asserts that a select option in the current page exists.
AssertContentTrait::assertPattern protected function Triggers a pass if the Perl regex pattern is found in the raw content.
AssertContentTrait::assertRaw protected function Passes if the raw text IS found on the loaded page, fail otherwise.
AssertContentTrait::assertText protected function Passes if the page (with HTML stripped) contains the text.
AssertContentTrait::assertTextHelper protected function Helper for assertText and assertNoText.
AssertContentTrait::assertTextPattern protected function Asserts that a Perl regex pattern is found in the plain-text content.
AssertContentTrait::assertThemeOutput protected function Asserts themed output.
AssertContentTrait::assertTitle protected function Pass if the page title is the given string.
AssertContentTrait::assertUniqueText protected function Passes if the text is found ONLY ONCE on the text version of the page.
AssertContentTrait::assertUniqueTextHelper protected function Helper for assertUniqueText and assertNoUniqueText.
AssertContentTrait::buildXPathQuery protected function Builds an XPath query.
AssertContentTrait::constructFieldXpath protected function Helper: Constructs an XPath for the given set of attributes and value.
AssertContentTrait::cssSelect protected function Searches elements using a CSS selector in the raw content.
AssertContentTrait::getAllOptions protected function Get all option elements, including nested options, in a select.
AssertContentTrait::getDrupalSettings protected function Gets the value of drupalSettings for the currently-loaded page.
AssertContentTrait::getRawContent protected function Gets the current raw content.
AssertContentTrait::getSelectedItem protected function Get the selected value from a select field.
AssertContentTrait::getTextContent protected function Retrieves the plain-text content from the current raw content.
AssertContentTrait::parse protected function Parse content returned from curlExec using DOM and SimpleXML.
AssertContentTrait::removeWhiteSpace protected function Removes all white-space between HTML tags from the raw content.
AssertContentTrait::setDrupalSettings protected function Sets the value of drupalSettings for the currently-loaded page.
AssertContentTrait::setRawContent protected function Sets the raw content (e.g. HTML).
AssertContentTrait::xpath protected function Performs an xpath search on the contents of the internal browser.
ConfigTestTrait::configImporter protected function Returns a ConfigImporter object to import test configuration.
ConfigTestTrait::copyConfig protected function Copies configuration objects from source storage to target storage.
DatabaseTestBase::$connection protected property The database connection for testing.
DatabaseTestBase::$modules protected static property Modules to install. Overrides KernelTestBase::$modules 3
DatabaseTestBase::ensureSampleDataNull public function Sets up tables for NULL handling.
DatabaseTestBase::setUp protected function Overrides KernelTestBase::setUp 1
DatabaseTestSchemaDataTrait::addSampleData protected function Sets up our sample data.
DatabaseTestSchemaInstallTrait::installSampleSchema protected function Sets up our sample table schema.
ExtensionListTestTrait::getModulePath protected function Gets the path for the specified module.
ExtensionListTestTrait::getThemePath protected function Gets the path for the specified theme.
KernelTestBase::$backupGlobals protected property Back up and restore any global variables that may be changed by tests.
KernelTestBase::$backupStaticAttributes protected property Back up and restore static class properties that may be changed by tests.
KernelTestBase::$backupStaticAttributesBlacklist protected property Contains a few static class properties for performance.
KernelTestBase::$classLoader protected property
KernelTestBase::$configImporter protected property @todo Move into Config test base class. 6
KernelTestBase::$configSchemaCheckerExclusions protected static property An array of config object names that are excluded from schema checking. 3
KernelTestBase::$container protected property
KernelTestBase::$databasePrefix protected property
KernelTestBase::$keyValue protected property The key_value service that must persist between container rebuilds.
KernelTestBase::$preserveGlobalState protected property Do not forward any global state from the parent process to the processes
that run the actual tests.
KernelTestBase::$root protected property The app root.
KernelTestBase::$runTestInSeparateProcess protected property Kernel tests are run in separate processes because they allow autoloading
of code from extensions. Running the test in a separate process isolates
this behavior from other tests. Subclasses should not override this
property.
KernelTestBase::$siteDirectory protected property
KernelTestBase::$strictConfigSchema protected property Set to TRUE to strict check all configuration saved. 9
KernelTestBase::$usesSuperUserAccessPolicy protected property Set to TRUE to make user 1 a super user. 7
KernelTestBase::$vfsRoot protected property The virtual filesystem root directory.
KernelTestBase::assertPostConditions protected function 1
KernelTestBase::bootEnvironment protected function Bootstraps a basic test environment.
KernelTestBase::bootKernel protected function Bootstraps a kernel for a test. 1
KernelTestBase::config protected function Configuration accessor for tests. Returns non-overridden configuration.
KernelTestBase::disableModules protected function Disables modules for this test.
KernelTestBase::enableModules protected function Enables modules for this test. 1
KernelTestBase::getConfigSchemaExclusions protected function Gets the config schema exclusions for this test.
KernelTestBase::getDatabaseConnectionInfo protected function Returns the Database connection info to be used for this test. 2
KernelTestBase::getDatabasePrefix public function
KernelTestBase::getExtensionsForModules private function Returns Extension objects for $modules to install.
KernelTestBase::getModulesToEnable private static function Returns the modules to install for this test.
KernelTestBase::initFileCache protected function Initializes the FileCache component.
KernelTestBase::installConfig protected function Installs default configuration for a given list of modules.
KernelTestBase::installEntitySchema protected function Installs the storage schema for a specific entity type.
KernelTestBase::installSchema protected function Installs database tables from a module schema definition.
KernelTestBase::register public function Registers test-specific services. Overrides ServiceProviderInterface::register 27
KernelTestBase::render protected function Renders a render array. 1
KernelTestBase::setInstallProfile protected function Sets the install profile and rebuilds the container to update it.
KernelTestBase::setSetting protected function Sets an in-memory Settings variable.
KernelTestBase::setUpBeforeClass public static function 1
KernelTestBase::setUpFilesystem protected function Sets up the filesystem, so things like the file directory. 2
KernelTestBase::stop Deprecated protected function Stops test execution.
KernelTestBase::tearDown protected function 6
KernelTestBase::tearDownCloseDatabaseConnection public function @after
KernelTestBase::vfsDump protected function Dumps the current state of the virtual filesystem to STDOUT.
KernelTestBase::__get public function
KernelTestBase::__sleep public function Prevents serializing any properties.
PhpUnitWarnings::$deprecationWarnings private static property Deprecation warnings from PHPUnit to raise with @trigger_error().
PhpUnitWarnings::addWarning public function Converts PHPUnit deprecation warnings to E_USER_DEPRECATED.
RandomGeneratorTrait::getRandomGenerator protected function Gets the random generator for the utility methods.
RandomGeneratorTrait::randomMachineName protected function Generates a unique random string containing letters and numbers.
RandomGeneratorTrait::randomObject public function Generates a random PHP object.
RandomGeneratorTrait::randomString public function Generates a pseudo-random string of ASCII characters of codes 32 to 126.
RandomGeneratorTrait::randomStringValidate Deprecated public function Callback for random string validation.
SelectSubqueryTest::testConditionSubquerySelect public function Tests that we can use a subquery with an IN operator in a WHERE clause.
SelectSubqueryTest::testConditionSubquerySelect2 public function Tests we can use a subquery with a relational operator in a WHERE clause.
SelectSubqueryTest::testConditionSubquerySelect3 public function Tests we can use 2 subqueries with a relational operator in a WHERE clause.
SelectSubqueryTest::testConditionSubquerySelect4 public function Tests that we can use multiple subqueries.
SelectSubqueryTest::testExistsSubquerySelect public function Tests EXISTS subquery conditionals on SELECT statements.
SelectSubqueryTest::testFromSubquerySelect public function Tests that we can use a subquery in a FROM clause.
SelectSubqueryTest::testFromSubquerySelectWithLimit public function Tests that we can use a subquery in a FROM clause with a LIMIT.
SelectSubqueryTest::testJoinSubquerySelect public function Tests that we can use a subquery in a JOIN clause.
SelectSubqueryTest::testNotExistsSubquerySelect public function Tests NOT EXISTS subquery conditionals on SELECT statements.
StorageCopyTrait::replaceStorageContents protected static function Copy the configuration from one storage to another and remove stale items.
TestRequirementsTrait::checkModuleRequirements Deprecated private function Checks missing module requirements.
TestRequirementsTrait::checkRequirements Deprecated protected function Check module requirements for the Drupal use case.
TestRequirementsTrait::getDrupalRoot protected static function Returns the Drupal root directory.

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