DataSchemaModel Class

The DataSchemaModel is a specialization of the ModelStore. All database schema providers must implement a class that inherits this base class.

Inheritance Hierarchy

System.Object
  Microsoft.Data.Schema.SchemaModel.ModelStore
    Microsoft.Data.Schema.SchemaModel.DataSchemaModel
      Microsoft.Data.Schema.Sql.SchemaModel.SqlSchemaModel

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

Syntax

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

[SerializableAttribute]
public abstract class DataSchemaModel : ModelStore

[SerializableAttribute]
public ref class DataSchemaModel abstract : public ModelStore

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

public abstract class DataSchemaModel extends ModelStore

The DataSchemaModel type exposes the following members.

Constructors

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

Top

Properties

	Name	Description
	AnnotationsIncludedInSerialization	Gets a list of the types of annotations that will be included when the model is serialized.
	Collation	(Inherited from ModelStore.)
	Comparer	Gets the collation comparer object. (Inherited from ModelStore.)
	Controller	Gets the model controller.
	DatabaseSchemaProvider	Gets the database schema provider.
	ElementProcessingOperationsCount	Gets the number of element-processing operations that remain before the model is ready.
	ErrorManager	Gets the error manager to report errors.
	IsDisposing	(Inherited from ModelStore.)
	IsOptimizedForInsert	(Inherited from ModelStore.)
	IsOptimizedForQuery	(Inherited from ModelStore.)
	Schema	(Inherited from ModelStore.)
	ScriptCache	Gets the script cache to cache scripts.
	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.
	BeginBatchUpdate	Begins batch update.
	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.)
	Deserialize(String, ErrorManager)
	Deserialize(TextReader, ErrorManager, String)
	Deserialize(String, ErrorManager, Action<DataSchemaModelHeader, DatabaseSchemaProvider, DataSchemaModelConstructor>)
	Deserialize(TextReader, ErrorManager, String, Action<DataSchemaModelHeader, DatabaseSchemaProvider, DataSchemaModelConstructor>)
	DeserializeExternalProperty	Returns the value of an external property by using the provided XML reader and property metadata object. (Inherited from ModelStore.)
	Dispose()	Disposes the model. (Inherited from ModelStore.)
	Dispose(Boolean)	(Overrides ModelStore.Dispose(Boolean).)
	EndBatchUpdate	Ends the batch update.
	Equals	Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
	Finalize	(Inherited from ModelStore.)
	FixupAfterDeserialization	(Inherited from ModelStore.)
	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.
	GetCustomData(String)	Gets a list of custom data by using the provided category.
	GetCustomData(String, String)	Gets a list of custom data by using the provided category and type name.
	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.
	GetElementSources	Gets the element sources for a particular element.
	GetExternalProperty<TProperty>	(Inherited from ModelStore.)
	GetExternalSourceFileName	Gets the external source file name for the specified model element.
	GetExternalSourceLogicalName	Gets the logical name for the external source of the specified model element.
	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	Returns a SerializationInfo object that contains all the data that are needed to serialize the DataSchemaModel object. (Overrides ModelStore.GetObjectData(SerializationInfo, StreamingContext).)
	GetRelationshipEntrySources	Gets a list of relationship entry sources.
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	InitializeReferenceConstructor	Initializes a reference constructor by using the provided header data and model constructor.
	IsElementFromCompositeReference	Indicates whether the element is from another schema model that was added to the current model.
	IsElementFromExternalReference(IModelElement)	Indicates whether the specified element is from an external reference.
	IsElementFromExternalReference(IModelElement, String)	Indicates whether the specified element is from an external reference.
	LoadExternals	Loads model elements from an external sources, such as a persisted model.
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	OnCustomDataAdded	Called when custom data is added.
	OnCustomDataRemoved	Called when custom data is removed.
	OnModelElementChanged	Called when a model element changes. (Overrides ModelStore.OnModelElementChanged(IModelElement, ModelEventType).)
	OptimizeForInitialPopulation	(Inherited from ModelStore.)
	OptimizeForQuery	(Inherited from ModelStore.)
	ReadDataSchemaModelHeader(TextReader)	Override this method in a database schema provider implementation to read the data schema model header.
	ReadDataSchemaModelHeader(String)
	ReadDataSchemaModelHeader(TextReader, Boolean)	Override this method in a database schema provider implementation to read the data schema model header.
	ReadDataSchemaModelHeader(String, Boolean)	Override this method in a database schema provider implementation to read the data schema model header.
	RegisterForController	Registers for a model controller.
	RemoveAnnotation	Removes an annotation from the model. (Inherited from ModelStore.)
	RemoveCustomData	Removes custom data.
	Resolve()	Resolves all elements in the model.
	Resolve(Int32)	Resolves the specified number of elements.
	Serialize(TextWriter)
	Serialize(TextWriter, IEnumerable<Type>)
	Serialize(TextWriter, IEnumerable<Type>, Boolean)	Writes the data schema model to the specified output.
	SerializeExternalProperty	(Inherited from ModelStore.)
	SetExternalProperty<TProperty>	(Inherited from ModelStore.)
	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.
	UpdateSourceNamePrefixes	(Inherited from ModelStore.)
	ValidateWriteAccess	Validates write access. (Overrides ModelStore.ValidateWriteAccess().)
	ValidReferenceTranslator	Returns a value that indicates whether a reference translator can be used translate from another database schema provider to the current one.

Top

Events

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

Top

Fields

	Name	Description
	CustomSchemaDataFileName	Value is "FileName".
	CustomSchemaDataLogicalName	Value is "LogicalName".
	DatabaseSchemaReferenceExternalParts	Value is "ExternalParts".
	DatabaseSchemaType	Value is "DbSchema".
	ReferenceCategory	Value is "Reference".
	SuppressMissingDependenciesErrors	Value is "SuppressMissingDependenciesErrors".

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.SchemaModel Namespace

ModelStore