SMO での SQL Server の構成

[アーティクル]
07/05/2024

適用対象: SQL Server Azure SQL Database Azure SQL Managed Instance Azure Synapse Analytics

SMO では、 Information オブジェクト、 Settings オブジェクト、 UserOptions オブジェクト、および Configuration オブジェクトには、Microsoft SQL Server のインスタンスの設定と情報が含まれます。

SQL Server には、インストールされているインスタンスの動作を記述する多数のプロパティがあります。これらのプロパティでは、スタートアップオプション、サーバーの既定、ファイルとディレクトリ、システムとプロセッサの情報、製品とバージョン、接続情報、メモリオプション、言語と照合順序の選択、および認証モードについて記述します。

SQL Server 構成

Information オブジェクトのプロパティには、プロセッサやプラットフォームなど、SQL Server のインスタンスに関する情報が含まれています。

Settings オブジェクトのプロパティには、SQL Server のインスタンスに関する情報が含まれています。 Mail Profile および Server Account に加え、既定のデータベースファイルおよびディレクトリも変更することができます。これらのプロパティは、接続が続いている間は保持されます。

UserOptions オブジェクトプロパティには、算術、ANSI 規格、およびトランザクションに関連する現在の接続の動作に関する情報が含まれています。

また、Configuration オブジェクトで表現される構成オプションのセットもあります。これには、 sp_configure ストアドプロシージャによって変更可能なオプションを表すプロパティのセットが含まれています。 Priority Boost、Recovery Interval Network Packet Size などのオプション SQL Server のインスタンスのパフォーマンスを制御します。これらのオプションの多くは動的に変更できますが、場合によっては、SQL Server のインスタンスが再起動されたときに値が最初に構成され、その後変更される場合があります。

構成オプションごとに Configuration オブジェクトプロパティがあります。 ConfigProperty オブジェクトを使用すると、グローバル構成設定を変更することができます。多くのプロパティには、最大値および最小値が設定されており、これらも ConfigProperty プロパティとして格納されます。これらのプロパティでは、SQL Server のインスタンスに変更をコミットするために、 Alter メソッドが必要です。

Configuration オブジェクトの構成オプションの変更はすべて、システム管理者が行う必要があります。

例

次のコード例では、アプリケーションを作成するプログラミング環境、プログラミングテンプレート、およびプログラミング言語を選択する必要があります。詳細については、「 Visual Studio .NET で Visual C# SMO プロジェクトを作成するを参照してください。

Visual Basic での SQL Server 構成オプションの変更

このコード例は、Visual Basic .NET で構成オプションを更新する方法を示しています。また、指定された構成オプションの最大値と最小値についての情報を取得および表示しています。最後に、変更が動的に行われたかどうか、または SQL Server のインスタンスが再起動されるまで保存されているかどうかをユーザーに通知します。

'Connect to the local, default instance of SQL Server.
Dim srv As Server
srv = New Server
'Display all the configuration options.
Dim p As ConfigProperty
For Each p In srv.Configuration.Properties
    Console.WriteLine(p.DisplayName)
Next
Console.WriteLine("There are " & srv.Configuration.Properties.Count.ToString & " configuration options.")
'Display the maximum and minimum values for ShowAdvancedOptions.
Dim min As Integer
Dim max As Integer
min = srv.Configuration.ShowAdvancedOptions.Minimum
max = srv.Configuration.ShowAdvancedOptions.Maximum
Console.WriteLine("Minimum and Maximum values are " & min & " and " & max & ".")
'Modify the value of ShowAdvancedOptions and run the Alter method.
srv.Configuration.ShowAdvancedOptions.ConfigValue = 0
srv.Configuration.Alter()
'Display when the change takes place according to the IsDynamic property.
If srv.Configuration.ShowAdvancedOptions.IsDynamic = True Then
    Console.WriteLine("Configuration option has been updated.")
Else
    Console.WriteLine("Configuration option will be updated when SQL Server is restarted.")
End If

Visual Basic での SQL Server 設定の変更

このコード例では、sql Server のインスタンスに関する情報を Information および Settingsに表示し、 Settings プロパティと UserOptionsobject プロパティの設定を変更します。

この例では、UserOptions オブジェクトと Settings オブジェクトの両方に Alter メソッドがあります。 Alter メソッドは、これらのオブジェクトに対して個別に実行できます。

'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()

Visual C# での SQL Server 設定の変更

//Connect to the local, default instance of SQL Server.

{  
            Server srv = new Server();  
            //Display all the configuration options.   
  
            foreach (ConfigProperty p in srv.Configuration.Properties)  
            {  
                Console.WriteLine(p.DisplayName);  
            }  
            Console.WriteLine("There are " + srv.Configuration.Properties.Count.ToString() + " configuration options.");  
            //Display the maximum and minimum values for ShowAdvancedOptions.   
            int min = 0;  
            int max = 0;  
            min = srv.Configuration.ShowAdvancedOptions.Minimum;  
            max = srv.Configuration.ShowAdvancedOptions.Maximum;  
            Console.WriteLine("Minimum and Maximum values are " + min + " and " + max + ".");  
            //Modify the value of ShowAdvancedOptions and run the Alter method.   
            srv.Configuration.ShowAdvancedOptions.ConfigValue = 0;  
            srv.Configuration.Alter();  
            //Display when the change takes place according to the IsDynamic property.   
            if (srv.Configuration.ShowAdvancedOptions.IsDynamic == true)  
            {  
                Console.WriteLine("Configuration option has been updated.");  
            }  
            else  
            {  
                Console.WriteLine("Configuration option will be updated when SQL Server is restarted.");  
            }  
        }

PowerShell での SQL Server 設定の変更

# Set the path context to the local, default instance of SQL Server.  
CD \sql\localhost\  
$srv = get-item default  
  
#Display information about the instance of SQL Server in Information and Settings.  
"OS Version = " + $srv.Information.OSVersion  
"State = "+ $srv.Settings.State.ToString()  
  
#Display information specific to the current user in UserOptions.  
"Quoted Identifier support = " + $srv.UserOptions.QuotedIdentifier  
  
#Modify server settings in Settings.  
$srv.Settings.LoginMode = [Microsoft.SqlServer.Management.SMO.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()

PowerShell での SQL Server 構成オプションの変更

#Get a server object which corresponds to the default instance replace LocalMachine with the physical server  
cd \sql\LocalMachine  
$svr = get-item default  
  
#enumerate its properties  
foreach ($Item in $Svr.Configuration.Properties)   
{  
 $Item.DisplayName  
}  
  
"There are " + $svr.Configuration.Properties.Count.ToString() + " configuration options."  
  
#Display the maximum and minimum values for ShowAdvancedOptions.  
$min = $svr.Configuration.ShowAdvancedOptions.Minimum  
$max = $svr.Configuration.ShowAdvancedOptions.Maximum  
"Minimum and Maximum values are " + $min.ToString() + " and " + $max.ToString() + "."  
  
#Modify the value of ShowAdvancedOptions and run the Alter method.  
$svr.Configuration.ShowAdvancedOptions.ConfigValue = 0  
$svr.Configuration.Alter()  
  
#Display when the change takes place according to the IsDynamic property.  
If ($svr.Configuration.ShowAdvancedOptions.IsDynamic -eq $true)  
 {    
   "Configuration option has been updated."  
 }  
Else  
{  
    "Configuration option will be updated when SQL Server is restarted."  
}

次の方法で共有