Aplus Framework Docs

CreateTable extends TableStatement
in package

Class CreateTable.

Tags
see
https://mariadb.com/kb/en/create-table/

Table of Contents

OPT_AUTO_INCREMENT  = 'AUTO_INCREMENT'
OPT_AVG_ROW_LENGTH  = 'AVG_ROW_LENGTH'
OPT_CHARSET  = 'CHARSET'
OPT_CHECKSUM  = 'CHECKSUM'
OPT_COLLATE  = 'COLLATE'
OPT_COMMENT  = 'COMMENT'
OPT_CONNECTION  = 'CONNECTION'
OPT_DATA_DIRECTORY  = 'DATA DIRECTORY'
OPT_DELAY_KEY_WRITE  = 'DELAY_KEY_WRITE'
OPT_ENCRYPTED  = 'ENCRYPTED'
OPT_ENCRYPTION_KEY_ID  = 'ENCRYPTION_KEY_ID'
OPT_ENGINE  = 'ENGINE'
OPT_IETF_QUOTES  = 'IETF_QUOTES'
OPT_INDEX_DIRECTORY  = 'INDEX DIRECTORY'
OPT_INSERT_METHOD  = 'INSERT_METHOD'
OPT_KEY_BLOCK_SIZE  = 'KEY_BLOCK_SIZE'
OPT_MAX_ROWS  = 'MAX_ROWS'
OPT_MIN_ROWS  = 'MIN_ROWS'
OPT_PACK_KEYS  = 'PACK_KEYS'
OPT_PAGE_CHECKSUM  = 'PAGE_CHECKSUM'
OPT_PAGE_COMPRESSED  = 'PAGE_COMPRESSED'
OPT_PAGE_COMPRESSION_LEVEL  = 'PAGE_COMPRESSION_LEVEL'
OPT_PASSWORD  = 'PASSWORD'
OPT_ROW_FORMAT  = 'ROW_FORMAT'
OPT_SEQUENCE  = 'SEQUENCE'
OPT_STATS_AUTO_RECALC  = 'STATS_AUTO_RECALC'
OPT_STATS_PERSISTENT  = 'STATS_PERSISTENT'
OPT_STATS_SAMPLE_PAGES  = 'STATS_SAMPLE_PAGES'
OPT_TABLESPACE  = 'TABLESPACE'
OPT_TRANSACTIONAL  = 'TRANSACTIONAL'
OPT_UNION  = 'UNION'
OPT_WITH_SYSTEM_VERSIONING  = 'WITH SYSTEM VERSIONING'
$database  : Database
$sql  : array<string|int, mixed>
SQL clauses and parts.
__construct()  : mixed
Statement constructor.
__toString()  : string
definition()  : static
ifNotExists()  : static
option()  : static
Adds a table option.
options()  : static
Adds table options.
orReplace()  : static
Adds a OR REPLACE part.
reset()  : static
Resets SQL clauses and parts.
run()  : int|string
Runs the CREATE TABLE statement.
sql()  : string
table()  : static
temporary()  : static
renderDefinition()  : string
renderIfNotExists()  : string|null
renderOptions()  : string|null
renderOrReplace()  : string|null
renderTable()  : string
renderTemporary()  : string|null

Constants

Properties

$sql

SQL clauses and parts.

protected array<string|int, mixed> $sql = []

Methods

__construct()

Statement constructor.

public __construct(Database $database) : mixed
Parameters
$database : Database
Return values
mixed —

__toString()

public __toString() : string
Return values
string —

definition()

public definition(callable $definition) : static
Parameters
$definition : callable
Return values
static —

ifNotExists()

public ifNotExists() : static
Return values
static —

option()

Adds a table option.

public option(string $name[, int|string|null $value = null ]) : static
Parameters
$name : string
$value : int|string|null = null
Return values
static —

options()

Adds table options.

public options(array<string, int|string> $options) : static
Parameters
$options : array<string, int|string>
Return values
static —

orReplace()

Adds a OR REPLACE part.

public orReplace() : static

WARNING: This feature is MariaDB only. It is not compatible with MySQL.

Return values
static —

reset()

Resets SQL clauses and parts.

public reset([string|null $sql = null ]) : static
Parameters
$sql : string|null = null

A part name or null to reset all

Tags
see
Statement::$sql
Return values
static —

run()

Runs the CREATE TABLE statement.

public run() : int|string
Return values
int|string —

The number of affected rows

sql()

public sql() : string
Return values
string —

table()

public table(string $tableName) : static
Parameters
$tableName : string
Return values
static —

temporary()

public temporary() : static
Return values
static —

renderDefinition()

protected renderDefinition() : string
Return values
string —

renderIfNotExists()

protected renderIfNotExists() : string|null
Return values
string|null —

renderOptions()

protected renderOptions() : string|null
Return values
string|null —

renderOrReplace()

protected renderOrReplace() : string|null
Return values
string|null —

renderTable()

protected renderTable() : string
Return values
string —

renderTemporary()

protected renderTemporary() : string|null
Return values
string|null —

Search results