extends |
AbstractAsset |
|---|
Object representation of a database schema.
Different vendors have very inconsistent naming with regard to the concept of a "schema". Doctrine understands a schema as the entity that conceptually wraps a set of database objects such as tables, sequences, indexes and foreign keys that belong to each other into a namespace. A Doctrine Schema has nothing to do with the "SCHEMA" defined as in PostgreSQL, it is more related to the concept of "DATABASE" that exists in MySQL and PostgreSQL.
Every asset in the doctrine schema has a name. A name consists of either a namespace.local name pair or just a local unqualified name.
The abstraction layer that covers a PostgreSQL schema is the namespace of an database object (asset). A schema can have a name, which will be used as default namespace for the unqualified database objects that are created in the schema.
In the case of MySQL where cross-database queries are allowed this leads to databases being "misinterpreted" as namespaces. This is intentional, however the CREATE/DROP SQL visitors will just filter this queries and do not execute them. Only the queries for the currently connected database are executed.
| Methods | ||
|---|---|---|
public
|
__construct(
Table[] $tables = [],
Sequence[] $sequences = [],
?SchemaConfig $schemaConfig = null,
string[] $namespaces = [],
)
|
# |
public
|
hasExplicitForeignKeyIndexes(): bool
|
# |
public
|
getNamespaces(): string[]
|
# |
public
|
getTables(): Table[]
|
# |
public
|
getTable(string $name): Table
|
# |
public
|
hasNamespace(string $name): bool
|
# |
public
|
hasTable(string $name): bool
|
# |
public
|
getTableNames(): string[]
|
# |
public
|
hasSequence(string $name): bool
|
# |
public
|
getSequence(string $name): Sequence
|
# |
public
|
getSequences(): Sequence[]
|
# |
public
|
createNamespace(string $name): Schema
|
# |
public
|
createTable(string $name): Table
|
# |
public
|
renameTable(string $oldName, string $newName): Schema
|
# |
public
|
dropTable(string $name): Schema
|
# |
public
|
createSequence(string $name, int $allocationSize = 1, int $initialValue = 1): Sequence
|
# |
public
|
dropSequence(string $name): Schema
|
# |
public
|
toSql(AbstractPlatform $platform): string[]
|
# |
public
|
toDropSql(AbstractPlatform $platform): string[]
|
# |
public
|
getMigrateToSql(Schema $toSchema, AbstractPlatform $platform): string[]
|
# |
public
|
getMigrateFromSql(Schema $fromSchema, AbstractPlatform $platform): string[]
|
# |
public
|
visit(Visitor $visitor): void
|
# |
public
|
__clone(): void
|
# |
| Methods inherited from Doctrine\DBAL\Schema\AbstractAsset |
|---|
isInDefaultNamespace(), getNamespaceName(), getShortestName(), getFullQualifiedName(), isQuoted(), getName(), getQuotedName() |