Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[11.x] Improve Schema::hasTable() performance #53006

Merged
merged 4 commits into from
Oct 3, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 1 addition & 2 deletions src/Illuminate/Database/Schema/Builder.php
Original file line number Diff line number Diff line change
Expand Up @@ -144,8 +144,7 @@ public function hasTable($table)
{
$table = $this->connection->getTablePrefix().$table;

/** @phpstan-ignore arguments.count (SQLite accepts a withSize argument) */
foreach ($this->getTables(false) as $value) {
foreach ($this->getTables() as $value) {
if (strtolower($table) === strtolower($value['name'])) {
return true;
}
Expand Down
17 changes: 17 additions & 0 deletions src/Illuminate/Database/Schema/Grammars/MySqlGrammar.php
Original file line number Diff line number Diff line change
Expand Up @@ -76,6 +76,23 @@ public function compileDropDatabaseIfExists($name)
);
}

/**
* Compile the query to determine if the given table exists.
*
* @param string $database
* @param string $table
* @return string
*/
public function compileTableExists($database, $table)
{
return sprintf(
'select exists (select 1 from information_schema.tables where '
."table_schema = %s and table_name = %s and table_type in ('BASE TABLE', 'SYSTEM VERSIONED')) as `exists`",
$this->quoteString($database),
$this->quoteString($table)
);
}

/**
* Compile the query to determine the tables.
*
Expand Down
17 changes: 17 additions & 0 deletions src/Illuminate/Database/Schema/Grammars/PostgresGrammar.php
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,23 @@ public function compileDropDatabaseIfExists($name)
);
}

/**
* Compile the query to determine if the given table exists.
*
* @param string $schema
* @param string $table
* @return string
*/
public function compileTableExists($schema, $table)
{
return sprintf(
'select exists (select 1 from pg_class c, pg_namespace n where '
."n.nspname = %s and c.relname = %s and c.relkind in ('r', 'p') and n.oid = c.relnamespace)",
$this->quoteString($schema),
$this->quoteString($table)
);
}

/**
* Compile the query to determine the tables.
*
Expand Down
14 changes: 14 additions & 0 deletions src/Illuminate/Database/Schema/Grammars/SQLiteGrammar.php
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,20 @@ public function compileDbstatExists()
return "select exists (select 1 from pragma_compile_options where compile_options = 'ENABLE_DBSTAT_VTAB') as enabled";
}

/**
* Compile the query to determine if the given table exists.
*
* @param string $table
* @return string
*/
public function compileTableExists($table)
{
return sprintf(
'select exists (select 1 from sqlite_master where name = %s and type = \'table\') as "exists"',
$this->quoteString(str_replace('.', '__', $table))
);
}

/**
* Compile the query to determine the tables.
*
Expand Down
15 changes: 15 additions & 0 deletions src/Illuminate/Database/Schema/Grammars/SqlServerGrammar.php
Original file line number Diff line number Diff line change
Expand Up @@ -76,6 +76,21 @@ public function compileDropDatabaseIfExists($name)
);
}

/**
* Compile the query to determine if the given table exists.
*
* @param string|null $schema
* @param string $table
* @return string
*/
public function compileTableExists($schema, $table)
{
return sprintf(
'select (case when object_id(%s, \'U\') is null then 0 else 1 end) as [exists]',
$this->quoteString($schema ? $schema.'.'.$table : $table)
);
}

/**
* Compile the query to determine the tables.
*
Expand Down
17 changes: 17 additions & 0 deletions src/Illuminate/Database/Schema/MySqlBuilder.php
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,23 @@ public function dropDatabaseIfExists($name)
);
}

/**
* Determine if the given table exists.
*
* @param string $table
* @return bool
*/
public function hasTable($table)
{
$table = $this->connection->getTablePrefix().$table;

$database = $this->connection->getDatabaseName();

return (bool) $this->connection->scalar(
$this->grammar->compileTableExists($database, $table)
);
}

/**
* Get the tables for the database.
*
Expand Down
11 changes: 3 additions & 8 deletions src/Illuminate/Database/Schema/PostgresBuilder.php
Original file line number Diff line number Diff line change
Expand Up @@ -49,14 +49,9 @@ public function hasTable($table)

$table = $this->connection->getTablePrefix().$table;

foreach ($this->getTables() as $value) {
if (strtolower($table) === strtolower($value['name'])
&& strtolower($schema) === strtolower($value['schema'])) {
return true;
}
}

return false;
return (bool) $this->connection->scalar(
$this->grammar->compileTableExists($schema, $table)
);
}

/**
Expand Down
15 changes: 15 additions & 0 deletions src/Illuminate/Database/Schema/SQLiteBuilder.php
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,21 @@ public function dropDatabaseIfExists($name)
: true;
}

/**
* Determine if the given table exists.
*
* @param string $table
* @return bool
*/
public function hasTable($table)
{
$table = $this->connection->getTablePrefix().$table;

return (bool) $this->connection->scalar(
$this->grammar->compileTableExists($table)
);
}

/**
* Get the tables for the database.
*
Expand Down
12 changes: 3 additions & 9 deletions src/Illuminate/Database/Schema/SqlServerBuilder.php
Original file line number Diff line number Diff line change
Expand Up @@ -42,17 +42,11 @@ public function hasTable($table)
{
[$schema, $table] = $this->parseSchemaAndTable($table);

$schema ??= $this->getDefaultSchema();
$table = $this->connection->getTablePrefix().$table;

foreach ($this->getTables() as $value) {
if (strtolower($table) === strtolower($value['name'])
&& strtolower($schema) === strtolower($value['schema'])) {
return true;
}
}

return false;
return (bool) $this->connection->scalar(
$this->grammar->compileTableExists($schema, $table)
);
}

/**
Expand Down
7 changes: 2 additions & 5 deletions tests/Database/DatabaseMariaDbSchemaBuilderTest.php
Original file line number Diff line number Diff line change
Expand Up @@ -20,15 +20,12 @@ public function testHasTable()
{
$connection = m::mock(Connection::class);
$grammar = m::mock(MariaDbGrammar::class);
$processor = m::mock(MariaDbProcessor::class);
$connection->shouldReceive('getDatabaseName')->andReturn('db');
$connection->shouldReceive('getSchemaGrammar')->andReturn($grammar);
$connection->shouldReceive('getPostProcessor')->andReturn($processor);
$builder = new MariaDbBuilder($connection);
$grammar->shouldReceive('compileTables')->once()->andReturn('sql');
$processor->shouldReceive('processTables')->once()->andReturn([['name' => 'prefix_table']]);
$grammar->shouldReceive('compileTableExists')->once()->andReturn('sql');
$connection->shouldReceive('getTablePrefix')->once()->andReturn('prefix_');
$connection->shouldReceive('selectFromWriteConnection')->once()->with('sql')->andReturn([['name' => 'prefix_table']]);
$connection->shouldReceive('scalar')->once()->with('sql')->andReturn(1);

$this->assertTrue($builder->hasTable('table'));
}
Expand Down
7 changes: 2 additions & 5 deletions tests/Database/DatabaseMySQLSchemaBuilderTest.php
Original file line number Diff line number Diff line change
Expand Up @@ -20,15 +20,12 @@ public function testHasTable()
{
$connection = m::mock(Connection::class);
$grammar = m::mock(MySqlGrammar::class);
$processor = m::mock(MySqlProcessor::class);
$connection->shouldReceive('getDatabaseName')->andReturn('db');
$connection->shouldReceive('getSchemaGrammar')->andReturn($grammar);
$connection->shouldReceive('getPostProcessor')->andReturn($processor);
$builder = new MySqlBuilder($connection);
$grammar->shouldReceive('compileTables')->once()->andReturn('sql');
$processor->shouldReceive('processTables')->once()->andReturn([['name' => 'prefix_table']]);
$grammar->shouldReceive('compileTableExists')->once()->andReturn('sql');
$connection->shouldReceive('getTablePrefix')->once()->andReturn('prefix_');
$connection->shouldReceive('selectFromWriteConnection')->once()->with('sql')->andReturn([['name' => 'prefix_table']]);
$connection->shouldReceive('scalar')->once()->with('sql')->andReturn(1);

$this->assertTrue($builder->hasTable('table'));
}
Expand Down
35 changes: 10 additions & 25 deletions tests/Database/DatabasePostgresBuilderTest.php
Original file line number Diff line number Diff line change
Expand Up @@ -52,14 +52,11 @@ public function testHasTableWhenSchemaUnqualifiedAndSearchPathMissing()
$connection->shouldReceive('getConfig')->with('search_path')->andReturn(null);
$connection->shouldReceive('getConfig')->with('schema')->andReturn(null);
$grammar = m::mock(PostgresGrammar::class);
$processor = m::mock(PostgresProcessor::class);
$connection->shouldReceive('getSchemaGrammar')->once()->andReturn($grammar);
$connection->shouldReceive('getPostProcessor')->andReturn($processor);
$grammar->shouldReceive('compileTables')->andReturn('sql');
$connection->shouldReceive('selectFromWriteConnection')->with('sql')->andReturn([['schema' => 'public', 'name' => 'foo']]);
$grammar->shouldReceive('compileTableExists')->andReturn('sql');
$connection->shouldReceive('scalar')->with('sql')->andReturn(1);
$connection->shouldReceive('getTablePrefix');
$builder = $this->getBuilder($connection);
$processor->shouldReceive('processTables')->andReturn([['schema' => 'public', 'name' => 'foo']]);

$this->assertTrue($builder->hasTable('foo'));
$this->assertTrue($builder->hasTable('public.foo'));
Expand All @@ -70,14 +67,11 @@ public function testHasTableWhenSchemaUnqualifiedAndSearchPathFilled()
$connection = $this->getConnection();
$connection->shouldReceive('getConfig')->with('search_path')->andReturn('myapp,public');
$grammar = m::mock(PostgresGrammar::class);
$processor = m::mock(PostgresProcessor::class);
$connection->shouldReceive('getSchemaGrammar')->once()->andReturn($grammar);
$connection->shouldReceive('getPostProcessor')->andReturn($processor);
$grammar->shouldReceive('compileTables')->andReturn('sql');
$connection->shouldReceive('selectFromWriteConnection')->with('sql')->andReturn([['schema' => 'myapp', 'name' => 'foo']]);
$grammar->shouldReceive('compileTableExists')->andReturn('sql');
$connection->shouldReceive('scalar')->with('sql')->andReturn(1);
$connection->shouldReceive('getTablePrefix');
$builder = $this->getBuilder($connection);
$processor->shouldReceive('processTables')->andReturn([['schema' => 'myapp', 'name' => 'foo']]);

$this->assertTrue($builder->hasTable('foo'));
$this->assertTrue($builder->hasTable('myapp.foo'));
Expand All @@ -89,14 +83,11 @@ public function testHasTableWhenSchemaUnqualifiedAndSearchPathFallbackFilled()
$connection->shouldReceive('getConfig')->with('search_path')->andReturn(null);
$connection->shouldReceive('getConfig')->with('schema')->andReturn(['myapp', 'public']);
$grammar = m::mock(PostgresGrammar::class);
$processor = m::mock(PostgresProcessor::class);
$connection->shouldReceive('getSchemaGrammar')->once()->andReturn($grammar);
$connection->shouldReceive('getPostProcessor')->andReturn($processor);
$grammar->shouldReceive('compileTables')->andReturn('sql');
$connection->shouldReceive('selectFromWriteConnection')->with('sql')->andReturn([['schema' => 'myapp', 'name' => 'foo']]);
$grammar->shouldReceive('compileTableExists')->andReturn('sql');
$connection->shouldReceive('scalar')->with('sql')->andReturn(1);
$connection->shouldReceive('getTablePrefix');
$builder = $this->getBuilder($connection);
$processor->shouldReceive('processTables')->andReturn([['schema' => 'myapp', 'name' => 'foo']]);

$this->assertTrue($builder->hasTable('foo'));
$this->assertTrue($builder->hasTable('myapp.foo'));
Expand All @@ -108,14 +99,11 @@ public function testHasTableWhenSchemaUnqualifiedAndSearchPathIsUserVariable()
$connection->shouldReceive('getConfig')->with('username')->andReturn('foouser');
$connection->shouldReceive('getConfig')->with('search_path')->andReturn('$user');
$grammar = m::mock(PostgresGrammar::class);
$processor = m::mock(PostgresProcessor::class);
$connection->shouldReceive('getSchemaGrammar')->once()->andReturn($grammar);
$connection->shouldReceive('getPostProcessor')->andReturn($processor);
$grammar->shouldReceive('compileTables')->andReturn('sql');
$connection->shouldReceive('selectFromWriteConnection')->with('sql')->andReturn([['schema' => 'foouser', 'name' => 'foo']]);
$grammar->shouldReceive('compileTableExists')->andReturn('sql');
$connection->shouldReceive('scalar')->with('sql')->andReturn(1);
$connection->shouldReceive('getTablePrefix');
$builder = $this->getBuilder($connection);
$processor->shouldReceive('processTables')->andReturn([['schema' => 'foouser', 'name' => 'foo']]);

$this->assertTrue($builder->hasTable('foo'));
$this->assertTrue($builder->hasTable('foouser.foo'));
Expand All @@ -126,14 +114,11 @@ public function testHasTableWhenSchemaQualifiedAndSearchPathMismatches()
$connection = $this->getConnection();
$connection->shouldReceive('getConfig')->with('search_path')->andReturn('public');
$grammar = m::mock(PostgresGrammar::class);
$processor = m::mock(PostgresProcessor::class);
$connection->shouldReceive('getSchemaGrammar')->once()->andReturn($grammar);
$connection->shouldReceive('getPostProcessor')->andReturn($processor);
$grammar->shouldReceive('compileTables')->andReturn('sql');
$connection->shouldReceive('selectFromWriteConnection')->with('sql')->andReturn([['schema' => 'myapp', 'name' => 'foo']]);
$grammar->shouldReceive('compileTableExists')->andReturn('sql');
$connection->shouldReceive('scalar')->with('sql')->andReturn(1);
$connection->shouldReceive('getTablePrefix');
$builder = $this->getBuilder($connection);
$processor->shouldReceive('processTables')->andReturn([['schema' => 'myapp', 'name' => 'foo']]);

$this->assertTrue($builder->hasTable('myapp.foo'));
}
Expand Down
7 changes: 2 additions & 5 deletions tests/Database/DatabasePostgresSchemaBuilderTest.php
Original file line number Diff line number Diff line change
Expand Up @@ -20,16 +20,13 @@ public function testHasTable()
{
$connection = m::mock(Connection::class);
$grammar = m::mock(PostgresGrammar::class);
$processor = m::mock(PostgresProcessor::class);
$connection->shouldReceive('getSchemaGrammar')->andReturn($grammar);
$connection->shouldReceive('getPostProcessor')->andReturn($processor);
$connection->shouldReceive('getConfig')->with('schema')->andReturn('schema');
$connection->shouldReceive('getConfig')->with('search_path')->andReturn('public');
$builder = new PostgresBuilder($connection);
$grammar->shouldReceive('compileTables')->twice()->andReturn('sql');
$processor->shouldReceive('processTables')->twice()->andReturn([['schema' => 'public', 'name' => 'prefix_table']]);
$grammar->shouldReceive('compileTableExists')->twice()->andReturn('sql');
$connection->shouldReceive('getTablePrefix')->twice()->andReturn('prefix_');
$connection->shouldReceive('selectFromWriteConnection')->twice()->with('sql')->andReturn([['schema' => 'public', 'name' => 'prefix_table']]);
$connection->shouldReceive('scalar')->twice()->with('sql')->andReturn(1);

$this->assertTrue($builder->hasTable('table'));
$this->assertTrue($builder->hasTable('public.table'));
Expand Down