Aplus Framework Docs

TableStatement extends Statement
in package

AbstractYes

Class TableStatement.

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

Table of Contents

Constants

OPT_AUTO_INCREMENT  : string = 'AUTO_INCREMENT'
OPT_AVG_ROW_LENGTH  : string = 'AVG_ROW_LENGTH'
OPT_CHARSET  : string = 'CHARSET'
OPT_CHECKSUM  : string = 'CHECKSUM'
OPT_COLLATE  : string = 'COLLATE'
OPT_COMMENT  : string = 'COMMENT'
OPT_CONNECTION  : string = 'CONNECTION'
OPT_DATA_DIRECTORY  : string = 'DATA DIRECTORY'
OPT_DELAY_KEY_WRITE  : string = 'DELAY_KEY_WRITE'
OPT_ENCRYPTED  : string = 'ENCRYPTED'
OPT_ENCRYPTION_KEY_ID  : string = 'ENCRYPTION_KEY_ID'
OPT_ENGINE  : string = 'ENGINE'
OPT_IETF_QUOTES  : string = 'IETF_QUOTES'
OPT_INDEX_DIRECTORY  : string = 'INDEX DIRECTORY'
OPT_INSERT_METHOD  : string = 'INSERT_METHOD'
OPT_KEY_BLOCK_SIZE  : string = 'KEY_BLOCK_SIZE'
OPT_MAX_ROWS  : string = 'MAX_ROWS'
OPT_MIN_ROWS  : string = 'MIN_ROWS'
OPT_PACK_KEYS  : string = 'PACK_KEYS'
OPT_PAGE_CHECKSUM  : string = 'PAGE_CHECKSUM'
OPT_PAGE_COMPRESSED  : string = 'PAGE_COMPRESSED'
OPT_PAGE_COMPRESSION_LEVEL  : string = 'PAGE_COMPRESSION_LEVEL'
OPT_PASSWORD  : string = 'PASSWORD'
OPT_ROW_FORMAT  : string = 'ROW_FORMAT'
OPT_SEQUENCE  : string = 'SEQUENCE'
OPT_STATS_AUTO_RECALC  : string = 'STATS_AUTO_RECALC'
OPT_STATS_PERSISTENT  : string = 'STATS_PERSISTENT'
OPT_STATS_SAMPLE_PAGES  : string = 'STATS_SAMPLE_PAGES'
OPT_TABLESPACE  : string = 'TABLESPACE'
OPT_TRANSACTIONAL  : string = 'TRANSACTIONAL'
OPT_UNION  : string = 'UNION'
OPT_WITH_SYSTEM_VERSIONING  : string = 'WITH SYSTEM VERSIONING'

Properties

$database  : Database
$sql  : array<string, mixed>
SQL clauses and parts.

Methods

__construct()  : mixed
Statement constructor.
__toString()  : string
option()  : static
Adds a table option.
options()  : static
Adds table options.
reset()  : static
Resets SQL clauses and parts.
run()  : mixed
Runs the SQL statement.
sql()  : string
Renders the SQL statement.
renderOptions()  : string|null

Constants

Properties

$sql

SQL clauses and parts.

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

Methods

__toString()

public __toString() : string
Return values
string

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

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 SQL statement.

public abstract run() : mixed

sql()

Renders the SQL statement.

public abstract sql() : string
Return values
string

renderOptions()

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

        
On this page

Search results