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) のメンバーはすべて、スレッド セーフです。インスタンス メンバーの場合は、スレッド セーフであるとは限りません。