Skip to content

[11.x] Add MariaDB driver #50146

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

Merged
merged 1 commit into from
Feb 19, 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
2 changes: 1 addition & 1 deletion config/database.php
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@
],

'mariadb' => [
'driver' => 'mysql',
'driver' => 'mariadb',
'url' => env('DB_URL'),
'host' => env('DB_HOST', '127.0.0.1'),
'port' => env('DB_PORT', '3306'),
Expand Down
3 changes: 3 additions & 0 deletions src/Illuminate/Database/Connectors/ConnectionFactory.php
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@

use Illuminate\Contracts\Container\Container;
use Illuminate\Database\Connection;
use Illuminate\Database\MariaDbConnection;
use Illuminate\Database\MySqlConnection;
use Illuminate\Database\PostgresConnection;
use Illuminate\Database\SQLiteConnection;
Expand Down Expand Up @@ -241,6 +242,7 @@ public function createConnector(array $config)

return match ($config['driver']) {
'mysql' => new MySqlConnector,
'mariadb' => new MariaDbConnector,
'pgsql' => new PostgresConnector,
'sqlite' => new SQLiteConnector,
'sqlsrv' => new SqlServerConnector,
Expand Down Expand Up @@ -268,6 +270,7 @@ protected function createConnection($driver, $connection, $database, $prefix = '

return match ($driver) {
'mysql' => new MySqlConnection($connection, $database, $prefix, $config),
'mariadb' => new MariaDbConnection($connection, $database, $prefix, $config),
'pgsql' => new PostgresConnection($connection, $database, $prefix, $config),
'sqlite' => new SQLiteConnection($connection, $database, $prefix, $config),
'sqlsrv' => new SqlServerConnection($connection, $database, $prefix, $config),
Expand Down
20 changes: 20 additions & 0 deletions src/Illuminate/Database/Connectors/MariaDbConnector.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
<?php

namespace Illuminate\Database\Connectors;

use PDO;

class MariaDbConnector extends MySqlConnector implements ConnectorInterface
{
/**
* Get the query to enable strict mode.
*
* @param \PDO $connection
* @param array $config
* @return string
*/
protected function strictMode(PDO $connection, $config)
{
return "set session sql_mode='ONLY_FULL_GROUP_BY,STRICT_TRANS_TABLES,NO_ZERO_IN_DATE,NO_ZERO_DATE,ERROR_FOR_DIVISION_BY_ZERO,NO_ENGINE_SUBSTITUTION'";
}
}
2 changes: 2 additions & 0 deletions src/Illuminate/Database/Console/DatabaseInspectionCommand.php
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@

use Illuminate\Console\Command;
use Illuminate\Database\ConnectionInterface;
use Illuminate\Database\MariaDbConnection;
use Illuminate\Database\MySqlConnection;
use Illuminate\Database\PostgresConnection;
use Illuminate\Database\SQLiteConnection;
Expand All @@ -24,6 +25,7 @@ protected function getConnectionName(ConnectionInterface $connection, $database)
return match (true) {
$connection instanceof MySqlConnection && $connection->isMaria() => 'MariaDB',
$connection instanceof MySqlConnection => 'MySQL',
$connection instanceof MariaDbConnection => 'MariaDB',
$connection instanceof PostgresConnection => 'PostgreSQL',
$connection instanceof SQLiteConnection => 'SQLite',
$connection instanceof SqlServerConnection => 'SQL Server',
Expand Down
13 changes: 12 additions & 1 deletion src/Illuminate/Database/Console/DbCommand.php
Original file line number Diff line number Diff line change
Expand Up @@ -130,7 +130,7 @@ public function commandEnvironment(array $connection)
public function getCommand(array $connection)
{
return [
'mysql' => 'mysql',
'mysql', 'mariadb' => 'mysql',
'pgsql' => 'psql',
'sqlite' => 'sqlite3',
'sqlsrv' => 'sqlcmd',
Expand All @@ -156,6 +156,17 @@ protected function getMysqlArguments(array $connection)
], $connection), [$connection['database']]);
}

/**
* Get the arguments for the MariaDB CLI.
*
* @param array $connection
* @return array
*/
protected function getMariaDbArguments(array $connection)
{
return $this->getMysqlArguments($connection);
}

/**
* Get the arguments for the Postgres CLI.
*
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -148,7 +148,7 @@ protected function repositoryExists()
if (
$e->getPrevious() instanceof PDOException &&
$e->getPrevious()->getCode() === 1049 &&
$connection->getDriverName() === 'mysql') {
in_array($connection->getDriverName(), ['mysql', 'mariadb'])) {
return $this->createMissingMysqlDatabase($connection);
}

Expand Down
4 changes: 2 additions & 2 deletions src/Illuminate/Database/DatabaseManager.php
Original file line number Diff line number Diff line change
Expand Up @@ -361,13 +361,13 @@ public function setDefaultConnection($name)
}

/**
* Get all of the support drivers.
* Get all of the supported drivers.
*
* @return string[]
*/
public function supportedDrivers()
{
return ['mysql', 'pgsql', 'sqlite', 'sqlsrv'];
return ['mysql', 'mariadb', 'pgsql', 'sqlite', 'sqlsrv'];
}

/**
Expand Down
94 changes: 94 additions & 0 deletions src/Illuminate/Database/MariaDbConnection.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,94 @@
<?php

namespace Illuminate\Database;

use Illuminate\Database\Query\Grammars\MariaDbGrammar as QueryGrammar;
use Illuminate\Database\Query\Processors\MariaDbProcessor;
use Illuminate\Database\Schema\Grammars\MariaDbGrammar as SchemaGrammar;
use Illuminate\Database\Schema\MariaDbBuilder;
use Illuminate\Database\Schema\MariaDbSchemaState;
use Illuminate\Filesystem\Filesystem;
use Illuminate\Support\Str;

class MariaDbConnection extends MySqlConnection
{
/**
* Determine if the connected database is a MariaDB database.
*
* @return bool
*/
public function isMaria()
{
return true;
}

/**
* Get the server version for the connection.
*
* @return string
*/
public function getServerVersion(): string
{
return Str::between(parent::getServerVersion(), '5.5.5-', '-MariaDB');
}

/**
* Get the default query grammar instance.
*
* @return \Illuminate\Database\Query\Grammars\MariaDbGrammar
*/
protected function getDefaultQueryGrammar()
{
($grammar = new QueryGrammar)->setConnection($this);

return $this->withTablePrefix($grammar);
}

/**
* Get a schema builder instance for the connection.
*
* @return \Illuminate\Database\Schema\MariaDbBuilder
*/
public function getSchemaBuilder()
{
if (is_null($this->schemaGrammar)) {
$this->useDefaultSchemaGrammar();
}

return new MariaDbBuilder($this);
}

/**
* Get the default schema grammar instance.
*
* @return \Illuminate\Database\Schema\Grammars\MariaDbGrammar
*/
protected function getDefaultSchemaGrammar()
{
($grammar = new SchemaGrammar)->setConnection($this);

return $this->withTablePrefix($grammar);
}

/**
* Get the schema state for the connection.
*
* @param \Illuminate\Filesystem\Filesystem|null $files
* @param callable|null $processFactory
* @return \Illuminate\Database\Schema\MariaDbSchemaState
*/
public function getSchemaState(Filesystem $files = null, callable $processFactory = null)
{
return new MariaDbSchemaState($this, $files, $processFactory);
}

/**
* Get the default post processor instance.
*
* @return \Illuminate\Database\Query\Processors\MariaDbProcessor
*/
protected function getDefaultPostProcessor()
{
return new MariaDbProcessor;
}
}
19 changes: 19 additions & 0 deletions src/Illuminate/Database/Query/Grammars/MariaDbGrammar.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
<?php

namespace Illuminate\Database\Query\Grammars;

use Illuminate\Database\Query\Builder;

class MariaDbGrammar extends MySqlGrammar
{
/**
* Determine whether to use a legacy group limit clause for MySQL < 8.0.
*
* @param \Illuminate\Database\Query\Builder $query
* @return bool
*/
public function useLegacyGroupLimit(Builder $query)
{
return false;
}
}
8 changes: 8 additions & 0 deletions src/Illuminate/Database/Query/Processors/MariaDbProcessor.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
<?php

namespace Illuminate\Database\Query\Processors;

class MariaDbProcessor extends MySqlProcessor
{
//
}
76 changes: 76 additions & 0 deletions src/Illuminate/Database/Schema/Grammars/MariaDbGrammar.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,76 @@
<?php

namespace Illuminate\Database\Schema\Grammars;

use Illuminate\Database\Connection;
use Illuminate\Database\Query\Expression;
use Illuminate\Database\Schema\Blueprint;
use Illuminate\Database\Schema\ColumnDefinition;
use Illuminate\Support\Fluent;

class MariaDbGrammar extends MySqlGrammar
{
/**
* Compile a rename column command.
*
* @param \Illuminate\Database\Schema\Blueprint $blueprint
* @param \Illuminate\Support\Fluent $command
* @param \Illuminate\Database\Connection $connection
* @return array|string
*/
public function compileRenameColumn(Blueprint $blueprint, Fluent $command, Connection $connection)
{
if (version_compare($connection->getServerVersion(), '10.5.2', '<')) {
$column = collect($connection->getSchemaBuilder()->getColumns($blueprint->getTable()))
->firstWhere('name', $command->from);

$modifiers = $this->addModifiers($column['type'], $blueprint, new ColumnDefinition([
'change' => true,
'type' => match ($column['type_name']) {
'bigint' => 'bigInteger',
'int' => 'integer',
'mediumint' => 'mediumInteger',
'smallint' => 'smallInteger',
'tinyint' => 'tinyInteger',
default => $column['type_name'],
},
'nullable' => $column['nullable'],
'default' => $column['default'] && str_starts_with(strtolower($column['default']), 'current_timestamp')
? new Expression($column['default'])
: $column['default'],
'autoIncrement' => $column['auto_increment'],
'collation' => $column['collation'],
'comment' => $column['comment'],
]));

return sprintf('alter table %s change %s %s %s',
$this->wrapTable($blueprint),
$this->wrap($command->from),
$this->wrap($command->to),
$modifiers
);
}

return parent::compileRenameColumn($blueprint, $command, $connection);
}

/**
* Create the column definition for a spatial Geometry type.
*
* @param \Illuminate\Support\Fluent $column
* @return string
*/
protected function typeGeometry(Fluent $column)
{
$subtype = $column->subtype ? strtolower($column->subtype) : null;

if (! in_array($subtype, ['point', 'linestring', 'polygon', 'geometrycollection', 'multipoint', 'multilinestring', 'multipolygon'])) {
$subtype = null;
}

return sprintf('%s%s',
$subtype ?? 'geometry',
$column->srid ? ' ref_system_id='.$column->srid : ''
);
}
}
8 changes: 8 additions & 0 deletions src/Illuminate/Database/Schema/MariaDbBuilder.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
<?php

namespace Illuminate\Database\Schema;

class MariaDbBuilder extends MySqlBuilder
{
//
}
18 changes: 18 additions & 0 deletions src/Illuminate/Database/Schema/MariaDbSchemaState.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
<?php

namespace Illuminate\Database\Schema;

class MariaDbSchemaState extends MySqlSchemaState
{
/**
* Get the base dump command arguments for MariaDB as a string.
*
* @return string
*/
protected function baseDumpCommand()
{
$command = 'mysqldump '.$this->connectionString().' --no-tablespaces --skip-add-locks --skip-comments --skip-set-charset --tz-utc --column-statistics=0';

return $command.' "${:LARAVEL_LOAD_DATABASE}"';
}
}
48 changes: 48 additions & 0 deletions tests/Database/DatabaseMariaDbBuilderTest.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
<?php

namespace Database;

use Illuminate\Database\Connection;
use Illuminate\Database\Schema\Grammars\MariaDbGrammar;
use Illuminate\Database\Schema\MariaDbBuilder;
use Mockery as m;
use PHPUnit\Framework\TestCase;

class DatabaseMariaDbBuilderTest extends TestCase
{
protected function tearDown(): void
{
m::close();
}

public function testCreateDatabase()
{
$grammar = new MariaDbGrammar;

$connection = m::mock(Connection::class);
$connection->shouldReceive('getConfig')->once()->with('charset')->andReturn('utf8mb4');
$connection->shouldReceive('getConfig')->once()->with('collation')->andReturn('utf8mb4_unicode_ci');
$connection->shouldReceive('getSchemaGrammar')->once()->andReturn($grammar);
$connection->shouldReceive('statement')->once()->with(
'create database `my_temporary_database` default character set `utf8mb4` default collate `utf8mb4_unicode_ci`'
)->andReturn(true);

$builder = new MariaDbBuilder($connection);
$builder->createDatabase('my_temporary_database');
}

public function testDropDatabaseIfExists()
{
$grammar = new MariaDbGrammar;

$connection = m::mock(Connection::class);
$connection->shouldReceive('getSchemaGrammar')->once()->andReturn($grammar);
$connection->shouldReceive('statement')->once()->with(
'drop database if exists `my_database_a`'
)->andReturn(true);

$builder = new MariaDbBuilder($connection);

$builder->dropDatabaseIfExists('my_database_a');
}
}
Loading