centerpoint/reader

This package will help you to build a collection from different database of your project

v2.0.0 2023-08-27 10:50 UTC

This package is auto-updated.

Last update: 2024-06-10 04:51:52 UTC


README

Laravel package for Easy to get report list from different database.

About

This package only for who need a report list from database a particular table which is independent database server. The package have self controller, config, view and service provider files.

Installation

The preferred method of installation is via [Packagist][] and [Composer][]. Run the following command to install the package and add it as a requirement to your project's composer.json:

composer require centerpoint/reader

Latest Laravel versions have auto dicovery and automatically add service providers, however if you're using Laravel 5.4.x and below, remember to add it to providers array at /app/config/app.php:

Centerpoint\Reader\ReaderServiceProvider::class

Set those in .env file

DB_CONNECTION=databaseconnectionname
DB_HOST=your_host //127.0.0.1
DB_PORT=your_port //3306
DB_DATABASE=your_database // admindatabase
DB_USERNAME=your_username
DB_PASSWORD=your_password

Set those in config/database.php file

'databaseconnectionname' => [
            'driver'        => 'mysql',
            'host'          => env('DB_HOST', '127.0.0.1'),
            'port'          => env('DB_PORT', '3306'),
            'database'      => env('DB_DATABASE', ''),
            'username'      => env('DB_USERNAME', ''),
            'password'      => env('DB_PASSWORD', ''),
            'charset'       => 'utf8',
            'collation'     => 'utf8_unicode_ci',
],

After install the package let's configure your db setup, that's menus what type of relation do you want to build for a particular db.

Execute composer run-script queryGenerate

This will ask you some question like

"What's the table name(like users): "

You have to enter the table name.

"What's the table columns(like id, name, email): "

Enter the table columns with exact same as like the example.

"What's will the 'orderBy' table column(like id): "

Enter the column name according to your table, this will help you to retrieve data from the table according to the table field or column name.

"What's will be the 'oderBy' type(like desc or asc): "

Enter order type properly.

"How many data you want to retrive(like 100): "

Enter the amount of data you want to retrieve

"Do you want joining(like yes or no): "

If you enter yes then it will ask some more question to build relation according to your entry value. If you enter no then it will terminated and this 127.0.0.1:8000/reader link will show list of data.

If you enter yes then enter the parent table name. "Enter parent table name(like users):"

Enter the column name which is the foreign key of the table. Like if you define users table and hold domain_id column which is foreign key.

"Enter table col name(like id from user table) which will be the FOREIGN KEY: "

Enter the join table name.

"What's the joining table name(like domain): "

Enter the column name which is the references the id in the table. Like we define domains table and id column is the references id.

"What's joining table col name(like domain_id) which will be the REFERENCES ID: "

Enter the column name for the joining table.

"What's your excepted col name(like subdomain) that you retrive from the joining table: "