Skip to content

A utility library for ease of using PostgreSQL with Laravel.

License

Notifications You must be signed in to change notification settings

PHPExpertsInc/PostgresForLaravel

Repository files navigation

Postgres For Laravel Library

TravisCI Maintainability Test Coverage

Postgres For Laravel is a PHP Experts, Inc., Project meant to ease the use of the PostgreSQL database in Laravel.

Installation

Via Composer

composer require phpexperts/postgres-for-laravel

Usage

The library should be ready to be used immediately after including via composer.

PostgreSQL Timestamps

Postgres' timestamp support is extremely suprior to MySQL's. Yet, Laravel only supports the dumbed-down timestamps by default. For best performance -including- both timezone-aware and millisecond resolution timestamps, it is best to let POstgres itself handle every table's timestamps. To do this, do the following:

  vendor   |       project        |         created_at         |         updated_at
------------+----------------------+----------------------------+----------------------------
phpexperts | simple-dto           | 2020-04-30 23:35:00        | 2023-07-18 19:08:47
phpexperts | rest-speaker         | 2023-07-30 09:35:53        | 2023-07-30 09:37:37
phpexperts | postgres-for-laravel | 2023-12-14 17:58:46.381623 | 2023-12-14 17:58:46.417537

Automatic Autowiring

  1. Extend every model from PHPExperts\PostgresForLaravel\PostgresModel.
  2. Run ./artisan migrate

Manual Wiring

  1. Add public $timestamps = false; to your Model.
  2. Create a new migration: ./artisan make:migration use_native_postgres_timestamps
  3. Add the following code to the migration:
<?php declare(strict_types=1);

use Illuminate\Database\Migrations\Migration;
use PHPExperts\PostgresForLaravel\PostgresMigrationHelper;

class UseNativePostgresTimestamps extends Migration
{
    private const TABLES = [
        'packages',
    ];

    public function up(): void
    {
        PostgresMigrationHelper::addPostgresTimestamps(static::TABLES);
    }

    public function down(): void
    {
        PostgresMigrationHelper::dropPostgresTimestamps(static::TABLES, PostgresMigrationHelper::DEFAULT_TIMESTAMPS);
    }
}

Use cases

✔ Use PostgreSQL native timestamp generation code.

Testing

phpunit --testdox

Contributors

Theodore R. Smith theodore@phpexperts.pro
GPG Fingerprint: 4BF8 2613 1C34 87AC D28F 2AD8 EB24 A91D D612 5690
CEO: PHP Experts, Inc.

License

MIT license. Please see the license file for more information. :wq

About

A utility library for ease of using PostgreSQL with Laravel.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages