Export (0) Print
Expand All

DatabaseOptions Class

The DatabaseOptions object represents SQL Server database options.

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

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

The DatabaseOptions type exposes the following members.

  NameDescription
Public propertyAnsiNullDefaultGets or sets a Boolean property value that specifies whether the ANSI_NULL_DEFAULT database option is active.
Public propertyAnsiNullsEnabledGets or sets a Boolean property value that specifies whether the ANSI_NULLS_ENABLED database option is active.
Public propertyAnsiPaddingEnabledGets or sets a Boolean property value that specifies whether the ANSI_PADDING_ENABLED database option is active.
Public propertyAnsiWarningsEnabledGets or sets a Boolean property value that specifies whether the ANSI_WARNING_ENABLED database option is active.
Public propertyArithmeticAbortEnabledGets or sets a Boolean property value that specifies whether the ARITHMETICABORT database option is active.
Public propertyAutoCloseGets or sets a Boolean property value that specifies whether the AUTOCLOSE database option is active.
Public propertyAutoCreateStatisticsGets or sets a Boolean property value that specifies whether the AUTOCREATESTATISTICS database option is active.
Public propertyAutoShrinkGets or sets a Boolean property value that specifies whether the AUTOSHRINK database option is active.
Public propertyAutoUpdateStatisticsGets or sets a Boolean property value that specifies whether the AUTOUPDATESTATISTICS database option is active.
Public propertyAutoUpdateStatisticsAsyncGets or sets a Boolean property value that specifies whether the AUTOUPDATESTATISTICSASYNC database option is active.
Public propertyBrokerEnabledGets or sets a Boolean property value that specifies whether the Service Broker service is enabled.
Public propertyCloseCursorsOnCommitEnabledGets or sets a Boolean property value that specifies whether the CURSOR_CLOSE_ON_COMMIT database option is active.
Public propertyConcatenateNullYieldsNullGets or sets a Boolean property value that specifies whether the CONCAT_NULL_YIELDS_NULL database option is active.
Public propertyDatabaseOwnershipChainingGets or sets a Boolean property value that specifies whether the database ownership chaining is active.
Public propertyDateCorrelationOptimizationGets or sets a Boolean property value that specifies whether the date correlation optimization is active.
Protected propertyExecuteForScalarGets or sets the Boolean property value that specifies whether the object is set to the execute for scalar option. (Inherited from SqlSmoObject.)
Public propertyIsParameterizationForcedGets or sets a Boolean property value that specifies whether parameterization is forced on the database.
Protected propertyIsTouchedGets the Boolean property value that specifies whether the object properties have been updated but not yet persisted on the server. (Inherited from SqlSmoObject.)
Public propertyLocalCursorsDefaultGets the Boolean value that specifies whether the local server cursors are used by default.
Public propertyMirroringRedoQueueMaxSizeGets or sets the maximum size of the redo queue of the mirror server instance in KB.
Public propertyMirroringTimeoutGets 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 propertyNumericRoundAbortEnabledGets or sets a Boolean property value that specifies whether the NUMERIC_ROUNDABORT database option is active.
Protected propertyObjectInSpaceGets the Boolean property value that specifies whether the object exists in isolation, or whether it is directly or indirectly connected to the instance of SQL Server. (Inherited from SqlSmoObject.)
Public propertyPageVerifySpecifies the type of page integrity check that Microsoft SQL Server performs when reading database pages.
Public propertyParentGets the Database object that is the parent of the DatabaseOptions object.
Public propertyPropertiesGets a collection of Property objects that represent the object properties.
Public propertyQuotedIdentifiersEnabledGets 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 propertyReadOnlyGets or sets the Boolean property value that specifies whether the database is read-only.
Public propertyRecoveryModelGets or sets the recovery model for the database.
Public propertyRecursiveTriggersEnabledGets or sets the Boolean value that specifies whether recursive triggers are enabled on the database.
Protected propertyScalarResultGets the scalar result for the referenced object. (Inherited from SqlSmoObject.)
Public propertySnapshotIsolationStateGets the snapshot isolation state for the database.
Public propertyStateGets the state of the referenced object. (Inherited from SmoObjectBase.)
Public propertyTrustworthyThe TRUSTWORTHY database property is used to indicate whether the instance of SQL Server trusts the database and the contents within it.
Public propertyUrnGets the Uniform Resource Name (URN) address value that uniquely identifies the object. (Inherited from SqlSmoObject.)
Public propertyUserAccessGets or sets the database user access.
Public propertyUserDataGets or sets user-defined data associated with the referenced object. (Inherited from SmoObjectBase.)
Top

  NameDescription
Protected methodAddDatabaseContext(StringCollection)Add the database context to the collection of queries identified by the queries parameter. (Inherited from SqlSmoObject.)
Protected methodAddDatabaseContext(StringCollection, ScriptingOptions)Add the database context to the collection of queries identified by the queries parameter, and using the specified scripting options. (Inherited from SqlSmoObject.)
Public methodAlter()Updates any DatabaseOptions object property changes on the instance of SQL Server.
Public methodAlter(TimeSpan)Updates any DatabaseOptions object property changes on the instance of Microsoft SQL Server.
Public methodAlter(TerminationClause)Updates any DatabaseOptions object property changes on the instance of SQL Server.
Protected methodAlterImplActivates the object altered event. (Inherited from SqlSmoObject.)
Protected methodAlterImplFinishMethod called when object altered event finishes. (Inherited from SqlSmoObject.)
Protected methodAlterImplInitMethod called when object-altered event is intialized. (Inherited from SqlSmoObject.)
Protected methodAlterImplWorkerCalls the Alter methods. (Inherited from SqlSmoObject.)
Protected methodBindDefaultImplBinds the default items identified by the parameters. (Inherited from SqlSmoObject.)
Protected methodBindRuleImplBinds the rule schema to the rule and columns identified by the parameters. (Inherited from SqlSmoObject.)
Protected methodCheckCollationChecks the order of the scripting options by the collation method identified by the collationName parameter. (Inherited from SqlSmoObject.)
Protected methodCheckObjectState()Validates the state of the referenced object. (Inherited from SqlSmoObject.)
Protected methodCheckObjectState(Boolean)Validates the state of the referenced object with the option to specify that an exception is thrown if the object is not yet created. (Inherited from SqlSmoObject.)
Protected methodCheckObjectStateImplChecks the state of a SqlSmoObject. (Inherited from SqlSmoObject.)
Protected methodCheckVersion100Checks whether version of SQL Server is SQL Server 2008. (Inherited from SqlSmoObject.)
Protected methodCheckVersion80Checks the validity of the object on SQL Server 2000. (Inherited from SqlSmoObject.)
Protected methodCheckVersion80SP3Checks the validity of the object on SQL Server 2000 SP3. (Inherited from SqlSmoObject.)
Protected methodCheckVersion90Check the validity of the object on SQL Server 2005. (Inherited from SqlSmoObject.)
Protected methodCheckVersionBelow90Checks whether version of SQL Server is before SQL Server 2005. (Inherited from SqlSmoObject.)
Protected methodCleanObjectSets the object to unmodified state. (Inherited from SqlSmoObject.)
Protected methodCreateImplCreates an object with scripting options. (Inherited from SqlSmoObject.)
Protected methodCreateImplFinishMethod called when the create event finishes. (Inherited from SqlSmoObject.)
Protected methodCreateImplInitMethod called when the create event initializes. (Inherited from SqlSmoObject.)
Public methodDiscoverDiscovers a list of type Object. (Inherited from SqlSmoObject.)
Protected methodDropImplDrops a SqlSmoObject. (Inherited from SqlSmoObject.)
Protected methodDropImplWorkerCalls the drop methods. (Inherited from SqlSmoObject.)
Protected methodEnumScriptImplEnumerates scripts specified by the so parameter. (Inherited from SqlSmoObject.)
Protected methodEnumScriptImplWorkerCalls the methods that enumerate scripts specified by the so parameter. (Inherited from SqlSmoObject.)
Protected methodEnumScriptImplWorkerSOChangedReturns an IEnumerable string describing the scripting options for an object. (Inherited from SqlSmoObject.)
Public methodEquals (Inherited from Object.)
Protected methodExecuteNonQueryExecutes a batch in the context of the database where there are no results returned. (Inherited from SqlSmoObject.)
Protected methodFinalize (Inherited from Object.)
Protected methodFormatSqlVariantFormats an object as SqlVariant type. (Inherited from SqlSmoObject.)
Protected methodGenerateDataSpaceFileStreamScriptGenerates a script to create data file. (Inherited from SqlSmoObject.)
Protected methodGenerateDataSpaceScriptGenerates a script to allocate space in the data file. (Inherited from SqlSmoObject.)
Protected methodGetBindDefaultScriptGets the script that binds defaults specified by the defSchema and defName parameters. (Inherited from SqlSmoObject.)
Protected methodGetBindRuleScriptGets the script that specifies the binding rules. (Inherited from SqlSmoObject.)
Protected methodGetBoolParameter(StringBuilder, ScriptingOptions, String, String, Int32)Assigns a Boolean parameter of the SqlSmoObject. (Inherited from SqlSmoObject.)
Protected methodGetBoolParameter(StringBuilder, ScriptingOptions, String, String, Int32, Boolean)Assigns a Boolean property of the SqlSmoObject. (Inherited from SqlSmoObject.)
Protected methodGetDateTimeParameterAssigns the datetime property of the SqlSmoObject. (Inherited from SqlSmoObject.)
Protected methodGetDateTimeParameterAsIntAssigns the datetime property of the SqlSmoObject as an integer value if the datetime property is not null. (Inherited from SqlSmoObject.)
Protected methodGetDBNameGets the database name that is associated with the object. (Inherited from SqlSmoObject.)
Protected methodGetEnumParameterAssigns an enumeration property of the SqlSmoObject. (Inherited from SqlSmoObject.)
Protected methodGetFragOptionStringGets a FragmentationOption object as a string value. (Inherited from SqlSmoObject.)
Protected methodGetGuidParameterAssigns a Guid property of the SqlSmoObject. (Inherited from SqlSmoObject.)
Public methodGetHashCode (Inherited from Object.)
Protected methodGetParameter(StringBuilder, ScriptingOptions, String, String, Int32)Assigns a parameter of the SqlSmoObject. (Inherited from SqlSmoObject.)
Protected methodGetParameter(StringBuilder, ScriptingOptions, String, String, Int32, Boolean)Assigns a parameter of the SqlSmoObject. (Inherited from SqlSmoObject.)
Protected methodGetPropValueGets a property value of the SqlSmoObject object. (Inherited from SqlSmoObject.)
Protected methodGetPropValueOptionalGets a property value of the SqlSmoObject object. (Inherited from SqlSmoObject.)
Protected methodGetPropValueOptionalAllowNullGets a property value of the SqlSmoObject object. (Inherited from SqlSmoObject.)
Protected methodGetRealValueGets a property value of the SqlSmoObject object. (Inherited from SqlSmoObject.)
Protected methodGetScriptingOptionsForCreateGets ScriptingOptions for the SqlSmoObject object. (Inherited from SqlSmoObject.)
Protected methodGetServerNameGets the name of the instance of SQL Server with which the object is associated. (Inherited from SqlSmoObject.)
Protected methodGetServerObjectGets the server of the SqlSmoObject object. (Inherited from SqlSmoObject.)
Protected methodGetSqlServerVersionNameGets the version name of the instance of SQL Server with which the object is associated. (Inherited from SqlSmoObject.)
Protected methodGetStringParameter(StringBuilder, ScriptingOptions, String, String, Int32)Assigns a string parameter of the SqlSmoObject object. (Inherited from SqlSmoObject.)
Protected methodGetStringParameter(StringBuilder, ScriptingOptions, String, String, Int32, Boolean)Assigns a string parameter of the SqlSmoObject object. (Inherited from SqlSmoObject.)
Protected methodGetTimeSpanParameterAsIntAssigns a time span parameter of the SqlSmoObject object. (Inherited from SqlSmoObject.)
Public methodGetType (Inherited from Object.)
Protected methodGetUrnRecursive(StringBuilder)Assigns an Urn object of the SqlSmoObject object. (Inherited from SqlSmoObject.)
Protected methodGetUrnRecursive(StringBuilder, UrnIdOption)Assigns an Urn object of the SqlSmoObject object. (Inherited from SqlSmoObject.)
Protected methodImplInitializeInitializes the fields of the SqlSmoObject object. (Inherited from SqlSmoObject.)
Public methodInitialize()Initializes the object and forces the properties be loaded. (Inherited from SqlSmoObject.)
Public methodInitialize(Boolean)Initializes the object and forces the properties be loaded. (Inherited from SqlSmoObject.)
Protected methodIsObjectDirtyVerifies whether the object properties have been modified and the changes have not yet been persisted on the instance of SQL Server. (Inherited from SqlSmoObject.)
Protected methodIsObjectInitializedVerifies whether the object has been initialized. (Inherited from SqlSmoObject.)
Protected methodIsObjectInSpaceVerifies whether the object is isolated or connected to the instance of SQL Server. (Inherited from SqlSmoObject.)
Protected methodIsVersion80SP3Determines whether the version of SQL Server is SQL Server 2000 with SP3. (Inherited from SqlSmoObject.)
Protected methodIsVersion90AndAboveDetermines whether the version of SQL Server is SQL Server 2005 or later. (Inherited from SqlSmoObject.)
Protected methodMarkDroppedSets the SqlSmoState to dropped. (Inherited from SqlSmoObject.)
Protected methodMarkForDropImplSets the SqlSmoState to dropped. (Inherited from SqlSmoObject.)
Protected methodMemberwiseClone (Inherited from Object.)
Protected methodPostAlterMethod activated after the SqlSmoObject is altered. (Inherited from SqlSmoObject.)
Protected methodPostCreateMethod activated after the SqlSmoObject is created. (Inherited from SqlSmoObject.)
Protected methodPostDropMethod activated after the SqlSmoObject is dropped. (Inherited from SqlSmoObject.)
Public methodRefreshRefreshes the object and retrieves properties when the object is next accessed. (Overrides SqlSmoObject.Refresh().)
Protected methodScriptAlterAlters the SqlSmoObject according to the parameters. (Inherited from SqlSmoObject.)
Protected methodScriptCreateAlters the SqlSmoObject according to the parameters. (Inherited from SqlSmoObject.)
Protected methodScriptDdlThrows InvalidSmoOperationException. (Inherited from SqlSmoObject.)
Protected methodScriptDropThrows InvalidSmoOperationException. (Inherited from SqlSmoObject.)
Protected methodScriptImpl()Gets a collection of scripts of the SqlSmoObject. (Inherited from SqlSmoObject.)
Protected methodScriptImpl(ScriptingOptions)Gets a collection of scripts of the SqlSmoObject. (Inherited from SqlSmoObject.)
Protected methodScriptImplWorkerGets a collection of scripts of the SqlSmoObject. (Inherited from SqlSmoObject.)
Protected methodSetParentImplSets the parent of the SqlSmoObject to the newParent parameter. (Inherited from SqlSmoObject.)
Public methodSetSnapshotIsolationSets the snapshot isolation level.
Public methodToStringReturns a String that represents the referenced object. (Inherited from SqlSmoObject.)
Protected methodTouchImplNot implemented. (Inherited from SqlSmoObject.)
Protected methodUnbindDefaultImplUnbinds the default columns of the SqlSmoObject. (Inherited from SqlSmoObject.)
Protected methodUnbindRuleImplUnbinds rules of the SqlSmoObject. (Inherited from SqlSmoObject.)
Public methodValidateValidates the state of an object. (Inherited from SmoObjectBase.)
Top

  NameDescription
Public eventPropertyChangedRepresents the event that occurs when a property is changed. (Inherited from SqlSmoObject.)
Public eventPropertyMetadataChangedRepresents the event that occurs when property metadata changes. (Inherited from SqlSmoObject.)
Top

  NameDescription
Protected fieldm_ExtendedPropertiesRepresents a property that is defined to extend the properties provided by a SqlSmoObject. (Inherited from SqlSmoObject.)
Protected fieldsingletonParentRepresents the singleton parent. (Inherited from SqlSmoObject.)
Top

  NameDescription
Explicit interface implemetationPrivate methodIAlienObject.DiscoverDiscovers any dependencies. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate methodIAlienObject.GetDomainRootReturns the root of the domain. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate methodIAlienObject.GetParentGets 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 methodIAlienObject.GetPropertyTypeGets the type of the specified property. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate methodIAlienObject.GetPropertyValueGets the value of the specified property. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate methodIAlienObject.GetUrnGets the Unified Resource Name of the object. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate methodIAlienObject.ResolveGets the instance that contains the information about the object from the Unified Resource Name of the object. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate methodIAlienObject.SetObjectStateSets the object state to the specified SfcObjectState value. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate methodIAlienObject.SetPropertyValueSets the property value. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate methodISfcPropertyProvider.GetPropertySetGets the interface reference to the set of properties of this object. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SqlSmoObject.)
Top

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.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft