googletest/sqlcommenter-laravel

SQLCommenter implementation for Laravel. SQLCommenter is a set of tools that augments SQL Statements with comments containing information about the code that caused its execution. These information can be action, controller, framework, db_driver, route and opentelemetry traceparent.

dev-main 2023-04-06 06:56 UTC

Requires

• open-telemetry/opentelemetry: ^1.0.0beta1
• php-http/guzzle7-adapter: ^1.0

Requires (Dev)

• phpunit/phpunit: ^9.5

MIT

• GoogleTest Developers

README

sqlcommenter is a plugin/middleware/wrapper to augment SQL statements from laravel with comments that can be used later to correlate user code with SQL statements.

Installation

Add this to your composer.json

"repositories": [
    {
        "type": "path",
        "url": "/full/or/relative/path/to/sqlcommenter-laravel/package"
    }
]

Install the package

composer require "googletest/sqlcommenter-laravel"

Usage

Publish the config file from library to into laravel app using below command

php artisan vendor:publish --provider="GoogleTest\GoogleSqlCommenterLaravel\GoogleSqlCommenterServiceProvider"

Add the following class above Illuminate\Database\DatabaseServiceProvider::class, in config/app.php

'providers' => [
    ...
    GoogleTest\GoogleSqlCommenterLaravel\Database\DatabaseServiceProvider::class,
    Illuminate\Database\DatabaseServiceProvider::class,
    ...
]

Run unit tests

Run unit tests using below command

./vendor/bin/phpunit tests