TableStatement
extends Statement
in package
Class TableStatement.
Tags
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
- 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
- getValue() : string
- invalidValue() : InvalidArgumentException
- makeAutoIncrement() : string
- makeAvgRowLength() : string
- makeCharset() : string
- makeChecksum() : string
- makeCollate() : string
- makeComment() : string
- makeConnection() : string
- makeDataDirectory() : string
- makeDelayKeyWrite() : string
- makeEncrypted() : string
- makeEncryptionKeyId() : string
- makeEngine() : string
- makeIetfQuotes() : string
- makeIndexDirectory() : string
- makeInsertMethod() : string
- makeKeyBlockSize() : string
- makeMaxRows() : string
- makeMinRows() : string
- makePackKeys() : string
- makePageChecksum() : string
- makePageCompressed() : string
- makePageCompressionLevel() : string
- makePassword() : string
- makeRowFormat() : string
- makeSequence() : string
- makeStatsAutoRecalc() : string
- makeStatsPersistent() : string
- makeStatsSamplePages() : string
- makeTablespace() : string
- makeTransactional() : string
- makeUnion() : string
- quote() : string
Constants
OPT_AUTO_INCREMENT
public
string
OPT_AUTO_INCREMENT
= 'AUTO_INCREMENT'
Tags
OPT_AVG_ROW_LENGTH
public
string
OPT_AVG_ROW_LENGTH
= 'AVG_ROW_LENGTH'
Tags
OPT_CHARSET
public
string
OPT_CHARSET
= 'CHARSET'
Tags
OPT_CHECKSUM
public
string
OPT_CHECKSUM
= 'CHECKSUM'
Tags
OPT_COLLATE
public
string
OPT_COLLATE
= 'COLLATE'
Tags
OPT_COMMENT
public
string
OPT_COMMENT
= 'COMMENT'
Tags
OPT_CONNECTION
public
string
OPT_CONNECTION
= 'CONNECTION'
Tags
OPT_DATA_DIRECTORY
public
string
OPT_DATA_DIRECTORY
= 'DATA DIRECTORY'
Tags
OPT_DELAY_KEY_WRITE
public
string
OPT_DELAY_KEY_WRITE
= 'DELAY_KEY_WRITE'
Tags
OPT_ENCRYPTED
public
string
OPT_ENCRYPTED
= 'ENCRYPTED'
Tags
OPT_ENCRYPTION_KEY_ID
public
string
OPT_ENCRYPTION_KEY_ID
= 'ENCRYPTION_KEY_ID'
Tags
OPT_ENGINE
public
string
OPT_ENGINE
= 'ENGINE'
Tags
OPT_IETF_QUOTES
public
string
OPT_IETF_QUOTES
= 'IETF_QUOTES'
Tags
OPT_INDEX_DIRECTORY
public
string
OPT_INDEX_DIRECTORY
= 'INDEX DIRECTORY'
Tags
OPT_INSERT_METHOD
public
string
OPT_INSERT_METHOD
= 'INSERT_METHOD'
Tags
OPT_KEY_BLOCK_SIZE
public
string
OPT_KEY_BLOCK_SIZE
= 'KEY_BLOCK_SIZE'
Tags
OPT_MAX_ROWS
public
string
OPT_MAX_ROWS
= 'MAX_ROWS'
Tags
OPT_MIN_ROWS
public
string
OPT_MIN_ROWS
= 'MIN_ROWS'
Tags
OPT_PACK_KEYS
public
string
OPT_PACK_KEYS
= 'PACK_KEYS'
Tags
OPT_PAGE_CHECKSUM
public
string
OPT_PAGE_CHECKSUM
= 'PAGE_CHECKSUM'
Tags
OPT_PAGE_COMPRESSED
public
string
OPT_PAGE_COMPRESSED
= 'PAGE_COMPRESSED'
Tags
OPT_PAGE_COMPRESSION_LEVEL
public
string
OPT_PAGE_COMPRESSION_LEVEL
= 'PAGE_COMPRESSION_LEVEL'
Tags
OPT_PASSWORD
public
string
OPT_PASSWORD
= 'PASSWORD'
Tags
OPT_ROW_FORMAT
public
string
OPT_ROW_FORMAT
= 'ROW_FORMAT'
Tags
OPT_SEQUENCE
public
string
OPT_SEQUENCE
= 'SEQUENCE'
Tags
OPT_STATS_AUTO_RECALC
public
string
OPT_STATS_AUTO_RECALC
= 'STATS_AUTO_RECALC'
Tags
OPT_STATS_PERSISTENT
public
string
OPT_STATS_PERSISTENT
= 'STATS_PERSISTENT'
Tags
OPT_STATS_SAMPLE_PAGES
public
string
OPT_STATS_SAMPLE_PAGES
= 'STATS_SAMPLE_PAGES'
Tags
OPT_TABLESPACE
public
string
OPT_TABLESPACE
= 'TABLESPACE'
Tags
OPT_TRANSACTIONAL
public
string
OPT_TRANSACTIONAL
= 'TRANSACTIONAL'
Tags
OPT_UNION
public
string
OPT_UNION
= 'UNION'
Tags
OPT_WITH_SYSTEM_VERSIONING
public
string
OPT_WITH_SYSTEM_VERSIONING
= 'WITH SYSTEM VERSIONING'
Tags
Properties
$database
protected
Database
$database
$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 —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
Return values
static —run()
Runs the SQL statement.
public
abstract run() : mixed
Return values
mixed —sql()
Renders the SQL statement.
public
abstract sql() : string
Return values
string —renderOptions()
protected
renderOptions() : string|null
Return values
string|null —getValue()
private
getValue(string $optionName, string $originalValue, array<string|int, string> $options[, string|null $value = null ][, bool $getByKey = false ]) : string
Parameters
- $optionName : string
- $originalValue : string
- $options : array<string|int, string>
- $value : string|null = null
- $getByKey : bool = false
Return values
string —invalidValue()
private
invalidValue(string $option, string $value) : InvalidArgumentException
Parameters
- $option : string
- $value : string
Return values
InvalidArgumentException —makeAutoIncrement()
private
makeAutoIncrement(string $value) : string
Parameters
- $value : string
Return values
string —makeAvgRowLength()
private
makeAvgRowLength(string $value) : string
Parameters
- $value : string
Return values
string —makeCharset()
private
makeCharset(string $value) : string
Parameters
- $value : string
Return values
string —makeChecksum()
private
makeChecksum(string $value) : string
Parameters
- $value : string
Return values
string —makeCollate()
private
makeCollate(string $value) : string
Parameters
- $value : string
Return values
string —makeComment()
private
makeComment(string $value) : string
Parameters
- $value : string
Return values
string —makeConnection()
private
makeConnection(string $value) : string
Parameters
- $value : string
Return values
string —makeDataDirectory()
private
makeDataDirectory(string $value) : string
Parameters
- $value : string
Return values
string —makeDelayKeyWrite()
private
makeDelayKeyWrite(string $value) : string
Parameters
- $value : string
Return values
string —makeEncrypted()
private
makeEncrypted(string $value) : string
Parameters
- $value : string
Return values
string —makeEncryptionKeyId()
private
makeEncryptionKeyId(string $value) : string
Parameters
- $value : string
Return values
string —makeEngine()
private
makeEngine(string $value) : string
Parameters
- $value : string
Return values
string —makeIetfQuotes()
private
makeIetfQuotes(string $value) : string
Parameters
- $value : string
Return values
string —makeIndexDirectory()
private
makeIndexDirectory(string $value) : string
Parameters
- $value : string
Return values
string —makeInsertMethod()
private
makeInsertMethod(string $value) : string
Parameters
- $value : string
Return values
string —makeKeyBlockSize()
private
makeKeyBlockSize(string $value) : string
Parameters
- $value : string
Return values
string —makeMaxRows()
private
makeMaxRows(string $value) : string
Parameters
- $value : string
Return values
string —makeMinRows()
private
makeMinRows(string $value) : string
Parameters
- $value : string
Return values
string —makePackKeys()
private
makePackKeys(string $value) : string
Parameters
- $value : string
Return values
string —makePageChecksum()
private
makePageChecksum(string $value) : string
Parameters
- $value : string
Return values
string —makePageCompressed()
private
makePageCompressed(string $value) : string
Parameters
- $value : string
Return values
string —makePageCompressionLevel()
private
makePageCompressionLevel(string $value) : string
Parameters
- $value : string
Return values
string —makePassword()
private
makePassword(string $value) : string
Parameters
- $value : string
Return values
string —makeRowFormat()
private
makeRowFormat(string $value) : string
Parameters
- $value : string
Return values
string —makeSequence()
private
makeSequence(string $value) : string
Parameters
- $value : string
Return values
string —makeStatsAutoRecalc()
private
makeStatsAutoRecalc(string $value) : string
Parameters
- $value : string
Return values
string —makeStatsPersistent()
private
makeStatsPersistent(string $value) : string
Parameters
- $value : string
Return values
string —makeStatsSamplePages()
private
makeStatsSamplePages(string $value) : string
Parameters
- $value : string
Return values
string —makeTablespace()
private
makeTablespace(string $value) : string
Parameters
- $value : string
Return values
string —makeTransactional()
private
makeTransactional(string $value) : string
Parameters
- $value : string
Return values
string —makeUnion()
private
makeUnion(string $value) : string
Parameters
- $value : string
Return values
string —quote()
private
quote(string $value) : string
Parameters
- $value : string