github.com

classTableDefinition

packages/ztd-query-core/src/Schema/TableDefinition.php:24
final class TableDefinition

Structured representation of a table's schema metadata.

Values remain opaque to the neutral core until a platform interprets them. This also preserves driver values such as LOB streams and caller literals.

Type Aliases§

RowValue = mixed
Row = array<string, RowValue>

Properties§

public array<string, ColumnDeclaration> $typedColumns
source§
public array<string, string> $columnDefaults
source§
public array<string, IdentityGenerationStrategy> $identityStrategies
source§
public array<string, string> $generatedExpressions
source§
public array<string, ForeignKeyDefinition> $foreignKeys
source§
public TablePartitioning|null $partitioning
source§
public TablePartitionKey|null $partitionKey
source§
public TablePartitionRelation|null $partitionRelation
source§
public array<string, PartialUniqueIndex> $partialUniqueIndexes
source§
public list<string> $columns
source§
public array<string, string> $columnTypes
source§
public list<string> $primaryKeys
source§
public list<string> $notNullColumns
source§
public array<string, list<string>> $uniqueConstraints
source§

Methods§

public function __construct(
    public list<string> $columns,
    public array<string, string> $columnTypes,
    public list<string> $primaryKeys,
    public list<string> $notNullColumns,
    public array<string, list<string>> $uniqueConstraints,
    array<string, ColumnDeclaration> $typedColumns = [],
    array<string, string> $columnDefaults = [],
    array<string, IdentityGenerationStrategy> $identityStrategies = [],
    array<string, string> $generatedExpressions = [],
    array<string, ForeignKeyDefinition> $foreignKeys = [],
    TablePartitioning|null $partitioning = null,
    TablePartitionKey|null $partitionKey = null,
    TablePartitionRelation|null $partitionRelation = null,
    array<string, PartialUniqueIndex> $partialUniqueIndexes = [],
)
source§

Parameters

$columnslist<string>Column names in declaration order.
$columnTypesarray<string, string>Column name => MySQL type string.
$primaryKeyslist<string>Primary key column names.
$notNullColumnslist<string>Columns with NOT NULL constraint.
$uniqueConstraintsarray<string, list<string>>Key name => column list.
$typedColumnsarray<string, ColumnDeclaration>Column name => structured ColumnDeclaration.
$columnDefaultsarray<string, string>Column name => SQL default expression.
$identityStrategiesarray<string, IdentityGenerationStrategy>Column name => shadow generation strategy.
$generatedExpressionsarray<string, string>Column name => database generated expression.
$foreignKeysarray<string, ForeignKeyDefinition>Constraint name => foreign-key definition.
$partitioningTablePartitioning|nullNamed partition selection predicates.
$partitionKeyTablePartitionKey|nullDeclarative partition key metadata.
$partitionRelationTablePartitionRelation|nullParent partition relationship.
$partialUniqueIndexesarray<string, PartialUniqueIndex>Partial unique indexes keyed by name.
public function withPartitioning(?TablePartitioning $partitioning): self
source§

With partitioning.

Parameters

$partitioning?TablePartitioning

Returns

self
Test cases 1
Calls 1
public function withPartialUniqueIndex(PartialUniqueIndex $index): self
source§

With partial unique index.

Parameters

$indexPartialUniqueIndex

Returns

self
Test cases 2
Calls 1

Test cases 621§

Test cases that cover or call this symbol, from the coverage report and from the analyzed test sources.

Dedicated tests 7
Other tests reaching this symbol 614

Relations§

Instantiated in 8
Method calls 1
Type declarations 40