Created
October 12, 2019 18:28
-
-
Save DarkGhostHunter/3c341b394dfcfaf3b39302ff882e8efd to your computer and use it in GitHub Desktop.
Enable WAL Journal in SQLite database
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
<?php | |
namespace App\Console\Commands\Sqlite; | |
use LogicException; | |
use Illuminate\Console\Command; | |
use Illuminate\Database\DatabaseManager; | |
use Illuminate\Database\Query\Expression; | |
use Illuminate\Database\SQLiteConnection; | |
use Illuminate\Database\ConnectionInterface; | |
class SqliteWalEnable extends Command | |
{ | |
/** | |
* The name and signature of the console command. | |
* | |
* @var string | |
*/ | |
protected $signature = 'sqlite:wal-enable | |
{connection=sqlite : The connection to enable WAL journal}'; | |
/** | |
* The console command description. | |
* | |
* @var string | |
*/ | |
protected $description = 'Enables WAL journal on SQLite databases as performance optimization.'; | |
/** | |
* Execute the console command. | |
* | |
* @param \Illuminate\Database\DatabaseManager $manager | |
* @return void | |
*/ | |
public function handle(DatabaseManager $manager) | |
{ | |
$this->setWalJournalMode( | |
$db = $this->getDatabase($manager, $connection = $this->argument('connection')) | |
); | |
$journal = $this->getJournalMode($db); | |
if ($journal !== 'wal') { | |
return $this->error("The '$connection' could not be set as WAL, returned [$journal] as journal mode."); | |
} | |
$this->info("The '$connection' connection has been set as [$journal] journal mode."); | |
} | |
/** | |
* Returns the Database Connection | |
* | |
* @param \Illuminate\Database\DatabaseManager $manager | |
* @param string $connection | |
* @return \Illuminate\Database\Connection | |
*/ | |
protected function getDatabase(DatabaseManager $manager, string $connection) | |
{ | |
$db = $manager->connection($connection); | |
// We will throw an exception if the database is not SQLite | |
if(!$db instanceof SQLiteConnection) { | |
throw new LogicException("The '$connection' connection must be sqlite, [{$db->getDriverName()}] given."); | |
} | |
return $db; | |
} | |
/** | |
* Sets the Journal Mode to WAL | |
* | |
* @param \Illuminate\Database\ConnectionInterface $connection | |
* @return bool | |
*/ | |
protected function setWalJournalMode(ConnectionInterface $connection) | |
{ | |
return $connection->statement('PRAGMA journal_mode=WAL;'); | |
} | |
/** | |
* Returns the current Journal Mode of the Database Connection | |
* | |
* @param \Illuminate\Database\ConnectionInterface $connection | |
* @return string | |
*/ | |
protected function getJournalMode(ConnectionInterface $connection) | |
{ | |
return data_get($connection->select(new Expression('PRAGMA journal_mode')), '0.journal_mode'); | |
} | |
} |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment