DatabaseOptions Class

The DatabaseOptions object represents SQL Server database options.

Inheritance Hierarchy

System.Object
  Microsoft.SqlServer.Management.Smo.SmoObjectBase
    Microsoft.SqlServer.Management.Smo.SqlSmoObject
      Microsoft.SqlServer.Management.Smo.DatabaseOptions

Namespace:  Microsoft.SqlServer.Management.Smo
Assembly:  Microsoft.SqlServer.Smo (in Microsoft.SqlServer.Smo.dll)

Syntax

'Declaration
<SfcElementTypeAttribute("Option")> _
Public NotInheritable Class DatabaseOptions _
    Inherits SqlSmoObject _
    Implements IAlterable
'Usage
Dim instance As DatabaseOptions

[SfcElementTypeAttribute("Option")]
public sealed class DatabaseOptions : SqlSmoObject, 
    IAlterable

[SfcElementTypeAttribute(L"Option")]
public ref class DatabaseOptions sealed : public SqlSmoObject, 
    IAlterable

[<SealedAttribute>]
[<SfcElementTypeAttribute("Option")>]
type DatabaseOptions =  
    class 
        inherit SqlSmoObject 
        interface IAlterable 
    end

public final class DatabaseOptions extends SqlSmoObject implements IAlterable

The DatabaseOptions type exposes the following members.

Properties

	Name	Description
	AnsiNullDefault	Gets or sets a Boolean property value that specifies whether the ANSI_NULL_DEFAULT database option is active.
	AnsiNullsEnabled	Gets or sets a Boolean property value that specifies whether the ANSI_NULLS_ENABLED database option is active.
	AnsiPaddingEnabled	Gets or sets a Boolean property value that specifies whether the ANSI_PADDING_ENABLED database option is active.
	AnsiWarningsEnabled	Gets or sets a Boolean property value that specifies whether the ANSI_WARNING_ENABLED database option is active.
	ArithmeticAbortEnabled	Gets or sets a Boolean property value that specifies whether the ARITHMETICABORT database option is active.
	AutoClose	Gets or sets a Boolean property value that specifies whether the AUTOCLOSE database option is active.
	AutoCreateStatistics	Gets or sets a Boolean property value that specifies whether the AUTOCREATESTATISTICS database option is active.
	AutoShrink	Gets or sets a Boolean property value that specifies whether the AUTOSHRINK database option is active.
	AutoUpdateStatistics	Gets or sets a Boolean property value that specifies whether the AUTOUPDATESTATISTICS database option is active.
	AutoUpdateStatisticsAsync	Gets or sets a Boolean property value that specifies whether the AUTOUPDATESTATISTICSASYNC database option is active.
	BrokerEnabled	Gets or sets a Boolean property value that specifies whether the Service Broker service is enabled.
	CloseCursorsOnCommitEnabled	Gets or sets a Boolean property value that specifies whether the CURSOR_CLOSE_ON_COMMIT database option is active.
	ConcatenateNullYieldsNull	Gets or sets a Boolean property value that specifies whether the CONCAT_NULL_YIELDS_NULL database option is active.
	DatabaseOwnershipChaining	Gets or sets a Boolean property value that specifies whether the database ownership chaining is active.
	DateCorrelationOptimization	Gets or sets a Boolean property value that specifies whether the date correlation optimization is active.
	IsParameterizationForced	Gets or sets a Boolean property value that specifies whether parameterization is forced on the database.
	LocalCursorsDefault	Gets the Boolean value that specifies whether the local server cursors are used by default.
	MirroringRedoQueueMaxSize	Gets or sets the maximum size of the redo queue of the mirror server instance in KB.
	MirroringTimeout	Gets or sets the maximum time, in seconds, that the principal server instance waits for a PING message from another instance in the mirroring session before assuming the other instance is disconnected.
	NumericRoundAbortEnabled	Gets or sets a Boolean property value that specifies whether the NUMERIC_ROUNDABORT database option is active.
	PageVerify	Specifies the type of page integrity check that Microsoft SQL Server performs when reading database pages.
	Parent	Gets the Database object that is the parent of the DatabaseOptions object.
	Properties	Gets a collection of Property objects that represent the object properties.
	QuotedIdentifiersEnabled	Gets or sets a Boolean property value that specifies whether identifiers delimited by double quotation marks (" ") are Transact-SQL reserved keywords or contain characters not usually allowed by the Transact-SQL syntax rules.
	ReadOnly	Gets or sets the Boolean property value that specifies whether the database is read-only.
	RecoveryModel	Gets or sets the recovery model for the database.
	RecursiveTriggersEnabled	Gets or sets the Boolean value that specifies whether recursive triggers are enabled on the database.
	SnapshotIsolationState	Gets the snapshot isolation state for the database.
	State	Gets the state of the referenced object. (Inherited from SmoObjectBase.)
	Trustworthy	The TRUSTWORTHY database property is used to indicate whether the instance of SQL Server trusts the database and the contents within it.
	Urn	Gets the Uniform Resource Name (URN) address value that uniquely identifies the object. (Inherited from SqlSmoObject.)
	UserAccess	Gets or sets the database user access.
	UserData	Gets or sets user-defined data associated with the referenced object. (Inherited from SmoObjectBase.)

Top

Methods

	Name	Description
	Alter()	Updates any DatabaseOptions object property changes on the instance of SQL Server.
	Alter(TimeSpan)	Updates any DatabaseOptions object property changes on the instance of Microsoft SQL Server.
	Alter(TerminationClause)	Updates any DatabaseOptions object property changes on the instance of SQL Server.
	Discover	Discovers a list of type Object. (Inherited from SqlSmoObject.)
	Equals	(Inherited from Object.)
	FormatSqlVariant	Formats an object as SqlVariant type. (Inherited from SqlSmoObject.)
	GetContextDB	Gets the context database that is associated with this object. (Inherited from SqlSmoObject.)
	GetDBName	Gets the database name that is associated with the object. (Inherited from SqlSmoObject.)
	GetHashCode	(Inherited from Object.)
	GetPropValue	Gets a property value of the SqlSmoObject object. (Inherited from SqlSmoObject.)
	GetPropValueOptional	Gets a property value of the SqlSmoObject object. (Inherited from SqlSmoObject.)
	GetPropValueOptionalAllowNull	Gets a property value of the SqlSmoObject object. (Inherited from SqlSmoObject.)
	GetServerObject	Gets the server of the SqlSmoObject object. (Inherited from SqlSmoObject.)
	GetType	(Inherited from Object.)
	Initialize()	Initializes the object and forces the properties be loaded. (Inherited from SqlSmoObject.)
	Initialize(Boolean)	Initializes the object and forces the properties be loaded. (Inherited from SqlSmoObject.)
	IsObjectInitialized	Verifies whether the object has been initialized. (Inherited from SqlSmoObject.)
	IsObjectInSpace	Verifies whether the object is isolated or connected to the instance of SQL Server. (Inherited from SqlSmoObject.)
	Refresh	Refreshes the object and retrieves properties when the object is next accessed. (Overrides SqlSmoObject.Refresh().)
	SetParentImpl	Sets the parent of the SqlSmoObject to the newParent parameter. (Inherited from SqlSmoObject.)
	SetSnapshotIsolation	Sets the snapshot isolation level.
	ToString	Returns a String that represents the referenced object. (Inherited from SqlSmoObject.)
	Validate	Validates the state of an object. (Inherited from SmoObjectBase.)

Top

Events

	Name	Description
	PropertyChanged	Represents the event that occurs when a property is changed. (Inherited from SqlSmoObject.)
	PropertyMetadataChanged	Represents the event that occurs when property metadata changes. (Inherited from SqlSmoObject.)

Top

Explicit Interface Implementations

	Name	Description
	IAlienObject.Discover	Discovers any dependencies. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SqlSmoObject.)
	IAlienObject.GetDomainRoot	Returns the root of the domain. (Inherited from SqlSmoObject.)
	IAlienObject.GetParent	Gets the parent of this object. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SqlSmoObject.)
	IAlienObject.GetPropertyType	Gets the type of the specified property. (Inherited from SqlSmoObject.)
	IAlienObject.GetPropertyValue	Gets the value of the specified property. (Inherited from SqlSmoObject.)
	IAlienObject.GetUrn	Gets the Unified Resource Name (URN) of the object. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SqlSmoObject.)
	IAlienObject.Resolve	Gets the instance that contains the information about the object from the Unified Resource Name (URN) of the object. (Inherited from SqlSmoObject.)
	IAlienObject.SetObjectState	Sets the object state to the specified SfcObjectState value. (Inherited from SqlSmoObject.)
	IAlienObject.SetPropertyValue	Sets the property value. (Inherited from SqlSmoObject.)
	ISfcPropertyProvider.GetPropertySet	Gets the interface reference to the set of properties of this object. (Inherited from SqlSmoObject.)

Top

Remarks

This feature will be removed in a future version of Microsoft SQL Server. Avoid using this feature in new development work, and plan to modify applications that currently use this feature. Configurable database options, such as ANSI settings, cursor settings, arithmetic behavior, recovery model, and the read-only status, are contained in the DatabaseOptions object. The DatabaseOptions object is a child of the Database object.

Thread Safety

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

Examples

Setting Properties

Thread Safety

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

See Also

Reference

Microsoft.SqlServer.Management.Smo Namespace

Other Resources

Database Options