Skip to content

Commit

Permalink
Merge pull request #777 from ovoronyi/ticket-440
Browse files Browse the repository at this point in the history 
Add schema support to MS SQL Server
  • Loading branch information
@markstory
markstory authored Nov 29, 2024
2 parents 89b6331 + 6d50c41 commit f8b4991
Show file tree
Hide file tree
Showing 2 changed files with 224 additions and 20 deletions.
187 changes: 170 additions & 17 deletions src/Db/Adapter/SqlserverAdapter.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -98,12 +98,25 @@ public function rollbackTransaction(): void
$this->getConnection()->rollback();
}

/**
* Quotes a schema name for use in a query.
*
* @param string $schemaName Schema Name
* @return string
*/
public function quoteSchemaName(string $schemaName): string
{
return $this->quoteColumnName($schemaName);
}

/**
* @inheritDoc
*/
public function quoteTableName(string $tableName): string
{
return str_replace('.', '].[', $this->quoteColumnName($tableName));
$parts = $this->getSchemaName($tableName);

return $this->quoteSchemaName($parts['schema']) . '.' . $this->quoteColumnName($parts['table']);
}

/**
Expand All @@ -123,8 +136,13 @@ public function hasTable(string $tableName): bool
return true;
}

$parts = $this->getSchemaName($tableName);
/** @var array<string, mixed> $result */
$result = $this->fetchRow(sprintf("SELECT count(*) as [count] FROM INFORMATION_SCHEMA.TABLES WHERE TABLE_NAME = '%s';", $tableName));
$result = $this->fetchRow(sprintf(
"SELECT count(*) as [count] FROM INFORMATION_SCHEMA.TABLES WHERE TABLE_SCHEMA = '%s' AND TABLE_NAME = '%s';",
$parts['schema'],
$parts['table'],
));

return $result['count'] > 0;
}
Expand All @@ -135,6 +153,7 @@ public function hasTable(string $tableName): bool
public function createTable(Table $table, array $columns = [], array $indexes = []): void
{
$options = $table->getOptions();
$parts = $this->getSchemaName($table->getName());

// Add the default primary key
if (!isset($options['id']) || $options['id'] === true) {
Expand Down Expand Up @@ -170,7 +189,7 @@ public function createTable(Table $table, array $columns = [], array $indexes =

// set the primary key(s)
if (isset($options['primary_key'])) {
$pkSql = sprintf('CONSTRAINT PK_%s PRIMARY KEY (', $table->getName());
$pkSql = sprintf('CONSTRAINT PK_%s PRIMARY KEY (', $parts['table']);
/** @var string|array $primaryKey */
$primaryKey = $options['primary_key'];

Expand Down Expand Up @@ -347,6 +366,7 @@ public function getColumnComment(string $tableName, ?string $columnName): ?strin
*/
public function getColumns(string $tableName): array
{
$parts = $this->getSchemaName($tableName);
$columns = [];
$sql = sprintf(
"SELECT DISTINCT TABLE_SCHEMA AS [schema], TABLE_NAME as [table_name], COLUMN_NAME AS [name], DATA_TYPE AS [type],
Expand All @@ -356,9 +376,10 @@ public function getColumns(string $tableName): array
NUMERIC_SCALE AS [scale], ORDINAL_POSITION AS [ordinal_position],
COLUMNPROPERTY(object_id(TABLE_NAME), COLUMN_NAME, 'IsIdentity') as [identity]
FROM INFORMATION_SCHEMA.COLUMNS
WHERE TABLE_NAME = '%s'
WHERE TABLE_SCHEMA = '%s' AND TABLE_NAME = '%s'
ORDER BY ordinal_position",
$tableName
$parts['schema'],
$parts['table'],
);
$rows = $this->fetchAll($sql);
foreach ($rows as $columnInfo) {
Expand Down Expand Up @@ -415,11 +436,13 @@ protected function parseDefault(?string $default): int|string|null
*/
public function hasColumn(string $tableName, string $columnName): bool
{
$parts = $this->getSchemaName($tableName);
$sql = sprintf(
"SELECT count(*) as [count]
FROM INFORMATION_SCHEMA.COLUMNS
WHERE TABLE_NAME = '%s' AND COLUMN_NAME = '%s'",
$tableName,
WHERE TABLE_SCHEMA = '%s' AND TABLE_NAME = '%s' AND COLUMN_NAME = '%s'",
$parts['schema'],
$parts['table'],
$columnName
);
/** @var array<string, mixed> $result */
Expand Down Expand Up @@ -650,12 +673,19 @@ protected function getIndexColumns(string $tableId, string $indexId): array
*/
public function getIndexes(string $tableName): array
{
$parts = $this->getSchemaName($tableName);

$indexes = [];
$sql = "SELECT I.[name] AS [index_name], I.[index_id] as [index_id], T.[object_id] as [table_id]
$sql = sprintf(
"SELECT I.[name] AS [index_name], I.[index_id] as [index_id], T.[object_id] as [table_id]
FROM sys.[tables] AS T
INNER JOIN sys.[indexes] I ON T.[object_id] = I.[object_id]
WHERE T.[is_ms_shipped] = 0 AND I.[type_desc] <> 'HEAP' AND T.[name] = '{$tableName}'
ORDER BY T.[name], I.[index_id];";
INNER JOIN sys.[schemas] S ON S.schema_id = T.schema_id
WHERE T.[is_ms_shipped] = 0 AND I.[type_desc] <> 'HEAP' AND S.[name] = '%s' AND T.[name] = '%s'
ORDER BY T.[name], I.[index_id];",
$parts['schema'],
$parts['table'],
);

$rows = $this->fetchAll($sql);
foreach ($rows as $row) {
Expand Down Expand Up @@ -803,6 +833,7 @@ public function hasPrimaryKey(string $tableName, $columns, ?string $constraint =
*/
public function getPrimaryKey(string $tableName): array
{
$parts = $this->getSchemaName($tableName);
$rows = $this->fetchAll(sprintf(
"SELECT
tc.CONSTRAINT_NAME,
Expand All @@ -811,9 +842,11 @@ public function getPrimaryKey(string $tableName): array
JOIN INFORMATION_SCHEMA.KEY_COLUMN_USAGE AS kcu
ON tc.CONSTRAINT_NAME = kcu.CONSTRAINT_NAME
WHERE CONSTRAINT_TYPE = 'PRIMARY KEY'
AND tc.CONSTRAINT_SCHEMA = '%s'
AND tc.TABLE_NAME = '%s'
ORDER BY kcu.ORDINAL_POSITION",
$tableName
$parts['schema'],
$parts['table'],
));

$primaryKey = [
Expand Down Expand Up @@ -862,6 +895,7 @@ public function hasForeignKey(string $tableName, $columns, ?string $constraint =
*/
protected function getForeignKeys(string $tableName): array
{
$parts = $this->getSchemaName($tableName);
$foreignKeys = [];
$rows = $this->fetchAll(sprintf(
"SELECT
Expand All @@ -873,9 +907,10 @@ protected function getForeignKeys(string $tableName): array
INFORMATION_SCHEMA.TABLE_CONSTRAINTS AS tc
JOIN INFORMATION_SCHEMA.KEY_COLUMN_USAGE AS kcu ON tc.CONSTRAINT_NAME = kcu.CONSTRAINT_NAME
JOIN INFORMATION_SCHEMA.CONSTRAINT_COLUMN_USAGE AS ccu ON ccu.CONSTRAINT_NAME = tc.CONSTRAINT_NAME
WHERE CONSTRAINT_TYPE = 'FOREIGN KEY' AND tc.TABLE_NAME = '%s'
WHERE CONSTRAINT_TYPE = 'FOREIGN KEY' AND tc.TABLE_SCHEMA = '%s' AND tc.TABLE_NAME = '%s'
ORDER BY kcu.ORDINAL_POSITION",
$tableName
$parts['schema'],
$parts['table'],
));
foreach ($rows as $row) {
$foreignKeys[$row['CONSTRAINT_NAME']]['table'] = $row['TABLE_NAME'];
Expand Down Expand Up @@ -1171,15 +1206,17 @@ protected function getColumnSqlDefinition(Column $column, bool $create = true):
* Gets the SqlServer Index Definition for an Index object.
*
* @param \Migrations\Db\Table\Index $index Index
* @param ?string $tableName Table name
* @param string $tableName Table name
* @return string
*/
protected function getIndexSqlDefinition(Index $index, ?string $tableName): string
protected function getIndexSqlDefinition(Index $index, string $tableName): string
{
$parts = $this->getSchemaName($tableName);
$columnNames = (array)$index->getColumns();

$indexName = $index->getName();
if (!is_string($indexName)) {
$indexName = sprintf('%s_%s', (string)$tableName, implode('_', $columnNames));
$indexName = sprintf('%s_%s', $parts['table'], implode('_', $columnNames));
}
$order = $index->getOrder() ?? [];
$columnNames = array_map(function ($columnName) use ($order) {
Expand All @@ -1198,7 +1235,7 @@ protected function getIndexSqlDefinition(Index $index, ?string $tableName): stri
'CREATE %s INDEX %s ON %s (%s) %s;',
($index->getType() === Index::UNIQUE ? 'UNIQUE' : ''),
$indexName,
$this->quoteTableName((string)$tableName),
$this->quoteTableName($tableName),
implode(',', $columnNames),
$includedColumns
);
Expand Down Expand Up @@ -1227,6 +1264,122 @@ protected function getForeignKeySqlDefinition(ForeignKey $foreignKey, string $ta
return $def;
}

/**
* Creates the specified schema.
*
* @param string $schemaName Schema Name
* @return void
*/
public function createSchema(string $schemaName = 'public'): void
{
if ($this->hasSchema($schemaName) === false) {
$sql = sprintf('CREATE SCHEMA %s', $this->quoteColumnName($schemaName));
$this->execute($sql);
}
}

/**
* Checks to see if a schema exists.
*
* @param string $schemaName Schema Name
* @return bool
*/
public function hasSchema(string $schemaName): bool
{
$sql = sprintf(
'SELECT count(*) AS [count]
FROM sys.schemas
WHERE name = %s',
$this->quoteString($schemaName)
);
$result = $this->fetchRow($sql);
if (!$result) {
return false;
}

return $result['count'] > 0;
}

/**
* Drops the specified schema table.
*
* @param string $schemaName Schema name
* @return void
*/
public function dropSchema(string $schemaName): void
{
$sql = sprintf('DROP SCHEMA IF EXISTS %s', $this->quoteSchemaName($schemaName));
$this->execute($sql);

foreach ($this->createdTables as $idx => $createdTable) {
if ($this->getSchemaName($createdTable)['schema'] === $this->quoteSchemaName($schemaName)) {
unset($this->createdTables[$idx]);
}
}
}

/**
* Drops all schemas.
*
* @return void
*/
public function dropAllSchemas(): void
{
foreach ($this->getAllSchemas() as $schema) {
$this->dropSchema($schema);
}
}

/**
* Returns schemas.
*
* @return array
*/
public function getAllSchemas(): array
{
$sql = "SELECT name
FROM sys.schemas
WHERE name not in ('information_schema', 'sys', 'guest', 'dbo') AND name not like 'db_%'";
$items = $this->fetchAll($sql);
$schemaNames = [];
foreach ($items as $item) {
$schemaNames[] = $item['name'];
}

return $schemaNames;
}

/**
* @param string $tableName Table name
* @return array
*/
protected function getSchemaName(string $tableName): array
{
$schema = $this->getGlobalSchemaName();
$table = $tableName;
if (strpos($tableName, '.') !== false) {
[$schema, $table] = explode('.', $tableName);
}

return [
'schema' => $schema,
'table' => $table,
];
}

/**
* Gets the schema name.
*
* @return string
*/
protected function getGlobalSchemaName(): string
{
$options = $this->getOptions();
$config = $options['connection']->config() ?? [];

return empty($config['schema']) ? $this->schema : $config['schema'];
}

/**
* @inheritDoc
*/
Expand Down
57 changes: 54 additions & 3 deletions tests/TestCase/Db/Adapter/SqlserverAdapterTest.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -99,7 +99,8 @@ public function testSchemaTableIsCreatedWithPrimaryKey()

public function testQuoteTableName()
{
$this->assertEquals('[test_table]', $this->adapter->quoteTableName('test_table'));
$this->assertEquals('[dbo].[test_table]', $this->adapter->quoteTableName('test_table'));
$this->assertEquals('[schema].[table]', $this->adapter->quoteTableName('schema.table'));
}

public function testQuoteColumnName()
Expand All @@ -120,6 +121,24 @@ public function testCreateTable()
$this->assertFalse($this->adapter->hasColumn('ntable', 'address'));
}

public function testCreateTableWithSchema()
{
$this->adapter->createSchema('nschema');

$table = new Table('nschema.ntable', [], $this->adapter);
$table->addColumn('realname', 'string')
->addColumn('email', 'integer')
->save();
$this->assertTrue($this->adapter->hasTable('nschema.ntable'));
$this->assertTrue($this->adapter->hasColumn('nschema.ntable', 'id'));
$this->assertTrue($this->adapter->hasColumn('nschema.ntable', 'realname'));
$this->assertTrue($this->adapter->hasColumn('nschema.ntable', 'email'));
$this->assertFalse($this->adapter->hasColumn('nschema.ntable', 'address'));

$this->adapter->dropTable('nschema.ntable');
$this->adapter->dropSchema('nschema');
}

public function testCreateTableCustomIdColumn()
{
$table = new Table('ntable', ['id' => 'custom_id'], $this->adapter);
Expand Down Expand Up @@ -1064,6 +1083,38 @@ public function testDropDatabase()
$this->adapter->dropDatabase('phinx_temp_database');
}

public function testCreateSchema()
{
$this->adapter->createSchema('foo');
$this->assertTrue($this->adapter->hasSchema('foo'));
}

public function testDropSchema()
{
$this->adapter->createSchema('foo');
$this->assertTrue($this->adapter->hasSchema('foo'));
$this->adapter->dropSchema('foo');
$this->assertFalse($this->adapter->hasSchema('foo'));
}

public function testDropAllSchemas()
{
$this->adapter->createSchema('foo');
$this->adapter->createSchema('bar');

$this->assertTrue($this->adapter->hasSchema('foo'));
$this->assertTrue($this->adapter->hasSchema('bar'));
$this->adapter->dropAllSchemas();
$this->assertFalse($this->adapter->hasSchema('foo'));
$this->assertFalse($this->adapter->hasSchema('bar'));
}

public function testQuoteSchemaName()
{
$this->assertEquals('[schema]', $this->adapter->quoteSchemaName('schema'));
$this->assertEquals('[schema.schema]', $this->adapter->quoteSchemaName('schema.schema'));
}

public function testInvalidSqlType()
{
$this->expectException(RuntimeException::class);
Expand Down Expand Up @@ -1342,8 +1393,8 @@ public function testDumpCreateTableAndThenInsert()
])->save();

$expectedOutput = <<<'OUTPUT'
CREATE TABLE [table1] ([column1] NVARCHAR (255) NOT NULL , [column2] INT NULL DEFAULT NULL, CONSTRAINT PK_table1 PRIMARY KEY ([column1]));
INSERT INTO [table1] ([column1], [column2]) VALUES ('id1', 1);
CREATE TABLE [dbo].[table1] ([column1] NVARCHAR (255) NOT NULL , [column2] INT NULL DEFAULT NULL, CONSTRAINT PK_table1 PRIMARY KEY ([column1]));
INSERT INTO [dbo].[table1] ([column1], [column2]) VALUES ('id1', 1);
OUTPUT;
$output = join("\n", $this->out->messages());
$actualOutput = str_replace("\r\n", "\n", $output);
Expand Down

0 comments on commit f8b4991

Please sign in to comment.