DacServices.Extract Method (String, String, String, Version, String, IEnumerable<Tuple<String, String>>, DacExtractOptions, Nullable<CancellationToken>)

Extracts the schema from a database into a package.

Namespace:  Microsoft.SqlServer.Dac
Assembly:  Microsoft.SqlServer.Dac (in Microsoft.SqlServer.Dac.dll)

Syntax

'Declaration
Public Sub Extract ( _
    packageFileName As String, _
    databaseName As String, _
    applicationName As String, _
    applicationVersion As Version, _
    applicationDescription As String, _
    tables As IEnumerable(Of Tuple(Of String, String)), _
    extractOptions As DacExtractOptions, _
    cancellationToken As Nullable(Of CancellationToken) _
)
'Usage
Dim instance As DacServices 
Dim packageFileName As String 
Dim databaseName As String 
Dim applicationName As String 
Dim applicationVersion As Version 
Dim applicationDescription As String 
Dim tables As IEnumerable(Of Tuple(Of String, String))
Dim extractOptions As DacExtractOptions 
Dim cancellationToken As Nullable(Of CancellationToken)

instance.Extract(packageFileName, databaseName, _
    applicationName, applicationVersion, _
    applicationDescription, tables, _
    extractOptions, cancellationToken)

public void Extract(
    string packageFileName,
    string databaseName,
    string applicationName,
    Version applicationVersion,
    string applicationDescription,
    IEnumerable<Tuple<string, string>> tables,
    DacExtractOptions extractOptions,
    Nullable<CancellationToken> cancellationToken
)

public:
void Extract(
    String^ packageFileName, 
    String^ databaseName, 
    String^ applicationName, 
    Version^ applicationVersion, 
    String^ applicationDescription, 
    IEnumerable<Tuple<String^, String^>^>^ tables, 
    DacExtractOptions^ extractOptions, 
    Nullable<CancellationToken> cancellationToken
)

member Extract : 
        packageFileName:string * 
        databaseName:string * 
        applicationName:string * 
        applicationVersion:Version * 
        applicationDescription:string * 
        tables:IEnumerable<Tuple<string, string>> * 
        extractOptions:DacExtractOptions * 
        cancellationToken:Nullable<CancellationToken> -> unit

public function Extract(
    packageFileName : String, 
    databaseName : String, 
    applicationName : String, 
    applicationVersion : Version, 
    applicationDescription : String, 
    tables : IEnumerable<Tuple<String, String>>, 
    extractOptions : DacExtractOptions, 
    cancellationToken : Nullable<CancellationToken>
)

Parameters

• packageFileName
  Type: String
  The path to the package file to be created.

• databaseName
  Type: String
  The name of the source database.

• applicationName
  Type: String
  The string identifier for the DAC application.

• applicationVersion
  Type: Version
  The version of the DAC application.

• applicationDescription
  Type: String
  The optional string summary of the DAC application.

• tables
  Type: IEnumerable<Tuple<String, String>>
  The optional enumerable used to retrieve enumerator over set of tables for which reference data should be stored. For each Tuple in the enumeration the first item specifies the schema of the table, and the second specifies the base identifier of the table. If the value for this parameter is a null reference, no reference data will be stored.

• extractOptions
  Type: Microsoft.SqlServer.Dac.DacExtractOptions
  The optional DacExtractOptions instance used to specify options that affect the behavior of package extraction.

• cancellationToken
  Type: Nullable<CancellationToken>
  The optional CancellationToken that can be used to indicate that the operation should be cancelled. Use of this object does not guarantee that the operation will be cancelled.

Exceptions

See Also

Reference

DacServices Class

Extract Overload

Microsoft.SqlServer.Dac Namespace