CreateStatement

MMO\pdo\statements · 1 symbol · generated 5 Oct 2026

class

CreateStatement

Ex1: $stmt = new CreateStatement($handler); $stmt->ifNotExists(); $stmt->temporary(); $stmt->table('test'); $stmt->fields(['id' => 'INT(3) UNSIGNED NOT NULL PRIMARY KEY', 'name' => 'VARCHAR(255) NOT NULL KEY']); $stmt->primary('id'); $stmt->index('name'); echo $stmt;

class MMO\pdo\statements\CreateStatement extends MMO\pdo\statements\Statement

Namespace: MMO\pdo\statements
Extends: Statement

Index

	clear()
	execute()	Same as `Statement::execute`, plus the statements of `indexStatements` once the table exists.
	fields($fields)
	foreign($key, $ref)	Add a table-level `FOREIGN KEY (…) REFERENCES …` constraint -- the form a composite key, or one carrying `ON UPDATE`/`ON DELETE`, needs.
	fulltext($ids)
	ifNotExists($value)
	index($ids)
	indexStatements($opts)	The statements creating this table's indexes apart from the CREATE TABLE: SQLite takes no `INDEX(…)` inside one (`near "INDEX": syntax error`), so each indexed column gets its own `CREATE INDEX IF …
	isSqlite($opts)
	options($opts)
	primary($ids)
	render($opts)	Same as `Statement::render`.
	table($name)
	temporary($value)
	unique($ids)
	__construct($handler, $table, $fields, $primary, $index)

Methods16

clear()

CreateStatement.php:51

function clear(): self

returns

self

execute()

CreateStatement.php:85

Same as Statement::execute, plus the statements of indexStatements once the table exists.

function execute(): PDOStatement

returns

PDOStatement

the CREATE TABLE's

fields($fields)

CreateStatement.php:126

function fields(array|string $fields): self

$fields	array \| string
returns	self

foreign($key, $ref)

CreateStatement.php:172

Add a table-level FOREIGN KEY (…) REFERENCES … constraint -- the form a composite key, or one carrying ON UPDATE/ON DELETE, needs. A single-column reference can also be written inline in the column's own definition (Field).

function foreign(array|string $key, string $ref): self

$key	array \| string	the referencing column(s)
$ref	string	the referenced table and column(s), plus any trailing clause
returns	self

$stmt->foreign(['author', 'date'], 'author(id, regDate) ON UPDATE CASCADE ON DELETE RESTRICT');

fulltext($ids)

CreateStatement.php:154

function fulltext(string ...$ids): self

...$ids	string
returns	self

ifNotExists($value)

CreateStatement.php:193

function ifNotExists(bool $value = true): self

$value = true	bool
returns	self

index($ids)

CreateStatement.php:138

function index(string ...$ids): self

...$ids	string
returns	self

indexStatements($opts)

CreateStatement.php:99

The statements creating this table's indexes apart from the CREATE TABLE: SQLite takes no INDEX(…) inside one (near "INDEX": syntax error), so each indexed column gets its own CREATE INDEX IF NOT EXISTS <table>_<column>. Empty for MySQL, which declares them inline.

function indexStatements(array $opts = []): array

$opts = []	array
returns	array

$table->createStatement()->indexStatements(); // [CREATE INDEX IF NOT EXISTS `t_day` ON `t`(`day`)]

isSqlite($opts)

CreateStatement.php:114

protected function isSqlite(array $opts = []): bool

$opts = []	array
returns	bool

options($opts)

CreateStatement.php:180

function options(array $opts): self

$opts	array
returns	self

primary($ids)

CreateStatement.php:130

function primary(string ...$ids): self

...$ids	string
returns	self

render($opts)

CreateStatement.php:67

Same as Statement::render. For SQLite, a table's one primary column, when it is AUTO_INCREMENT, is declared inline -- id INTEGER PRIMARY KEY AUTOINCREMENT -- without a PRIMARY KEY(id): SQLite takes the keyword nowhere else, and without it the id is the rowid, which gives the id of the highest row deleted to the next one.

function render(array $opts = []): string

NOTE: until 2026-09 it was `id INTEGER, …, PRIMARY KEY(id)`. A table created then still gives ids again: SQLite cannot add AUTOINCREMENT to a table (create another, copy the rows over).

$opts = []	array
returns	string

$table->createStatement()->render(['driver' => 'sqlite']); // CREATE TABLE `user` ( id INTEGER PRIMARY KEY AUTOINCREMENT, …)

table($name)

CreateStatement.php:121

function table(string $name): self

$name	string
returns	self

temporary($value)

CreateStatement.php:189

function temporary(bool $value = true): self

$value = true	bool
returns	self

unique($ids)

CreateStatement.php:146

function unique(string ...$ids): self

...$ids	string
returns	self

__construct($handler, $table, $fields, $primary, $index)

CreateStatement.php:37

$handler	iHandler
$table = ''	string
$fields = null	array \| string \| null
$primary = null	array \| string \| null
$index = null	array \| string \| null

Inherited members (50)

	Constants	Declared by	Description
	`ALL_FLAG`	Statement
	`CREATE_IF_NOT_EXISTS_FLAG`	Statement
	`CREATE_TEMPORARY_FLAG`	Statement
	`DELAYED_FLAG`	Statement
	`DISTINCT_FLAG`	Statement
	`DISTINCT_ROW_FLAG`	Statement
	`HIGH_PRIORITY_FLAG`	Statement
	`IF_EXISTS_FLAG`	Statement
	`IGNORE_FLAG`	Statement
	`LOW_PRIORITY_FLAG`	Statement
	`QUICK_FLAG`	Statement
	`STRAIGHT_JOIN_FLAG`	Statement

	Properties	Declared by	Description
	`content`	Statement
	`handler`	Statement
	`opts`	Statement
	`stmt`	Statement
	`template`	Statement

Methods	Declared by	Description
`addOptions($opts, $appendList)`	Statement	Merge $opts into the existing options (through `merge`), rather than replacing them wholesale like `setOptions`.
`bindValue($pdo, $index, $value, $type, $binds)`	Statement	Bind one already-emitted value onto the PDO statement.
`clearOptions()`	Statement	Empty the options bag.
`count()`	Statement	\Countable::count
`fetch($opt)`	Statement	Fetch the first row of the query's result
`fetchAll($clear)`	Statement	Fetch all the result of a query
`fetchAllObjects($class, $constructFirst, $args, $clear)`	Statement	Fetch all the result of a query as Objects.
`fetchObject($class, $constructFirst, $args)`	Statement	Fetch the result of a query as an Object.
`fetchValue($key)`	Statement	Fetch the column's value of the first row of the query's result and advance fetch pointer
`fetchValues($key)`	Statement	Fetch the column's value of all the row of the query's result
`flag($key, $flag, $set)`	Statement
`getIterator()`	Statement	\IteratorAggregate::getIterator
`getOption($key, $default)`	Statement
`getOptions()`	Statement
`getPDOStatement()`	Statement
`getPlaceholders()`	Statement	Extract placeholder from template
`isEmpty()`	Statement
`jsonSerialize()`	Statement	\JsonSerializable::jsonSerialize -- the raw content is returned as-is (not recursively converted), so json_encode() relies on any nested iArray values being JsonSerializable themselves.
`keys()`	Statement
`loadArray($data)`	Statement	Load every entry of a plain array into the content, through `offsetSet` (so any offsetSet() override defined by the class using this trait, e.g.
`offsetExists($key)`	Statement	\ArrayAccess::offsetExists
`offsetGet($key)`	Statement	\ArrayAccess::offsetGet
`offsetSet($key, $value)`	Statement	\ArrayAccess::offsetSet -- a null $key appends (`$bag[] = $value`), like a plain PHP array.
`offsetUnset($key)`	Statement	\ArrayAccess::offsetUnset -- on a list (sequential integer keys, as produced by `$bag[] = ...`), the element is spliced out (closing the gap and reindexing), matching \unset() semantics on a plain …
`prepare($binds, $sql)`	Statement	Prepare a PDO statement by binding values.
`push($key, $fields)`	Statement
`reset()`	Statement
`rowCount()`	Statement
`setOption($key, $value)`	Statement	Set (or, with a null $value, remove) a single option.
`setOptions($opts)`	Statement	Replace the whole options bag.
`SplitType($key)`	Statement	Split a `column:type` key used by the INSERT/UPDATE value lists.
`toArray()`	Statement	Convert the content to a plain array, recursively converting any nested `iArray` value (e.g.
`__toString()`	Statement