SqlImportScriptService Class

This service is offered to allow other database features to import scripts.

This API is not CLS-compliant. 

Inheritance Hierarchy

System.Object
  Microsoft.VisualStudio.Data.Schema.Package.Sql.Project.SqlImportScriptService

Namespace:  Microsoft.VisualStudio.Data.Schema.Package.Sql.Project
Assembly:  Microsoft.VisualStudio.Data.Schema.Package.Sql (in Microsoft.VisualStudio.Data.Schema.Package.Sql.dll)

Syntax

'Declaration
<CLSCompliantAttribute(False)> _
Public NotInheritable Class SqlImportScriptService
[CLSCompliantAttribute(false)]
public sealed class SqlImportScriptService
[CLSCompliantAttribute(false)]
public ref class SqlImportScriptService sealed
[<Sealed>]
[<CLSCompliantAttribute(false)>]
type SqlImportScriptService =  class end
public final class SqlImportScriptService

The SqlImportScriptService type exposes the following members.

Properties

  Name Description
Public property AddImportedPermissionsToModel Gets a value indicating whether to add imported permissions to the model.
Public property Completed Gets a value that indicates whether the import operation was successfully completed.
Public property Encoding Gets the file encoding.
Public property IgnoreExtendedProperties Ignore extended properties.
Public property IgnorePermissions Ignore permissions.
Public property Messages Gets a list of messages that were generated during the import operation.
Public property OverwriteExistingObjects Gets a value indicating whether to overwrite existing objects.
Public property ScriptFileName Gets the file name to import.
Public property ThrownException Gets the exception that can be thrown during the operation.
Public property WasCanceled Gets a value that indicates whether the import operation was canceled.

Top

Methods

  Name Description
Public method DoImportScript This method performs the import operation based on the properties of this object.
Public method Equals Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected method Finalize Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public method GetHashCode Serves as a hash function for a particular type. (Inherited from Object.)
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Public method ToString Returns a string that represents the current object. (Inherited from Object.)

Top

Events

  Name Description
Public event Canceled This event is used to indicate that the engine was canceled.
Public event MessageGenerated This event is used to provide messages back to the creator of this engine.
Public event PlanCreated This event indicates that the initial import of the objects has been completed and the engine is ready to update the project.
Public event Progress This event is used to indicate the progress of the import operation.
Public event ProjectUpdated This event indicates that the project has been updated with any new scripts.

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.VisualStudio.Data.Schema.Package.Sql.Project Namespace