Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/schmeits/pulse-database-table-info

A Laravel Pulse card displaying the table info of the current database.
https://github.com/schmeits/pulse-database-table-info

laravel livewire php pulse

Last synced: 7 days ago
JSON representation

A Laravel Pulse card displaying the table info of the current database.

Host: GitHub
URL: https://github.com/schmeits/pulse-database-table-info
Owner: schmeits
License: mit
Created: 2024-01-25T13:16:48.000Z (10 months ago)
Default Branch: main
Last Pushed: 2024-04-29T23:09:07.000Z (7 months ago)
Last Synced: 2024-04-30T00:25:36.495Z (7 months ago)
Topics: laravel, livewire, php, pulse
Language: PHP
Homepage:
Size: 154 KB
Stars: 1
Watchers: 1
Forks: 1
Open Issues: 0
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md

Awesome Lists containing this project

README

        # A Laravel Pulse card displaying the table info of the current database.

[![Latest Version on Packagist](https://img.shields.io/packagist/v/schmeits/pulse-database-table-info.svg?style=flat-square)](https://packagist.org/packages/schmeits/pulse-database-table-info)

[![GitHub Tests Action Status](https://img.shields.io/github/actions/workflow/status/schmeits/pulse-database-table-info/run-tests.yml?branch=main&label=tests&style=flat-square)](https://github.com/schmeits/pulse-database-table-info/actions?query=workflow%3Arun-tests+branch%3Amain)

[![GitHub Code Style Action Status](https://img.shields.io/github/actions/workflow/status/schmeits/pulse-database-table-info/fix-php-code-style-issues.yml?branch=main&label=code%20style&style=flat-square)](https://github.com/schmeits/pulse-database-table-info/actions?query=workflow%3A"Fix+PHP+code+style+issues"+branch%3Amain)

[![Total Downloads](https://img.shields.io/packagist/dt/schmeits/pulse-database-table-info.svg?style=flat-square)](https://packagist.org/packages/schmeits/pulse-database-table-info)

This pulse card displays the tables in the database with their corresponding info (size and rows).

![example-screenshot.png](docs-assets%2Fscreenshots%2Fexample-screenshot.png)

## Installation

You can install the package via composer:

```bash

composer require schmeits/pulse-database-table-info

```

## Register the recorder

To run the checks you must add the `TableInfoRecorder` to the `pulse.php` file.

```diff

return [

    // ...

    

    'recorders' => [

+        \Schmeits\Pulse\DatabaseTableInfo\Recorders\TableInfoRecorder::class => [],

    ]

]

```

You also need to be running [the `pulse:check` command](https://laravel.com/docs/10.x/pulse#dashboard-cards).

## Configure the recorder

```php

\Schmeits\Pulse\DatabaseTableInfo\Recorders\TableInfoRecorder::class => [

    'enabled' => env('PULSE_DATABASE_TABLE_ENABLED', true), // ebabling the recorder

    'ignore' => [

        '#^pulse#', // Ignore pulse entries...

        '#^telescope#', // Ignore telescope entries...

        '#^health_check_result#', // ignore health_check_results

    ],

],

```

## Add to your dashboard

To add the card to the Pulse dashboard, you must first [publish the vendor view](https://laravel.com/docs/10.x/pulse#dashboard-customization).

Then, you can modify the `dashboard.blade.php` file:

```diff

+    

    

    

    

    

    

    

    

    

    

```

That's it :)

## Testing

```bash

composer test

```

## Changelog

Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.

## Credits

- [Tally Schmeits](https://github.com/schmeits)

- [All Contributors](../../contributors)

## License

The MIT License (MIT). Please see [License File](LICENSE.md) for more information.