ScriptingOptions クラス
ScriptingOptions スクリプト作成操作に必要なオプションをプログラムで設定できます。
継承階層
System.Object
Microsoft.SqlServer.Management.Smo.ScriptingOptions
名前空間: Microsoft.SqlServer.Management.Smo
アセンブリ: Microsoft.SqlServer.Smo (Microsoft.SqlServer.Smo.dll)
構文
'宣言
Public NotInheritable Class ScriptingOptions
'使用
Dim instance As ScriptingOptions
public sealed class ScriptingOptions
public ref class ScriptingOptions sealed
[<SealedAttribute>]
type ScriptingOptions = class end
public final class ScriptingOptions
ScriptingOptions 型は、以下のメンバーを公開しています。
コンストラクター
| 名前 | 説明 | |
|---|---|---|
.gif "パブリック メソッド") |
ScriptingOptions() | ScriptingOptions クラスの新しいインスタンスを初期化します。 |
|
ScriptingOptions(ScriptingOptions) | 指定したスクリプト作成オプションに基づいて ScriptingOptions クラスの新しいインスタンスを初期化します。 |
|
ScriptingOptions(ScriptOption) | 指定したスクリプト オプションに基づく特定の ScriptOption オブジェクトに従って、ScriptingOptions クラスの新しいインスタンスを初期化します。 |
先頭に戻る
プロパティ
| 名前 | 説明 | |
|---|---|---|
.gif "パブリック プロパティ") |
AgentAlertJob | 警告オブジェクトに対する SQL Server エージェント ジョブ名をスクリプトに含めるかどうかを示す Boolean プロパティを取得または設定します。 |
|
AgentJobId | 警告オブジェクトに対する SQL Server エージェントのジョブ ID 値をスクリプトに含めるかどうかを示す Boolean プロパティを取得または設定します。 |
|
AgentNotify | SQL Server エージェントの警告の通知をスクリプトに含めるかどうかを示す Boolean プロパティを取得または設定します。 |
|
AllowSystemObjects | システム オブジェクトをスクリプトに含めることができるかどうかを示す Boolean プロパティを取得または設定します。 |
|
AnsiFile | スクリプトがマルチバイト文字を使用していて、文字の意味を評価するためにコード ページ 1252 が必要かどうかを示す Boolean プロパティを取得または設定します。 |
|
AnsiPadding | Transact-SQL ステートメント SET ANSI-PADDING ON および SET ANSI-PADDING OFF を、生成されるスクリプトの CREATE TABLE ステートメントの前後に含めるかどうかを示す Boolean プロパティを取得または設定します。 |
|
AppendToFile | スクリプトを出力ファイルの末尾に追加するか、または出力ファイルを上書きするかを示す Boolean プロパティ値を取得または設定します。 |
|
BatchSize | バッチ ターミネータまでのステートメント数を取得または設定します。 |
|
Bindings | バインド ステートメント sp_binddefault および sp_bindrule を、生成されるスクリプトに含めるかどうかを示す Boolean プロパティ値を取得または設定します。このプロパティが適用されるのは、SQL Server テーブルのスクリプト作成時だけです。 |
|
ChangeTracking | ScriptingOptions が変更を追跡しているかどうかを取得または設定します。 |
|
ClusteredIndexes | クラスター化インデックスを定義するステートメントを、生成されるスクリプトに含めるかどうかを示す Boolean プロパティ値を取得または設定します。 |
|
ContinueScriptingOnError | エラーが発生した後もスクリプト作成操作を続行するかどうかを示す Boolean プロパティ値を取得または設定します。 |
|
ConvertUserDefinedDataTypesToBaseType | 生成されるスクリプトでユーザー定義データ型を最も適切な SQL Server 基本データ型に変換するかどうかを示す Boolean プロパティ値を取得または設定します。 |
|
DdlBodyOnly | ストアド プロシージャやトリガーなどのテキスト本文を持つデータ定義言語 (DDL) オブジェクトについて、テキスト定義のみをスクリプトに含めるかどうかを示す Boolean プロパティ値を取得または設定します。 |
|
DdlHeaderOnly | ストアド プロシージャやトリガーなどのテキスト本文を持つデータ定義言語 (DDL) オブジェクトについて、ヘッダー情報のみをスクリプトに含めるかどうかを示す Boolean プロパティ値を取得または設定します。 |
|
Default | 参照するオブジェクトの作成を、生成されるスクリプトに含めるかどうかを示す Boolean プロパティ値を取得または設定します。 |
|
DriAll | すべての DRI オブジェクトを、生成されるスクリプトに含めるかどうかを示す Boolean プロパティ値を取得または設定します。 |
|
DriAllConstraints | 生成されたスクリプトにすべての宣言参照整合性制約を含めるかどうかを示す Boolean プロパティ値を取得または設定します。 |
|
DriAllKeys | 生成されたスクリプトにすべての宣言参照整合性キーによって定義されている依存関係を含めるかどうかを示す Boolean プロパティ値を取得または設定します。 |
|
DriChecks | 宣言参照整合性が適用された CHECK 制約で定義されている列固有の依存関係をスクリプトに含めるかどうかを示す Boolean プロパティ値を取得または設定します。 |
|
DriClustered | 宣言参照整合性が適用されたクラスター化インデックスで定義されている依存関係をスクリプトに含めるかどうかを示す Boolean プロパティ値を取得または設定します。 |
|
DriDefaults | 宣言参照整合性が適用された既定値で定義されている依存関係をスクリプトに含めるかどうかを示す Boolean プロパティ値を取得または設定します。 |
|
DriForeignKeys | 宣言参照整合性が適用された外部キーで定義されている依存関係をスクリプトに含めるかどうかを示す Boolean プロパティ値を取得または設定します。 |
|
DriIncludeSystemNames | 宣言参照整合性を適用するために使用されるシステム生成の制約名をスクリプトに含めるかどうかを示す Boolean プロパティ値を取得または設定します。 |
|
DriIndexes | 一意インデックスを使用して宣言参照整合性を実装する PRIMARY KEY 制約をスクリプトに含めるかどうかを示す Boolean プロパティ値を取得または設定します。 |
|
DriNonClustered | 宣言参照整合性が適用された非クラスター化インデックスで定義されている依存関係をスクリプトに含めるかどうかを示す Boolean プロパティ値を取得または設定します。 |
|
DriPrimaryKey | 宣言参照整合性が適用された主キーで定義されている依存関係をスクリプトに含めるかどうかを示す Boolean プロパティ値を取得または設定します。 |
|
DriUniqueKeys | 宣言参照整合性が適用された一意キーで定義されている依存関係をスクリプトに含めるかどうかを示す Boolean プロパティ値を取得または設定します。 |
|
DriWithNoCheck | no check ステートメントをスクリプトに含めるかどうかを示す Boolean プロパティ値を取得または設定します。 |
|
Encoding | スクリプト作成オプションのエンコードを取得または設定します。 |
|
EnforceScriptingOptions | SchemaQualify などのテキスト ベースのオブジェクトにすべてのスクリプト作成オプションの適用を強制するかどうかを示す Boolean プロパティ値を取得または設定します。 |
|
ExtendedProperties | オブジェクトの拡張プロパティを、生成されるスクリプトに含めるかどうかを示す Boolean プロパティ値を取得または設定します。 |
|
FileName | 生成されるスクリプトの出力先ファイルの名前を取得または設定します。 |
|
FullTextCatalogs | フルテキスト カタログを、生成されるスクリプトに含めるかどうかを示す Boolean プロパティ値を取得または設定します。 |
|
FullTextIndexes | フルテキスト インデックスを、生成されるスクリプトに含めるかどうかを示す Boolean プロパティ値を取得または設定します。 |
|
FullTextStopLists | フルテキスト ストップ リストを、生成されるスクリプトに含めるかどうかを示す Boolean プロパティ値を取得または設定します。 |
|
IncludeDatabaseContext | 生成されるスクリプトにデータベース コンテキストを含めるかどうかを示す Boolean プロパティ値を取得または設定します。 |
|
IncludeDatabaseRoleMemberships | データベース ロール メンバーシップが含まれるかどうかを示す値を取得または設定します。 |
|
IncludeFullTextCatalogRootPath | フルテキスト カタログのルート パスが含まれるかどうかを示す値を取得または設定します。 |
|
IncludeHeaders | 生成日時などの情報を含むヘッダーを、生成されるスクリプトにプレフィックスとして含めるかどうかを示す Boolean プロパティ値を取得または設定します。 |
|
IncludeIfNotExists | オブジェクトをスクリプトに含める前にその存在を確認するかどうかを示す Boolean プロパティ値を取得または設定します。 |
|
Indexes | インデックスを生成されるスクリプトに含めるかどうかを示す Boolean プロパティ値を取得または設定します。 |
|
LoginSid | スクリプト化されたログイン用のセキュリティ識別子を、生成されるスクリプトに含めるかどうかを示す Boolean プロパティ値を取得または設定します。 |
|
NoAssemblies | アセンブリを生成されるスクリプトに含めるかどうかを示す Boolean プロパティ値を取得または設定します。 |
|
NoCollation | 照合順序句を生成されるスクリプトに含めるかどうかを示す Boolean プロパティ値を取得または設定します。 |
|
NoCommandTerminator | 生成されるスクリプト内で、個々の Transact-SQL ステートメントを区切るかどうかを示す Boolean プロパティ値を取得または設定します。 |
|
NoExecuteAs | ストアド プロシージャやユーザー定義関数の EXECUTE AS オプションをスクリプトに含めるかどうかを示す Boolean プロパティ値を取得または設定します。 |
|
NoFileGroup | 'ON <filegroup>' 句を生成されるスクリプトに含めるかどうかを示す Boolean プロパティ値を取得または設定します。 |
|
NoFileStream | VarBinaryMax 列を作成する場合、生成したスクリプトに FILESTREAM_ON 句を含めるかどうかを示すオブジェクト値を取得または設定します。 |
|
NoFileStreamColumn | VarBinaryMax 列を作成する場合、生成したスクリプトに FILESTREAM_ON 句を含めるかどうかを示すオブジェクト値を取得または設定します。 |
|
NoIdentities | ID プロパティのシードと増分値の定義を生成されるスクリプトに含めるかどうかを示す Boolean プロパティ値を取得または設定します。 |
|
NoIndexPartitioningSchemes | インデックスのパーティション構成を、生成されるスクリプトに含めるかどうかを示す Boolean プロパティ値を取得または設定します。 |
|
NoMailProfileAccounts | メール プロファイルによって参照されるメール アカウントを、生成されるスクリプトに含めるかどうかを示す Boolean プロパティ値を取得または設定します。 |
|
NoMailProfilePrincipals | メール プロファイルによって参照されるプリンシパルを、生成されるスクリプトに含めるかどうかを示す Boolean プロパティ値を取得または設定します。 |
|
NonClusteredIndexes | 非クラスター化インデックスを、生成されるスクリプトに含めるかどうかを示す Boolean プロパティ値を取得または設定します。 |
|
NoTablePartitioningSchemes | テーブルのパーティション構成を、生成されるスクリプトに含めるかどうかを示す Boolean プロパティ値を取得または設定します。 |
|
NoVardecimal | vardecimal 列を作成する場合、生成したスクリプトに N 句を含めるかどうかを示すオブジェクト値を取得または設定します。 |
|
NoViewColumns | ビューに対して指定した列を含めるかどうかを示す Boolean プロパティ値を取得または設定します。 |
|
NoXmlNamespaces | XML 名前空間を、生成されるスクリプトに含めるかどうかを示す Boolean プロパティ値を取得または設定します。 |
|
OptimizerData | 参照するオブジェクトのスクリプト オプティマイザー データを、生成されるスクリプトに含めるかどうかを示す Boolean プロパティ値を取得または設定します。 |
|
Permissions | すべての権限を生成されるスクリプトに含めるかどうかを示す Boolean プロパティ値を取得または設定します。 |
|
PrimaryObject | 参照するオブジェクトの作成を、生成されるスクリプトに含めるかどうかを示す Boolean プロパティ値を取得または設定します。 |
|
SchemaQualify | オブジェクトに関連付けられたスキーマを、生成されるスクリプトに含めるかどうかを示す Boolean プロパティ値を取得または設定します。 |
|
SchemaQualifyForeignKeysReferences | 外部キー制約のスキーマ修飾テーブル参照を、生成されるスクリプトに含めるかどうかを示す Boolean プロパティ値を取得または設定します。 |
|
ScriptBatchTerminator | ScriptBatchTerminator プロパティ値を取得または設定します。 |
|
ScriptData | ScriptData プロパティ値を取得または設定します。 |
|
ScriptDataCompression | データ圧縮情報を、生成されるスクリプトに含めるかどうかを示す Boolean プロパティ値を取得または設定します。 |
|
ScriptDrops | スクリプト作成操作で、参照するコンポーネントを削除する Transact-SQL スクリプトを生成するかどうかを示す Boolean プロパティ値を取得または設定します。 |
|
ScriptOwner | スクリプトの所有者を、生成されるスクリプトに含めるかどうかを示す Boolean プロパティ値を取得または設定します。 |
|
ScriptSchema | ScriptSchema プロパティ値を取得または設定します。 |
|
Statistics | テーブルやビューの統計を、生成されるスクリプトに含めるかどうかを示す Boolean プロパティ値を取得または設定します。 |
|
TargetDatabaseEngineType | DatabaseEngineType プロパティ値を取得または設定します。 |
|
TargetServerVersion | 生成されるスクリプトの対象となる SQL Server インスタンスのバージョンを取得または設定します。 |
|
TimestampToBinary | テーブルまたはユーザー定義データ型を生成するスクリプトの作成時、timestamp データ型を binary(8) データ型に変換するかどうかを示す Boolean プロパティ値を取得または設定します。 |
|
ToFileOnly | ファイルのみに出力するか、または文字列出力も生成するかを示す Boolean プロパティ値を取得または設定します。 |
|
Triggers | トリガーの定義を生成されるスクリプトに含めるかどうかを示す Boolean プロパティ値を取得または設定します。 |
|
WithDependencies | すべての依存オブジェクトを、生成されるスクリプトに含めるかどうかを示す Boolean プロパティ値を取得または設定します。 |
|
XmlIndexes | XML インデックスを、生成されるスクリプトに含めるかどうかを示す Boolean プロパティ値を取得または設定します。 |
先頭に戻る
メソッド
| 名前 | 説明 | |
|---|---|---|
|
Add(ScriptOption) | ScriptOption オブジェクトを ScriptingOptions オブジェクトに追加します。 |
.gif "静的メンバー") |
Add(ScriptingOptions, ScriptOption) | 指定した ScriptOption オブジェクトおよび ScriptingOptions オブジェクトを ScriptingOptions に追加します。 |
|
ConvertVersion | サーバーのバージョンを SqlServerVersion 値に変換します。 |
|
Equals | (Object から継承されています。) |
|
GetHashCode | (Object から継承されています。) |
|
GetType | (Object から継承されています。) |
|
Remove | ScriptOption オブジェクトを ScriptingOptions オブジェクトから削除します。 |
|
SetTargetDatabaseEngineType | DatabaseEngineType オブジェクトで指定されているとおり、データベース エンジンの種類を設定します。 |
|
SetTargetServerVersion | スクリプト作成操作を実行する SQL Server インスタンスのバージョンを設定します。 |
|
Subtract | 指定された ScriptOption 値を、指定された ScriptingOptions オブジェクトから減算します。 |
|
ToString | ScriptingOptions オブジェクトを表す文字列を返します。 (Object.ToString() をオーバーライドします。) |
先頭に戻る
演算子
| 名前 | 説明 | |
|---|---|---|
.gif "パブリック演算子") |
Addition | ScriptingOptions オブジェクトと ScriptOption オブジェクトの加算演算を実行することによって、スクリプト作成オプションのセットを作成します。 |
|
Subtraction | ScriptingOptions オブジェクトと ScriptOption オブジェクトの減算演算を実行することによって、スクリプト作成オプションのセットを作成します。 |
先頭に戻る
説明
.gif "注記") 注意 |
|---|
使用するスクリプト作成オプションによっては、対象サーバーで実行されないスクリプトが Transfer オブジェクトによって生成される場合があります。 |
スレッド セーフ
この型の public static (Microsoft Visual Basic では Shared) のすべてのメンバーは、マルチスレッド操作で安全に使用できます。インスタンス メンバーの場合は、スレッド セーフであるとは限りません。
使用例
'Connect to the local, default instance of SQL Server.
Dim srv As Server
srv = New Server
'Reference the AdventureWorks2012 database.
Dim db As Database
db = srv.Databases("AdventureWorks2012")
'Define a Scripter object and set the required scripting options.
Dim scrp As Scripter
scrp = New Scripter(srv)
scrp.Options.ScriptDrops = False
scrp.Options.WithDependencies = True
'Iterate through the tables in database and script each one. Display the script.
'Note that the StringCollection type needs the System.Collections.Specialized namespace to be included.
Dim tb As Table
Dim smoObjects(1) As Urn
For Each tb In db.Tables
smoObjects = New Urn(0) {}
smoObjects(0) = tb.Urn
If tb.IsSystemObject = False Then
Dim sc As StringCollection
sc = scrp.Script(smoObjects)
Dim st As String
For Each st In sc
Console.WriteLine(st)
Next
End If
Next
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
$tb = New-Object Microsoft.SqlServer.Management.Smo.Table
#$smoObjects = new-object Microsoft.SqlServer.Management.Smo.Urn[]0
$smoObjects = $tb.Urn
foreach ($tb in $db.Tables)
{
$smoObjects = $tb.Urn
if ($tb.IsSystemObject -eq $FALSE)
{
$sc = $scrp.Script($smoObjects)
foreach ($st in $sc)
{
Write-Host $st
}
}
}
スレッド セーフ
この型の public static (Visual Basic では Shared) のメンバーはすべて、スレッド セーフです。インスタンス メンバーの場合は、スレッド セーフであるとは限りません。
関連項目
参照
Microsoft.SqlServer.Management.Smo 名前空間