https://github.com/milantex/mysql-tso

Creates a PHP object which describes the MySQL table structure for a specified table in the database.
https://github.com/milantex/mysql-tso

Last synced: 13 days ago
JSON representation

Creates a PHP object which describes the MySQL table structure for a specified table in the database.

• Host: GitHub
• URL: https://github.com/milantex/mysql-tso
• Owner: Milantex
• Created: 2017-04-24T07:48:03.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2017-04-29T09:34:53.000Z (over 7 years ago)
• Last Synced: 2024-04-20T08:03:30.073Z (9 months ago)
• Language: PHP
• Size: 17.6 KB
• Stars: 0
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
[![Build Status](https://travis-ci.org/Milantex/mysql-tso.svg?branch=master)](https://travis-ci.org/Milantex/mysql-tso)

[![codecov](https://codecov.io/gh/Milantex/mysql-tso/branch/master/graph/badge.svg)](https://codecov.io/gh/Milantex/mysql-tso)

[![Code Climate](https://codeclimate.com/github/Milantex/mysql-tso/badges/gpa.svg)](https://codeclimate.com/github/Milantex/mysql-tso)

[![Latest Stable Version](https://poser.pugx.org/milantex/mysql-tso/v/stable)](https://packagist.org/packages/milantex/mysql-tso)

[![Total Downloads](https://poser.pugx.org/milantex/mysql-tso/downloads)](https://packagist.org/packages/milantex/mysql-tso)

[![License](https://poser.pugx.org/milantex/mysql-tso/license)](https://packagist.org/packages/milantex/mysql-tso)

[![SensioLabsInsight](https://insight.sensiolabs.com/projects/f76e17d9-8cfa-4fd5-ab00-5ea53cd4faf5/mini.png)](https://insight.sensiolabs.com/projects/f76e17d9-8cfa-4fd5-ab00-5ea53cd4faf5)

# What is MySQL-TSO?

This package provides a mechanism that analyzes the structure of tables in a MySQL/MariaDB database. It might be better to see an example of how to use it instead of reading a lengthy description.

## Installation

#### Using composer in the command line

You can use composer to install the package using the following command from within your project's source directory:

`composer require milantex/mysql-tso`

Make sure to update your autoloader if needed:

`composer dump-autoload -o`

#### Requiring the package as a dependency in composer.json

Add the following code to your composer.json. Here is an example of a composer.json file with the milantex/mysql-tso package required:

```javascript

{

    "name": "your-name/your-project",

    "description": "Your project's description",

    "type": "project",

    "license": "MIT",

    "authors": [

        {

            "name": "Your Name",

            "email": "[email protected]"

        }

    ],

    "require": {

        "milantex/mysql-tso": "*"

    }

}

```

Make sure to run the composer command to install dependencies:

`composer install`

## Using the library in your project

```php

    require_once '../vendor/autoload.php';

    use Milantex\DAW\DataBase;

    use Milantex\TSO\TableStructureDescriptor;

    # Enter database parameters

    $daw = new DataBase('localhost', 'demo', 'root', '');

    # Instantiate a table structure descriptor object

    $tso = new TableStructureDescriptor($daw);

    # Start the database analysis

    $tso->analyse();

    if ($tso->tableExists('page') &&

        $tso->getTableStructure('page')->fieldExists('title')) {

        echo 'Can page.title be null? ';

        if ($tso->getTableStructure('page')

                ->getFieldStructure('title')

                ->isNullable()) {

            echo 'Yes';

        } else {

            echo 'No';

        }

    }

```