0 follower

Interface Yiisoft\Db\Schema\TableSchemaInterface

All Classes | Methods

Implemented by	Yiisoft\Db\Schema\TableSchema

Represents the metadata of a database table.

It defines a set of methods to retrieve the table name, schema name, column names, primary key, foreign keys, etc.

The information is obtained from the database schema and may vary according to the DBMS type.

Public Methods

Hide inherited methods

Method	Description	Defined By
checks()	Set check constraints of this table.	Yiisoft\Db\Schema\TableSchemaInterface
column()	Set metadata for a column specified.	Yiisoft\Db\Schema\TableSchemaInterface
columns()	Set metadata for multiple columns.	Yiisoft\Db\Schema\TableSchemaInterface
comment()	Set the comment of the table or `null` if there is no comment.	Yiisoft\Db\Schema\TableSchemaInterface
createSql()	Set SQL for creating this table, empty string if it is not found, or `null` if it is not initialized.	Yiisoft\Db\Schema\TableSchemaInterface
defaultValues()	Set default value constraints of this table.	Yiisoft\Db\Schema\TableSchemaInterface
foreignKeys()	Set foreign key constraints of this table.	Yiisoft\Db\Schema\TableSchemaInterface
getChecks()		Yiisoft\Db\Schema\TableSchemaInterface
getColumn()	Returns the named column metadata or `null` if the named column does not exist.	Yiisoft\Db\Schema\TableSchemaInterface
getColumnNames()		Yiisoft\Db\Schema\TableSchemaInterface
getColumns()		Yiisoft\Db\Schema\TableSchemaInterface
getComment()	Returns the comment of the table or `null` if no comment.	Yiisoft\Db\Schema\TableSchemaInterface
getCreateSql()	Returns SQL for create this table, empty string if it is not found, or `null` if it is not initialized.	Yiisoft\Db\Schema\TableSchemaInterface
getDefaultValues()		Yiisoft\Db\Schema\TableSchemaInterface
getForeignKeys()		Yiisoft\Db\Schema\TableSchemaInterface
getFullName()	Returns the full name of this table including the schema name.	Yiisoft\Db\Schema\TableSchemaInterface
getIndexes()	Returns the index constraints of this table.	Yiisoft\Db\Schema\TableSchemaInterface
getName()	Returns the table name. The schema name is not included. Use getFullName() to get the table name with the schema name.	Yiisoft\Db\Schema\TableSchemaInterface
getOptions()	Returns the options of this table.	Yiisoft\Db\Schema\TableSchemaInterface
getPrimaryKey()		Yiisoft\Db\Schema\TableSchemaInterface
getSchemaName()	Returns the schema name that this table belongs to.	Yiisoft\Db\Schema\TableSchemaInterface
getSequenceName()	Return the sequence name for the primary key or `null` if no sequence.	Yiisoft\Db\Schema\TableSchemaInterface
getUniques()	Returns the unique indexes of this table.	Yiisoft\Db\Schema\TableSchemaInterface
indexes()	Set indexes of this table.	Yiisoft\Db\Schema\TableSchemaInterface
name()	Set the name of this table.	Yiisoft\Db\Schema\TableSchemaInterface
options()	Set the options of this table.	Yiisoft\Db\Schema\TableSchemaInterface
schemaName()	Set the name of the schema that this table belongs to or empty string for the default schema.	Yiisoft\Db\Schema\TableSchemaInterface
sequenceName()	Set a sequence name for the primary key or `null` if no sequence.	Yiisoft\Db\Schema\TableSchemaInterface

Method Details

Hide inherited methods

checks() public abstract method

Set check constraints of this table.

public abstract checks( Yiisoft\Db\Constraint\Check $checks ): Yiisoft\Db\Schema\TableSchemaInterface
$checks	Yiisoft\Db\Constraint\Check	The check constraints.

Source code

                public function checks(Check ...$checks): static;

column() public abstract method

Set metadata for a column specified.

public abstract column( string $name, Yiisoft\Db\Schema\Column\ColumnInterface $column ): Yiisoft\Db\Schema\TableSchemaInterface
$name	string	The column name.
$column	Yiisoft\Db\Schema\Column\ColumnInterface

Source code

                public function column(string $name, ColumnInterface $column): static;

columns() public abstract method

Set metadata for multiple columns.

public abstract columns( Yiisoft\Db\Schema\Column\ColumnInterface[] $columns ): Yiisoft\Db\Schema\TableSchemaInterface
$columns	Yiisoft\Db\Schema\Column\ColumnInterface[]	The columns metadata indexed by column names.

Source code

                public function columns(array $columns): static;

comment() public abstract method

Set the comment of the table or null if there is no comment.

Not all DBMS support this.

public abstract comment( string\|null $comment ): Yiisoft\Db\Schema\TableSchemaInterface
$comment	string\|null

Source code

                public function comment(?string $comment): static;

createSql() public abstract method

Set SQL for creating this table, empty string if it is not found, or null if it is not initialized.

Supported by MySQL and Oracle DBMS.

public abstract createSql( string\|null $sql ): Yiisoft\Db\Schema\TableSchemaInterface
$sql	string\|null

Source code

                public function createSql(?string $sql): static;

defaultValues() public abstract method

Set default value constraints of this table.

public abstract defaultValues( Yiisoft\Db\Constraint\DefaultValue $defaultValues ): Yiisoft\Db\Schema\TableSchemaInterface
$defaultValues	Yiisoft\Db\Constraint\DefaultValue	The default value constraints.

Source code

                public function defaultValues(DefaultValue ...$defaultValues): static;

foreignKeys() public abstract method

Set foreign key constraints of this table.

public abstract foreignKeys( Yiisoft\Db\Constraint\ForeignKey $foreignKeys ): Yiisoft\Db\Schema\TableSchemaInterface
$foreignKeys	Yiisoft\Db\Constraint\ForeignKey	The foreign key constraints.

Source code

                public function foreignKeys(ForeignKey ...$foreignKeys): static;

getChecks() public abstract method

public abstract getChecks( ): Yiisoft\Db\Constraint\Check[]
return	Yiisoft\Db\Constraint\Check[]	The check constraints of this table.

Source code

                public function getChecks(): array;

getColumn() public abstract method

Returns the named column metadata or null if the named column does not exist.

public abstract getColumn( string $name ): Yiisoft\Db\Schema\Column\ColumnInterface\|null
$name	string	The column name.

Source code

                public function getColumn(string $name): ?ColumnInterface;

getColumnNames() public abstract method

public abstract getColumnNames( ): string[]
return	string[]	The names of all columns in this table.

Source code

                public function getColumnNames(): array;

getColumns() public abstract method

public abstract getColumns( ): Yiisoft\Db\Schema\Column\ColumnInterface[]
return	Yiisoft\Db\Schema\Column\ColumnInterface[]	The column metadata of this table. Array of Yiisoft\Db\Schema\Column\ColumnInterface objects indexed by column names.

Source code

                public function getColumns(): array;

getComment() public abstract method

Returns the comment of the table or null if no comment.

public abstract getComment( ): string\|null

Source code

                public function getComment(): ?string;

getCreateSql() public abstract method

Returns SQL for create this table, empty string if it is not found, or null if it is not initialized.

Supported by MySQL and Oracle DBMS.

public abstract getCreateSql( ): string\|null

Source code

                public function getCreateSql(): ?string;

getDefaultValues() public abstract method

public abstract getDefaultValues( ): Yiisoft\Db\Constraint\DefaultValue[]
return	Yiisoft\Db\Constraint\DefaultValue[]	The default value constraints of this table.

Source code

                public function getDefaultValues(): array;

getForeignKeys() public abstract method

public abstract getForeignKeys( ): Yiisoft\Db\Constraint\ForeignKey[]
return	Yiisoft\Db\Constraint\ForeignKey[]	The foreign key constraints of this table.

Source code

                public function getForeignKeys(): array;

getFullName() public abstract method

Returns the full name of this table including the schema name.

public abstract getFullName( ): string

Source code

                public function getFullName(): string;

getIndexes() public abstract method

Returns the index constraints of this table.

public abstract getIndexes( ): Yiisoft\Db\Constraint\Index[]
return	Yiisoft\Db\Constraint\Index[]	The index constraints of this table.

Source code

                public function getIndexes(): array;

getName() public abstract method

Returns the table name. The schema name is not included. Use getFullName() to get the table name with the schema name.

public abstract getName( ): string

Source code

                public function getName(): string;

getOptions() public abstract method

Returns the options of this table.

public abstract getOptions( ): string[]
return	string[]	The options of this table.

Source code

                public function getOptions(): array;

getPrimaryKey() public abstract method

public abstract getPrimaryKey( ): string[]
return	string[]	The primary key column names.

Source code

                public function getPrimaryKey(): array;

getSchemaName() public abstract method

Returns the schema name that this table belongs to.

public abstract getSchemaName( ): string

Source code

                public function getSchemaName(): string;

getSequenceName() public abstract method

Return the sequence name for the primary key or null if no sequence.

public abstract getSequenceName( ): string\|null

Source code

                public function getSequenceName(): ?string;

getUniques() public abstract method

Returns the unique indexes of this table.

public abstract getUniques( ): Yiisoft\Db\Constraint\Index[]
return	Yiisoft\Db\Constraint\Index[]	The unique indexes of this table.

Source code

                public function getUniques(): array;

indexes() public abstract method

Set indexes of this table.

public abstract indexes( Yiisoft\Db\Constraint\Index $indexes ): Yiisoft\Db\Schema\TableSchemaInterface
$indexes	Yiisoft\Db\Constraint\Index	The indexes.

Source code

                public function indexes(Index ...$indexes): static;

name() public abstract method

Set the name of this table.

The schema name must not be included. Use schemaName() to set the table schema name.

public abstract name( string $name ): Yiisoft\Db\Schema\TableSchemaInterface
$name	string

Source code

                public function name(string $name): static;

options() public abstract method

Set the options of this table.

public abstract options( string $options ): Yiisoft\Db\Schema\TableSchemaInterface
$options	string	The options.

Source code

                public function options(string ...$options): static;

schemaName() public abstract method

Set the name of the schema that this table belongs to or empty string for the default schema.

public abstract schemaName( string $schemaName ): Yiisoft\Db\Schema\TableSchemaInterface
$schemaName	string

Source code

                public function schemaName(string $schemaName): static;

sequenceName() public abstract method

Set a sequence name for the primary key or null if no sequence.

public abstract sequenceName( string\|null $sequenceName ): Yiisoft\Db\Schema\TableSchemaInterface
$sequenceName	string\|null

Source code

                public function sequenceName(?string $sequenceName): static;