SqlSchemaModel Class

The base class for schema managers for SQL Server databases.

Inheritance Hierarchy

System.Object
  Microsoft.Data.Schema.SchemaModel.ModelStore
    Microsoft.Data.Schema.SchemaModel.DataSchemaModel
      Microsoft.Data.Schema.Sql.SchemaModel.SqlSchemaModel
        Microsoft.Data.Schema.Sql.SchemaModel.Sql100SchemaModel
        Microsoft.Data.Schema.Sql.SchemaModel.Sql80SchemaModel
        Microsoft.Data.Schema.Sql.SchemaModel.Sql90SchemaModel

Namespace:  Microsoft.Data.Schema.Sql.SchemaModel
Assembly:  Microsoft.Data.Schema.Sql (in Microsoft.Data.Schema.Sql.dll)

Syntax

'Declaration
<SerializableAttribute> _
Public MustInherit Class SqlSchemaModel _
    Inherits DataSchemaModel

[SerializableAttribute]
public abstract class SqlSchemaModel : DataSchemaModel

[SerializableAttribute]
public ref class SqlSchemaModel abstract : public DataSchemaModel

[<AbstractClass>]
[<SerializableAttribute>]
type SqlSchemaModel =  
    class
        inherit DataSchemaModel
    end

public abstract class SqlSchemaModel extends DataSchemaModel

The SqlSchemaModel type exposes the following members.

Constructors

	Name	Description
	SqlSchemaModel(SerializationInfo, StreamingContext)	Initializes a new instance of the SqlSchemaModel class.
	SqlSchemaModel(ModelCollation, ModelSchema, String, ScriptCache, ErrorManager, Boolean, SqlModelCapability)	Initializes a new instance of the SqlSchemaModel class.

Top

Properties

	Name	Description
	AnnotationsIncludedInSerialization	Gets a value that indicates whether annotations are included when the model is serialized. (Overrides DataSchemaModel.AnnotationsIncludedInSerialization.)
	Capability	Gets a value that indicates what capabilities this model has.
	Collation	(Inherited from ModelStore.)
	Comparer	Gets the collation comparer object. (Inherited from ModelStore.)
	Controller	Gets the model controller. (Inherited from DataSchemaModel.)
	DatabaseSchemaProvider	Gets the database schema provider. (Inherited from DataSchemaModel.)
	ElementProcessingOperationsCount	Gets the number of operations that remain before the model is resolved. (Overrides DataSchemaModel.ElementProcessingOperationsCount.)
	ErrorManager	Gets the error manager to report errors. (Inherited from DataSchemaModel.)
	IsDisposing	(Inherited from ModelStore.)
	IsOptimizedForInsert	(Inherited from ModelStore.)
	IsOptimizedForQuery	(Inherited from ModelStore.)
	Schema	(Inherited from ModelStore.)
	ScriptCache	Gets the script cache to cache scripts. (Inherited from DataSchemaModel.)
	SqlDatabaseSchemaProvider	Gets the database schema provider for this model.
	ValidationEnabled	Gets a value that indicates whether validation is enabled for this schema model.
	WriteCount	Returns the value of the current write count. (Inherited from ModelStore.)

Top

Methods

	Name	Description
	AddAnnotation	Adds an annotation to the model. (Inherited from ModelStore.)
	AddCustomData	Adds custom data to the model. (Inherited from DataSchemaModel.)
	AddScriptCacheForFile
	BeginBatchUpdate	Called at the beginning of a batch update operation. (Overrides DataSchemaModel.BeginBatchUpdate().)
	CleanupExternalProperty	When implemented in a derived class, releases resources that are used by an external property when the element is deleted. (Inherited from ModelStore.)
	CreateAnnotation(Type)	(Inherited from ModelStore.)
	CreateAnnotation(ModelAnnotationClass)	Creates an annotation by using the given annotation metadata. (Inherited from ModelStore.)
	CreateAnnotation<TAnnotation>()	(Inherited from ModelStore.)
	CreateElement(Type)	(Inherited from ModelStore.)
	CreateElement(ModelElementClass)	Creates an element by using the given element metadata object. (Inherited from ModelStore.)
	CreateElement<TElement>()	(Inherited from ModelStore.)
	CreateElementHandle	(Inherited from ModelStore.)
	CreateExternalElement(Type)	Creates an external element. (Inherited from ModelStore.)
	CreateExternalElement(ModelElementClass)	Creates an external element by using the provided element metadata object. (Inherited from ModelStore.)
	CreateExternalElement<TElement>()	Creates an external element of the specified type. (Inherited from ModelStore.)
	CreateExternalNamedElement(Type, ModelIdentifier)	Creates a named external element by using the provided type and identifier. (Inherited from ModelStore.)
	CreateExternalNamedElement(ModelElementClass, ModelIdentifier)	Creates a named external element by using the provided element metadata object and identifier. (Inherited from ModelStore.)
	CreateExternalNamedElement<TElement>(ModelIdentifier)	Creates a named external element of the specified type by using the provided element metadata object and identifier. (Inherited from ModelStore.)
	CreateIdentifier(ICollection<String>)	Creates a unique model identifier by using the provided collection of part names. (Inherited from ModelStore.)
	CreateIdentifier(array<String[])	Creates a unique model identifier by using the provided array of part names. (Inherited from ModelStore.)
	CreateIdentifier(Boolean, ICollection<String>)	Creates a unique model identifier by using the provided collection of name parts. (Inherited from ModelStore.)
	CreateIdentifier(Boolean, array<String[])	Creates a unique model identifier by using the provided case-sensitive indication and array of part names. (Inherited from ModelStore.)
	CreateIdentifier(IList<String>, ICollection<String>)	Creates a unique model identifier by using the provided list of external part names, indication of case sensitivity, and collection of part names. (Inherited from ModelStore.)
	CreateIdentifier(IList<String>, Boolean, ICollection<String>)	Creates a unique model identifier by using the provided list of external parts, indication of case sensitivity, and collection of part names. (Inherited from ModelStore.)
	CreateIdentifier(IList<String>, Boolean, array<String[])	Creates a unique model identifier by using the provided list of external part names, indication of case sensitivity, and array of part names. (Inherited from ModelStore.)
	CreateIdentifierHandle	Creates a handle for the provided identifier. (Inherited from ModelStore.)
	CreateNamedAnnotation(Type, ModelIdentifier)	Creates a named ModelAnnotation object by using the provided model identifier. (Inherited from ModelStore.)
	CreateNamedAnnotation(ModelAnnotationClass, ModelIdentifier)	Creates a named ModelAnnotation object by using the provided annotation metadata object and identifier. (Inherited from ModelStore.)
	CreateNamedAnnotation<TAnnotation>(ModelIdentifier)	Creates a named ModelAnnotation object by using the provided model identifier. (Inherited from ModelStore.)
	CreateNamedElement(Type, ModelIdentifier)	(Inherited from ModelStore.)
	CreateNamedElement(ModelElementClass, ModelIdentifier)	(Inherited from ModelStore.)
	CreateNamedElement<TElement>(ModelIdentifier)	(Inherited from ModelStore.)
	DecodeIdentifier(String)	Returns an identifier that corresponds to the decoded value of the provided string. (Inherited from ModelStore.)
	DeserializeExternalProperty	Deserializes any external properties that are supported by SqlSchemaModel. (Overrides ModelStore.DeserializeExternalProperty(XmlReader, ModelPropertyClass).)
	Dispose()	Disposes the model. (Inherited from ModelStore.)
	Dispose(Boolean)	Releases resources. (Overrides DataSchemaModel.Dispose(Boolean).)
	EndBatchUpdate	Called at the end of a batch update operation. (Overrides DataSchemaModel.EndBatchUpdate().)
	Equals	Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
	Finalize	(Inherited from ModelStore.)
	FixupAfterDeserialization	Performs additional actions to guarantee model consistency after deserialization from a .dbmdl file. (Overrides ModelStore.FixupAfterDeserialization().)
	FixupAfterXmlDeserialization	Performs additional actions to guarantee model consistency after deserialization from an XML file. (Overrides DataSchemaModel.FixupAfterXmlDeserialization().)
	FreeElementHandle	Frees the provided element handle. (Inherited from ModelStore.)
	FreeIdentifierHandle	Frees the provided element handle. (Inherited from ModelStore.)
	GetAllAnnotations()	Returns a list of all annotations. (Inherited from ModelStore.)
	GetAllAnnotations(Type)	(Inherited from ModelStore.)
	GetAllAnnotations(ModelIdentifier)	Returns a list of all annotations that are named with the provided identifier. (Inherited from ModelStore.)
	GetAllAnnotations(ModelIdentifier, Type)	(Inherited from ModelStore.)
	GetAnnotations()	Returns all the annotations on the model. (Inherited from ModelStore.)
	GetAnnotations(Type)	Returns a list of the annotations on the model that implements the given type. (Inherited from ModelStore.)
	GetAnnotations(ModelIdentifier)	Returns a list of the annotations on the model that matches the given identifiers. (Inherited from ModelStore.)
	GetAnnotations(ModelIdentifier, Type)	Returns all annotations that have the given identifier name, and that implement the given type. (Inherited from ModelStore.)
	GetCustomData()	Gets a list of custom data. (Inherited from DataSchemaModel.)
	GetCustomData(String)	Gets a list of custom data by using the provided category. (Inherited from DataSchemaModel.)
	GetCustomData(String, String)	Gets a list of custom data by using the provided category and type name. (Inherited from DataSchemaModel.)
	GetElementHandleTarget	Returns a model element that is identified by the provided handle. (Inherited from ModelStore.)
	GetElements(ModelElementResolutionStatus)	Returns a list of the elements in the store that has the given resolution status. (Inherited from ModelStore.)
	GetElements(ModelElementValidationStatus)	Returns a list of the elements in the store that has the given validation status. (Inherited from ModelStore.)
	GetElements(Type, ModelElementQueryFilter)	(Inherited from ModelStore.)
	GetElements(ModelElementClass, ModelElementQueryFilter)	Returns elements that share the given metadata object as selected by the given filter. (Inherited from ModelStore.)
	GetElements(ModelElementResolutionStatus, Int32)	Returns a list of the elements that aredetermined by the count that has the given resolution status. (Inherited from ModelStore.)
	GetElements(ModelElementValidationStatus, Int32)	Returns a list of the elements that are determined by the count that has the given validation status. (Inherited from ModelStore.)
	GetElements(ModelIdentifier, ModelElementClass, ModelElementQueryFilter)	(Inherited from ModelStore.)
	GetElements(ModelIdentifier, ModelIdentifierGroup, ModelElementQueryFilter)	(Inherited from ModelStore.)
	GetElements(ModelIdentifier, Type, ModelElementQueryFilter)	(Inherited from ModelStore.)
	GetElements<TElement>(ModelElementQueryFilter)	(Inherited from ModelStore.)
	GetElements<TElement>(ModelIdentifier, ModelElementQueryFilter)	(Inherited from ModelStore.)
	GetElementsCount(ModelElementResolutionStatus)	Returns the number of elements in the store that match the given status. (Inherited from ModelStore.)
	GetElementsCount(ModelElementValidationStatus)	Returns the number of elements in the store that match the given status. (Inherited from ModelStore.)
	GetElementsFrom(String, ModelElementClass, ModelElementQueryFilter)	(Inherited from ModelStore.)
	GetElementsFrom(String, Type, ModelElementQueryFilter)	(Inherited from ModelStore.)
	GetElementsFrom<TElement>(String, ModelElementQueryFilter)	(Inherited from ModelStore.)
	GetElementsFromExternalSource	Gets the elements from an external source. (Inherited from DataSchemaModel.)
	GetElementSources	Returns the source information for a particular element. (Overrides DataSchemaModel.GetElementSources(IModelElement).)
	GetExternalProperty<TProperty>	Gets an external property of a particular class for the specified model element. (Overrides ModelStore.GetExternalProperty<TProperty>(IModelElement, ModelPropertyClass).)
	GetHashCode	Serves as a hash function for a particular type. (Inherited from Object.)
	GetIdentifier(ICollection<String>)	(Inherited from ModelStore.)
	GetIdentifier(array<String[])	Gets the identifier from the model by scope ID and a string. (Inherited from ModelStore.)
	GetIdentifier(IList<String>, ICollection<String>)	(Inherited from ModelStore.)
	GetIdentifierHandleTarget	(Inherited from ModelStore.)
	GetObjectData	Populates a [System.Runtime.Serialization.SerializationInfo] object with the data that are required to serialize the current SqlSchemaModel object. (Overrides DataSchemaModel.GetObjectData(SerializationInfo, StreamingContext).)
	GetRelationshipEntrySources	Returns the source information for a particular relationship entry. (Overrides DataSchemaModel.GetRelationshipEntrySources(IModelRelationshipEntry).)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	InitializeReferenceConstructor	Called to initialize the reference constructor. (Overrides DataSchemaModel.InitializeReferenceConstructor(DataSchemaModelHeader, DataSchemaModelConstructor).)
	IsOwnedChildObjectType	Returns a value that indicates whether a type is a schema-bound child object.
	IsOwnedObjectType	Returns a value that indicates whether a type is a schema-bound object.
	LoadExternals	Loads model elements from an external sources, such as a persisted model. (Inherited from DataSchemaModel.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	OnCustomDataAdded	Override this method to handle addition of SqlModelCapability data. (Overrides DataSchemaModel.OnCustomDataAdded(CustomSchemaData).)
	OnCustomDataRemoved	Override this method to handle removal of extra names (from elements marked as AliasedToDbo or GloballyScoped) if a reference is removed. (Overrides DataSchemaModel.OnCustomDataRemoved(CustomSchemaData).)
	OnModelElementChanged	Called when a model element changes. (Inherited from DataSchemaModel.)
	OptimizeForInitialPopulation	(Inherited from ModelStore.)
	OptimizeForQuery	(Inherited from ModelStore.)
	RegisterForController	Registers for a model controller. (Inherited from DataSchemaModel.)
	RemoveAnnotation	Removes an annotation from the model. (Inherited from ModelStore.)
	RemoveCustomData	Removes custom data. (Inherited from DataSchemaModel.)
	RemoveScriptCacheForFile	Removes the script cache that is associated with the specified file.
	Resolve()	Resolves all of the elements in the model. (Overrides DataSchemaModel.Resolve().)
	Resolve(Int32)	Resolves the specified number of elements. (Overrides DataSchemaModel.Resolve(Int32).)
	Serialize(TextWriter)	(Inherited from DataSchemaModel.)
	Serialize(TextWriter, IEnumerable<Type>)	(Inherited from DataSchemaModel.)
	Serialize(TextWriter, IEnumerable<Type>, Boolean)	Writes the data schema model to the specified output. (Inherited from DataSchemaModel.)
	SerializeExternalProperty	Serializes any external properties that are supported by SqlSchemaModel. (Overrides ModelStore.SerializeExternalProperty(XmlWriter, ModelPropertyClass, Object).)
	SetExternalProperty<TProperty>(IModelElement, ModelPropertyClass, TProperty)	(Inherited from ModelStore.)
	SetExternalProperty<TProperty>(IModelElement, ModelPropertyClass, TProperty)	(Overrides ModelStore.SetExternalProperty<TProperty>(IModelElement, ModelPropertyClass, TProperty).)
	TestWriteCount	Tests the write count with the given value. (Inherited from ModelStore.)
	ToString	Returns a string that represents the current object. (Inherited from Object.)
	UnloadExternals	Unloads external elements from the specified file. (Inherited from DataSchemaModel.)
	UpdateSourceNamePrefixes	(Inherited from ModelStore.)
	ValidateWriteAccess	Validates write access. (Inherited from DataSchemaModel.)
	ValidReferenceTranslator	Returns a value that indicates whether a reference translator can be used translate from another database schema provider to the current one. (Inherited from DataSchemaModel.)

Top

Events

	Name	Description
	ModelChanged	(Inherited from ModelStore.)
	ModelOptimizationChanged	(Inherited from ModelStore.)

Top

Fields

	Name	Description
	AnsiNullsCategory	A constant that is used by the schema model.
	ClrAssemblyIsCheckingDataDisabled	A constant that is used by the schema model.
	ClrAssemblyIsVisible	A constant that is used by the schema model.
	ClrAssemblyName	A constant that is used by the schema model.
	ClrAssemblyOwner	A constant that is used by the schema model.
	ClrAssemblyPermissionSet	A constant that is used by the schema model.
	ClrAssemblyPermissionSetExternalAccess	A constant that is used by the schema model.
	ClrAssemblyPermissionSetSafe	A constant that is used by the schema model.
	ClrAssemblyPermissionSetUnsafe	A constant that is used by the schema model.
	ClrAssemblyType	A constant that is used by the schema model.
	CompatibilityModeCategory	A constant that is used by the schema model.
	ModelCapabilityCategory	A constant that is used by the schema model.
	PermissionsCategory	A constant that is used by the schema model.
	PermissionsType	A constant that is used by the schema model.
	QuotedIdentifierCategory	A constant that is used by the schema model.
	XsdRelationalSchema	A constant that is used by the schema model.
	XsdType	A constant that is used by the schema model.
	XsdXmlSchemaCollectionName	A constant that is used by the schema model.

Top

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

See Also

Reference

Microsoft.Data.Schema.Sql.SchemaModel Namespace