Database.Script Database.Script Database.Script Method

Definition

Generates a Transact-SQL script that can be used to re-create the database.

Overloads

Script() Script() Script()

Generates a Transact-SQL script that can be used to re-create the database.

Script(ScriptingOptions) Script(ScriptingOptions)

Generates a Transact-SQL script that can be used to re-create the database as specified by the script options.

Script() Script() Script()

Generates a Transact-SQL script that can be used to re-create the database.

public:
 virtual System::Collections::Specialized::StringCollection ^ Script();
public System.Collections.Specialized.StringCollection Script ();
Public Function Script () As StringCollection
Returns

A StringCollection system object value that contains a list of Transact-SQL statements in the script.

Implements

Examples

VB

PowerShell

$srv = new-Object Microsoft.SqlServer.Management.Smo.Server("(local)")  
$db = New-Object Microsoft.SqlServer.Management.Smo.Database  
$db = $srv.Databases.Item("AdventureWorks2012")  

$scrp = New-Object Microsoft.SqlServer.Management.Smo.Scripter($srv)  
$scrp.Options.ScriptDrops = $FALSE  
$scrp.Options.WithDependencies = $TRUE  

Foreach ($tb in $db.Tables)  
{  
   $smoObjects = $tb.Urn  
   If ($tb.IsSystemObject -eq $FALSE)  
   {  
      $sc = $scrp.Script($smoObjects)  
      Foreach ($st in $sc)  
      {  
      Write-Host $st  
      }  
   }  
}  

Remarks

The Script method generates a set of Transact-SQL statements that are used to create the database. This method generates a script that can be used to create the database only. The whole database, including dependent objects such as tables, can be scripted by using the Scripter object. The generated script might contain undocumented, internal procedures, which are required for the complete script output.

Script(ScriptingOptions) Script(ScriptingOptions)

Generates a Transact-SQL script that can be used to re-create the database as specified by the script options.

public:
 virtual System::Collections::Specialized::StringCollection ^ Script(Microsoft::SqlServer::Management::Smo::ScriptingOptions ^ scriptingOptions);
public System.Collections.Specialized.StringCollection Script (Microsoft.SqlServer.Management.Smo.ScriptingOptions scriptingOptions);
Parameters
scriptingOptions
ScriptingOptions ScriptingOptions ScriptingOptions

A ScriptingOptions object value that is used to specify the script options.

Returns

A StringCollection system object value that contains a list of Transact-SQL statements in the script.

Implements

Examples

VB

PowerShell

$srv = new-Object Microsoft.SqlServer.Management.Smo.Server("(local)")  
$db = New-Object Microsoft.SqlServer.Management.Smo.Database  
$db = $srv.Databases.Item("AdventureWorks2012")  

$scrp = New-Object Microsoft.SqlServer.Management.Smo.Scripter($srv)  
$scrp.Options.ScriptDrops = $FALSE  
$scrp.Options.WithDependencies = $TRUE  

Foreach ($tb in $db.Tables)  
{  
   $smoObjects = $tb.Urn  
   If ($tb.IsSystemObject -eq $FALSE)  
   {  
      $sc = $scrp.Script($smoObjects)  
      Foreach ($st in $sc)  
      {  
      Write-Host $st  
      }  
   }  
}  

Remarks

The Script method generates a set of Transact-SQL statements that are used to create the database. This method generates a script that can be used to create the database only. The whole database, including dependent objects such as tables, can be scripted by using the Scripter object.

The scriptingOptions parameter is used to filter information in the generated script.

The generated script might contain undocumented, internal procedures, which are required for the complete script output.

Applies to