Instance.InstanceDatabaseOptions Property

Article
12/03/2008

Gets or sets the instance database properties, including filegroups, data files, log files, and the database collation.

Namespace: Microsoft.SqlServer.Management.Nmo
Assembly: Microsoft.SqlServer.Smo (in microsoft.sqlserver.smo.dll)

Syntax

'Declaration
Public Property InstanceDatabaseOptions As InstanceDatabaseOptions

public InstanceDatabaseOptions InstanceDatabaseOptions { get; set; }

public:
property InstanceDatabaseOptions^ InstanceDatabaseOptions {
    InstanceDatabaseOptions^ get ();
    void set (InstanceDatabaseOptions^ value);
}

/** @property */
public InstanceDatabaseOptions get_InstanceDatabaseOptions ()

/** @property */
public void set_InstanceDatabaseOptions (InstanceDatabaseOptions value)

public function get InstanceDatabaseOptions () : InstanceDatabaseOptions

public function set InstanceDatabaseOptions (value : InstanceDatabaseOptions)

Property Value

An InstanceDatabaseOptions object that specifies properties of the instance database.

Remarks

Specifying instance database properties is optional. For more information about default values, see Defining the Instance Database.

Example

The following example shows how to define database properties for an instance of Notification Services:

// Define instance database properties
// Create the InstanceDatabaseOptions object
InstanceDatabaseOptions idb = 
    new InstanceDatabaseOptions(myInstance, "MyInstDB");

// Define and add a filegroup
InstanceDatabaseFileGroup idb_fg = 
    new InstanceDatabaseFileGroup(idb, "PRIMARY");
idb.InstanceDatabaseFileGroups.Add(idb_fg);

// Define and add a data file
InstanceDatabaseFile idb_file1 = 
    new InstanceDatabaseFile(idb_fg, "MyInst_PrimaryFile1");
idb_file1.FileName = @"C:\NS\Full\MyInst_PrimaryFile1.mdf";
idb_file1.InitialSize = "5MB";
idb_file1.MaxSize = "15MB";
idb_file1.GrowthIncrement = "10%";
idb_fg.InstanceDatabaseFiles.Add(idb_file1);

// Define and add a log file
InstanceDatabaseLogFile idb_log = 
    new InstanceDatabaseLogFile(idb, "MyInst_LogFile1");
idb_log.FileName = @"C:\NS\Full\MyInst_LogFile1.ldf";
idb_log.InitialSize = "3MB";
idb_log.MaxSize = "10MB";
idb_log.GrowthIncrement = "10%";
idb.InstanceDatabaseLogFiles.Add(idb_log);

// Define database options
idb.CollationName = "Latin1_General_CS_AS";
idb.DefaultFileGroup = "PRIMARY";

// Assign options to Instance.InstanceDatabaseOptions property
myInstance.InstanceDatabaseOptions = idb;

' Create the InstanceDatabaseOptions object
Dim idb As InstanceDatabaseOptions = _
    New InstanceDatabaseOptions(myInstance, "MyInstDB")

' Define and add a filegroup
Dim idb_fg As InstanceDatabaseFileGroup = _
    New InstanceDatabaseFileGroup(idb, "PRIMARY")
idb.InstanceDatabaseFileGroups.Add(idb_fg)

' Define and add a data file
Dim idb_file1 As InstanceDatabaseFile = _
    New InstanceDatabaseFile(idb_fg, "MyInst_PrimaryFile1")
idb_file1.FileName = "C:\NS\Full\MyInst_PrimaryFile1.mdf"
idb_file1.InitialSize = "5MB"
idb_file1.MaxSize = "15MB"
idb_file1.GrowthIncrement = "10%"
idb_fg.InstanceDatabaseFiles.Add(idb_file1)

' Define and add a log file
Dim idb_log As InstanceDatabaseLogFile = _
    New InstanceDatabaseLogFile(idb, "MyInst_LogFile1")
idb_log.FileName = "C:\NS\Full\MyInst_LogFile1.ldf"
idb_log.InitialSize = "3MB"
idb_log.MaxSize = "10MB"
idb_log.GrowthIncrement = "10%"
idb.InstanceDatabaseLogFiles.Add(idb_log)

' Define database options
idb.CollationName = "Latin1_General_CS_AS"
idb.DefaultFileGroup = "PRIMARY"

' Assign options to Instance.InstanceDatabaseOptions property.
myInstance.InstanceDatabaseOptions = idb

Thread Safety

Any public static (Shared in Microsoft Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Platforms

Development Platforms

For a list of the supported platforms, see Hardware and Software Requirements for Installing SQL Server 2005.

Target Platforms