Commit e9b5d1d5 authored by abkrim's avatar abkrim 😀
Browse files

Initial commit

parents
Pipeline #189 canceled with stages
; This file is for unifying the coding style for different editors and IDEs.
; More information at http://editorconfig.org
root = true
[*]
charset = utf-8
indent_size = 4
indent_style = space
end_of_line = lf
insert_final_newline = true
trim_trailing_whitespace = true
[*.md]
trim_trailing_whitespace = false
# Path-based git attributes
# https://www.kernel.org/pub/software/scm/git/docs/gitattributes.html
# Ignore all test and documentation with "export-ignore".
/.gitattributes export-ignore
/.gitignore export-ignore
/.travis.yml export-ignore
/phpunit.xml.dist export-ignore
/.scrutinizer.yml export-ignore
/tests export-ignore
/.editorconfig export-ignore
build
composer.lock
docs
vendor
coverage
\ No newline at end of file
filter:
excluded_paths: [tests/*]
checks:
php:
remove_extra_empty_lines: true
remove_php_closing_tag: true
remove_trailing_whitespace: true
fix_use_statements:
remove_unused: true
preserve_multiple: false
preserve_blanklines: true
order_alphabetically: true
fix_php_opening_tag: true
fix_linefeed: true
fix_line_ending: true
fix_identation_4spaces: true
fix_doc_comments: true
preset: laravel
disabled:
- single_class_element_per_statement
language: php
php:
- 7.1
- 7.2
- 7.3
env:
matrix:
- COMPOSER_FLAGS="--prefer-lowest"
- COMPOSER_FLAGS=""
before_script:
- travis_retry composer self-update
- travis_retry composer update ${COMPOSER_FLAGS} --no-interaction --prefer-source
script:
- vendor/bin/phpunit --coverage-text --coverage-clover=coverage.clover
after_script:
- php vendor/bin/ocular code-coverage:upload --format=php-clover coverage.clover
# Changelog
All notable changes to `db-schema` will be documented in this file
## 1.0.0 - 201X-XX-XX
- initial release
# Contributing
Contributions are **welcome** and will be fully **credited**.
Please read and understand the contribution guide before creating an issue or pull request.
## Etiquette
This project is open source, and as such, the maintainers give their free time to build and maintain the source code
held within. They make the code freely available in the hope that it will be of use to other developers. It would be
extremely unfair for them to suffer abuse or anger for their hard work.
Please be considerate towards maintainers when raising issues or presenting pull requests. Let's show the
world that developers are civilized and selfless people.
It's the duty of the maintainer to ensure that all submissions to the project are of sufficient
quality to benefit the project. Many developers have different skillsets, strengths, and weaknesses. Respect the maintainer's decision, and do not be upset or abusive if your submission is not used.
## Viability
When requesting or submitting new features, first consider whether it might be useful to others. Open
source projects are used by many developers, who may have entirely different needs to your own. Think about
whether or not your feature is likely to be used by other users of the project.
## Procedure
Before filing an issue:
- Attempt to replicate the problem, to ensure that it wasn't a coincidental incident.
- Check to make sure your feature suggestion isn't already present within the project.
- Check the pull requests tab to ensure that the bug doesn't have a fix in progress.
- Check the pull requests tab to ensure that the feature isn't already in progress.
Before submitting a pull request:
- Check the codebase to ensure that your feature doesn't already exist.
- Check the pull requests to ensure that another person hasn't already submitted the feature or fix.
## Requirements
If the project maintainer has any additional requirements, you will find them listed here.
- **[PSR-2 Coding Standard](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-2-coding-style-guide.md)** - The easiest way to apply the conventions is to install [PHP Code Sniffer](https://pear.php.net/package/PHP_CodeSniffer).
- **Add tests!** - Your patch won't be accepted if it doesn't have tests.
- **Document any change in behaviour** - Make sure the `README.md` and any other relevant documentation are kept up-to-date.
- **Consider our release cycle** - We try to follow [SemVer v2.0.0](https://semver.org/). Randomly breaking public APIs is not an option.
- **One pull request per feature** - If you want to do more than one thing, send multiple pull requests.
- **Send coherent history** - Make sure each individual commit in your pull request is meaningful. If you had to make multiple intermediate commits while developing, please [squash them](https://www.git-scm.com/book/en/v2/Git-Tools-Rewriting-History#Changing-Multiple-Commit-Messages) before submitting.
**Happy coding**!
MIT License
Copyright (c) AbdelKarim Mateos
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
\ No newline at end of file
# Very short description of the package
[![Latest Version on Packagist](https://img.shields.io/packagist/v/abkrim/db-schema.svg?style=flat-square)](https://packagist.org/packages/abkrim/db-schema)
[![Build Status](https://img.shields.io/travis/abkrim/db-schema/master.svg?style=flat-square)](https://travis-ci.org/abkrim/db-schema)
[![Quality Score](https://img.shields.io/scrutinizer/g/abkrim/db-schema.svg?style=flat-square)](https://scrutinizer-ci.com/g/abkrim/db-schema)
[![Total Downloads](https://img.shields.io/packagist/dt/abkrim/db-schema.svg?style=flat-square)](https://packagist.org/packages/abkrim/db-schema)
This package will help to display database schema information from terminal or save in file
## Installation
You can install the package via composer:
```bash
composer require --dev abkrim/db-schema
```
## Usage
**Show Schema information in tabular form**
```bash
php artisan schema:show
```
Example output: Schema information in tabular form
![Schema information in tabular form](https://raw.githubusercontent.com/thedevsaddam/laravel-schema/master/screenshots/tabular.png)
If you want to see a specific table then pass table name or Namespace\\\Model
```bash
php artisan schema:show --t=tableName or --t=Namespace\\Model
```
![database info commandline](https://raw.githubusercontent.com/thedevsaddam/laravel-schema/master/screenshots/tabular-single.png)
_Note: Same condition will be applied for tables **list** view_
**Show Schema information in List**
```bash
php artisan schema:list
```
Example output: Schema information in list
![database info commandline](https://raw.githubusercontent.com/thedevsaddam/laravel-schema/master/screenshots/list.png)
Avaliable Options in **show** and **list**:
* `--t=tableName` or `-t tableName` to provide table name or Namespace\\Model
* `--c=connectionName` or `-c connectionName` to provide connection name
**Show Table names and total rows**
```bash
php artisan schema:simple
```
Example output: Tables name with rows count
![Tables name with rows count](https://raw.githubusercontent.com/thedevsaddam/laravel-schema/master/screenshots/simple.png)
_Note: You may pass `--c=connectionName` or `-c connectionName` to display a specific connection schema info_
**Show table definition**
```bash
php artisan schema:table --t=tableName or --t=Namespace\\Model
```
Example output: Table definition with default page and limit
![Table definition with default page and limit](https://raw.githubusercontent.com/thedevsaddam/laravel-schema/master/screenshots/table-pagination.png)
Avaliable Options in **table**:
* `--t=tableName` or `-t tableName` to provide table name or Namespace\\\Model (e.g: --t=App\\\User or --t=users).
* `--p=pageNumber` or `-p PageNumber` to provide current page which you want to see
* `--o=orderBy` or `-o orderBy` to provide orderBy clause against a column (e.g: --o=id:desc or --o=id:asc [default asc]).
* `--l=rowsLimitPerPage` or `-l rowsLimitPerPage` to provide number of rows you want to display (e.g: --l=20).
* `--c=connectionName` or `-c connectionName` to provide connection name
* `--w=widthOfTableCell` or `-w widthOfTableCell` to provide character length of cell to show in tables (numeric [default=10]).
* `--s=columnName` to provide the column to display, you can provide comma (,) separated names to display (e.g: --s=name or --s=id,name).
```bash
php artisan schema:table --t=countries --p=4 --o=id:desc --l=25
```
**Perform raw sql query**
```bash
php artisan schema:query --r="your sql query"
```
Example output: Query result will be dumped in console
![Query result will be dumped in console](https://raw.githubusercontent.com/thedevsaddam/laravel-schema/master/screenshots/raw-query.png)
Avaliable Options in **query**:
* `--r=yourRawQuery` or `-r yourRawQuery` to provide your raw sql query (e.g: --r="select * from someTable limit 20").
* `--c=connectionName` or `-c connectionName` to provide connection name (e.g: --c=mysql or -c sqlite)
**Monitor database server**
```bash
php artisan schema:monitor
```
Example output: Showing the database status
![Schema information in tabular form](https://raw.githubusercontent.com/thedevsaddam/laravel-schema/master/screenshots/monitoring-schema.png)
You can pass --i=integerNumber as refresh time interval and --c=ConnectionName as well
```bash
php artisan schema:monitor --i=3 --c=secondaryDatabase
```
### Testing
``` bash
composer test
```
### Laravel versions
This package is only tested in Laravel 6.0 and is possible that work in all version since 5.4
For older versions that do not have auto discover providers you may need to add service provider.
### Changelog
Please see [CHANGELOG](CHANGELOG.md) for more information what has changed recently.
## Contributing
Please see [CONTRIBUTING](CONTRIBUTING.md) for details.
### Security
If you discover any security related issues, please email abdelkarim.mateos@castris.com instead of using the issue tracker.
## Credits
- [AbdelKarim Mateos](https://github.com/abkrim)
- [All Contributors](../../contributors)
## License
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.
## Laravel Package Boilerplate
This package was generated using the [Laravel Package Boilerplate](https://laravelpackageboilerplate.com).
{
"name": "abkrim/db-schema",
"description": "A fork of thedevsaddam/laravel-schema of Saddam H thedevsaddam@gmail.com with some improvements and maintained",
"keywords": [
"abkrim",
"db-schema"
],
"homepage": "https://github.com/abkrim/db-schema",
"license": "MIT",
"type": "library",
"authors": [
{
"name": "AbdelKarim Mateos",
"email": "abdelkarim.mateos@castris.com",
"role": "Developer"
}
],
"require": {
"php": "^7.1",
"illuminate/support": "5.8.*"
},
"require-dev": {
"orchestra/testbench": "3.8.*",
"phpunit/phpunit": "^7.0"
},
"autoload": {
"psr-4": {
"Abkrim\\DbSchema\\": "src"
}
},
"autoload-dev": {
"psr-4": {
"Abkrim\\DbSchema\\Tests\\": "tests"
}
},
"scripts": {
"test": "vendor/bin/phpunit",
"test-coverage": "vendor/bin/phpunit --coverage-html coverage"
},
"config": {
"sort-packages": true
},
"extra": {
"laravel": {
"providers": [
"Abkrim\\DbSchema\\DbSchemaServiceProvider"
],
"aliases": {
"DbSchema": "Abkrim\\DbSchema\\DbSchemaFacade"
}
}
}
}
<?php
/*
* You can place your custom package configuration in here.
*/
return [
];
\ No newline at end of file
<?xml version="1.0" encoding="UTF-8"?>
<phpunit bootstrap="vendor/autoload.php"
backupGlobals="false"
backupStaticAttributes="false"
colors="true"
verbose="true"
convertErrorsToExceptions="true"
convertNoticesToExceptions="true"
convertWarningsToExceptions="true"
processIsolation="false"
stopOnFailure="false">
<testsuites>
<testsuite name="Test Suite">
<directory>tests</directory>
</testsuite>
</testsuites>
<filter>
<whitelist>
<directory suffix=".php">src/</directory>
</whitelist>
</filter>
<logging>
<log type="tap" target="build/report.tap"/>
<log type="junit" target="build/report.junit.xml"/>
<log type="coverage-html" target="build/coverage" charset="UTF-8" yui="true" highlight="true"/>
<log type="coverage-text" target="build/coverage.txt"/>
<log type="coverage-clover" target="build/logs/clover.xml"/>
</logging>
</phpunit>
<?php
namespace Abkrim\DbSchema;
class DbSchema
{
// Build your next great package.
}
<?php
namespace Abkrim\DbSchema;
use Illuminate\Support\Facades\Facade;
/**
* @see \Abkrim\DbSchema\Skeleton\SkeletonClass
*/
class DbSchemaFacade extends Facade
{
/**
* Get the registered name of the component.
*
* @return string
*/
protected static function getFacadeAccessor()
{
return 'db-schema';
}
}
<?php
namespace Abkrim\DbSchema;
use Illuminate\Support\ServiceProvider;
class DbSchemaServiceProvider extends ServiceProvider
{
/**
* Bootstrap the application services.
*/
public function boot()
{
/*
* Optional methods to load your package assets
*/
// $this->loadTranslationsFrom(__DIR__.'/../resources/lang', 'db-schema');
// $this->loadViewsFrom(__DIR__.'/../resources/views', 'db-schema');
// $this->loadMigrationsFrom(__DIR__.'/../database/migrations');
// $this->loadRoutesFrom(__DIR__.'/routes.php');
if ($this->app->runningInConsole()) {
$this->publishes([
__DIR__.'/../config/config.php' => config_path('db-schema.php'),
], 'config');
// Publishing the views.
/*$this->publishes([
__DIR__.'/../resources/views' => resource_path('views/vendor/db-schema'),
], 'views');*/
// Publishing assets.
/*$this->publishes([
__DIR__.'/../resources/assets' => public_path('vendor/db-schema'),
], 'assets');*/
// Publishing the translation files.
/*$this->publishes([
__DIR__.'/../resources/lang' => resource_path('lang/vendor/db-schema'),
], 'lang');*/
// Registering package commands.
// $this->commands([]);
}
}
/**
* Register the application services.
*/
public function register()
{
// Automatically apply the package configuration
$this->mergeConfigFrom(__DIR__.'/../config/config.php', 'db-schema');
// Register the main class to use with the facade
$this->app->singleton('db-schema', function () {
return new DbSchema;
});
}
}
<?php
namespace Abkrim\DbSchema\Tests;
use PHPUnit\Framework\TestCase;
class ExampleTest extends TestCase
{
/** @test */
public function true_is_true()
{
$this->assertTrue(true);
}
}
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment