anthonyedmonds/laravel-mysqlite

Generate MySQL and Sqlite3 expressions on the fly based on the active database

3.0.0 2024-04-25 12:34 UTC

This package is auto-updated.

Last update: 2024-04-25 12:35:18 UTC


README

Generate MySQL and SQLite3 expressions on the fly based on the active database.

Designed primarily for situations where an SQLite3 database is used for testing, but MySQL is used for production.

Calling the MySqlite:: helper will provide the correct syntax for the default database connection.

Installation

  1. Install via Composer: composer require anthonyedmonds/laravel-mysqlite
  2. Use in your code: use AnthonyEdmonds\LaravelMySqlite\MySqlite

Usage

Laravel MySqlite provides syntax for the following MySQL/SQLite conversions:

MySqlite Method MySQL Syntax SQLite Syntax Notes
MySqlite::cast() CAST() CAST() Must be a value from MySqlite::CASTS_MYSQL
MySqlite::concat() CONCAT() || Pass literal strings with quotation marks, such as '"String"'
MySqlite::day() DAY() STRFTIME()
MySqlite::dateFormat() DATE_FORMAT() STRFTIME() Use date formats supported by both MySQL and SQLite
MySqlite::disableForeignKeys() SET FOREIGN_KEY_CHECKS=0 PRAGMA foreign_keys = 0
MySqlite::enableForeignKeys() SET FOREIGN_KEY_CHECKS=1 PRAGMA foreign_keys = 1
MySqlite::hour() HOUR() STRFTIME()
MySqlite::jsonUnquote() JSON_UNQUOTE() TRIM(") Performs a trim on qutoation marks
MySqlite::month() MONTH() STRFTIME()
MySqlite::setAutoIncrement() ALTER TABLE... UPDATE sqlite_sequence... Used as a standalone statement
MySqlite::trim() TRIM() TRIM(), LTRIM(), RTRIM() Pass literal strings with quotation marks, such as '"String"'
MySqlite::year() YEAR() STRFTIME()

The helper returns an Expression with custom __toString behaviour, so you may use it directly inside queries:

DB::table('users')
    ->select([
        MySqlite::concat(['users.first_name', '" "', 'users.last_name'], 'name'),
        MySqlite::dateFormat('users.created_at', '%d/%m/%Y', 'formatted_date'),
        MySqlite::day('AVG(users.updated_at)', 'aggregated_day'),
        MySqlite::trim('", "', 'users.aliases_list', 'formatted_aliases', MySqlite::TRIM_TRAILING),
    ])
    ->groupBy([
        MySqlite::year('users.updated_at')
    ])
    ->get();

Columns

The column/columns value of a method accepts a string/array of:

  • A column name 'users.first_name'
  • An aggregate method 'COUNT(users.id)'
  • A string literal in quotation marks '"Literally this"'
  • Any other valid SQL expression

Aliasing / As

The optional $as parameter adds a column alias when set:

MySqlite::hour('users.created_at', 'potato') === HOUR(users.created_at) AS potato

Roadmap

There are more syntax differences between MySQL and SQLite that can be compensated for with minor syntax changes, which will be added as they are encountered.

If you require a particular method conversion, raise an issue.