3 use Wikimedia\Rdbms\IDatabase
;
4 use Wikimedia\Rdbms\LikeMatch
;
5 use Wikimedia\Rdbms\Database
;
6 use Wikimedia\TestingAccessWrapper
;
7 use Wikimedia\Rdbms\DBUnexpectedError
;
10 * Test the parts of the Database abstract class that deal
11 * with creating SQL text.
13 class DatabaseSQLTest
extends PHPUnit\Framework\TestCase
{
15 use MediaWikiCoversValidator
;
17 /** @var DatabaseTestHelper|Database */
20 protected function setUp() {
22 $this->database
= new DatabaseTestHelper( __CLASS__
, [ 'cliMode' => true ] );
25 protected function assertLastSql( $sqlText ) {
28 $this->database
->getLastSqls()
32 protected function assertLastSqlDb( $sqlText, DatabaseTestHelper
$db ) {
33 $this->assertEquals( $sqlText, $db->getLastSqls() );
37 * @dataProvider provideSelect
38 * @covers Wikimedia\Rdbms\Database::select
39 * @covers Wikimedia\Rdbms\Database::selectSQLText
40 * @covers Wikimedia\Rdbms\Database::tableNamesWithIndexClauseOrJOIN
41 * @covers Wikimedia\Rdbms\Database::useIndexClause
42 * @covers Wikimedia\Rdbms\Database::ignoreIndexClause
43 * @covers Wikimedia\Rdbms\Database::makeSelectOptions
44 * @covers Wikimedia\Rdbms\Database::makeOrderBy
45 * @covers Wikimedia\Rdbms\Database::makeGroupByWithHaving
47 public function testSelect( $sql, $sqlText ) {
48 $this->database
->select(
51 isset( $sql['conds'] ) ?
$sql['conds'] : [],
53 isset( $sql['options'] ) ?
$sql['options'] : [],
54 isset( $sql['join_conds'] ) ?
$sql['join_conds'] : []
56 $this->assertLastSql( $sqlText );
59 public static function provideSelect() {
64 'fields' => [ 'field', 'alias' => 'field2' ],
65 'conds' => [ 'alias' => 'text' ],
67 "SELECT field,field2 AS alias " .
69 "WHERE alias = 'text'"
74 'fields' => [ 'field', 'alias' => 'field2' ],
75 'conds' => 'alias = \'text\'',
77 "SELECT field,field2 AS alias " .
79 "WHERE alias = 'text'"
84 'fields' => [ 'field', 'alias' => 'field2' ],
87 "SELECT field,field2 AS alias " .
93 'fields' => [ 'field', 'alias' => 'field2' ],
96 "SELECT field,field2 AS alias " .
102 'fields' => [ 'field', 'alias' => 'field2' ],
103 'conds' => '0', // T188314
105 "SELECT field,field2 AS alias " .
111 // 'tables' with space prepended indicates pre-escaped table name
112 'tables' => ' table LEFT JOIN table2',
113 'fields' => [ 'field' ],
114 'conds' => [ 'field' => 'text' ],
116 "SELECT field FROM table LEFT JOIN table2 WHERE field = 'text'"
120 // Empty 'tables' is allowed
122 'fields' => [ 'SPECIAL_QUERY()' ],
124 "SELECT SPECIAL_QUERY()"
129 'fields' => [ 'field', 'alias' => 'field2' ],
130 'conds' => [ 'alias' => 'text' ],
131 'options' => [ 'LIMIT' => 1, 'ORDER BY' => 'field' ],
133 "SELECT field,field2 AS alias " .
135 "WHERE alias = 'text' " .
141 'tables' => [ 'table', 't2' => 'table2' ],
142 'fields' => [ 'tid', 'field', 'alias' => 'field2', 't2.id' ],
143 'conds' => [ 'alias' => 'text' ],
144 'options' => [ 'LIMIT' => 1, 'ORDER BY' => 'field' ],
145 'join_conds' => [ 't2' => [
146 'LEFT JOIN', 'tid = t2.id'
149 "SELECT tid,field,field2 AS alias,t2.id " .
150 "FROM table LEFT JOIN table2 t2 ON ((tid = t2.id)) " .
151 "WHERE alias = 'text' " .
157 'tables' => [ 'table', 't2' => 'table2' ],
158 'fields' => [ 'tid', 'field', 'alias' => 'field2', 't2.id' ],
159 'conds' => [ 'alias' => 'text' ],
160 'options' => [ 'LIMIT' => 1, 'GROUP BY' => 'field', 'HAVING' => 'COUNT(*) > 1' ],
161 'join_conds' => [ 't2' => [
162 'LEFT JOIN', 'tid = t2.id'
165 "SELECT tid,field,field2 AS alias,t2.id " .
166 "FROM table LEFT JOIN table2 t2 ON ((tid = t2.id)) " .
167 "WHERE alias = 'text' " .
168 "GROUP BY field HAVING COUNT(*) > 1 " .
173 'tables' => [ 'table', 't2' => 'table2' ],
174 'fields' => [ 'tid', 'field', 'alias' => 'field2', 't2.id' ],
175 'conds' => [ 'alias' => 'text' ],
178 'GROUP BY' => [ 'field', 'field2' ],
179 'HAVING' => [ 'COUNT(*) > 1', 'field' => 1 ]
181 'join_conds' => [ 't2' => [
182 'LEFT JOIN', 'tid = t2.id'
185 "SELECT tid,field,field2 AS alias,t2.id " .
186 "FROM table LEFT JOIN table2 t2 ON ((tid = t2.id)) " .
187 "WHERE alias = 'text' " .
188 "GROUP BY field,field2 HAVING (COUNT(*) > 1) AND field = '1' " .
193 'tables' => [ 'table' ],
194 'fields' => [ 'alias' => 'field' ],
195 'conds' => [ 'alias' => [ 1, 2, 3, 4 ] ],
197 "SELECT field AS alias " .
199 "WHERE alias IN ('1','2','3','4')"
204 'fields' => [ 'field' ],
205 'options' => [ 'USE INDEX' => [ 'table' => 'X' ] ],
208 "SELECT field FROM table"
213 'fields' => [ 'field' ],
214 'options' => [ 'IGNORE INDEX' => [ 'table' => 'X' ] ],
217 "SELECT field FROM table"
222 'fields' => [ 'field' ],
223 'options' => [ 'DISTINCT', 'LOCK IN SHARE MODE' ],
225 "SELECT DISTINCT field FROM table LOCK IN SHARE MODE"
230 'fields' => [ 'field' ],
231 'options' => [ 'EXPLAIN' => true ],
233 'EXPLAIN SELECT field FROM table'
238 'fields' => [ 'field' ],
239 'options' => [ 'FOR UPDATE' ],
241 "SELECT field FROM table FOR UPDATE"
247 * @covers Wikimedia\Rdbms\Subquery
248 * @dataProvider provideSelectRowCount
252 public function testSelectRowCount( $sql, $sqlText ) {
253 $this->database
->selectRowCount(
256 isset( $sql['conds'] ) ?
$sql['conds'] : [],
258 isset( $sql['options'] ) ?
$sql['options'] : [],
259 isset( $sql['join_conds'] ) ?
$sql['join_conds'] : []
261 $this->assertLastSql( $sqlText );
264 public static function provideSelectRowCount() {
270 'conds' => [ 'field' => 'text' ],
272 "SELECT COUNT(*) AS rowcount FROM " .
273 "(SELECT 1 FROM table WHERE field = 'text' ) tmp_count"
278 'field' => [ 'column' ],
279 'conds' => [ 'field' => 'text' ],
281 "SELECT COUNT(*) AS rowcount FROM " .
282 "(SELECT 1 FROM table WHERE field = 'text' AND (column IS NOT NULL) ) tmp_count"
287 'field' => [ 'alias' => 'column' ],
288 'conds' => [ 'field' => 'text' ],
290 "SELECT COUNT(*) AS rowcount FROM " .
291 "(SELECT 1 FROM table WHERE field = 'text' AND (column IS NOT NULL) ) tmp_count"
296 'field' => [ 'alias' => 'column' ],
299 "SELECT COUNT(*) AS rowcount FROM " .
300 "(SELECT 1 FROM table WHERE (column IS NOT NULL) ) tmp_count"
305 'field' => [ 'alias' => 'column' ],
308 "SELECT COUNT(*) AS rowcount FROM " .
309 "(SELECT 1 FROM table WHERE (column IS NOT NULL) ) tmp_count"
314 'field' => [ 'alias' => 'column' ],
317 "SELECT COUNT(*) AS rowcount FROM " .
318 "(SELECT 1 FROM table WHERE (column IS NOT NULL) ) tmp_count"
323 'field' => [ 'alias' => 'column' ],
326 "SELECT COUNT(*) AS rowcount FROM " .
327 "(SELECT 1 FROM table WHERE (1) AND (column IS NOT NULL) ) tmp_count"
332 'field' => [ 'alias' => 'column' ],
335 "SELECT COUNT(*) AS rowcount FROM " .
336 "(SELECT 1 FROM table WHERE (0) AND (column IS NOT NULL) ) tmp_count"
342 * @dataProvider provideUpdate
343 * @covers Wikimedia\Rdbms\Database::update
344 * @covers Wikimedia\Rdbms\Database::makeUpdateOptions
345 * @covers Wikimedia\Rdbms\Database::makeUpdateOptionsArray
347 public function testUpdate( $sql, $sqlText ) {
348 $this->database
->update(
353 isset( $sql['options'] ) ?
$sql['options'] : []
355 $this->assertLastSql( $sqlText );
358 public static function provideUpdate() {
363 'values' => [ 'field' => 'text', 'field2' => 'text2' ],
364 'conds' => [ 'alias' => 'text' ],
367 "SET field = 'text'" .
368 ",field2 = 'text2' " .
369 "WHERE alias = 'text'"
374 'values' => [ 'field = other', 'field2' => 'text2' ],
375 'conds' => [ 'id' => '1' ],
378 "SET field = other" .
379 ",field2 = 'text2' " .
385 'values' => [ 'field = other', 'field2' => 'text2' ],
389 "SET field = other" .
396 * @dataProvider provideDelete
397 * @covers Wikimedia\Rdbms\Database::delete
399 public function testDelete( $sql, $sqlText ) {
400 $this->database
->delete(
405 $this->assertLastSql( $sqlText );
408 public static function provideDelete() {
413 'conds' => [ 'alias' => 'text' ],
415 "DELETE FROM table " .
416 "WHERE alias = 'text'"
429 * @dataProvider provideUpsert
430 * @covers Wikimedia\Rdbms\Database::upsert
432 public function testUpsert( $sql, $sqlText ) {
433 $this->database
->upsert(
436 $sql['uniqueIndexes'],
440 $this->assertLastSql( $sqlText );
443 public static function provideUpsert() {
447 'table' => 'upsert_table',
448 'rows' => [ 'field' => 'text', 'field2' => 'text2' ],
449 'uniqueIndexes' => [ 'field' ],
450 'set' => [ 'field' => 'set' ],
453 "UPDATE upsert_table " .
454 "SET field = 'set' " .
455 "WHERE ((field = 'text')); " .
456 "INSERT IGNORE INTO upsert_table " .
458 "VALUES ('text','text2'); " .
465 * @dataProvider provideDeleteJoin
466 * @covers Wikimedia\Rdbms\Database::deleteJoin
468 public function testDeleteJoin( $sql, $sqlText ) {
469 $this->database
->deleteJoin(
477 $this->assertLastSql( $sqlText );
480 public static function provideDeleteJoin() {
484 'delTable' => 'table',
485 'joinTable' => 'table_join',
487 'joinVar' => 'field_join',
488 'conds' => [ 'alias' => 'text' ],
490 "DELETE FROM table " .
492 "SELECT field_join FROM table_join WHERE alias = 'text'" .
497 'delTable' => 'table',
498 'joinTable' => 'table_join',
500 'joinVar' => 'field_join',
503 "DELETE FROM table " .
505 "SELECT field_join FROM table_join " .
512 * @dataProvider provideInsert
513 * @covers Wikimedia\Rdbms\Database::insert
514 * @covers Wikimedia\Rdbms\Database::makeInsertOptions
516 public function testInsert( $sql, $sqlText ) {
517 $this->database
->insert(
521 isset( $sql['options'] ) ?
$sql['options'] : []
523 $this->assertLastSql( $sqlText );
526 public static function provideInsert() {
531 'rows' => [ 'field' => 'text', 'field2' => 2 ],
533 "INSERT INTO table " .
535 "VALUES ('text','2')"
540 'rows' => [ 'field' => 'text', 'field2' => 2 ],
541 'options' => 'IGNORE',
543 "INSERT IGNORE INTO table " .
545 "VALUES ('text','2')"
551 [ 'field' => 'text', 'field2' => 2 ],
552 [ 'field' => 'multi', 'field2' => 3 ],
554 'options' => 'IGNORE',
556 "INSERT IGNORE INTO table " .
566 * @dataProvider provideInsertSelect
567 * @covers Wikimedia\Rdbms\Database::insertSelect
568 * @covers Wikimedia\Rdbms\Database::nativeInsertSelect
570 public function testInsertSelect( $sql, $sqlTextNative, $sqlSelect, $sqlInsert ) {
571 $this->database
->insertSelect(
577 isset( $sql['insertOptions'] ) ?
$sql['insertOptions'] : [],
578 isset( $sql['selectOptions'] ) ?
$sql['selectOptions'] : [],
579 isset( $sql['selectJoinConds'] ) ?
$sql['selectJoinConds'] : []
581 $this->assertLastSql( $sqlTextNative );
583 $dbWeb = new DatabaseTestHelper( __CLASS__
, [ 'cliMode' => false ] );
584 $dbWeb->forceNextResult( [
585 array_flip( array_keys( $sql['varMap'] ) )
587 $dbWeb->insertSelect(
593 isset( $sql['insertOptions'] ) ?
$sql['insertOptions'] : [],
594 isset( $sql['selectOptions'] ) ?
$sql['selectOptions'] : [],
595 isset( $sql['selectJoinConds'] ) ?
$sql['selectJoinConds'] : []
597 $this->assertLastSqlDb( implode( '; ', [ $sqlSelect, 'BEGIN', $sqlInsert, 'COMMIT' ] ), $dbWeb );
600 public static function provideInsertSelect() {
604 'destTable' => 'insert_table',
605 'srcTable' => 'select_table',
606 'varMap' => [ 'field_insert' => 'field_select', 'field' => 'field2' ],
609 "INSERT INTO insert_table " .
610 "(field_insert,field) " .
611 "SELECT field_select,field2 " .
612 "FROM select_table WHERE *",
613 "SELECT field_select AS field_insert,field2 AS field " .
614 "FROM select_table WHERE * FOR UPDATE",
615 "INSERT INTO insert_table (field_insert,field) VALUES ('0','1')"
619 'destTable' => 'insert_table',
620 'srcTable' => 'select_table',
621 'varMap' => [ 'field_insert' => 'field_select', 'field' => 'field2' ],
622 'conds' => [ 'field' => 2 ],
624 "INSERT INTO insert_table " .
625 "(field_insert,field) " .
626 "SELECT field_select,field2 " .
627 "FROM select_table " .
629 "SELECT field_select AS field_insert,field2 AS field FROM " .
630 "select_table WHERE field = '2' FOR UPDATE",
631 "INSERT INTO insert_table (field_insert,field) VALUES ('0','1')"
635 'destTable' => 'insert_table',
636 'srcTable' => 'select_table',
637 'varMap' => [ 'field_insert' => 'field_select', 'field' => 'field2' ],
638 'conds' => [ 'field' => 2 ],
639 'insertOptions' => 'IGNORE',
640 'selectOptions' => [ 'ORDER BY' => 'field' ],
642 "INSERT IGNORE INTO insert_table " .
643 "(field_insert,field) " .
644 "SELECT field_select,field2 " .
645 "FROM select_table " .
646 "WHERE field = '2' " .
648 "SELECT field_select AS field_insert,field2 AS field " .
649 "FROM select_table WHERE field = '2' ORDER BY field FOR UPDATE",
650 "INSERT IGNORE INTO insert_table (field_insert,field) VALUES ('0','1')"
654 'destTable' => 'insert_table',
655 'srcTable' => [ 'select_table1', 'select_table2' ],
656 'varMap' => [ 'field_insert' => 'field_select', 'field' => 'field2' ],
657 'conds' => [ 'field' => 2 ],
658 'insertOptions' => [ 'NO_AUTO_COLUMNS' ],
659 'selectOptions' => [ 'ORDER BY' => 'field', 'FORCE INDEX' => [ 'select_table1' => 'index1' ] ],
660 'selectJoinConds' => [
661 'select_table2' => [ 'LEFT JOIN', [ 'select_table1.foo = select_table2.bar' ] ],
664 "INSERT INTO insert_table " .
665 "(field_insert,field) " .
666 "SELECT field_select,field2 " .
667 "FROM select_table1 LEFT JOIN select_table2 ON ((select_table1.foo = select_table2.bar)) " .
668 "WHERE field = '2' " .
670 "SELECT field_select AS field_insert,field2 AS field " .
671 "FROM select_table1 LEFT JOIN select_table2 ON ((select_table1.foo = select_table2.bar)) " .
672 "WHERE field = '2' ORDER BY field FOR UPDATE",
673 "INSERT INTO insert_table (field_insert,field) VALUES ('0','1')"
678 public function testInsertSelectBatching() {
679 $dbWeb = new DatabaseTestHelper( __CLASS__
, [ 'cliMode' => false ] );
681 for ( $i = 0; $i <= 25000; $i++
) {
682 $rows[] = [ 'field' => $i ];
684 $dbWeb->forceNextResult( $rows );
685 $dbWeb->insertSelect(
688 [ 'field' => 'field2' ],
692 $this->assertLastSqlDb( implode( '; ', [
693 'SELECT field2 AS field FROM select_table WHERE * FOR UPDATE',
695 "INSERT INTO insert_table (field) VALUES ('" . implode( "'),('", range( 0, 9999 ) ) . "')",
696 "INSERT INTO insert_table (field) VALUES ('" . implode( "'),('", range( 10000, 19999 ) ) . "')",
697 "INSERT INTO insert_table (field) VALUES ('" . implode( "'),('", range( 20000, 25000 ) ) . "')",
703 * @dataProvider provideReplace
704 * @covers Wikimedia\Rdbms\Database::replace
706 public function testReplace( $sql, $sqlText ) {
707 $this->database
->replace(
709 $sql['uniqueIndexes'],
713 $this->assertLastSql( $sqlText );
716 public static function provideReplace() {
720 'table' => 'replace_table',
721 'uniqueIndexes' => [ 'field' ],
722 'rows' => [ 'field' => 'text', 'field2' => 'text2' ],
724 "BEGIN; DELETE FROM replace_table " .
725 "WHERE (field = 'text'); " .
726 "INSERT INTO replace_table " .
728 "VALUES ('text','text2'); COMMIT"
732 'table' => 'module_deps',
733 'uniqueIndexes' => [ [ 'md_module', 'md_skin' ] ],
735 'md_module' => 'module',
740 "BEGIN; DELETE FROM module_deps " .
741 "WHERE (md_module = 'module' AND md_skin = 'skin'); " .
742 "INSERT INTO module_deps " .
743 "(md_module,md_skin,md_deps) " .
744 "VALUES ('module','skin','deps'); COMMIT"
748 'table' => 'module_deps',
749 'uniqueIndexes' => [ [ 'md_module', 'md_skin' ] ],
752 'md_module' => 'module',
756 'md_module' => 'module2',
757 'md_skin' => 'skin2',
758 'md_deps' => 'deps2',
762 "BEGIN; DELETE FROM module_deps " .
763 "WHERE (md_module = 'module' AND md_skin = 'skin'); " .
764 "INSERT INTO module_deps " .
765 "(md_module,md_skin,md_deps) " .
766 "VALUES ('module','skin','deps'); " .
767 "DELETE FROM module_deps " .
768 "WHERE (md_module = 'module2' AND md_skin = 'skin2'); " .
769 "INSERT INTO module_deps " .
770 "(md_module,md_skin,md_deps) " .
771 "VALUES ('module2','skin2','deps2'); COMMIT"
775 'table' => 'module_deps',
776 'uniqueIndexes' => [ 'md_module', 'md_skin' ],
779 'md_module' => 'module',
783 'md_module' => 'module2',
784 'md_skin' => 'skin2',
785 'md_deps' => 'deps2',
789 "BEGIN; DELETE FROM module_deps " .
790 "WHERE (md_module = 'module') OR (md_skin = 'skin'); " .
791 "INSERT INTO module_deps " .
792 "(md_module,md_skin,md_deps) " .
793 "VALUES ('module','skin','deps'); " .
794 "DELETE FROM module_deps " .
795 "WHERE (md_module = 'module2') OR (md_skin = 'skin2'); " .
796 "INSERT INTO module_deps " .
797 "(md_module,md_skin,md_deps) " .
798 "VALUES ('module2','skin2','deps2'); COMMIT"
802 'table' => 'module_deps',
803 'uniqueIndexes' => [],
805 'md_module' => 'module',
810 "BEGIN; INSERT INTO module_deps " .
811 "(md_module,md_skin,md_deps) " .
812 "VALUES ('module','skin','deps'); COMMIT"
818 * @dataProvider provideNativeReplace
819 * @covers Wikimedia\Rdbms\Database::nativeReplace
821 public function testNativeReplace( $sql, $sqlText ) {
822 $this->database
->nativeReplace(
827 $this->assertLastSql( $sqlText );
830 public static function provideNativeReplace() {
834 'table' => 'replace_table',
835 'rows' => [ 'field' => 'text', 'field2' => 'text2' ],
837 "REPLACE INTO replace_table " .
839 "VALUES ('text','text2')"
845 * @dataProvider provideConditional
846 * @covers Wikimedia\Rdbms\Database::conditional
848 public function testConditional( $sql, $sqlText ) {
849 $this->assertEquals( trim( $this->database
->conditional(
856 public static function provideConditional() {
860 'conds' => [ 'field' => 'text' ],
864 "(CASE WHEN field = 'text' THEN 1 ELSE NULL END)"
868 'conds' => [ 'field' => 'text', 'field2' => 'anothertext' ],
872 "(CASE WHEN field = 'text' AND field2 = 'anothertext' THEN 1 ELSE NULL END)"
876 'conds' => 'field=1',
880 "(CASE WHEN field=1 THEN 1 ELSE NULL END)"
886 * @dataProvider provideBuildConcat
887 * @covers Wikimedia\Rdbms\Database::buildConcat
889 public function testBuildConcat( $stringList, $sqlText ) {
890 $this->assertEquals( trim( $this->database
->buildConcat(
895 public static function provideBuildConcat() {
898 [ 'field', 'field2' ],
899 "CONCAT(field,field2)"
902 [ "'test'", 'field2' ],
903 "CONCAT('test',field2)"
909 * @dataProvider provideBuildLike
910 * @covers Wikimedia\Rdbms\Database::buildLike
911 * @covers Wikimedia\Rdbms\Database::escapeLikeInternal
913 public function testBuildLike( $array, $sqlText ) {
914 $this->assertEquals( trim( $this->database
->buildLike(
919 public static function provideBuildLike() {
923 "LIKE 'text' ESCAPE '`'"
926 [ 'text', new LikeMatch( '%' ) ],
927 "LIKE 'text%' ESCAPE '`'"
930 [ 'text', new LikeMatch( '%' ), 'text2' ],
931 "LIKE 'text%text2' ESCAPE '`'"
934 [ 'text', new LikeMatch( '_' ) ],
935 "LIKE 'text_' ESCAPE '`'"
939 "LIKE 'more`_text' ESCAPE '`'"
942 [ 'C:\\Windows\\', new LikeMatch( '%' ) ],
943 "LIKE 'C:\\Windows\\%' ESCAPE '`'"
946 [ 'accent`_test`', new LikeMatch( '%' ) ],
947 "LIKE 'accent```_test``%' ESCAPE '`'"
953 * @dataProvider provideUnionQueries
954 * @covers Wikimedia\Rdbms\Database::unionQueries
956 public function testUnionQueries( $sql, $sqlText ) {
957 $this->assertEquals( trim( $this->database
->unionQueries(
963 public static function provideUnionQueries() {
967 'sqls' => [ 'RAW SQL', 'RAW2SQL' ],
970 "(RAW SQL) UNION ALL (RAW2SQL)"
974 'sqls' => [ 'RAW SQL', 'RAW2SQL' ],
977 "(RAW SQL) UNION (RAW2SQL)"
981 'sqls' => [ 'RAW SQL', 'RAW2SQL', 'RAW3SQL' ],
984 "(RAW SQL) UNION (RAW2SQL) UNION (RAW3SQL)"
990 * @dataProvider provideUnionConditionPermutations
991 * @covers Wikimedia\Rdbms\Database::unionConditionPermutations
993 public function testUnionConditionPermutations( $params, $expect ) {
994 if ( isset( $params['unionSupportsOrderAndLimit'] ) ) {
995 $this->database
->setUnionSupportsOrderAndLimit( $params['unionSupportsOrderAndLimit'] );
998 $sql = trim( $this->database
->unionConditionPermutations(
1001 $params['permute_conds'],
1002 isset( $params['extra_conds'] ) ?
$params['extra_conds'] : '',
1004 isset( $params['options'] ) ?
$params['options'] : [],
1005 isset( $params['join_conds'] ) ?
$params['join_conds'] : []
1007 $this->assertEquals( $expect, $sql );
1010 public static function provideUnionConditionPermutations() {
1011 // phpcs:disable Generic.Files.LineLength
1015 'table' => [ 'table1', 'table2' ],
1016 'vars' => [ 'field1', 'alias' => 'field2' ],
1017 'permute_conds' => [
1018 'field3' => [ 1, 2, 3 ],
1019 'duplicates' => [ 4, 5, 4 ],
1023 'extra_conds' => 'table2.bar > 23',
1025 'ORDER BY' => [ 'field1', 'alias' ],
1026 'INNER ORDER BY' => [ 'field1', 'field2' ],
1030 'table2' => [ 'JOIN', 'table1.foo_id = table2.foo_id' ],
1033 "(SELECT field1,field2 AS alias FROM table1 JOIN table2 ON ((table1.foo_id = table2.foo_id)) WHERE field3 = '1' AND duplicates = '4' AND single = '0' AND (table2.bar > 23) ORDER BY field1,field2 LIMIT 100 ) UNION ALL " .
1034 "(SELECT field1,field2 AS alias FROM table1 JOIN table2 ON ((table1.foo_id = table2.foo_id)) WHERE field3 = '1' AND duplicates = '5' AND single = '0' AND (table2.bar > 23) ORDER BY field1,field2 LIMIT 100 ) UNION ALL " .
1035 "(SELECT field1,field2 AS alias FROM table1 JOIN table2 ON ((table1.foo_id = table2.foo_id)) WHERE field3 = '2' AND duplicates = '4' AND single = '0' AND (table2.bar > 23) ORDER BY field1,field2 LIMIT 100 ) UNION ALL " .
1036 "(SELECT field1,field2 AS alias FROM table1 JOIN table2 ON ((table1.foo_id = table2.foo_id)) WHERE field3 = '2' AND duplicates = '5' AND single = '0' AND (table2.bar > 23) ORDER BY field1,field2 LIMIT 100 ) UNION ALL " .
1037 "(SELECT field1,field2 AS alias FROM table1 JOIN table2 ON ((table1.foo_id = table2.foo_id)) WHERE field3 = '3' AND duplicates = '4' AND single = '0' AND (table2.bar > 23) ORDER BY field1,field2 LIMIT 100 ) UNION ALL " .
1038 "(SELECT field1,field2 AS alias FROM table1 JOIN table2 ON ((table1.foo_id = table2.foo_id)) WHERE field3 = '3' AND duplicates = '5' AND single = '0' AND (table2.bar > 23) ORDER BY field1,field2 LIMIT 100 ) " .
1039 "ORDER BY field1,alias LIMIT 100"
1044 'vars' => [ 'foo_id' ],
1045 'permute_conds' => [
1046 'bar' => [ 1, 2, 3 ],
1048 'extra_conds' => [ 'baz' => null ],
1051 'ORDER BY' => [ 'foo_id' ],
1055 "(SELECT foo_id FROM foo WHERE bar = '1' AND baz IS NULL ORDER BY foo_id LIMIT 25 ) UNION " .
1056 "(SELECT foo_id FROM foo WHERE bar = '2' AND baz IS NULL ORDER BY foo_id LIMIT 25 ) UNION " .
1057 "(SELECT foo_id FROM foo WHERE bar = '3' AND baz IS NULL ORDER BY foo_id LIMIT 25 ) " .
1058 "ORDER BY foo_id LIMIT 25"
1063 'vars' => [ 'foo_id' ],
1064 'permute_conds' => [
1065 'bar' => [ 1, 2, 3 ],
1067 'extra_conds' => [ 'baz' => null ],
1070 'ORDER BY' => [ 'foo_id' ],
1073 'unionSupportsOrderAndLimit' => false,
1075 "(SELECT foo_id FROM foo WHERE bar = '1' AND baz IS NULL ) UNION " .
1076 "(SELECT foo_id FROM foo WHERE bar = '2' AND baz IS NULL ) UNION " .
1077 "(SELECT foo_id FROM foo WHERE bar = '3' AND baz IS NULL ) " .
1078 "ORDER BY foo_id LIMIT 25"
1083 'vars' => [ 'foo_id' ],
1084 'permute_conds' => [],
1085 'extra_conds' => [ 'baz' => null ],
1087 'ORDER BY' => [ 'foo_id' ],
1091 "SELECT foo_id FROM foo WHERE baz IS NULL ORDER BY foo_id LIMIT 25"
1096 'vars' => [ 'foo_id' ],
1097 'permute_conds' => [
1100 'extra_conds' => [ 'baz' => null ],
1102 'ORDER BY' => [ 'foo_id' ],
1106 "SELECT foo_id FROM foo WHERE baz IS NULL ORDER BY foo_id LIMIT 25"
1111 'vars' => [ 'foo_id' ],
1112 'permute_conds' => [
1116 'ORDER BY' => [ 'foo_id' ],
1121 "SELECT foo_id FROM foo WHERE bar = '1' ORDER BY foo_id LIMIT 150,25"
1126 'vars' => [ 'foo_id' ],
1127 'permute_conds' => [],
1128 'extra_conds' => [ 'baz' => null ],
1130 'ORDER BY' => [ 'foo_id' ],
1133 'INNER ORDER BY' => [ 'bar_id' ],
1136 "(SELECT foo_id FROM foo WHERE baz IS NULL ORDER BY bar_id LIMIT 175 ) ORDER BY foo_id LIMIT 150,25"
1141 'vars' => [ 'foo_id' ],
1142 'permute_conds' => [],
1143 'extra_conds' => [ 'baz' => null ],
1145 'ORDER BY' => [ 'foo_id' ],
1148 'INNER ORDER BY' => [ 'bar_id' ],
1150 'unionSupportsOrderAndLimit' => false,
1152 "SELECT foo_id FROM foo WHERE baz IS NULL ORDER BY foo_id LIMIT 150,25"
1159 * @covers Wikimedia\Rdbms\Database::commit
1160 * @covers Wikimedia\Rdbms\Database::doCommit
1162 public function testTransactionCommit() {
1163 $this->database
->begin( __METHOD__
);
1164 $this->database
->commit( __METHOD__
);
1165 $this->assertLastSql( 'BEGIN; COMMIT' );
1169 * @covers Wikimedia\Rdbms\Database::rollback
1170 * @covers Wikimedia\Rdbms\Database::doRollback
1172 public function testTransactionRollback() {
1173 $this->database
->begin( __METHOD__
);
1174 $this->database
->rollback( __METHOD__
);
1175 $this->assertLastSql( 'BEGIN; ROLLBACK' );
1179 * @covers Wikimedia\Rdbms\Database::dropTable
1181 public function testDropTable() {
1182 $this->database
->setExistingTables( [ 'table' ] );
1183 $this->database
->dropTable( 'table', __METHOD__
);
1184 $this->assertLastSql( 'DROP TABLE table CASCADE' );
1188 * @covers Wikimedia\Rdbms\Database::dropTable
1190 public function testDropNonExistingTable() {
1192 $this->database
->dropTable( 'non_existing', __METHOD__
)
1197 * @dataProvider provideMakeList
1198 * @covers Wikimedia\Rdbms\Database::makeList
1200 public function testMakeList( $list, $mode, $sqlText ) {
1201 $this->assertEquals( trim( $this->database
->makeList(
1206 public static function provideMakeList() {
1209 [ 'value', 'value2' ],
1214 [ 'field', 'field2' ],
1219 [ 'field' => 'value', 'field2' => 'value2' ],
1221 "field = 'value' AND field2 = 'value2'"
1224 [ 'field' => null, "field2 != 'value2'" ],
1226 "field IS NULL AND (field2 != 'value2')"
1229 [ 'field' => [ 'value', null, 'value2' ], 'field2' => 'value2' ],
1231 "(field IN ('value','value2') OR field IS NULL) AND field2 = 'value2'"
1234 [ 'field' => [ null ], 'field2' => null ],
1236 "field IS NULL AND field2 IS NULL"
1239 [ 'field' => 'value', 'field2' => 'value2' ],
1241 "field = 'value' OR field2 = 'value2'"
1244 [ 'field' => 'value', 'field2' => null ],
1246 "field = 'value' OR field2 IS NULL"
1249 [ 'field' => [ 'value', 'value2' ], 'field2' => [ 'value' ] ],
1251 "field IN ('value','value2') OR field2 = 'value'"
1254 [ 'field' => [ null, 'value', null, 'value2' ], "field2 != 'value2'" ],
1256 "(field IN ('value','value2') OR field IS NULL) OR (field2 != 'value2')"
1259 [ 'field' => 'value', 'field2' => 'value2' ],
1261 "field = 'value',field2 = 'value2'"
1264 [ 'field' => 'value', 'field2' => null ],
1266 "field = 'value',field2 = NULL"
1269 [ 'field' => 'value', "field2 != 'value2'" ],
1271 "field = 'value',field2 != 'value2'"
1277 * @covers Wikimedia\Rdbms\Database::registerTempTableOperation
1279 public function testSessionTempTables() {
1280 $temp1 = $this->database
->tableName( 'tmp_table_1' );
1281 $temp2 = $this->database
->tableName( 'tmp_table_2' );
1282 $temp3 = $this->database
->tableName( 'tmp_table_3' );
1284 $this->database
->query( "CREATE TEMPORARY TABLE $temp1 LIKE orig_tbl", __METHOD__
);
1285 $this->database
->query( "CREATE TEMPORARY TABLE $temp2 LIKE orig_tbl", __METHOD__
);
1286 $this->database
->query( "CREATE TEMPORARY TABLE $temp3 LIKE orig_tbl", __METHOD__
);
1288 $this->assertTrue( $this->database
->tableExists( "tmp_table_1", __METHOD__
) );
1289 $this->assertTrue( $this->database
->tableExists( "tmp_table_2", __METHOD__
) );
1290 $this->assertTrue( $this->database
->tableExists( "tmp_table_3", __METHOD__
) );
1292 $this->database
->dropTable( 'tmp_table_1', __METHOD__
);
1293 $this->database
->dropTable( 'tmp_table_2', __METHOD__
);
1294 $this->database
->dropTable( 'tmp_table_3', __METHOD__
);
1296 $this->assertFalse( $this->database
->tableExists( "tmp_table_1", __METHOD__
) );
1297 $this->assertFalse( $this->database
->tableExists( "tmp_table_2", __METHOD__
) );
1298 $this->assertFalse( $this->database
->tableExists( "tmp_table_3", __METHOD__
) );
1300 $this->database
->query( "CREATE TEMPORARY TABLE tmp_table_1 LIKE orig_tbl", __METHOD__
);
1301 $this->database
->query( "CREATE TEMPORARY TABLE 'tmp_table_2' LIKE orig_tbl", __METHOD__
);
1302 $this->database
->query( "CREATE TEMPORARY TABLE `tmp_table_3` LIKE orig_tbl", __METHOD__
);
1304 $this->assertTrue( $this->database
->tableExists( "tmp_table_1", __METHOD__
) );
1305 $this->assertTrue( $this->database
->tableExists( "tmp_table_2", __METHOD__
) );
1306 $this->assertTrue( $this->database
->tableExists( "tmp_table_3", __METHOD__
) );
1308 $this->database
->query( "DROP TEMPORARY TABLE tmp_table_1 LIKE orig_tbl", __METHOD__
);
1309 $this->database
->query( "DROP TEMPORARY TABLE 'tmp_table_2' LIKE orig_tbl", __METHOD__
);
1310 $this->database
->query( "DROP TABLE `tmp_table_3` LIKE orig_tbl", __METHOD__
);
1312 $this->assertFalse( $this->database
->tableExists( "tmp_table_1", __METHOD__
) );
1313 $this->assertFalse( $this->database
->tableExists( "tmp_table_2", __METHOD__
) );
1314 $this->assertFalse( $this->database
->tableExists( "tmp_table_3", __METHOD__
) );
1317 public function provideBuildSubstring() {
1318 yield
[ 'someField', 1, 2, 'SUBSTRING(someField FROM 1 FOR 2)' ];
1319 yield
[ 'someField', 1, null, 'SUBSTRING(someField FROM 1)' ];
1323 * @covers Wikimedia\Rdbms\Database::buildSubstring
1324 * @dataProvider provideBuildSubstring
1326 public function testBuildSubstring( $input, $start, $length, $expected ) {
1327 $output = $this->database
->buildSubstring( $input, $start, $length );
1328 $this->assertSame( $expected, $output );
1331 public function provideBuildSubstring_invalidParams() {
1341 * @covers Wikimedia\Rdbms\Database::buildSubstring
1342 * @covers Wikimedia\Rdbms\Database::assertBuildSubstringParams
1343 * @dataProvider provideBuildSubstring_invalidParams
1345 public function testBuildSubstring_invalidParams( $start, $length ) {
1346 $this->setExpectedException( InvalidArgumentException
::class );
1347 $this->database
->buildSubstring( 'foo', $start, $length );
1351 * @covers \Wikimedia\Rdbms\Database::buildIntegerCast
1353 public function testBuildIntegerCast() {
1354 $output = $this->database
->buildIntegerCast( 'fieldName' );
1355 $this->assertSame( 'CAST( fieldName AS INTEGER )', $output );
1359 * @covers \Wikimedia\Rdbms\Database::doSavepoint
1360 * @covers \Wikimedia\Rdbms\Database::doReleaseSavepoint
1361 * @covers \Wikimedia\Rdbms\Database::doRollbackToSavepoint
1362 * @covers \Wikimedia\Rdbms\Database::startAtomic
1363 * @covers \Wikimedia\Rdbms\Database::endAtomic
1364 * @covers \Wikimedia\Rdbms\Database::cancelAtomic
1365 * @covers \Wikimedia\Rdbms\Database::doAtomicSection
1367 public function testAtomicSections() {
1368 $this->database
->startAtomic( __METHOD__
);
1369 $this->database
->endAtomic( __METHOD__
);
1370 $this->assertLastSql( 'BEGIN; COMMIT' );
1372 $this->database
->startAtomic( __METHOD__
, IDatabase
::ATOMIC_CANCELABLE
);
1373 $this->database
->cancelAtomic( __METHOD__
);
1374 $this->assertLastSql( 'BEGIN; ROLLBACK' );
1376 $this->database
->begin( __METHOD__
);
1377 $this->database
->startAtomic( __METHOD__
);
1378 $this->database
->endAtomic( __METHOD__
);
1379 $this->database
->commit( __METHOD__
);
1380 $this->assertLastSql( 'BEGIN; COMMIT' );
1382 $this->database
->begin( __METHOD__
);
1383 $this->database
->startAtomic( __METHOD__
, IDatabase
::ATOMIC_CANCELABLE
);
1384 $this->database
->endAtomic( __METHOD__
);
1385 $this->database
->commit( __METHOD__
);
1386 // phpcs:ignore Generic.Files.LineLength
1387 $this->assertLastSql( 'BEGIN; SAVEPOINT wikimedia_rdbms_atomic1; RELEASE SAVEPOINT wikimedia_rdbms_atomic1; COMMIT' );
1389 $this->database
->begin( __METHOD__
);
1390 $this->database
->startAtomic( __METHOD__
, IDatabase
::ATOMIC_CANCELABLE
);
1391 $this->database
->cancelAtomic( __METHOD__
);
1392 $this->database
->commit( __METHOD__
);
1393 // phpcs:ignore Generic.Files.LineLength
1394 $this->assertLastSql( 'BEGIN; SAVEPOINT wikimedia_rdbms_atomic1; ROLLBACK TO SAVEPOINT wikimedia_rdbms_atomic1; COMMIT' );
1396 $this->database
->startAtomic( __METHOD__
, IDatabase
::ATOMIC_CANCELABLE
);
1397 $this->database
->startAtomic( __METHOD__
, IDatabase
::ATOMIC_CANCELABLE
);
1398 $this->database
->cancelAtomic( __METHOD__
);
1399 $this->database
->endAtomic( __METHOD__
);
1400 // phpcs:ignore Generic.Files.LineLength
1401 $this->assertLastSql( 'BEGIN; SAVEPOINT wikimedia_rdbms_atomic1; ROLLBACK TO SAVEPOINT wikimedia_rdbms_atomic1; COMMIT' );
1403 $this->database
->doAtomicSection( __METHOD__
, function () {
1405 $this->assertLastSql( 'BEGIN; COMMIT' );
1407 $this->database
->begin( __METHOD__
);
1408 $this->database
->doAtomicSection( __METHOD__
, function () {
1410 $this->database
->rollback( __METHOD__
);
1411 // phpcs:ignore Generic.Files.LineLength
1412 $this->assertLastSql( 'BEGIN; SAVEPOINT wikimedia_rdbms_atomic1; RELEASE SAVEPOINT wikimedia_rdbms_atomic1; ROLLBACK' );
1414 $this->database
->begin( __METHOD__
);
1416 $this->database
->doAtomicSection( __METHOD__
, function () {
1417 throw new RuntimeException( 'Test exception' );
1419 $this->fail( 'Expected exception not thrown' );
1420 } catch ( RuntimeException
$ex ) {
1421 $this->assertSame( 'Test exception', $ex->getMessage() );
1423 $this->database
->commit( __METHOD__
);
1424 // phpcs:ignore Generic.Files.LineLength
1425 $this->assertLastSql( 'BEGIN; SAVEPOINT wikimedia_rdbms_atomic1; ROLLBACK TO SAVEPOINT wikimedia_rdbms_atomic1; COMMIT' );
1428 public static function provideAtomicSectionMethodsForErrors() {
1436 * @dataProvider provideAtomicSectionMethodsForErrors
1437 * @covers \Wikimedia\Rdbms\Database::endAtomic
1438 * @covers \Wikimedia\Rdbms\Database::cancelAtomic
1440 public function testNoAtomicSection( $method ) {
1442 $this->database
->$method( __METHOD__
);
1443 $this->fail( 'Expected exception not thrown' );
1444 } catch ( DBUnexpectedError
$ex ) {
1446 'No atomic transaction is open (got ' . __METHOD__
. ').',
1453 * @dataProvider provideAtomicSectionMethodsForErrors
1454 * @covers \Wikimedia\Rdbms\Database::endAtomic
1455 * @covers \Wikimedia\Rdbms\Database::cancelAtomic
1457 public function testInvalidAtomicSectionEnded( $method ) {
1458 $this->database
->startAtomic( __METHOD__
. 'X' );
1460 $this->database
->$method( __METHOD__
);
1461 $this->fail( 'Expected exception not thrown' );
1462 } catch ( DBUnexpectedError
$ex ) {
1464 'Invalid atomic section ended (got ' . __METHOD__
. ').',
1471 * @covers \Wikimedia\Rdbms\Database::cancelAtomic
1473 public function testUncancellableAtomicSection() {
1474 $this->database
->startAtomic( __METHOD__
);
1476 $this->database
->cancelAtomic( __METHOD__
);
1477 $this->fail( 'Expected exception not thrown' );
1478 } catch ( DBUnexpectedError
$ex ) {
1480 'Uncancelable atomic section canceled (got ' . __METHOD__
. ').',
1487 * @expectedException \Wikimedia\Rdbms\DBTransactionStateError
1489 public function testTransactionErrorState1() {
1490 $wrapper = TestingAccessWrapper
::newFromObject( $this->database
);
1492 $this->database
->begin( __METHOD__
);
1493 $wrapper->trxStatus
= Database
::STATUS_TRX_ERROR
;
1494 $this->database
->delete( 'x', [ 'field' => 3 ], __METHOD__
);
1495 $this->database
->commit( __METHOD__
);
1499 * @covers \Wikimedia\Rdbms\Database::query
1501 public function testTransactionErrorState2() {
1502 $wrapper = TestingAccessWrapper
::newFromObject( $this->database
);
1504 $this->database
->startAtomic( __METHOD__
);
1505 $wrapper->trxStatus
= Database
::STATUS_TRX_ERROR
;
1506 $this->database
->rollback( __METHOD__
);
1507 $this->assertEquals( 0, $this->database
->trxLevel() );
1508 $this->assertEquals( Database
::STATUS_TRX_NONE
, $wrapper->trxStatus() );
1509 $this->assertLastSql( 'BEGIN; ROLLBACK' );
1511 $this->database
->startAtomic( __METHOD__
);
1512 $this->assertEquals( Database
::STATUS_TRX_OK
, $wrapper->trxStatus() );
1513 $this->database
->delete( 'x', [ 'field' => 1 ], __METHOD__
);
1514 $this->database
->endAtomic( __METHOD__
);
1515 $this->assertEquals( Database
::STATUS_TRX_NONE
, $wrapper->trxStatus() );
1516 $this->assertLastSql( 'BEGIN; DELETE FROM x WHERE field = \'1\'; COMMIT' );
1517 $this->assertEquals( 0, $this->database
->trxLevel(), 'Use after rollback()' );
1519 $this->database
->begin( __METHOD__
);
1520 $this->database
->startAtomic( __METHOD__
, Database
::ATOMIC_CANCELABLE
);
1521 $this->database
->update( 'y', [ 'a' => 1 ], [ 'field' => 1 ], __METHOD__
);
1522 $wrapper->trxStatus
= Database
::STATUS_TRX_ERROR
;
1523 $this->database
->cancelAtomic( __METHOD__
);
1524 $this->assertEquals( Database
::STATUS_TRX_OK
, $wrapper->trxStatus() );
1525 $this->database
->startAtomic( __METHOD__
);
1526 $this->database
->delete( 'y', [ 'field' => 1 ], __METHOD__
);
1527 $this->database
->endAtomic( __METHOD__
);
1528 $this->database
->commit( __METHOD__
);
1529 // phpcs:ignore Generic.Files.LineLength
1530 $this->assertLastSql( 'BEGIN; SAVEPOINT wikimedia_rdbms_atomic1; UPDATE y SET a = \'1\' WHERE field = \'1\'; ROLLBACK TO SAVEPOINT wikimedia_rdbms_atomic1; DELETE FROM y WHERE field = \'1\'; COMMIT' );
1531 $this->assertEquals( 0, $this->database
->trxLevel(), 'Use after rollback()' );
1534 $this->database
->startAtomic( __METHOD__
);
1535 $this->assertEquals( Database
::STATUS_TRX_OK
, $wrapper->trxStatus() );
1536 $this->database
->delete( 'x', [ 'field' => 3 ], __METHOD__
);
1537 $this->database
->endAtomic( __METHOD__
);
1538 $this->assertEquals( Database
::STATUS_TRX_NONE
, $wrapper->trxStatus() );
1539 $this->assertLastSql( 'BEGIN; DELETE FROM x WHERE field = \'3\'; COMMIT' );
1540 $this->assertEquals( 0, $this->database
->trxLevel() );
1544 * @covers \Wikimedia\Rdbms\Database::close
1546 public function testPrematureClose1() {
1547 $fname = __METHOD__
;
1548 $this->database
->begin( __METHOD__
);
1549 $this->database
->onTransactionIdle( function () use ( $fname ) {
1550 $this->database
->query( 'SELECT 1', $fname );
1552 $this->database
->delete( 'x', [ 'field' => 3 ], __METHOD__
);
1553 $this->database
->close();
1555 $this->assertFalse( $this->database
->isOpen() );
1556 $this->assertLastSql( 'BEGIN; DELETE FROM x WHERE field = \'3\'; COMMIT; SELECT 1' );
1557 $this->assertEquals( 0, $this->database
->trxLevel() );
1561 * @covers \Wikimedia\Rdbms\Database::close
1563 public function testPrematureClose2() {
1565 $fname = __METHOD__
;
1566 $this->database
->startAtomic( __METHOD__
);
1567 $this->database
->onTransactionIdle( function () use ( $fname ) {
1568 $this->database
->query( 'SELECT 1', $fname );
1570 $this->database
->delete( 'x', [ 'field' => 3 ], __METHOD__
);
1571 $this->database
->close();
1572 $this->fail( 'Expected exception not thrown' );
1573 } catch ( DBUnexpectedError
$ex ) {
1575 'Wikimedia\Rdbms\Database::close: atomic sections ' .
1576 'DatabaseSQLTest::testPrematureClose2 are still open.',
1581 $this->assertFalse( $this->database
->isOpen() );
1582 $this->assertLastSql( 'BEGIN; DELETE FROM x WHERE field = \'3\'; ROLLBACK' );
1583 $this->assertEquals( 0, $this->database
->trxLevel() );