# sqlcommenter-laravel-php

**Repository Path**: mirrors_google/sqlcommenter-laravel-php

## Basic Information

- **Project Name**: sqlcommenter-laravel-php
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2022-08-21
- **Last Updated**: 2025-12-13

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# sqlcommenter-laravel [In Development]

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`
```shell
"repositories": [
    {
        "type": "path",
        "url": "/full/or/relative/path/to/sqlcommenter-laravel/package"
    }
]
```
Install the package
```shell
composer require "google/sqlcommenter-laravel"
```
### Usage

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

```shell
php artisan vendor:publish --provider="Google\GoogleSqlCommenterLaravel\GoogleSqlCommenterServiceProvider"

```

Add the following class above `Illuminate\Database\DatabaseServiceProvider::class`,
 in `config/app.php`
```php
'providers' => [
    ...
    Google\GoogleSqlCommenterLaravel\Database\DatabaseServiceProvider::class,
    Illuminate\Database\DatabaseServiceProvider::class,
    ...
]
```
### Run unit tests

Run unit tests using below command
```shell
./vendor/bin/phpunit tests
```