Share via

TSqlObject.GetScript 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

Generates a CREATE script from the objects AST. AST generation is only supported for top-level objects, with certain objects such as the DatabaseOptions and inline constraints not supporting AST generation even though they are top level types. If it's unknown whether the object is capable of being scripted then the TryGetAst(TSqlScript) method should be used instead.

public string GetScript ();
member this.GetScript : unit -> string
Public Function GetScript () As String

Returns

String

DDL Creation script

Exceptions

DacModelException

If TSqlObject is not a top level statement object or if it does not support script generation (for example if it is a DatabaseOptions or a constraint that was originally defined inline with a Table).

Applies to