classSchemaReader

packages/sql-semantics/src/Core/Ast/SchemaReader.php:21

final class SchemaReader

Restricted visibility: declared "@visibility SqlSemantics". Code outside that scope must not name this declaration.

Builds a schema snapshot from CREATE TABLE syntax nodes.

Properties§

public Identifiers $identifiers

source §

public string $defaultSchema

source §

Methods§

public function __construct(
    public Identifiers $identifiers,
    public string $defaultSchema,
    ?ValueReader $values = null,
)

source §

Binds the dependencies used for semantic binding.

Parameters

`$identifiers`	`Identifiers`
`$defaultSchema`	`string`
`$values`	`?ValueReader`

Calls 2

method-call DialectParser::version() line 29
new DialectParser line 29

public function read(list<Node> $trees): list<TableDefinition>

source §

Parameters

$trees list<Node>

Returns

list<TableDefinition>

Throws

SemanticException

Called from 1

method-call SqlSemantics\Core\Analysis\SchemaAnalyzer::read() packages/sql-semantics/src/Core/Analysis/SchemaAnalyzer.php:59

Calls 10

static-call StatementList::read() line 41
static-call Tree::child() line 42
method-call SchemaChanges::drop() line 43
new SchemaChanges line 43
static-call Tree::unsupported() line 47
method-call SchemaReader::table() line 49
function-call preg_match line 51
static-call Tree::text() line 51
new SemanticException line 55
function-call array_values line 61

public function table(Node $create): TableDefinition

source §

Reads one table and promotes the nullability of primary key columns.

Parameters

$create Node

Returns

TableDefinition

Called from 1

method-call SqlSemantics\Core\Ast\SchemaReader::read() packages/sql-semantics/src/Core/Ast/SchemaReader.php:49

Calls 16

static-call Tree::outer() line 69
static-call Tree::child() line 70
static-call Tree::unsupported() line 72
method-call Identifiers::parts() line 74
function-call count line 76
method-call SchemaReader::validate() line 79
method-call SchemaReader::columnNodes() line 82
method-call ColumnReader::read() line 83
new ColumnReader line 83
function-call array_push line 85
method-call ConstraintReader::read() line 88
new ConstraintReader line 88
method-call SchemaReader::primaryKeys() line 96
new TableDefinition line 98
method-call ValueReader::read() line 98
function-call array_map line 98

public function validate(Node $source, Node $header): void

source §

Rejects declarations whose column state requires evaluating another relation.

Parameters

`$source`	`Node`
`$header`	`Node`

Called from 1

method-call SqlSemantics\Core\Ast\SchemaReader::table() packages/sql-semantics/src/Core/Ast/SchemaReader.php:79

public function columnNodes(Node $create): list<array{Node, list<Node>}>

source §

Parameters

$create Node

Returns

list<array{Node, list<Node>}>

Test cases 1

SchemaRulesTest::testColumnNodesHonorsAnInjectedPolicy calls

Called from 1

method-call SqlSemantics\Core\Ast\SchemaReader::table() packages/sql-semantics/src/Core/Ast/SchemaReader.php:82

public function primaryKeys(
    list<ColumnDefinition> $columns,
    list<TableConstraint> $constraints,
    Node $source,
): list<ColumnDefinition>

source §

Parameters

`$columns`	`list<ColumnDefinition>`
`$constraints`	`list<TableConstraint>`
`$source`	`Node`

Returns

list<ColumnDefinition>

Throws

SemanticException

Called from 1

method-call SqlSemantics\Core\Ast\SchemaReader::table() packages/sql-semantics/src/Core/Ast/SchemaReader.php:96

Calls 8

function-call array_map line 125
function-call count line 126
function-call array_unique line 126
new SemanticException line 127
function-call in_array line 132
class-const ConstraintKind::PrimaryKey() line 136
method-call SchemaReader::primaryNotNull() line 145
class-const Nullability::NotNull() line 146

public function primaryNotNull(
    ColumnDefinition $column,
    list<string> $primary,
    list<TableConstraint> $constraints,
): bool

source §

Parameters

`$column`	`ColumnDefinition`
`$primary`	`list<string>`
`$constraints`	`list<TableConstraint>`

Returns

bool

Called from 1

method-call SqlSemantics\Core\Ast\SchemaReader::primaryKeys() packages/sql-semantics/src/Core/Ast/SchemaReader.php:145

Private surface 1§

Implementation details, listed for orientation only.

private ValueReader $values

Test cases 60§

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

Dedicated tests 1

SchemaReaderTest calls

Other tests reaching this symbol 59

SchemaAnalyzerTest calls
ColumnPropertiesTest calls
ColumnReaderTest calls
ConstraintReaderTest calls
IdentifiersTest calls
SchemaChangesTest calls
StatementListTest calls
TokenGroupsTest calls
TreeTest calls
TypeReaderTest calls
BinderTest calls
BoundRelationTest calls
ExpressionBinderTest calls
ExpressionRulesTest calls
FromBinderTest calls
IdentitySequenceTest calls
LiteralBinderTest calls
NullFactsTest calls
ProjectionBinderTest calls
ScopeTest calls
SelectBinderTest calls
SelectModifiersBinderTest calls
SyntaxGuardTest calls
TableResolverTest calls
TypeResolutionTest calls
DialectTest calls
BoundSelectTest calls
ColumnBindingTest calls
ExpressionKindTest calls
ExpressionTest calls
JoinKindTest calls
JoinTest calls
OrderingTest calls
OutputColumnTest calls
TableUseTest calls
PlatformTest calls
NameRulesTest calls
QueryRulesTest calls
SchemaRulesTest::testColumnNodesHonorsAnInjectedPolicy calls
SyntaxRulesTest calls
TypeRulesTest calls
ColumnDefinitionTest calls
ColumnGenerationTest calls
ConstraintKindTest calls
GenerationKindTest calls
InvariantTest calls
TableConstraintTest calls
TableDefinitionTest calls
SchemaBuilderTest calls
SchemaTest calls
SemanticExceptionTest calls
NullabilityTest calls
TypeDescriptorTest calls
SchemaTest calls
NameRulesTest calls
PlatformTest calls
QueryRulesTest calls
SchemaRulesTest calls
TypeRulesTest calls

Relations§

Instantiated in 1

new SqlSemantics\Core\Analysis\SchemaAnalyzer::read() packages/sql-semantics/src/Core/Analysis/SchemaAnalyzer.php:59

Method calls 1

method-call SqlSemantics\Core\Analysis\SchemaAnalyzer::read() packages/sql-semantics/src/Core/Analysis/SchemaAnalyzer.php:59