ScriptOption クラス

ScriptOption オブジェクトは、ScriptingOptions オブジェクトを使用して設定されるスクリプト作成オプションに含めることができる SQL Server スクリプト オプションを表します。

継承階層

System. . :: . .Object
  Microsoft.SqlServer.Management.Smo..::..ScriptOption

名前空間:  Microsoft.SqlServer.Management.Smo
アセンブリ:  Microsoft.SqlServer.Smo (Microsoft.SqlServer.Smo.dll)

構文

'宣言
Public NotInheritable Class ScriptOption
'使用
Dim instance As ScriptOption
public sealed class ScriptOption
public ref class ScriptOption sealed
[<SealedAttribute>]
type ScriptOption =  class end
public final class ScriptOption

ScriptOption 型は、以下のメンバーを公開しています。

プロパティ

  名前 説明
パブリック プロパティ静的メンバー AgentAlertJob SQL Server エージェントの警告とジョブをスクリプトに含めるかどうかを示すオブジェクトを取得します。 
パブリック プロパティ静的メンバー AgentJobId SQL Server エージェントの警告とジョブをスクリプトに含めるかどうかを示すオブジェクトを取得します。 
パブリック プロパティ静的メンバー AgentNotify SQL Server エージェントの警告の通知をスクリプトに含めるかどうかを示すオブジェクトを取得します。 
パブリック プロパティ静的メンバー AllowSystemObjects システム オブジェクトをスクリプト化できるかどうかを示すオブジェクトを取得します。
パブリック プロパティ静的メンバー AnsiFile スクリプトでマルチバイト文字を使用しており、文字の意味を評価するためにコード ページ 1252 が必要であるかどうかを示すオブジェクトを取得します。
パブリック プロパティ静的メンバー AnsiPadding 生成されるスクリプトの CREATE TABLE ステートメントの前後に Transact-SQL ステートメント SET ANSI-PADDING ON および SET ANSI-PADDING OFF を含めるかどうかを示すオブジェクトを取得します。
パブリック プロパティ静的メンバー AppendToFile スクリプトを出力ファイルの末尾に追加するか出力ファイルを上書きするかを示すオブジェクトを取得します。
パブリック プロパティ静的メンバー Bindings 生成されるスクリプトにバインド ステートメント sp_binddefault および sp_bindrule を含めるかどうかを示すオブジェクトを取得します。このプロパティが適用されるのは、Microsoft SQL Server テーブルのスクリプト作成時だけです。
パブリック プロパティ静的メンバー ChangeTracking ChangeTracking プロパティ値を取得します。
パブリック プロパティ静的メンバー ClusteredIndexes 生成されるスクリプトに、クラスター化インデックスを定義するステートメントを含めるかどうかを示すオブジェクトを取得します。
パブリック プロパティ静的メンバー ContinueScriptingOnError エラーの検出後もスクリプト作成操作を続行するかどうかを示すオブジェクト値を取得します。
パブリック プロパティ静的メンバー ConvertUserDefinedDataTypesToBaseType 生成されるスクリプトで、ユーザー定義データ型を最も適切な SQL Server 基本データ型に変換するかどうかを示すオブジェクト値を取得します。 
パブリック プロパティ静的メンバー DdlBodyOnly ストアド プロシージャやトリガーなどのテキスト本文を持つデータ定義言語 (DDL) オブジェクトについて、テキスト定義のみをスクリプト化するかどうかを示すオブジェクト値を取得します。
パブリック プロパティ静的メンバー DdlHeaderOnly ストアド プロシージャやトリガーなどのテキスト本文を持つデータ定義言語 (DDL) オブジェクトについて、ヘッダー情報のみをスクリプト化するかどうかを示すオブジェクト値を取得します。
パブリック プロパティ静的メンバー Default 生成されるスクリプトに、参照先のオブジェクトの作成を含めるかどうかを示すオブジェクト値を取得します。
パブリック プロパティ静的メンバー DriAll 生成されるスクリプトに DRI オブジェクトを含めるかどうかを示すオブジェクト値を取得します。
パブリック プロパティ静的メンバー DriAllConstraints 生成されるスクリプトにすべての DRI 制約を含めるかどうかを示すオブジェクト値を取得します。
パブリック プロパティ静的メンバー DriAllKeys 生成されるスクリプトにすべての DRI キー (DriForeignKeys、DriPrimaryKey、DriUniqueKeys) を含めるかどうかを示すオブジェクト値を取得します。
パブリック プロパティ静的メンバー DriChecks 宣言参照整合性を適用して CHECK 制約で定義されている、列固有の依存関係をスクリプトに含めるかどうかを示すオブジェクト値を取得します。
パブリック プロパティ静的メンバー DriClustered 宣言参照整合性を適用してクラスター化インデックスで定義されている依存関係をスクリプトに含めるかどうかを示すオブジェクト値を取得します。
パブリック プロパティ静的メンバー DriDefaults 宣言参照整合性を適用して既定値で定義されている依存関係をスクリプトに含めるかどうかを示すオブジェクト値を取得します。
パブリック プロパティ静的メンバー DriForeignKeys 宣言参照整合性を適用して外部キーで定義されている依存関係をスクリプトに含めるかどうかを示すオブジェクト値を取得します。
パブリック プロパティ静的メンバー DriIncludeSystemNames 宣言参照整合性を適用するために使用されるシステム生成の制約名をスクリプトに含めるかどうかを示すオブジェクト値を取得します。
パブリック プロパティ静的メンバー DriIndexes 生成されるスクリプトに、一意インデックスを使用して宣言参照整合性を実装する PRIMARY KEY 制約を含めるかどうかを示すオブジェクト値を取得します。
パブリック プロパティ静的メンバー DriNonClustered 宣言参照整合性を適用して非クラスター化インデックスで定義されている依存関係をスクリプトに含めるかどうかを示すオブジェクト値を取得します。
パブリック プロパティ静的メンバー DriPrimaryKey 宣言参照整合性を適用して主キーで定義されている依存関係をスクリプトに含めるかどうかを示すオブジェクト値を取得します。
パブリック プロパティ静的メンバー DriUniqueKeys 宣言参照整合性を適用して一意キーで定義されている依存関係をスクリプトに含めるかどうかを示すオブジェクト値を取得します。
パブリック プロパティ静的メンバー DriWithNoCheck no check ステートメントをスクリプトに含めるかどうかを示すオブジェクト値を取得します。
パブリック プロパティ静的メンバー EnforceScriptingOptions SchemaQualify などのテキスト ベースのオブジェクトにすべてのスクリプト作成オプションを強制的に適用するかどうかを示すオブジェクト値を取得します。
パブリック プロパティ静的メンバー ExtendedProperties 生成されるスクリプトにオブジェクトの拡張プロパティを含めるかどうかを示すオブジェクト値を取得します。
パブリック プロパティ静的メンバー FullTextCatalogs 生成されるスクリプトにフルテキスト カタログを含めるかどうかを示すオブジェクト値を取得します。
パブリック プロパティ静的メンバー FullTextIndexes 生成されるスクリプトにフルテキスト インデックスを含めるかどうかを示すオブジェクト値を取得します。
パブリック プロパティ静的メンバー FullTextStopLists 生成されるスクリプトにフルテキスト ストップ リストを含めるかどうかを示すオブジェクト値を取得します。
パブリック プロパティ静的メンバー IncludeDatabaseContext 生成されるスクリプトにデータベースの内容を含めるかどうかを示すオブジェクト値を取得します。
パブリック プロパティ静的メンバー IncludeDatabaseRoleMemberships IncludeDatabaseRoleMemberships プロパティ値を取得します。
パブリック プロパティ静的メンバー IncludeFullTextCatalogRootPath IncludeFullTextCatalogRootPath プロパティ値を取得します。
パブリック プロパティ静的メンバー IncludeHeaders 生成されるスクリプトに、生成日時などの情報を含むヘッダーをプレフィックスとして含めるかどうかを示すオブジェクト値を取得します。
パブリック プロパティ静的メンバー IncludeIfNotExists オブジェクトをスクリプトに含める前にそのオブジェクトの存在を確認するかどうかを示すオブジェクト値を取得します。
パブリック プロパティ静的メンバー Indexes 生成されるスクリプトにインデックスを含めるかどうかを示すオブジェクトを取得します。
パブリック プロパティ静的メンバー LoginSid スクリプト化されたログイン用のセキュリティ識別子を、生成されるスクリプトに含めるかどうかを示すブール型プロパティ値を取得します。値の設定も可能です。
パブリック プロパティ静的メンバー NoAssemblies 生成されるスクリプトからアセンブリを除外するかどうかを示すオブジェクトを取得します。
パブリック プロパティ静的メンバー NoCollation サーバーで SQL Server 7.0 以降が実行されている場合に、生成されるスクリプトに照合順序を含めるかどうかを示すオブジェクト値を取得します。
パブリック プロパティ静的メンバー NoCommandTerminator 生成されるスクリプトで個々の Transact-SQL ステートメントを区切るかどうかを示すオブジェクト値を取得します。
パブリック プロパティ静的メンバー NoExecuteAs ストアド プロシージャやユーザー定義関数の EXECUTE AS オプションをスクリプトに含めるかどうかを示すオブジェクト値を取得します。
パブリック プロパティ静的メンバー NoFileGroup 生成されるスクリプトに "ON <filegroup>" 句を含めるかどうかを示すオブジェクト値を取得します。
パブリック プロパティ静的メンバー NoFileStream 生成されるスクリプトに VarBinaryMax 列を作成する場合に FILESTREAM_ON 句を含めるかどうかを示すオブジェクト値を取得します。
パブリック プロパティ静的メンバー NoFileStreamColumn 生成されるスクリプトに VarBinaryMax 列を作成する場合に FILESTREAM_ON 句を含めるかどうかを示すオブジェクト値を取得します。
パブリック プロパティ静的メンバー NoIdentities 生成されるスクリプトに ID プロパティのシードと増分値の定義を含めるかどうかを示すオブジェクト値を取得します。
パブリック プロパティ静的メンバー NoIndexPartitioningSchemes 生成されるスクリプトにインデックスのパーティション構成を含めるかどうかを示すオブジェクト値を取得します。
パブリック プロパティ静的メンバー NoMailProfileAccounts 生成されるスクリプトに、メール プロファイルによって参照されるメール アカウントを含めるかどうかを示すオブジェクト値を取得します。
パブリック プロパティ静的メンバー NoMailProfilePrincipals 生成されるスクリプトから、メール プロファイルによって参照されるプリンシパルを除外するかどうかを示すオブジェクト値を取得します。
パブリック プロパティ静的メンバー NonClusteredIndexes 生成されるスクリプトに非クラスター化インデックスを含めるかどうかを示すオブジェクト値を取得します。
パブリック プロパティ静的メンバー NoTablePartitioningSchemes 生成されるスクリプトにテーブルのパーティション構成を含めるかどうかを示すオブジェクト値を取得します。
パブリック プロパティ静的メンバー NoVardecimal NoVardecimal プロパティ値を取得します。
パブリック プロパティ静的メンバー NoViewColumns ビューに指定された列を含めるかどうかを示すオブジェクト値を取得します。
パブリック プロパティ静的メンバー NoXmlNamespaces 生成されるスクリプトに XML 名前空間を含めるかどうかを示すオブジェクト値を取得します。
パブリック プロパティ静的メンバー OptimizerData 生成されるスクリプトに、参照されたオブジェクトに対応するスクリプト オプティマイザー データを含めるかどうかを示すオブジェクト値を取得します。
パブリック プロパティ静的メンバー Permissions 生成されるスクリプトにすべての権限を含めるかどうかを示すオブジェクト値を取得します。
パブリック プロパティ静的メンバー PrimaryObject 生成されるスクリプトに参照先のオブジェクトの作成を含めるかどうかを示すオブジェクト値を取得します。
パブリック プロパティ静的メンバー SchemaQualify スキーマのないオブジェクトをスクリプトに含めるかどうかを示すオブジェクト値を取得します。
パブリック プロパティ静的メンバー SchemaQualifyForeignKeysReferences 生成されるスクリプトに、外部キーによって参照されるスキーマのないテーブルを含めるかどうかを示すオブジェクト値を取得します。
パブリック プロパティ静的メンバー ScriptBatchTerminator ScriptBatchTerminator プロパティ値を取得します。
パブリック プロパティ静的メンバー ScriptData ScriptData プロパティ値を取得します。
パブリック プロパティ静的メンバー ScriptDataCompression 生成されるスクリプトに、参照先のオブジェクトの作成を含めるかどうかを示すオブジェクト値を取得します。
パブリック プロパティ静的メンバー ScriptOwner 生成されるスクリプトに、参照先のオブジェクトの作成を含めるかどうかを示すオブジェクト値を取得します。
パブリック プロパティ静的メンバー ScriptSchema ScriptSchema プロパティ値を取得します。
パブリック プロパティ静的メンバー Statistics 生成されるスクリプトに含まれているテーブルやビューの統計を生成するかどうかを示すオブジェクト値を取得します。
パブリック プロパティ静的メンバー TimestampToBinary テーブルまたはユーザー定義データ型を作成するスクリプトの作成時に、timestamp データ型を binary(8) データ型に変換するかどうかを示すオブジェクト値を取得します。
パブリック プロパティ静的メンバー ToFileOnly ファイルのみに出力するか、それとも文字列出力も生成するかを示すオブジェクト値を取得します。
パブリック プロパティ静的メンバー Triggers 生成されるスクリプトにトリガーの定義を含めるかどうかを示すオブジェクト値を取得します。
パブリック プロパティ静的メンバー WithDependencies 生成されるスクリプトにすべての依存オブジェクトを含めるかどうかを示すオブジェクト値を取得します。
パブリック プロパティ静的メンバー XmlIndexes 生成されるスクリプトに XML インデックスを含めるかどうかを示すオブジェクト値を取得します。

先頭に戻る

メソッド

  名前 説明
パブリック メソッド静的メンバー Add 2 つの ScriptOption オブジェクトを加算して、ScriptOptions オブジェクトを作成します。
パブリック メソッド静的メンバー BitwiseOr ビット単位の OR 演算を使用して 2 つの ScriptOption オブジェクトを結合します。
パブリック メソッド Equals 2 つの ScriptOption が等しいかどうかを示すブール値を返します。 (Object. . :: . .Equals(Object) をオーバーライドします。)
プロテクト メソッド Finalize (Object から継承されています。)
パブリック メソッド GetHashCode このオブジェクトのハッシュ コードを返します。 (Object. . :: . .GetHashCode() () () () をオーバーライドします。)
パブリック メソッド GetType (Object から継承されています。)
プロテクト メソッド MemberwiseClone (Object から継承されています。)
パブリック メソッド ToString 現在のオブジェクトを表す文字列を返します。 (Object. . :: . .ToString() () () () をオーバーライドします。)

先頭に戻る

演算子

  名前 説明
パブリック演算子静的メンバー Addition 2 つの ScriptOption オブジェクトに対して加算演算を実行することによって、スクリプト作成オプションのセットを作成します。
パブリック演算子静的メンバー BitwiseOr 2 つの ScriptOption オブジェクトに対してビット単位の OR 演算を実行することによって、スクリプト作成オプションのセットを作成します。
パブリック演算子静的メンバー Implicit Widening Implicit Implicit Implicit(ScriptOption to ScriptingOptions) 指定した ScriptOption を暗黙的に ScriptingOptions オブジェクトに変換します。

先頭に戻る

説明

ScriptOption オブジェクトは、スクリプトを作成できる各種の SQL Server アイテムのプロパティを格納します。実際にスクリプトを作成するアイテムのセットは、ScriptingOptions オブジェクトを使用して指定します。

警告 : 使用するスクリプト オプションによっては、対象サーバーで実行されないスクリプトが 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 AdventureWorks2008R2 database.
Dim db As Database
db = srv.Databases("AdventureWorks2008R2")
'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

スレッド セーフ

この型の public static (Visual Basic では Shared) のメンバーはすべて、スレッド セーフです。インスタンス メンバーの場合は、スレッド セーフであるとは限りません。

関連項目

参照

その他の技術情報