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 型は、以下のメンバーを公開しています。
プロパティ
名前 | 説明 | |
---|---|---|
AuditLevel | Microsoft SQL Server のインスタンスの監査レベルを取得します。値の設定も可能です。 | |
BackupDirectory | Microsoft SQL Server のインスタンスの既定のバックアップ ディレクトリを取得します。 | |
DefaultFile | Microsoft SQL Server のインスタンスの既定のデータ ファイル ディレクトリを取得します。値の設定も可能です。 | |
DefaultLog | Microsoft SQL Server のインスタンスの既定のログ ファイル ディレクトリを取得します。値の設定も可能です。 | |
LoginMode | SQL Server のログオン モードを取得します。値の設定も可能です。 | |
MailProfile | SQL Server のインスタンスのメール プロファイルを取得します。値の設定も可能です。 | |
NumberOfLogFiles | SQL Server のインスタンスのデータベースで使用するログ ファイルの数を取得します。値の設定も可能です。 | |
OleDbProviderSettings | OleDbProviderSettings オブジェクトのコレクションを参照します。各 OleDbProviderSettings オブジェクトは、OLE DB プロバイダー設定を表します。 | |
Parent | Settings オブジェクトの親である Server オブジェクトを取得します。 | |
PerfMonMode | SQL Server のインスタンスのパフォーマンス モニターのポーリング動作を取得します。 | |
Properties | オブジェクトのプロパティを表す Property オブジェクトのコレクションを取得します。 (SqlSmoObject から継承されています。) | |
State | 参照先のオブジェクトの状態を取得します。 (SmoObjectBase から継承されています。) | |
TapeLoadWaitTime | テープ バックアップ デバイスにテープをマウントするのを待機する時間を取得します。値の設定も可能です。 | |
Urn | オブジェクトを一意に識別する URN (Uniform Resource Name) アドレスの値を取得します。 (SqlSmoObject から継承されています。) | |
UserData | 参照先のオブジェクトに関連付けられたユーザー定義データを取得します。値の設定も可能です。 (SmoObjectBase から継承されています。) |
先頭に戻る
メソッド
名前 | 説明 | |
---|---|---|
Alter | SQL Server のインスタンスの Settings オブジェクトのプロパティに対する変更をすべて更新します。 | |
Discover | Object 型の一覧を検出します。 (SqlSmoObject から継承されています。) | |
Equals | (Object から継承されています。) | |
FormatSqlVariant | SqlVariant 型としてオブジェクトの書式を設定します。 (SqlSmoObject から継承されています。) | |
GetContextDB | このオブジェクトに関連付けられているコンテキスト データベースを取得します。 (SqlSmoObject から継承されています。) | |
GetDBName | オブジェクトに関連付けられたデータベース名を取得します。 (SqlSmoObject から継承されています。) | |
GetHashCode | (Object から継承されています。) | |
GetPropValue | SqlSmoObject オブジェクトのプロパティの値を取得します。 (SqlSmoObject から継承されています。) | |
GetPropValueOptional | SqlSmoObject オブジェクトのプロパティの値を取得します。 (SqlSmoObject から継承されています。) | |
GetPropValueOptionalAllowNull | SqlSmoObject オブジェクトのプロパティの値を取得します。 (SqlSmoObject から継承されています。) | |
GetServerObject | SqlSmoObject オブジェクトのサーバーを取得します。 (SqlSmoObject から継承されています。) | |
GetType | (Object から継承されています。) | |
Initialize() | オブジェクトを初期化し、プロパティを強制的に読み込ませます。 (SqlSmoObject から継承されています。) | |
Initialize(Boolean) | オブジェクトを初期化し、プロパティを強制的に読み込ませます。 (SqlSmoObject から継承されています。) | |
IsObjectInitialized | オブジェクトが初期化されたかどうかを確認します。 (SqlSmoObject から継承されています。) | |
IsObjectInSpace | オブジェクトが孤立しているか、または SQL Server のインスタンスに接続されているかを確認します。 (SqlSmoObject から継承されています。) | |
Refresh | オブジェクトが次回アクセスされるときに、オブジェクトを更新し、プロパティを取得します。 (SqlSmoObject から継承されています。) | |
Script() | SQL Server の設定の再作成に使用できる Transact-SQL スクリプトを生成します。 | |
Script(ScriptingOptions) | スクリプト作成オプションで指定したとおりに SQL Server の設定を再作成するために使用できる Transact-SQL スクリプトを生成します。 | |
SetParentImpl | SqlSmoObject の親を newParent パラメーターに設定します。 (SqlSmoObject から継承されています。) | |
ToString | 参照するオブジェクトを表す String を返します。 (SqlSmoObject から継承されています。) | |
Validate | オブジェクトの状態を検証します。 (SmoObjectBase から継承されています。) |
先頭に戻る
イベント
名前 | 説明 | |
---|---|---|
PropertyChanged | プロパティが変更されるときに発生するイベントを表します。 (SqlSmoObject から継承されています。) | |
PropertyMetadataChanged | プロパティ メタデータが変更されたときに発生するイベントを表します。 (SqlSmoObject から継承されています。) |
先頭に戻る
明示的なインターフェイスの実装
名前 | 説明 | |
---|---|---|
IAlienObject.Discover | 依存関係を検出します。このメンバーをコード内で直接参照しないでください。このメンバーは、SQL Server インフラストラクチャをサポートしています。 (SqlSmoObject から継承されています。) | |
IAlienObject.GetDomainRoot | ドメインのルートを返します。 (SqlSmoObject から継承されています。) | |
IAlienObject.GetParent | このオブジェクトの親を取得します。このメンバーをコード内で直接参照しないでください。このメンバーは、SQL Server インフラストラクチャをサポートしています。 (SqlSmoObject から継承されています。) | |
IAlienObject.GetPropertyType | 指定したプロパティの種類を取得します。 (SqlSmoObject から継承されています。) | |
IAlienObject.GetPropertyValue | 指定されたプロパティの値を取得します。 (SqlSmoObject から継承されています。) | |
IAlienObject.GetUrn | オブジェクトの Unified Resource Name (URN) を取得します。このメンバーをコード内で直接参照しないでください。このメンバーは、SQL Server インフラストラクチャをサポートしています。 (SqlSmoObject から継承されています。) | |
IAlienObject.Resolve | オブジェクトに関する情報を含むインスタンスを、オブジェクトの Unified Resource Name (URN) から取得します。 (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) のメンバーはすべて、スレッド セーフです。インスタンス メンバーの場合は、スレッド セーフであるとは限りません。
関連項目
参照
Microsoft.SqlServer.Management.Smo 名前空間