Aplus Framework Docs

AlterTable extends TableStatement
in package

Class AlterTable.

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

Table of Contents

Constants

ALGO_COPY  : string = 'COPY'
ALGO_DEFAULT  : string = 'DEFAULT'
ALGO_INPLACE  : string = 'INPLACE'
ALGO_INSTANT  : string = 'INSTANT'
ALGO_NOCOPY  : string = 'NOCOPY'
LOCK_DEFAULT  : string = 'DEFAULT'
LOCK_EXCLUSIVE  : string = 'EXCLUSIVE'
LOCK_NONE  : string = 'NONE'
LOCK_SHARED  : string = 'SHARED'
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
add()  : static
addIfNotExists()  : static
algorithm()  : static
change()  : static
changeIfExists()  : static
charset()  : static
collate()  : static
convertToCharset()  : static
disableKeys()  : static
dropColumn()  : static
dropColumnIfExists()  : static
dropConstraint()  : static
dropConstraintIfExists()  : static
dropForeignKey()  : static
dropForeignKeyIfExists()  : static
dropKey()  : static
dropKeyIfExists()  : static
dropPrimaryKey()  : static
enableKeys()  : static
force()  : static
ifExists()  : static
ignore()  : static
lock()  : static
modify()  : static
modifyIfExists()  : static
noWait()  : static
online()  : static
option()  : static
Adds a table option.
options()  : static
Adds table options.
orderBy()  : static
renameColumn()  : static
renameKey()  : static
renameTo()  : static
reset()  : static
Resets SQL clauses and parts.
run()  : int|string
Runs the ALTER TABLE statement.
sql()  : string
Renders the SQL statement.
table()  : static
wait()  : static
joinParts()  : string
renderAdd()  : string|null
renderAlgorithm()  : string|null
renderChange()  : string|null
renderCharset()  : string|null
renderCollate()  : string|null
renderConvertToCharset()  : string|null
renderDisableKeys()  : string|null
renderDropColumns()  : string|null
renderDropConstraints()  : string|null
renderDropForeignKeys()  : string|null
renderDropKeys()  : string|null
renderDropPrimaryKey()  : string|null
renderEnableKeys()  : string|null
renderForce()  : string|null
renderIfExists()  : string|null
renderIgnore()  : string|null
renderLock()  : string|null
renderModify()  : string|null
renderNoWait()  : string|null
renderOnline()  : string|null
renderOptions()  : string|null
renderOrderBy()  : string|null
renderRenameColumns()  : string|null
renderRenameKeys()  : string|null
renderRenameTo()  : string|null
renderTable()  : string
renderWait()  : string|null

Constants

ALGO_DEFAULT

public string ALGO_DEFAULT = 'DEFAULT'

ALGO_INPLACE

public string ALGO_INPLACE = 'INPLACE'

ALGO_INSTANT

public string ALGO_INSTANT = 'INSTANT'

ALGO_NOCOPY

public string ALGO_NOCOPY = 'NOCOPY'

LOCK_DEFAULT

public string LOCK_DEFAULT = 'DEFAULT'

LOCK_EXCLUSIVE

public string LOCK_EXCLUSIVE = 'EXCLUSIVE'

LOCK_SHARED

public string LOCK_SHARED = 'SHARED'

Properties

$sql

SQL clauses and parts.

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

Methods

__toString()

public __toString() : string
Return values
string

add()

public add(callable $definition[, bool $ifNotExists = false ]) : static
Parameters
$definition : callable
$ifNotExists : bool = false
Return values
static

addIfNotExists()

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

change()

public change(callable $definition[, bool $ifExists = false ]) : static
Parameters
$definition : callable
$ifExists : bool = false
Return values
static

changeIfExists()

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

charset()

public charset(string|null $charset) : static
Parameters
$charset : string|null
Return values
static

collate()

public collate(string|null $collation) : static
Parameters
$collation : string|null
Return values
static

convertToCharset()

public convertToCharset(string $charset[, string|null $collation = null ]) : static
Parameters
$charset : string
$collation : string|null = null
Return values
static

disableKeys()

public disableKeys() : static
Return values
static

dropColumn()

public dropColumn(string $name[, bool $ifExists = false ]) : static
Parameters
$name : string
$ifExists : bool = false
Return values
static

dropColumnIfExists()

public dropColumnIfExists(string $name) : static
Parameters
$name : string
Return values
static

dropConstraint()

public dropConstraint(string $name[, bool $ifExists = false ]) : static
Parameters
$name : string
$ifExists : bool = false
Return values
static

dropConstraintIfExists()

public dropConstraintIfExists(string $name) : static
Parameters
$name : string
Return values
static

dropForeignKey()

public dropForeignKey(string $name[, bool $ifExists = false ]) : static
Parameters
$name : string
$ifExists : bool = false
Return values
static

dropForeignKeyIfExists()

public dropForeignKeyIfExists(string $name) : static
Parameters
$name : string
Return values
static

dropKey()

public dropKey(string $name[, bool $ifExists = false ]) : static
Parameters
$name : string
$ifExists : bool = false
Return values
static

dropKeyIfExists()

public dropKeyIfExists(string $name) : static
Parameters
$name : string
Return values
static

dropPrimaryKey()

public dropPrimaryKey() : static
Return values
static

enableKeys()

public enableKeys() : static
Return values
static

force()

public force() : static
Return values
static

ifExists()

public ifExists() : static
Return values
static

ignore()

public ignore() : static
Return values
static

modify()

public modify(callable $definition[, bool $ifExists = false ]) : static
Parameters
$definition : callable
$ifExists : bool = false
Return values
static

modifyIfExists()

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

noWait()

public noWait() : static
Return values
static

online()

public online() : 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

orderBy()

public orderBy(string $column, string ...$columns) : static
Parameters
$column : string
$columns : string
Return values
static

renameColumn()

public renameColumn(string $name, string $newName) : static
Parameters
$name : string
$newName : string
Return values
static

renameKey()

public renameKey(string $name, string $newName) : static
Parameters
$name : string
$newName : string
Return values
static

renameTo()

public renameTo(string $newTableName) : static
Parameters
$newTableName : 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 ALTER TABLE statement.

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

The number of affected rows

sql()

Renders the SQL statement.

public sql() : string
Return values
string

table()

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

wait()

public wait(int $seconds) : static
Parameters
$seconds : int
Return values
static

joinParts()

protected joinParts(array<string|int, string|null> $parts) : string
Parameters
$parts : array<string|int, string|null>
Return values
string

renderAdd()

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

renderAlgorithm()

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

renderChange()

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

renderCharset()

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

renderCollate()

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

renderConvertToCharset()

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

renderDisableKeys()

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

renderDropColumns()

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

renderDropConstraints()

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

renderDropForeignKeys()

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

renderDropKeys()

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

renderDropPrimaryKey()

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

renderEnableKeys()

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

renderForce()

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

renderIfExists()

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

renderIgnore()

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

renderLock()

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

renderModify()

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

renderNoWait()

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

renderOnline()

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

renderOptions()

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

renderOrderBy()

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

renderRenameColumns()

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

renderRenameKeys()

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

renderRenameTo()

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

renderTable()

protected renderTable() : string
Return values
string

renderWait()

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

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results