README

An database upgrader for upgrade mysql table structures automatically

Version: 0.0.1 alpha License: LGPL 3.0

Currently upgrade isnt fully integrated, but table creation should be work. Work in Progress!

Requirements

• PHP 7.0.8+
• MySQL 5.7+

Configuration

If you want to use the build-in MySQLDriver, you have to copy config/mysql.examplecfg.php to mysql.cfg.php and change values.

Supported Data Types

• INT
• VARCHAR
• TEXT
• CHAR
• TINYTEXT
• MEDIUMTEXT
• LONGTEXT (4294967295 characters)
• BIT
• BINARY
• TINYINT
• SMALLINT
• MEDIUMINT
• BIGINT
• DECIMAL
• NUMERIC
• DOUBLE
• FLOAT
• REAL
• BLOB
• TINYBLOB
• MEDIUMBLOB
• LONGBLOB
• ENUM
• SET
• DATE
• TIME
• YEAR
• TIMESTAMP
• DATETIME
• JSON

Supported Keys and Indexes

• PRIMARY KEY

• INDEX

• UNIQUE

• SPATIAL

• FULLTEXT

• FOREIGN KEY

• more are Work in Progress

Example

Generate CREATE TABLE query:

//create or upgrade test table
$table = new DBTable("test", $dbDriver);
$table->setEngine("InnoDB");
$table->setCharset("utf8");

//add int coloum
$table->addInt("id");

//add int coloum with length 10, NOT NULL and AUTO_INCREMENT
$table->addInt("testint", 10, true, true);

//add varchar column
$table->addVarchar("test_text", 255, true, "default value");

//add text column
$table->addText("text");

//print CREATE statement for debugging
echo $table->generateCreateQuery();

prints following query:

CREATE TABLE `{DBPRAEFIX}test` IF NOT EXISTS (
`id` INT,
`testint` INT(10) NOT NULL AUTO_INCREMENT,
`test_text` VARCHAR(255) NOT NULL DEFAULT 'default value',
`text` TEXT
) TYPE=InnoDB DEFAULT CHARSET=utf8;

How to add an PRIMARY KEY

PRIMARY with only 1 column:

//add primary key
$table->addPrimaryKey("column_name");

PRIMARY KEY with more than 1 column:

//add primary key
$table->addPrimaryKey(array("id", "testint"));

Because PRIMARY KEYS are limited to specific length, you can also specifiy length of columns used in PRIMARY KEY:

//add primary key
$table->addPrimaryKey(array("id", "testint", array('column' => "test_text", 'length' => 50)));