Files
sqltoolsservice/src/Microsoft.SqlTools.ServiceLayer/TableDesigner/TableDesignerValidator.cs
Hai Cao 262fd00afd fix memory optimized option inconsistent state (#1503)
* disable mem optimized instead of removing options

* bump DacFx
2022-05-23 13:27:18 -07:00

581 lines
24 KiB
C#

//
// Copyright (c) Microsoft. All rights reserved.
// Licensed under the MIT license. See LICENSE file in the project root for full license information.
//
using System.Collections.Generic;
using Microsoft.Data.Tools.Sql.DesignServices.TableDesigner;
using Dac = Microsoft.Data.Tools.Sql.DesignServices.TableDesigner;
using TableDesignerIssue = Microsoft.SqlTools.ServiceLayer.TableDesigner.Contracts.TableDesignerIssue;
using System.Linq;
namespace Microsoft.SqlTools.ServiceLayer.TableDesigner
{
public static class TableDesignerValidator
{
private static List<ITableDesignerValidationRule> Rules = new List<ITableDesignerValidationRule>() {
new IndexMustHaveColumnsRule(),
new ForeignKeyMustHaveColumnsRule(),
new ColumnCanOnlyAppearOnceInForeignKeyRule(),
new ColumnCanOnlyAppearOnceInIndexRule(),
new NoDuplicateColumnNameRule(),
new NoDuplicateConstraintNameRule(),
new NoDuplicateIndexNameRule(),
new EdgeConstraintMustHaveClausesRule(),
new EdgeConstraintNoRepeatingClausesRule(),
new MemoryOptimizedCannotBeEnabledWhenNotSupportedRule(),
new MemoryOptimizedTableMustHaveNonClusteredPrimaryKeyRule(),
new TemporalTableMustHavePeriodColumns(),
new PeriodColumnsRule(),
new ColumnsInPrimaryKeyCannotBeNullableRule(),
new OnlyDurableMemoryOptimizedTableCanBeSystemVersionedRule(),
new TemporalTableMustHavePrimaryKeyRule(),
new TableMustHaveAtLeastOneColumnRule(),
new MemoryOptimizedTableIdentityColumnRule(),
new TableShouldAvoidHavingMultipleEdgeConstraintsRule(),
new ColumnCannotBeListedMoreThanOnceInPrimaryKeyRule()
};
/// <summary>
/// Validate the table and return the validation errors.
/// </summary>
public static List<TableDesignerIssue> Validate(Dac.TableDesigner designer)
{
var errors = new List<TableDesignerIssue>();
foreach (var rule in Rules)
{
errors.AddRange(rule.Run(designer));
}
return errors;
}
}
public interface ITableDesignerValidationRule
{
List<TableDesignerIssue> Run(Dac.TableDesigner designer);
}
public class IndexMustHaveColumnsRule : ITableDesignerValidationRule
{
public List<TableDesignerIssue> Run(Dac.TableDesigner designer)
{
var table = designer.TableViewModel;
var errors = new List<TableDesignerIssue>();
for (int i = 0; i < table.Indexes.Items.Count; i++)
{
var index = table.Indexes.Items[i];
if (index.Columns.Count == 0)
{
errors.Add(new TableDesignerIssue()
{
Description = string.Format("Index '{0}' does not have any columns associated with it.", index.Name),
PropertyPath = new object[] { TablePropertyNames.Indexes, i }
});
}
}
return errors;
}
}
public class ForeignKeyMustHaveColumnsRule : ITableDesignerValidationRule
{
public List<TableDesignerIssue> Run(Dac.TableDesigner designer)
{
var table = designer.TableViewModel;
var errors = new List<TableDesignerIssue>();
for (int i = 0; i < table.ForeignKeys.Items.Count; i++)
{
var foreignKey = table.ForeignKeys.Items[i];
if (foreignKey.Columns.Count == 0)
{
errors.Add(new TableDesignerIssue()
{
Description = string.Format("Foreign key '{0}' does not have any columns specified.", foreignKey.Name),
PropertyPath = new object[] { TablePropertyNames.ForeignKeys, i }
});
}
}
return errors;
}
}
public class ColumnCanOnlyAppearOnceInIndexRule : ITableDesignerValidationRule
{
public List<TableDesignerIssue> Run(Dac.TableDesigner designer)
{
var table = designer.TableViewModel;
var errors = new List<TableDesignerIssue>();
for (int i = 0; i < table.Indexes.Items.Count; i++)
{
var index = table.Indexes.Items[i];
var existingColumns = new HashSet<string>();
for (int j = 0; j < index.Columns.Count; j++)
{
var columnSpec = index.Columns[j];
if (existingColumns.Contains(columnSpec.Column))
{
errors.Add(new TableDesignerIssue()
{
Description = string.Format("Column with name '{0}' has already been added to the index '{1}'. Row number: {2}.", columnSpec.Column, index.Name, j + 1),
PropertyPath = new object[] { TablePropertyNames.Indexes, i, IndexPropertyNames.Columns, j }
});
}
else
{
existingColumns.Add(columnSpec.Column);
}
}
}
return errors;
}
}
public class ColumnCanOnlyAppearOnceInForeignKeyRule : ITableDesignerValidationRule
{
public List<TableDesignerIssue> Run(Dac.TableDesigner designer)
{
var table = designer.TableViewModel;
var errors = new List<TableDesignerIssue>();
for (int i = 0; i < table.ForeignKeys.Items.Count; i++)
{
var foreignKey = table.ForeignKeys.Items[i];
var existingColumns = new HashSet<string>();
for (int j = 0; j < foreignKey.Columns.Count; j++)
{
var column = foreignKey.Columns[j];
if (existingColumns.Contains(column))
{
errors.Add(new TableDesignerIssue()
{
Description = string.Format("Column with name '{0}' has already been added to the foreign key '{1}'. Row number: {2}.", column, foreignKey.Name, j + 1),
PropertyPath = new object[] { TablePropertyNames.ForeignKeys, i, ForeignKeyPropertyNames.ColumnMapping, j, ForeignKeyColumnMappingPropertyNames.Column }
});
}
else
{
existingColumns.Add(column);
}
}
var existingForeignColumns = new HashSet<string>();
for (int j = 0; j < foreignKey.ForeignColumns.Count; j++)
{
var foreignColumn = foreignKey.ForeignColumns[j];
if (existingForeignColumns.Contains(foreignColumn))
{
errors.Add(new TableDesignerIssue()
{
Description = string.Format("Foreign column with name '{0}' has already been added to the foreign key '{1}'. Row number: {2}.", foreignColumn, foreignKey.Name, j + 1),
PropertyPath = new object[] { TablePropertyNames.ForeignKeys, i, ForeignKeyPropertyNames.ColumnMapping, j, ForeignKeyColumnMappingPropertyNames.ForeignColumn }
});
}
else
{
existingForeignColumns.Add(foreignColumn);
}
}
}
return errors;
}
}
public class NoDuplicateConstraintNameRule : ITableDesignerValidationRule
{
public List<TableDesignerIssue> Run(Dac.TableDesigner designer)
{
var errors = new List<TableDesignerIssue>();
var table = designer.TableViewModel;
var existingNames = new HashSet<string>();
for (int i = 0; i < table.ForeignKeys.Items.Count; i++)
{
var foreignKey = table.ForeignKeys.Items[i];
if (existingNames.Contains(foreignKey.Name))
{
errors.Add(new TableDesignerIssue()
{
Description = string.Format("The name '{0}' is already used by another constraint. Row number: {1}.", foreignKey.Name, i + 1),
PropertyPath = new object[] { TablePropertyNames.ForeignKeys, i, ForeignKeyPropertyNames.Name }
});
}
else
{
existingNames.Add(foreignKey.Name);
}
}
for (int i = 0; i < table.CheckConstraints.Items.Count; i++)
{
var checkConstraint = table.CheckConstraints.Items[i];
if (existingNames.Contains(checkConstraint.Name))
{
errors.Add(new TableDesignerIssue()
{
Description = string.Format("The name '{0}' is already used by another constraint. Row number: {1}.", checkConstraint.Name, i + 1),
PropertyPath = new object[] { TablePropertyNames.CheckConstraints, i, CheckConstraintPropertyNames.Name }
});
}
else
{
existingNames.Add(checkConstraint.Name);
}
}
for (int i = 0; i < table.EdgeConstraints.Items.Count; i++)
{
var edgeConstraint = table.EdgeConstraints.Items[i];
if (existingNames.Contains(edgeConstraint.Name))
{
errors.Add(new TableDesignerIssue()
{
Description = string.Format("The name '{0}' is already used by another constraint. Row number: {1}.", edgeConstraint.Name, i + 1),
PropertyPath = new object[] { TablePropertyNames.EdgeConstraints, i, EdgeConstraintPropertyNames.Name }
});
}
else
{
existingNames.Add(edgeConstraint.Name);
}
}
return errors;
}
}
public class NoDuplicateColumnNameRule : ITableDesignerValidationRule
{
public List<TableDesignerIssue> Run(Dac.TableDesigner designer)
{
var table = designer.TableViewModel;
var errors = new List<TableDesignerIssue>();
var existingNames = new HashSet<string>();
for (int i = 0; i < table.Columns.Items.Count; i++)
{
var column = table.Columns.Items[i];
if (existingNames.Contains(column.Name))
{
errors.Add(new TableDesignerIssue()
{
Description = string.Format("The name '{0}' is already used by another column. Row number: {1}.", column.Name, i + 1),
PropertyPath = new object[] { TablePropertyNames.Columns, i, TableColumnPropertyNames.Name }
});
}
else
{
existingNames.Add(column.Name);
}
}
return errors;
}
}
public class NoDuplicateIndexNameRule : ITableDesignerValidationRule
{
public List<TableDesignerIssue> Run(Dac.TableDesigner designer)
{
var table = designer.TableViewModel;
var errors = new List<TableDesignerIssue>();
var existingNames = new HashSet<string>();
for (int i = 0; i < table.Indexes.Items.Count; i++)
{
var index = table.Indexes.Items[i];
if (existingNames.Contains(index.Name))
{
errors.Add(new TableDesignerIssue()
{
Description = string.Format("The name '{0}' is already used by another index. Row number: {1}.", index.Name, i + 1),
PropertyPath = new object[] { TablePropertyNames.Indexes, i, IndexPropertyNames.Name }
});
}
else
{
existingNames.Add(index.Name);
}
}
return errors;
}
}
public class EdgeConstraintMustHaveClausesRule : ITableDesignerValidationRule
{
public List<TableDesignerIssue> Run(Dac.TableDesigner designer)
{
var table = designer.TableViewModel;
var errors = new List<TableDesignerIssue>();
for (int i = 0; i < table.EdgeConstraints.Items.Count; i++)
{
var edgeConstraint = table.EdgeConstraints.Items[i];
if (edgeConstraint.Clauses.Count == 0)
{
errors.Add(new TableDesignerIssue()
{
Description = string.Format("Edge constraint '{0}' does not have any clauses specified.", edgeConstraint.Name),
PropertyPath = new object[] { TablePropertyNames.EdgeConstraints, i }
});
}
}
return errors;
}
}
public class EdgeConstraintNoRepeatingClausesRule : ITableDesignerValidationRule
{
public List<TableDesignerIssue> Run(Dac.TableDesigner designer)
{
var table = designer.TableViewModel;
var errors = new List<TableDesignerIssue>();
for (int i = 0; i < table.EdgeConstraints.Items.Count; i++)
{
var edgeConstraint = table.EdgeConstraints.Items[i];
var existingPairs = new HashSet<string>();
for (int j = 0; j < edgeConstraint.Clauses.Count; j++)
{
var clause = edgeConstraint.Clauses[j];
var pair = string.Format("{0} - {1}", clause.FromTable, clause.ToTable);
if (existingPairs.Contains(pair))
{
errors.Add(new TableDesignerIssue()
{
Description = string.Format("The pair '{0}' is already defined by another clause in the edge constraint. Row number: {1}.", pair, j + 1),
PropertyPath = new object[] { TablePropertyNames.EdgeConstraints, i, EdgeConstraintPropertyNames.Clauses, j, EdgeConstraintClausePropertyNames.FromTable }
});
}
else
{
existingPairs.Add(pair);
}
}
}
return errors;
}
}
public class MemoryOptimizedTableMustHaveNonClusteredPrimaryKeyRule : ITableDesignerValidationRule
{
public List<TableDesignerIssue> Run(Dac.TableDesigner designer)
{
var table = designer.TableViewModel;
var errors = new List<TableDesignerIssue>();
if (table.IsMemoryOptimized && (table.PrimaryKey == null || table.PrimaryKey.IsClustered))
{
errors.Add(new TableDesignerIssue()
{
Description = "Memory-optimized table must have non-clustered primary key.",
PropertyPath = new object[] { TablePropertyNames.PrimaryKeyIsClustered }
});
}
return errors;
}
}
public class TemporalTableMustHavePrimaryKeyRule : ITableDesignerValidationRule
{
public List<TableDesignerIssue> Run(Dac.TableDesigner designer)
{
var table = designer.TableViewModel;
var errors = new List<TableDesignerIssue>();
if (table.SystemVersioningHistoryTable != null && table.PrimaryKey == null)
{
errors.Add(new TableDesignerIssue()
{
Description = "System versioned table must have primary key."
});
}
return errors;
}
}
public class TemporalTableMustHavePeriodColumns : ITableDesignerValidationRule
{
public List<TableDesignerIssue> Run(Dac.TableDesigner designer)
{
var table = designer.TableViewModel;
var errors = new List<TableDesignerIssue>();
if (table.SystemVersioningHistoryTable != null && !table.PeriodColumnsDefined)
{
errors.Add(new TableDesignerIssue()
{
Description = "System versioned table must have the period columns defined.",
MoreInfoLink = "https://docs.microsoft.com/sql/relational-databases/tables/creating-a-system-versioned-temporal-table"
});
}
return errors;
}
}
public class PeriodColumnsRule : ITableDesignerValidationRule
{
public List<TableDesignerIssue> Run(Dac.TableDesigner designer)
{
var table = designer.TableViewModel;
var errors = new List<TableDesignerIssue>();
var rowStart = table.Columns.Items.Where(c => c.GeneratedAlwaysAs == ColumnGeneratedAlwaysAsType.GeneratedAlwaysAsRowStart);
var rowEnd = table.Columns.Items.Where(c => c.GeneratedAlwaysAs == ColumnGeneratedAlwaysAsType.GeneratedAlwaysAsRowEnd);
if (rowStart.Count() > 1 || rowEnd.Count() > 1)
{
errors.Add(new TableDesignerIssue()
{
Description = "Period columns (Generated Always As Row Start/End) can only be defined once."
});
}
else if (rowEnd.Count() != rowStart.Count())
{
errors.Add(new TableDesignerIssue()
{
Description = "Period columns (Generated Always As Row Start/End) must be defined as pair. If one is defined, the other must also be defined"
});
}
return errors;
}
}
public class ColumnsInPrimaryKeyCannotBeNullableRule : ITableDesignerValidationRule
{
public List<TableDesignerIssue> Run(Dac.TableDesigner designer)
{
var table = designer.TableViewModel;
var errors = new List<TableDesignerIssue>();
for (int i = 0; i < table.Columns.Items.Count; i++)
{
var column = table.Columns.Items[i];
if (column.IsPrimaryKey && column.IsNullable)
{
errors.Add(new TableDesignerIssue()
{
Description = "Columns in primary key cannot be nullable.",
PropertyPath = new object[] { TablePropertyNames.Columns, i }
});
}
}
return errors;
}
}
public class OnlyDurableMemoryOptimizedTableCanBeSystemVersionedRule : ITableDesignerValidationRule
{
public List<TableDesignerIssue> Run(Dac.TableDesigner designer)
{
var table = designer.TableViewModel;
var errors = new List<TableDesignerIssue>();
if (table.Durability == TableDurability.SchemaOnly && table.IsMemoryOptimized && table.IsSystemVersioningEnabled)
{
errors.Add(new TableDesignerIssue()
{
Description = "Only durable (DURABILITY = SCHEMA_AND_DATA) memory-optimized tables can be system-versioned."
});
}
return errors;
}
}
public class TableMustHaveAtLeastOneColumnRule : ITableDesignerValidationRule
{
public List<TableDesignerIssue> Run(Dac.TableDesigner designer)
{
var table = designer.TableViewModel;
var errors = new List<TableDesignerIssue>();
if (!table.IsEdge && table.Columns.Items.Count == 0)
{
errors.Add(new TableDesignerIssue()
{
Description = "A table must have at least one column defined."
});
}
return errors;
}
}
public class MemoryOptimizedTableIdentityColumnRule : ITableDesignerValidationRule
{
public List<TableDesignerIssue> Run(Dac.TableDesigner designer)
{
var table = designer.TableViewModel;
var errors = new List<TableDesignerIssue>();
if (table.IsMemoryOptimized)
{
for (int i = 0; i < table.Columns.Items.Count; i++)
{
var column = table.Columns.Items[i];
if (column.IsIdentity && (column.IdentitySeed != 1 || column.IdentityIncrement != 1))
{
var propertyName = column.IdentitySeed != 1 ? TableColumnPropertyNames.IdentitySeed : TableColumnPropertyNames.IdentityIncrement;
errors.Add(new TableDesignerIssue()
{
Description = "The use of seed and increment values other than 1 is not supported with memory optimized tables.",
PropertyPath = new object[] { TablePropertyNames.Columns, i, propertyName }
});
}
}
}
return errors;
}
}
public class TableShouldAvoidHavingMultipleEdgeConstraintsRule : ITableDesignerValidationRule
{
public List<TableDesignerIssue> Run(Dac.TableDesigner designer)
{
var table = designer.TableViewModel;
var errors = new List<TableDesignerIssue>();
if (table.EdgeConstraints.Items.Count > 1)
{
errors.Add(new TableDesignerIssue()
{
Description = "The table has more than one edge constraint on it. This is only useful as a temporary state when modifying existing edge constraints, and should not be used in other cases.",
Severity = Contracts.IssueSeverity.Warning,
MoreInfoLink = "https://docs.microsoft.com/sql/relational-databases/tables/graph-edge-constraints"
});
}
return errors;
}
}
public class ColumnCannotBeListedMoreThanOnceInPrimaryKeyRule : ITableDesignerValidationRule
{
public List<TableDesignerIssue> Run(Dac.TableDesigner designer)
{
var table = designer.TableViewModel;
var errors = new List<TableDesignerIssue>();
if (table.PrimaryKey != null)
{
var existingNames = new HashSet<string>();
for (int i = 0; i < table.PrimaryKey.Columns.Count; i++)
{
var columnSpec = table.PrimaryKey.Columns[i];
if (existingNames.Contains(columnSpec.Column))
{
errors.Add(new TableDesignerIssue()
{
Description = string.Format("Cannot use duplicate column names in primary key, column name: {0}", columnSpec.Column),
PropertyPath = new object[] { TablePropertyNames.PrimaryKeyColumns, i, IndexColumnSpecificationPropertyNames.Column }
});
}
else
{
existingNames.Add(columnSpec.Column);
}
}
}
return errors;
}
}
public class MemoryOptimizedCannotBeEnabledWhenNotSupportedRule : ITableDesignerValidationRule
{
public List<TableDesignerIssue> Run(Dac.TableDesigner designer)
{
var table = designer.TableViewModel;
var errors = new List<TableDesignerIssue>();
if (!designer.IsMemoryOptimizedTableSupported && designer.TableViewModel.IsMemoryOptimized)
{
errors.Add(new TableDesignerIssue()
{
Description = string.Format("Memory-optimized table is not supported for this database."),
PropertyPath = new object[] { TablePropertyNames.IsMemoryOptimized },
MoreInfoLink = designer.IsAzure
? "https://docs.microsoft.com/en-us/azure/azure-sql/in-memory-oltp-overview"
: "https://docs.microsoft.com/en-us/sql/relational-databases/in-memory-oltp/overview-and-usage-scenarios"
});
}
return errors;
}
}
}