Settings クラス
Settings オブジェクトは、SQL Server のインスタンスの構成可能な設定のグループを表します。
継承階層
System. . :: . .Object
Microsoft.SqlServer.Management.Smo. . :: . .SmoObjectBase
Microsoft.SqlServer.Management.Smo. . :: . .SqlSmoObject
Microsoft.SqlServer.Management.Smo..::..Settings
名前空間: Microsoft.SqlServer.Management.Smo
アセンブリ: Microsoft.SqlServer.Smo (Microsoft.SqlServer.Smo.dll)
構文
'宣言
<SfcElementTypeAttribute("Setting")> _
Public NotInheritable Class Settings _
Inherits SqlSmoObject _
Implements IAlterable, IScriptable
'使用
Dim instance As Settings
[SfcElementTypeAttribute("Setting")]
public sealed class Settings : SqlSmoObject,
IAlterable, IScriptable
[SfcElementTypeAttribute(L"Setting")]
public ref class Settings sealed : public SqlSmoObject,
IAlterable, IScriptable
[<SealedAttribute>]
[<SfcElementTypeAttribute("Setting")>]
type Settings =
class
inherit SqlSmoObject
interface IAlterable
interface IScriptable
end
public final class Settings extends SqlSmoObject implements IAlterable, IScriptable
Settings 型は、以下のメンバーを公開しています。
プロパティ
| 名前 | 説明 | |
|---|---|---|
.gif "パブリック プロパティ") |
AuditLevel | Microsoft SQL Server のインスタンスの監査レベルを取得または設定します。 |
|
BackupDirectory | Microsoft SQL Server のインスタンスの既定のバックアップ ディレクトリを取得します。 |
|
DefaultFile | Microsoft SQL Server のインスタンスの既定のデータ ファイル ディレクトリを取得または設定します。 |
|
DefaultLog | Microsoft SQL Server のインスタンスの既定のログ ファイル ディレクトリを取得または設定します。 |
.gif "プロテクト プロパティ") |
ExecuteForScalar | オブジェクトがスカラー オプションの実行に対して設定されるかどうかを示す Boolean プロパティ値を取得または設定します。 (SqlSmoObject から継承されています。) |
|
IsTouched | オブジェクトのプロパティが更新されていてもサーバーに保存されていないかどうかを示す Boolean プロパティ値を取得します。 (SqlSmoObject から継承されています。) |
|
LoginMode | SQL Server のログオン モードを取得または設定します。 |
|
MailProfile | SQL Server のインスタンスのメール プロファイルを取得または設定します。 |
|
NumberOfLogFiles | SQL Server のインスタンスのデータベースで使用するログ ファイルの数を取得または設定します。 |
|
ObjectInSpace | オブジェクトが孤立して存在するか、SQL Server のインスタンスに直接的または間接的に接続されているかを示す Boolean プロパティ値を取得します。 (SqlSmoObject から継承されています。) |
|
OleDbProviderSettings | OleDbProviderSettings オブジェクトのコレクションを参照します。各 OleDbProviderSettings オブジェクトは、OLE DB プロバイダー設定を表します。 |
|
Parent | Settings オブジェクトの親である Server オブジェクトを取得します。 |
|
PerfMonMode | SQL Server のインスタンスのパフォーマンス モニターのポーリング動作を取得します。 |
|
Properties | オブジェクトのプロパティを表す Property オブジェクトのコレクションを取得します。 (SqlSmoObject から継承されています。) |
|
ScalarResult | 参照先オブジェクトのスカラー結果を取得します。 (SqlSmoObject から継承されています。) |
|
State | 参照先のオブジェクトの状態を取得します。 (SmoObjectBase から継承されています。) |
|
TapeLoadWaitTime | テープ バックアップ デバイスにテープをマウントするのを待機する時間を取得または設定します。 |
|
Urn | オブジェクトを一意に識別する URN (Uniform Resource Name) アドレスの値を取得します。 (SqlSmoObject から継承されています。) |
|
UserData | 参照先のオブジェクトに関連付けられたユーザー定義データを取得します。値の設定も可能です。 (SmoObjectBase から継承されています。) |
先頭に戻る
メソッド
| 名前 | 説明 | |
|---|---|---|
.gif "プロテクト メソッド") |
AddDatabaseContext(StringCollection) | queries パラメーターによって識別されたクエリのコレクションにデータベース コンテキストを追加します。 (SqlSmoObject から継承されています。) |
|
AddDatabaseContext(StringCollection, ScriptingOptions) | queries パラメーターによって識別されたクエリのコレクションに、指定したスクリプト作成オプションを使用してデータベース コンテキストを追加します。 (SqlSmoObject から継承されています。) |
.gif "パブリック メソッド") |
Alter | SQL Server のインスタンスの Settings オブジェクトのプロパティに対する変更をすべて更新します。 |
|
AlterImpl | Object Altered イベントをアクティブにします。 (SqlSmoObject から継承されています。) |
|
AlterImplFinish | Object Altered イベントの終了時に呼び出されるメソッドです。 (SqlSmoObject から継承されています。) |
|
AlterImplInit | Object-Altered イベントの初期化時に呼び出されるメソッドです。 (SqlSmoObject から継承されています。) |
|
AlterImplWorker | Alter メソッドを呼び出します。 (SqlSmoObject から継承されています。) |
|
BindDefaultImpl | パラメーターによって識別された既定のアイテムをバインドします。 (SqlSmoObject から継承されています。) |
|
BindRuleImpl | パラメーターによって識別されたルールおよび列にルール スキーマをバインドします。 (SqlSmoObject から継承されています。) |
|
CheckCollation | collationName パラメーターによって識別された Collation メソッドを使用して、スクリプト作成オプションの順序を確認します。 (SqlSmoObject から継承されています。) |
|
CheckObjectState() () () () | 参照先オブジェクトの状態を検証します。 (SqlSmoObject から継承されています。) |
|
CheckObjectState(Boolean) | 参照先オブジェクトの状態を検証します。オブジェクトがまだ作成されていない場合は、例外をスローするように指定することも可能です。 (SqlSmoObject から継承されています。) |
|
CheckObjectStateImpl | SqlSmoObject の状態を確認します。 (SqlSmoObject から継承されています。) |
|
CheckVersion100 | SQL Server のバージョンが SQL Server 2008 かどうかを確認します。 (SqlSmoObject から継承されています。) |
|
CheckVersion80 | SQL Server 2000 でのオブジェクトの有効性を確認します。 (SqlSmoObject から継承されています。) |
|
CheckVersion80SP3 | SQL Server 2000 SP3 でのオブジェクトの有効性を確認します。 (SqlSmoObject から継承されています。) |
|
CheckVersion90 | SQL Server 2005 でのオブジェクトの有効性を確認します。 (SqlSmoObject から継承されています。) |
|
CheckVersionBelow90 | SQL Server のバージョンが SQL Server 2005 より前のバージョンかどうかを確認します。 (SqlSmoObject から継承されています。) |
|
CleanObject | オブジェクトを変更されていない状態に設定します。 (SqlSmoObject から継承されています。) |
|
CreateImpl | スクリプト作成オプションを使用してオブジェクトを作成します。 (SqlSmoObject から継承されています。) |
|
CreateImplFinish | Create イベントの終了時に呼び出されるメソッドです。 (SqlSmoObject から継承されています。) |
|
CreateImplInit | Create イベントによる初期化時に呼び出されるメソッドです。 (SqlSmoObject から継承されています。) |
|
Discover | Object 型の一覧を検出します。 (SqlSmoObject から継承されています。) |
|
DropImpl | SqlSmoObject を削除します。 (SqlSmoObject から継承されています。) |
|
DropImplWorker | Drop メソッドを呼び出します。 (SqlSmoObject から継承されています。) |
|
EnumScriptImpl | so パラメーターで指定されたスクリプトを列挙します。 (SqlSmoObject から継承されています。) |
|
EnumScriptImplWorker | so パラメーターで指定されたスクリプトを列挙するメソッドを呼び出します。 (SqlSmoObject から継承されています。) |
|
EnumScriptImplWorkerSOChanged | オブジェクトのスクリプト作成オプションを説明する IEnumerable 文字列を返します。 (SqlSmoObject から継承されています。) |
|
Equals | (Object から継承されています。) |
|
ExecuteNonQuery | 返される結果がないデータベースのコンテキストで、バッチを実行します。 (SqlSmoObject から継承されています。) |
|
Finalize | (Object から継承されています。) |
|
FormatSqlVariant | SqlVariant 型としてオブジェクトの書式を設定します。 (SqlSmoObject から継承されています。) |
|
GenerateDataSpaceFileStreamScript | データ ファイルを作成するスクリプトを生成します。 (SqlSmoObject から継承されています。) |
|
GenerateDataSpaceScript | データ ファイルに領域を割り当てるスクリプトを生成します。 (SqlSmoObject から継承されています。) |
|
GetBindDefaultScript | defSchema パラメーターおよび defName パラメーターで指定された既定値をバインドするスクリプトを取得します。 (SqlSmoObject から継承されています。) |
|
GetBindRuleScript | バインド ルールを示すスクリプトを取得します。 (SqlSmoObject から継承されています。) |
|
GetBoolParameter(StringBuilder, ScriptingOptions, String, String, Int32%) | SqlSmoObject のブール型パラメーターを割り当てます。 (SqlSmoObject から継承されています。) |
|
GetBoolParameter(StringBuilder, ScriptingOptions, String, String, Int32%, Boolean) | SqlSmoObject のブール型プロパティを割り当てます。 (SqlSmoObject から継承されています。) |
|
GetDateTimeParameter | SqlSmoObject の日時プロパティを割り当てます。 (SqlSmoObject から継承されています。) |
|
GetDateTimeParameterAsInt | 日時プロパティが NULL でない場合、整数値として SqlSmoObject の日時プロパティを割り当てます。 (SqlSmoObject から継承されています。) |
|
GetDBName | オブジェクトに関連付けられたデータベース名を取得します。 (SqlSmoObject から継承されています。) |
|
GetEnumParameter | SqlSmoObject の列挙プロパティを割り当てます。 (SqlSmoObject から継承されています。) |
|
GetFragOptionString | FragmentationOption オブジェクトを文字列値として取得します。 (SqlSmoObject から継承されています。) |
|
GetGuidParameter | SqlSmoObject の Guid プロパティを割り当てます。 (SqlSmoObject から継承されています。) |
|
GetHashCode | (Object から継承されています。) |
|
GetParameter(StringBuilder, ScriptingOptions, String, String, Int32%) | SqlSmoObject のパラメーターを割り当てます。 (SqlSmoObject から継承されています。) |
|
GetParameter(StringBuilder, ScriptingOptions, String, String, Int32%, Boolean) | SqlSmoObject のパラメーターを割り当てます。 (SqlSmoObject から継承されています。) |
|
GetPropValue | SqlSmoObject オブジェクトのプロパティの値を取得します。 (SqlSmoObject から継承されています。) |
|
GetPropValueOptional | SqlSmoObject オブジェクトのプロパティの値を取得します。 (SqlSmoObject から継承されています。) |
|
GetPropValueOptionalAllowNull | SqlSmoObject オブジェクトのプロパティの値を取得します。 (SqlSmoObject から継承されています。) |
|
GetRealValue | SqlSmoObject オブジェクトのプロパティの値を取得します。 (SqlSmoObject から継承されています。) |
|
GetScriptingOptionsForCreate | SqlSmoObject オブジェクトの ScriptingOptions を取得します。 (SqlSmoObject から継承されています。) |
|
GetServerName | オブジェクトが関連付けられている SQL Server のインスタンスの名前を取得します。 (SqlSmoObject から継承されています。) |
|
GetServerObject | SqlSmoObject オブジェクトのサーバーを取得します。 (SqlSmoObject から継承されています。) |
|
GetSqlServerVersionName | オブジェクトが関連付けられている SQL Server のインスタンスのバージョン名を取得します。 (SqlSmoObject から継承されています。) |
|
GetStringParameter(StringBuilder, ScriptingOptions, String, String, Int32%) | SqlSmoObject オブジェクトの文字列パラメーターを割り当てます。 (SqlSmoObject から継承されています。) |
|
GetStringParameter(StringBuilder, ScriptingOptions, String, String, Int32%, Boolean) | SqlSmoObject オブジェクトの文字列パラメーターを割り当てます。 (SqlSmoObject から継承されています。) |
|
GetTimeSpanParameterAsInt | SqlSmoObject オブジェクトの期間パラメーターを割り当てます。 (SqlSmoObject から継承されています。) |
|
GetType | (Object から継承されています。) |
|
GetUrnRecursive(StringBuilder) | SqlSmoObject オブジェクトの Urn オブジェクトを割り当てます。 (SqlSmoObject から継承されています。) |
|
GetUrnRecursive(StringBuilder, UrnIdOption) | SqlSmoObject オブジェクトの Urn オブジェクトを割り当てます。 (SqlSmoObject から継承されています。) |
|
ImplInitialize | SqlSmoObject オブジェクトのフィールドを初期化します。 (SqlSmoObject から継承されています。) |
|
Initialize() () () () | オブジェクトを初期化し、プロパティを強制的に読み込ませます。 (SqlSmoObject から継承されています。) |
|
Initialize(Boolean) | オブジェクトを初期化し、プロパティを強制的に読み込ませます。 (SqlSmoObject から継承されています。) |
|
IsObjectDirty | オブジェクトのプロパティが変更されているかどうか、およびその変更が SQL Server のインスタンスにまだ保存されていないかどうかを確認します。 (SqlSmoObject から継承されています。) |
|
IsObjectInitialized | オブジェクトが初期化されたかどうかを確認します。 (SqlSmoObject から継承されています。) |
|
IsObjectInSpace | オブジェクトが孤立しているか、または SQL Server のインスタンスに接続されているかを確認します。 (SqlSmoObject から継承されています。) |
|
IsVersion80SP3 | SQL Server のバージョンが SQL Server 2000 SP3 かどうかを示します。 (SqlSmoObject から継承されています。) |
|
IsVersion90AndAbove | SQL Server のバージョンが SQL Server 2005 以降かどうかを示します。 (SqlSmoObject から継承されています。) |
|
MarkDropped | SqlSmoState が削除されるように設定します。 (SqlSmoObject から継承されています。) |
|
MarkForDropImpl | SqlSmoState が削除されるように設定します。 (SqlSmoObject から継承されています。) |
|
MemberwiseClone | (Object から継承されています。) |
|
PostAlter | SqlSmoObject の変更後にアクティブ化されるメソッドです。 (SqlSmoObject から継承されています。) |
|
PostCreate | SqlSmoObject の作成後にアクティブ化されるメソッドです。 (SqlSmoObject から継承されています。) |
|
PostDrop | SqlSmoObject の削除後にアクティブ化されるメソッドです。 (SqlSmoObject から継承されています。) |
|
Refresh | オブジェクトが次回アクセスされるときに、オブジェクトを更新し、プロパティを取得します。 (SqlSmoObject から継承されています。) |
|
Script() () () () | SQL Server の設定の再作成に使用できる Transact-SQL スクリプトを生成します。 |
|
Script(ScriptingOptions) | スクリプト作成オプションで指定したとおりに SQL Server の設定を再作成するために使用できる Transact-SQL スクリプトを生成します。 |
|
ScriptAlter | パラメーターに従って SqlSmoObject を変更します。 (SqlSmoObject から継承されています。) |
|
ScriptCreate | パラメーターに従って SqlSmoObject を変更します。 (SqlSmoObject から継承されています。) |
|
ScriptDdl | InvalidSmoOperationException をスローします。 (SqlSmoObject から継承されています。) |
|
ScriptDrop | InvalidSmoOperationException をスローします。 (SqlSmoObject から継承されています。) |
|
ScriptImpl() () () () | SqlSmoObject のスクリプトのコレクションを取得します。 (SqlSmoObject から継承されています。) |
|
ScriptImpl(ScriptingOptions) | SqlSmoObject のスクリプトのコレクションを取得します。 (SqlSmoObject から継承されています。) |
|
ScriptImplWorker | SqlSmoObject のスクリプトのコレクションを取得します。 (SqlSmoObject から継承されています。) |
|
SetParentImpl | SqlSmoObject の親を newParent パラメーターに設定します。 (SqlSmoObject から継承されています。) |
|
ToString | 参照するオブジェクトを表す String を返します。 (SqlSmoObject から継承されています。) |
|
TouchImpl | 未実装です。 (SqlSmoObject から継承されています。) |
|
UnbindDefaultImpl | SqlSmoObject の既定の列をバインド解除します。 (SqlSmoObject から継承されています。) |
|
UnbindRuleImpl | SqlSmoObject のルールをバインド解除します。 (SqlSmoObject から継承されています。) |
|
Validate | オブジェクトの状態を検証します。 (SmoObjectBase から継承されています。) |
先頭に戻る
イベント
| 名前 | 説明 | |
|---|---|---|
.gif "パブリック イベント") |
PropertyChanged | プロパティが変更されるときに発生するイベントを表します。 (SqlSmoObject から継承されています。) |
|
PropertyMetadataChanged | プロパティ メタデータが変更されたときに発生するイベントを表します。 (SqlSmoObject から継承されています。) |
先頭に戻る
フィールド
| 名前 | 説明 | |
|---|---|---|
.gif "プロテクト フィールド") |
m_ExtendedProperties | SqlSmoObject によって指定されたプロパティを拡張するよう定義されたプロパティを表します。 (SqlSmoObject から継承されています。) |
|
singletonParent | 単一の親を表します。 (SqlSmoObject から継承されています。) |
先頭に戻る
明示的なインターフェイスの実装
| 名前 | 説明 | |
|---|---|---|
.gif "明示的なインターフェイスの実装") .gif "プライベート メソッド") |
IAlienObject. . :: . .Discover | 依存関係を検出します。このメンバーをコード内で直接参照しないでください。このメンバーは、SQL Server インフラストラクチャをサポートしています。 (SqlSmoObject から継承されています。) |
|
IAlienObject. . :: . .GetDomainRoot | ドメインのルートを返します。 (SqlSmoObject から継承されています。) |
|
IAlienObject. . :: . .GetParent | このオブジェクトの親を取得します。このメンバーをコード内で直接参照しないでください。このメンバーは、SQL Server インフラストラクチャをサポートしています。 (SqlSmoObject から継承されています。) |
|
IAlienObject. . :: . .GetPropertyType | 指定したプロパティの種類を取得します。 (SqlSmoObject から継承されています。) |
|
IAlienObject. . :: . .GetPropertyValue | 指定されたプロパティの値を取得します。 (SqlSmoObject から継承されています。) |
|
IAlienObject. . :: . .GetUrn | オブジェクトの Uniform Resource Name を取得します。このメンバーをコード内で直接参照しないでください。このメンバーは、SQL Server インフラストラクチャをサポートしています。 (SqlSmoObject から継承されています。) |
|
IAlienObject. . :: . .Resolve | オブジェクトに関する情報を含むインスタンスを、オブジェクトの Unified Resource Name から取得します。 (SqlSmoObject から継承されています。) |
|
IAlienObject. . :: . .SetObjectState | オブジェクトの状態を、指定した SfcObjectState 値に設定します。 (SqlSmoObject から継承されています。) |
|
IAlienObject. . :: . .SetPropertyValue | プロパティの値を設定します。 (SqlSmoObject から継承されています。) |
|
ISfcPropertyProvider. . :: . .GetPropertySet | このオブジェクトのプロパティ セットへのインターフェイス リファレンスを取得します。このメンバーをコード内で直接参照しないでください。このメンバーは、SQL Server インフラストラクチャをサポートしています。 (SqlSmoObject から継承されています。) |
先頭に戻る
説明
この機能は、将来のバージョンの Microsoft SQL Server では削除される予定です。新しい開発作業では、この機能の使用を避け、現在この機能を使用しているアプリケーションは修正するようにしてください。
Settings オブジェクトのプロパティを取得するには、public 固定サーバー ロールのメンバーでもかまいません。
Settings オブジェクトのプロパティを設定するには、sysadmin 固定サーバー ロールのメンバーである必要があります。
スレッド セーフ
この型の public static (Microsoft Visual Basic では Shared) のすべてのメンバーは、マルチスレッド操作で安全に使用できます。インスタンス メンバーの場合は、スレッド セーフであるとは限りません。
使用例
'Connect to the local, default instance of SQL Server.
Dim srv As Server
srv = New Server
'Display information about the instance of SQL Server in Information and Settings.
Console.WriteLine("OS Version = " & srv.Information.OSVersion)
Console.WriteLine("State = " & srv.Settings.State.ToString)
'Display information specific to the current user in UserOptions.
Console.WriteLine("Quoted Identifier support = " & srv.UserOptions.QuotedIdentifier)
'Modify server settings in Settings.
srv.Settings.LoginMode = ServerLoginMode.Integrated
'Modify settings specific to the current connection in UserOptions.
srv.UserOptions.AbortOnArithmeticErrors = True
'Run the Alter method to make the changes on the instance of SQL Server.
srv.Alter()
スレッド セーフ
この型の public static (Visual Basic では Shared) のメンバーはすべて、スレッド セーフです。インスタンス メンバーの場合は、スレッド セーフであるとは限りません。