Jelix 1.6.40

jDbTable
in package

Table of Contents

$columns  : array<string|int, jDbColumn>
$indexes  : array<string|int, jDbIndex>
$name  : string
$primaryKey  : jDbPrimaryKey
$references  : array<string|int, jDbReference>
$schema  : jDbSchema
$uniqueKeys  : array<string|int, jDbUniqueKey>
__construct()  : mixed
addColumn()  : mixed
addIndex()  : mixed
addReference()  : mixed
addUniqueKey()  : mixed
alterColumn()  : mixed
alterIndex()  : mixed
alterReference()  : mixed
alterUniqueKey()  : mixed
dropColumn()  : mixed
dropIndex()  : mixed
dropPrimaryKey()  : mixed
dropReference()  : mixed
dropUniqueKey()  : mixed
getColumn()  : jDbColumn|null
getColumns()  : array<string|int, jDbColumn>
getIndex()  : jDbIndex|null
getIndexes()  : array<string|int, jDbIndex>
getName()  : mixed
getPrimaryKey()  : jDbPrimaryKey|false
getReference()  : jDbReference|null
getReferences()  : array<string|int, jDbReference>
getUniqueKey()  : jDbUniqueKey|null
getUniqueKeys()  : array<string|int, jDbUniqueKey>
setPrimaryKey()  : mixed
_addColumn()  : mixed
_alterColumn()  : mixed
_createConstraint()  : mixed
_createIndex()  : mixed
_dropColumn()  : mixed
_dropConstraint()  : mixed
_dropIndex()  : mixed
_loadColumns()  : mixed
_loadIndexesAndKeys()  : mixed
_loadReferences()  : mixed
_loadTableDefinition()  : mixed
_replaceConstraint()  : mixed

Properties

$indexes

protected array<string|int, jDbIndex> $indexes = ull

list of indexes. null means "indexes are not loaded"

$primaryKey

protected jDbPrimaryKey $primaryKey = ull

the primary key. null means "primary key is not loaded". false means : no primary key

$references

protected array<string|int, jDbReference> $references = ull

list of references. null means "references are not loaded"

$uniqueKeys

protected array<string|int, jDbUniqueKey> $uniqueKeys = ull

list unique keys. null means "unique key are not loaded"

Methods

__construct()

public __construct(string $name, jDbSchema $schema) : mixed
Parameters
$name : string

the table name

$schema : jDbSchema
Return values
mixed

alterColumn()

public alterColumn(jDbColumn $column[, mixed $oldName = '' ]) : mixed
Parameters
$column : jDbColumn
$oldName : mixed = ''
Return values
mixed

dropColumn()

public dropColumn(mixed $name) : mixed
Parameters
$name : mixed
Return values
mixed

dropIndex()

public dropIndex(mixed $indexName) : mixed
Parameters
$indexName : mixed
Return values
mixed

dropPrimaryKey()

public dropPrimaryKey() : mixed
Return values
mixed

dropReference()

public dropReference(mixed $refName) : mixed
Parameters
$refName : mixed
Return values
mixed

dropUniqueKey()

public dropUniqueKey(mixed $indexName) : mixed
Parameters
$indexName : mixed
Return values
mixed

getColumn()

public getColumn(string $name[, bool $forChange = false ]) : jDbColumn|null
Parameters
$name : string
$forChange : bool = false
Return values
jDbColumn|null

_loadColumns()

protected abstract _loadColumns() : mixed
Return values
mixed

_loadIndexesAndKeys()

protected abstract _loadIndexesAndKeys() : mixed
Return values
mixed

_loadReferences()

protected abstract _loadReferences() : mixed
Return values
mixed

_loadTableDefinition()

protected _loadTableDefinition() : mixed
Return values
mixed

Search results