Share via


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
Public property AnsiNullDefault Gets or sets a Boolean property value that specifies whether the ANSI_NULL_DEFAULT database option is active.
Public property AnsiNullsEnabled Gets or sets a Boolean property value that specifies whether the ANSI_NULLS_ENABLED database option is active.
Public property AnsiPaddingEnabled Gets or sets a Boolean property value that specifies whether the ANSI_PADDING_ENABLED database option is active.
Public property AnsiWarningsEnabled Gets or sets a Boolean property value that specifies whether the ANSI_WARNING_ENABLED database option is active.
Public property ArithmeticAbortEnabled Gets or sets a Boolean property value that specifies whether the ARITHMETICABORT database option is active.
Public property AutoClose Gets or sets a Boolean property value that specifies whether the AUTOCLOSE database option is active.
Public property AutoCreateStatistics Gets or sets a Boolean property value that specifies whether the AUTOCREATESTATISTICS database option is active.
Public property AutoShrink Gets or sets a Boolean property value that specifies whether the AUTOSHRINK database option is active.
Public property AutoUpdateStatistics Gets or sets a Boolean property value that specifies whether the AUTOUPDATESTATISTICS database option is active.
Public property AutoUpdateStatisticsAsync Gets or sets a Boolean property value that specifies whether the AUTOUPDATESTATISTICSASYNC database option is active.
Public property BrokerEnabled Gets or sets a Boolean property value that specifies whether the Service Broker service is enabled.
Public property CloseCursorsOnCommitEnabled Gets or sets a Boolean property value that specifies whether the CURSOR_CLOSE_ON_COMMIT database option is active.
Public property ConcatenateNullYieldsNull Gets or sets a Boolean property value that specifies whether the CONCAT_NULL_YIELDS_NULL database option is active.
Public property DatabaseOwnershipChaining Gets or sets a Boolean property value that specifies whether the database ownership chaining is active.
Public property DateCorrelationOptimization Gets or sets a Boolean property value that specifies whether the date correlation optimization is active.
Public property IsParameterizationForced Gets or sets a Boolean property value that specifies whether parameterization is forced on the database.
Public property LocalCursorsDefault Gets the Boolean value that specifies whether the local server cursors are used by default.
Public property MirroringRedoQueueMaxSize Gets or sets the maximum size of the redo queue of the mirror server instance in KB.
Public property 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.
Public property NumericRoundAbortEnabled Gets or sets a Boolean property value that specifies whether the NUMERIC_ROUNDABORT database option is active.
Public property PageVerify Specifies the type of page integrity check that Microsoft SQL Server performs when reading database pages.
Public property Parent Gets the Database object that is the parent of the DatabaseOptions object.
Public property Properties Gets a collection of Property objects that represent the object properties.
Public property 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.
Public property ReadOnly Gets or sets the Boolean property value that specifies whether the database is read-only.
Public property RecoveryModel Gets or sets the recovery model for the database.
Public property RecursiveTriggersEnabled Gets or sets the Boolean value that specifies whether recursive triggers are enabled on the database.
Public property SnapshotIsolationState Gets the snapshot isolation state for the database.
Public property State Gets the state of the referenced object. (Inherited from SmoObjectBase.)
Public property Trustworthy The TRUSTWORTHY database property is used to indicate whether the instance of SQL Server trusts the database and the contents within it.
Public property Urn Gets the Uniform Resource Name (URN) address value that uniquely identifies the object. (Inherited from SqlSmoObject.)
Public property UserAccess Gets or sets the database user access.
Public property UserData Gets or sets user-defined data associated with the referenced object. (Inherited from SmoObjectBase.)

Top

Methods

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

Top

Events

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

Top

Explicit Interface Implementations

  Name Description
Explicit interface implemetationPrivate method IAlienObject.Discover Discovers any dependencies. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate method IAlienObject.GetDomainRoot Returns the root of the domain. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate method 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.)
Explicit interface implemetationPrivate method IAlienObject.GetPropertyType Gets the type of the specified property. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate method IAlienObject.GetPropertyValue Gets the value of the specified property. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate method 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.)
Explicit interface implemetationPrivate method IAlienObject.Resolve Gets the instance that contains the information about the object from the Unified Resource Name (URN) of the object. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate method IAlienObject.SetObjectState Sets the object state to the specified SfcObjectState value. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate method IAlienObject.SetPropertyValue Sets the property value. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate method 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