DataGenerationServices Class

This abstract base class is responsible for providing database schema provider-specific information to the data generation feature to enable data generation for that provider.

Inheritance Hierarchy

System.Object
  Microsoft.Data.Schema.Tools.DataGenerator.DataGenerationServices

Namespace:  Microsoft.Data.Schema.Tools.DataGenerator
Assembly:  Microsoft.Data.Schema.Tools (in Microsoft.Data.Schema.Tools.dll)

Syntax

'Declaration
Public MustInherit Class DataGenerationServices _
    Implements IExtensionInformation, IExtension

public abstract class DataGenerationServices : IExtensionInformation, 
    IExtension

public ref class DataGenerationServices abstract : IExtensionInformation, 
    IExtension

[<AbstractClass>]
type DataGenerationServices =  
    class
        interface IExtensionInformation
        interface IExtension
    end

public abstract class DataGenerationServices implements IExtensionInformation, IExtension

The DataGenerationServices type exposes the following members.

Constructors

	Name	Description
	DataGenerationServices	Called from constructors in derived classes to initialize the DataGenerationServices class.

Top

Properties

	Name	Description
	ExtensionHandle	Gets the extension handle for this extension.

Top

Methods

	Name	Description
	Annotate	Analyzes the provided table and attaches data generation annotations to specify the configuration information for each column.
	AvailableColumnTypes	Returns a list of database data types that you choose to make available to define columns in Visual Studio.
	AvailableExtensionTypes	Returns a read-only collection of extended data types that you want to make available for use in the Tools Options dialog box.
	Equals	Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
	FilterGenerators	Removes output descriptors from the provided list of possible output descriptors for the provided column.
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	GetAnnotationsIncludedInSerialization	Returns a list of types of annotations that are included when a data generation plan is serialized.
	GetCopiedAnnotationTypes	Called when Visual Studio synchronizes a data generation plan with the existing project schema. This method enables Visual Studio to copy annotations from the project model to the data generation model.
	GetDbTypeExtension	Returns a type that represents an extended database type output to which you want the provided column to be mapped.
	GetDefaultForeignKeyGenerator	Returns a specific foreign key generator that is designated as the default.
	GetGeneratorInput	Returns a value for the provided column that is based on the provided AutoAssignedInput member.
	GetHashCode	Serves as a hash function for a particular type. (Inherited from Object.)
	GetModelCopyConfiguration	Gets the configuration for the elements in the provided data schema model.
	GetPreferredDataSink	Determines what occurs with the data that is generated from the data generation plan.
	GetReferencedColumn	Returns a list of columns that the provided column references.
	GetReferencedTables	Returns a list of tables that the provided table references, optionally including any self references.
	GetReferencingTables	Returns a list of tables that reference the provided table, optionally including any self references.
	GetRelevantModelClasses	Used to determine the set of model element changes to which the data generation plan will respond.
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	GetTypesExcludedFromComparison	Identifies the elements to be removed from the model comparison to the target database.
	InitializeModelComparerConstructor	Allows the developer to make any modifications to the comparer constructor that are specific to the data model.
	InitializePlanModelConstructor
	InitializeVerificationModelConstructor	Allows the developer to make any modifications to the provided reverse engineer constructor that are specific to the provided data model when the data plan is validated against the target database.
	IsNewColumnSelected	Determines whether the provided newly created, or newly loaded, column appears as selected for data generation.
	MapColumnToDbTypes	Returns a list of your choices for the most appropriate data types for the provided column.
	MapColumnToDefaultDbType	Returns the database data type that you want to use as the default for the provided column.
	MapGeneratorOutputToDbTypes	Returns an array of database data types that you judge to be appropriate to map output for the given custom database type.
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	PopulateDefaultMappings	Returns your choices for the specific default mappings of database data types to output descriptors by using the provided list of available generator to output descriptor mappings. It returns your choices for the specific default mappings of database data types to output descriptors, and the default mappings of extended database data types to output descriptors.
	SetExtensionHandle	Sets the extension handle for the current object.
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Top

Remarks

Writers of database schema providers implement this class to enable data generation for their provider. Developers of data generators do not have to implement this class. Most of the methods in this class are called by the Tools Options user interface in Visual Studio.

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.Tools.DataGenerator Namespace

Other Resources

Creating Custom Data Generators

An Overview of Data Generator Extensibility