spam-n-eggs/laravel-mysqlite

MySQLite is a Laravel connector for SQLite that emulates MySQL functionality. The currently ported functionalities can be viewed in README.md on the github site.

1.3.0 2023-07-06 12:46 UTC

This package is auto-updated.

Last update: 2024-02-21 01:56:50 UTC


README

Build Status Coverage Status StyleCI Scrutinizer Code Quality Latest Stable Version Total Downloads License Dependabot Status

Laravel MySQLite is meant to be used in conjunction with Laravel. It is a database connection that adds select functions from MySQL to SQLite.

Usage

Adding the Composer Resource

  1. Execute composer require spam-n-eggs/laravel-mysqlite or alternatively composer require --dev spam-n-eggs/laravel-mysqlite

Registering as a Service Provider

In order to reduce clutter it is preferable to create a separate Service Provider

  1. If there is a need to conditionally register the Service (i.e. you only use it in testing) create a new class in app/Providers that extends Mhorninger\SQLite\MySQLiteServiceProvider

    <?php
    namespace App\Providers;
    
    use Mhorninger\SQLite\MySQLiteServiceProvider as ServiceProvider;
    
    class MySQLiteServiceProvider extends ServiceProvider
    {
        public function register()
        {
            if ($shouldRegister) {
                parent::register();
            }
        }
    }
  2. Add a line to app/Providers/AppServiceProvider.php within the register() method:

    $this->app->register(MySQLiteServiceProvider::class);

Ported Functionality

Constants

Operators

Methods

Aggregate

Date and Time

Flow

Numeric

String

Miscellaneous

Vectorface-Specific

Comparison

Custom Functionality

While this package aims to cover common functionality, there are times when you need support for a function quickly or a custom function that is unique to your application. This is easy to do with two methods from the boot() method of your service provider class:

<?php

class MySQLiteServiceProvider extends ServiceProvider
{
    ...

    public function boot()
    {
        $connection = $this->app->get('db')->connection();
        
        if ($connection->getDriverName() === 'sqlite') {
            $connection
                ->addRewriteRule('/CURDATE\(\)/', "date('now')")
                ->addFunction('CURDATE', fn() => CarbonImmutable::today()->toDateString(), 0);
        }
    }
}
  • addRewriteRule() will replace a string in your query using regex, should Sqlite have a native function that could be used as a 1:1 replacement.
  • addFunction() uses PDO sqliteCreateFunction() to register a custom function with PHP in the event that Sqlite doesn't have a drop-in replacement or if logic is more complicated. Read More.

Contributing

Want to file a bug, contribute some code, improve documentation, or request a feature? Awesome Sauce! Read up on our guidelines for contributing. All contributions must follow our Code of Conduct.

Questions

Have a question? Log an issue with the Question tag. We'll get back to you in a timely fashion.

Credits

This library uses other Open Source components. You can find the source code of their open source projects along with license information below. We acknowledge and are grateful to these developers for their contributions to open source community.

Project: Database https://github.com/illuminate/database Copyright (c) Taylor Otwell License (MIT) https://github.com/laravel/framework/blob/5.7/LICENSE.md

Project: MySQLite https://github.com/Vectorface/MySQLite Copyright (c) 2014 Vectorface, Inc. License: (MIT) https://github.com/Vectorface/MySQLite/blob/master/LICENSE