TSqlModel.ConvertToScriptedObject(TSqlObject, String) Method

Reference

Definition

Namespace:: Microsoft.SqlServer.Dac.Model

Assembly:: Microsoft.SqlServer.Dac.Extensions.dll

Package:: Microsoft.SqlServer.DacFx.x64 v140.3881.1

Package:: Microsoft.SqlServer.DacFx v150.5282.3

Package:: Microsoft.SqlServer.DacFx v160.6161.0

Package:: Microsoft.SqlServer.DacFx v162.2.111

Package:: Microsoft.Data.Tools.Msbuild v10.0.61804.210

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Converts a specific top-level object in the model into a scripted representation of itself. This is useful when starting from a database sourced model and the caller wishes to modify this object's contents.

public Microsoft.SqlServer.Dac.Model.TSqlObject ConvertToScriptedObject (Microsoft.SqlServer.Dac.Model.TSqlObject tSqlObject, string sourceName);

member this.ConvertToScriptedObject : Microsoft.SqlServer.Dac.Model.TSqlObject * string -> Microsoft.SqlServer.Dac.Model.TSqlObject

Public Function ConvertToScriptedObject (tSqlObject As TSqlObject, sourceName As String) As TSqlObject

Parameters

tSqlObject: TSqlObject

Object to convert. Must not be null

sourceName: String

Optional source name. If left null a default name will be generated for the object. This name can be found using GetSourceInformation()'s SourceName property.

Returns

TSqlObject

New copy of the TSqlObject, which will now be script-backed. Or if the object was already script-backed, will simply return this object

Exceptions

DacModelException

Thrown if the object could not be scripted out, this class of object is never scriptable, or errors were found in the model during the script process

ArgumentException

If the oject is null, or if whitespace is used for the source name

Applies to