Article
02/08/2012

Database Class

The Database object represents a SQL Server database.

Inheritance Hierarchy

System.Object
  Microsoft.SqlServer.Management.Smo.SmoObjectBase
    Microsoft.SqlServer.Management.Smo.SqlSmoObject
      Microsoft.SqlServer.Management.Smo.NamedSmoObject
        Microsoft.SqlServer.Management.Smo.ScriptNameObjectBase
          Microsoft.SqlServer.Management.Smo.Database

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

Syntax

'Declaration
<EvaluationModeAttribute(AutomatedPolicyEvaluationMode.CheckOnSchedule)> _
<PhysicalFacetAttribute> _
Public NotInheritable Class Database _
    Inherits ScriptNameObjectBase _
    Implements ICreatable, IAlterable, IDroppable, IRenamable,  _
    IExtendedProperties, IScriptable, IDatabaseOptions, IDmfFacet, ISfcSupportsDesignMode
'Usage
Dim instance As Database

[EvaluationModeAttribute(AutomatedPolicyEvaluationMode.CheckOnSchedule)]
[PhysicalFacetAttribute]
public sealed class Database : ScriptNameObjectBase, 
    ICreatable, IAlterable, IDroppable, IRenamable, IExtendedProperties, 
    IScriptable, IDatabaseOptions, IDmfFacet, ISfcSupportsDesignMode

[EvaluationModeAttribute(AutomatedPolicyEvaluationMode::CheckOnSchedule)]
[PhysicalFacetAttribute]
public ref class Database sealed : public ScriptNameObjectBase, 
    ICreatable, IAlterable, IDroppable, IRenamable, IExtendedProperties, 
    IScriptable, IDatabaseOptions, IDmfFacet, ISfcSupportsDesignMode

[<SealedAttribute>]
[<EvaluationModeAttribute(AutomatedPolicyEvaluationMode.CheckOnSchedule)>]
[<PhysicalFacetAttribute>]
type Database =  
    class
        inherit ScriptNameObjectBase
        interface ICreatable
        interface IAlterable
        interface IDroppable
        interface IRenamable
        interface IExtendedProperties
        interface IScriptable
        interface IDatabaseOptions
        interface IDmfFacet
        interface ISfcSupportsDesignMode
    end

public final class Database extends ScriptNameObjectBase implements ICreatable, IAlterable, IDroppable, IRenamable, IExtendedProperties, IScriptable, IDatabaseOptions, IDmfFacet, ISfcSupportsDesignMode

The Database type exposes the following members.

Constructors

	Name	Description
	Database()	Initializes a new instance of the Database class.
	Database(Server, String)	Initializes a new instance of the Database class on the specified server and with the specified name.

Top

Properties

	Name	Description
	ActiveConnections	Gets the number of active connections to the database.
	ActiveDirectory	Gets the information about the Active Directory settings for the database.
	AnsiNullDefault	Gets or sets AnsiNullDefault Property.
	AnsiNullsEnabled	Gets or sets the Boolean ANSI_NULLS_ENABLED property value.
	AnsiPaddingEnabled	Gets or sets the ANSI_PADDING_ENABLED database option is enabled.
	AnsiWarningsEnabled	Gets or sets the Boolean ANSI_WARNING_ENABLED property value.
	ApplicationRoles	Represents a collection of ApplicationRole objects. Each ApplicationRole object represents an application role defined on the database.
	ArithmeticAbortEnabled	Gets or sets the ARITHMETICABORT property value.
	Assemblies	Represents a collection of SqlAssembly objects. Each SqlAssembly object represents an assembly defined on the database.
	AsymmetricKeys	Represents a collection of AsymmetricKey objects. Each AsymmetricKey object represents an asymmetric key defined on the database.
	AutoClose	Gets or sets the AUTOCLOSE database option is set.
	AutoCreateStatisticsEnabled	Gets a Boolean property value that specifies whether statistics are automatically created for the database.
	AutoShrink	Gets or sets the AUTO_SHRINK database option.
	AutoUpdateStatisticsAsync	Gets or sets a property value that specifies whether the AUTOUPDATESTATISTICSASYNC database option is active.
	AutoUpdateStatisticsEnabled	Gets a Boolean property value that specifies whether statistics are automatically updated for the database.
	BrokerEnabled	Gets or sets a property value that specifies whether the Service Broker service is enabled.
	CaseSensitive	Gets a Boolean property value that specifies whether uppercase letters and lowercase letters are evaluated as equal.
	Certificates	Represents a collection of Certificate objects. Each Certificate object represents a certificate defined on the database.
	ChangeTrackingAutoCleanUp	Gets or sets a Boolean property value that specifies whether the CHANGE_TRACKING_AUTO_CLEANUP OPTION is enabled.
	ChangeTrackingEnabled	Gets or sets a property value that specifies whether the CHANGE_TRACKING_VALUE option is enabled
	ChangeTrackingRetentionPeriod	Gets or sets the CHANGE_TRACKING_RETENTION_PERIOD value.
	ChangeTrackingRetentionPeriodUnits	Gets or sets the unit type for a retention period value.
	CloseCursorsOnCommitEnabled	Gets or sets a value that specifies whether the CURSOR_CLOSE_ON_COMMIT database option is active.
	Collation	Gets or sets the default collation used by the database.
	CompatibilityLevel	Gets or sets the compatibility level for the database.
	ConcatenateNullYieldsNull	Gets or sets a property value that specifies whether the CONCAT_NULL_YIELDS_NULL database option is active.
	CreateDate	Gets the date that the database was created.
	DatabaseAuditSpecifications	Represents a collection of DatabaseAuditSpecification objects. Each DatabaseAuditSpecification object represents an database audit specification defined on the server.
	DatabaseEncryptionKey	Gets a DataBaseEncryptionKey datatype.
	DatabaseGuid	Gets the Guid value that uniquely identifies the database.
	DatabaseOptions	Gets the DatabaseOptions object that contains configuration options for the database.
	DatabaseOwnershipChaining	Gets or sets a property value that specifies whether the database ownership chaining is active.
	DatabaseSnapshotBaseName	Gets the name of the snapshot base for the database.
	DataSpaceUsage	Gets the space used by the data in the database.
	DateCorrelationOptimization	Gets or sets a property value that specifies whether the date correlation optimization is active. For more information about date correlation optimization, see Setting Database Options.
	DboLogin	Gets the Boolean value that specifies whether the current user is logged on as the database owner (DBO).
	DefaultFileGroup	Gets the default file group used by the database.
	DefaultFileStreamFileGroup	Gets a DefaultFileStreamFileGroup datatype
	DefaultFullTextCatalog	Gets the default full-text catalog used by the database.
	Defaults	Represents a collection of Default objects. Each Default object represents a default defined on the database.
	DefaultSchema	Gets the default schema of the user.
	EncryptionEnabled	Gets or sets the ENCRYPTIONENABLED property of a database.
	Events	Gets the events associated with the database.
	ExecuteForScalar	Gets or sets the Boolean property value that specifies whether the object is set to the execute for scalar option. (Inherited from SqlSmoObject.)
	ExtendedProperties	Gets the extended properties of the database.
	ExtendedStoredProcedures	Represents a collection of ExtendedStoredProcedure objects. Each ExtendedStoredProcedure object represents an extended stored procedure defined on the database.
	FileGroups	Represents a collection of FileGroup objects. Each FileGroup object represents a filegroup defined on the database.
	FullTextCatalogs	Represents a collection of FullTextCatalog objects. Each FullTextCatalog object represents a full-text catalog defined on the database.
	FullTextStopLists	Represents a collection of FullTextStopList objects. Each FullTextStopList object represents a full text stop list defined on the server.
	HonorBrokerPriority	Gets or sets the Boolean value that specifies whether the priority specified by the broker is acknowledged or not.
	ID	Gets the database ID value that uniquely identifies the database.
	IndexSpaceUsage	Gets the space used by the indexes in the database.
	IsAccessible	Gets a Boolean property value that specifies whether the database can be accessed.
	IsDatabaseSnapshot	Gets a Boolean property value that specifies whether the database is a snapshot database.
	IsDatabaseSnapshotBase	Gets a Boolean property value that specifies whether the database is the base database for a snapshot database.
	IsDbAccessAdmin	Gets a Boolean property value that specifies whether the current user is a member of the DbAccessAdmin database role.
	IsDbBackupOperator	Gets a Boolean property value that specifies whether the current user is a member of the DbBackupOperator database role.
	IsDbDatareader	Gets a Boolean property value that specifies whether the current user is a member of the DbDatareader database role.
	IsDbDatawriter	Gets a Boolean property value that specifies whether the current user is a member of the DbDatawriter database role.
	IsDbDdlAdmin	Gets a Boolean property value that specifies whether the current user is a member of the DbDdlAdmin database role.
	IsDbDenyDatareader	Gets a Boolean property value that specifies whether the current user is a member of the DbDenyDatareader database role.
	IsDbDenyDatawriter	Gets a Boolean property value that specifies whether the current member is a member of the DbDenyDatawriter database.
	IsDbManager	Gets a Boolean value that specifies whether the current login is a database manager in SQL Azure.
	IsDbOwner	Gets a Boolean property value that specifies whether the current user is a member of the DbOwner database role.
	IsDbSecurityAdmin	Gets a Boolean property value that specifies whether the current user is a member of the DbSecurityAdmin database role.
	IsFullTextEnabled	Gets the Boolean value that specifies whether the database is enabled for full-text search.
	IsLoginManager	Gets a Boolean value that specifies whether the current login is a login manager in SQL Azure.
	IsMailHost	Gets the Boolean value that specifies whether the database is configured as a mail host.
	IsManagementDataWarehouse	Gets the Boolean value that specifies whether the database is a management data warehouse.
	IsMirroringEnabled	Gets the Boolean value that specifies whether mirroring is enabled on the database.
	IsParameterizationForced	Gets or sets a property value that specifies whether parameterization is forced on the database.
	IsReadCommittedSnapshotOn	Gets the Boolean value that specifies whether transactions with the read committed isolation level use row versioning.
	IsSystemObject	Gets the Boolean value that specifies whether the database is a system object or a user-defined database.
	IsTouched	Gets the Boolean property value that specifies whether the object properties have been updated but not yet persisted on the server. (Inherited from SqlSmoObject.)
	IsUpdateable	Gets the Boolean value that specifies whether the database can be updated.
	IsVarDecimalStorageFormatEnabled	Gets or sets a property value that specifies whether VarDecimal storage is enabled.
	LastBackupDate	Gets the date and time when the database was last backed up.
	LastDifferentialBackupDate	Gets the date and time when the last differential backup was performed.
	LastLogBackupDate	Gets the date and time when the transaction log was last backed up.
	LocalCursorsDefault	Gets the Boolean value that specifies whether the local server cursors are used by default.
	LogFiles	Represents a collection of LogFile objects. Each LogFile object represents a log file defined on the database.
	LogReuseWaitStatus	Gets the type of operation on which the reuse of transaction log space is waiting.
	MasterKey	Gets the master key that is used to encrypt the private keys of certificates.
	MirroringFailoverLogSequenceNumber	Gets the log sequence number at last failover.
	MirroringID	Gets the ID value that uniquely identifies the mirroring partnership.
	MirroringPartner	Gets or sets the address of the Database Engine instance that is the partner server for database mirroring.
	MirroringPartnerInstance	Gets the instance of SQL Server on which the mirroring partner is configured.
	MirroringRedoQueueMaxSize	Gets or sets the maximum size of the redo queue of the mirror server instance in KB.
	MirroringRoleSequence	Gets the role sequence number for primary/backup roles played by the mirroring partners.
	MirroringSafetyLevel	Gets or sets the mirroring safety level.
	MirroringSafetySequence	Gets the role sequence number for safety levels for the mirroring partners.
	MirroringStatus	Gets the status of the database and the database mirroring session.
	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.
	MirroringWitness	Gets or sets the name of the Database Engine instance of the database mirroring witness server.
	MirroringWitnessStatus	Gets the status of the mirroring witness server.
	Name	Gets or sets the name of the database. (Overrides NamedSmoObject.Name.)
	NumericRoundAbortEnabled	Gets or sets a Boolean property value that specifies whether the NUMERIC_ROUNDABORT database option is active.
	ObjectInSpace	Gets 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.)
	Owner	Gets the database principal that is the owner of the database.
	PageVerify	Specifies the type of page integrity check that SQL Server performs when reading database pages.
	Parent	Gets the Server object that is the parent of the Database object.
	PartitionFunctions	Represents a collection of PartitionFunction objects. Each PartitionFunction object represents a partition function defined on the database.
	PartitionSchemes	Represents a collection of PartitionScheme objects. Each PartitionScheme object represents a partition scheme defined on the database.
	PlanGuides	Gets Plan Guides associated with a database.
	PrimaryFilePath	Gets the operating system directory that contains the primary file for the database.
	Properties	Gets a collection of Property objects that represent the object properties. (Inherited from SqlSmoObject.)
	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.
	RecoveryForkGuid	Gets the GUID value that specifies the recovery fork on which the database is currently active.
	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.
	ReplicationOptions	Gets the active replication settings for a database,
	Roles	Represents a collection of DatabaseRole objects. Each DatabaseRole object represents a role defined on the database.
	Rules	Represents a collection of Rule objects. Each Rule object represents a rule defined on the database.
	ScalarResult	Gets the scalar result for the referenced object. (Inherited from SqlSmoObject.)
	Schemas	Represents a collection of Schema objects. Each Schema object represents a schema defined on the database.
	ServiceBroker	Gets the ServiceBroker object that represents the Service Broker.
	ServiceBrokerGuid	Gets the Guid object that uniquely identifies the instance of Service Broker.
	Size	Gets the size of the database in MB.
	SnapshotIsolationState	Gets the snapshot isolation state for the database.
	SpaceAvailable	Gets the available space in the database in KB.
	State	Gets the state of the referenced object. (Inherited from SmoObjectBase.)
	Status	Gets the database status.
	StoredProcedures	Represents a collection of StoredProcedure objects. Each StoredProcedure object represents a stored procedure defined on the database.
	SymmetricKeys	Represents a collection of SymmetricKey objects. Each SymmetricKey object represents a symmetric key defined on the database.
	Synonyms	Represents a collection of Synonym objects. Each Synonym object represents a synonym defined on the database.
	Tables	Represents a collection of Table objects. Each Table object represents a table defined on the database.
	Triggers	Represents a collection of DatabaseDdlTrigger objects. Each DatabaseDdlTrigger object represents a trigger defined on the database.
	Trustworthy	The TRUSTWORTHY database property is used to indicate whether the instance of SQL Server 2005 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.)
	UserDefinedAggregates	Represents a collection of UserDefinedAggregate objects. Each UserDefinedAggregate object represents a user-defined aggregate defined on the database.
	UserDefinedDataTypes	Represents a collection of UserDefinedDataType objects. Each UserDefinedDataType object represents a user-defined data type on the database.
	UserDefinedFunctions	Represents a collection of UserDefinedFunction objects. Each UserDefinedFunction object represents a user-defined function on the database.
	UserDefinedTableTypes	Represents a collection of UserDefinedTableType objects. Each UserDefinedTableType object represents a user-defined table type on the database.
	UserDefinedTypes	Represents a collection of UserDefinedType objects. Each UserDefinedType object represents a user-defined type on the database.
	UserName	Gets or sets the database user name.
	Users	Represents a collection of User objects. Each User object represents a user who is defined on the database.
	Version	Gets the version of the instance of SQL Server that was used to create the database.
	Views	Represents a collection of View objects. Each View object represents a view defined on the database.
	XmlSchemaCollections	Represents a collection of XmlSchemaCollection objects. Each XmlSchemaCollection object represents an XML schema defined on the database.

Top

Methods

	Name	Description
	AddDatabaseContext(StringCollection)	Add the database context to the collection of queries identified by the queries parameter. (Inherited from SqlSmoObject.)
	AddDatabaseContext(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.)
	Alter()	Updates any Database object property changes on the instance of SQL Server.
	Alter(TimeSpan)	Updates any Database object property changes on the instance of SQL Server.
	Alter(TerminationClause)	Updates any Database object property changes on the instance of SQL Server.
	AlterImpl	Activates the object altered event. (Inherited from SqlSmoObject.)
	AlterImplFinish	Method called when object altered event finishes. (Inherited from SqlSmoObject.)
	AlterImplInit	Method called when object-altered event is intialized. (Inherited from SqlSmoObject.)
	AlterImplWorker	Calls the Alter methods. (Inherited from SqlSmoObject.)
	AppendCommaText	Appends text, optionally separated by a comma. (Inherited from ScriptNameObjectBase.)
	AppendWithCommaText	Appends text, optionally separated by a comma. (Inherited from ScriptNameObjectBase.)
	AppendWithOption	Appends text and option text separated from the main text with a “WITH” string and optionally separated by a comma. (Inherited from ScriptNameObjectBase.)
	AutoGenerateName	Generates a name based on the object Guid. (Inherited from ScriptNameObjectBase.)
	BindDefaultImpl	Binds the default items identified by the parameters. (Inherited from SqlSmoObject.)
	BindRuleImpl	Binds the rule schema to the rule and columns identified by the parameters. (Inherited from SqlSmoObject.)
	ChangeMirroringState	Changes the mirroring configuration as specified by the options.
	CheckAllocations	Scans all pages of the referenced database and tests pages to help ensure integrity.
	CheckAllocationsDataOnly	Scans all pages of the referenced database and tests only the data to help ensure integrity.
	CheckCatalog	Tests the integrity of the database catalog.
	CheckCollation	Checks the order of the scripting options by the collation method identified by the collationName parameter. (Inherited from SqlSmoObject.)
	CheckIdentityValues	Verifies the integrity of all identity columns in tables in the database.
	CheckObjectDirty	Checks whether object has been modified and not persisted. (Inherited from ScriptNameObjectBase.)
	CheckObjectState()	Validates the state of the referenced object. (Inherited from SqlSmoObject.)
	CheckObjectState(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.)
	CheckObjectStateImpl	Checks the state of a SqlSmoObject. (Inherited from SqlSmoObject.)
	Checkpoint	Issues a checkpoint.
	CheckTables(RepairType)	Tests the integrity of database pages for all tables and indexes defined on the tables of the database.
	CheckTables(RepairType, RepairOptions)	Tests the integrity of database pages for all tables and indexes defined on the tables of the database.
	CheckTables(RepairType, RepairStructure)	Tests the integrity of database pages for all tables and indexes defined on the tables of the database.
	CheckTables(RepairType, RepairOptions, RepairStructure)	Tests the integrity of database pages for all tables and indexes defined on the tables of the database.
	CheckTablesDataOnly()	Tests integrity of data in pages that store data for all tables and indexes defined on the tables of the referenced database.
	CheckTablesDataOnly(RepairOptions)	Tests integrity of data in pages that store data for all tables and indexes defined on the tables of the referenced database, with the specified repair options.
	CheckTablesDataOnly(RepairStructure)	Tests integrity of data in pages that store data for all tables and indexes defined on the tables of the referenced database with the specified repair structure.
	CheckTablesDataOnly(RepairOptions, RepairStructure)	Tests integrity of data in pages that store data for all tables and indexes defined on the tables of the referenced database with the specified repair options and repair structure.
	CheckTextCorectness	Checks text for correctness against the parameters. (Inherited from ScriptNameObjectBase.)
	CheckTextModeSupport	Checks mode of support. (Inherited from ScriptNameObjectBase.)
	CheckVersion100	Checks whether version of SQL Server is SQL Server 2008. (Inherited from SqlSmoObject.)
	CheckVersion80	Checks the validity of the object on SQL Server 2000. (Inherited from SqlSmoObject.)
	CheckVersion80SP3	Checks the validity of the object on SQL Server 2000 SP3. (Inherited from SqlSmoObject.)
	CheckVersion90	Check the validity of the object on SQL Server 2005. (Inherited from SqlSmoObject.)
	CheckVersionBelow90	Checks whether version of SQL Server is before SQL Server 2005. (Inherited from SqlSmoObject.)
	CleanObject	Cleans the referenced object. (Inherited from ScriptNameObjectBase.)
	Create()	Creates a database on the instance of SQL Server as defined by the Database object.
	Create(Boolean)	Creates a database on the instance of SQL Server as defined by the Database object.
	CreateImpl	Creates an object with scripting options. (Inherited from SqlSmoObject.)
	CreateImplFinish	Method called when the create event finishes. (Inherited from SqlSmoObject.)
	CreateImplInit	Method called when the create event initializes. (Inherited from SqlSmoObject.)
	Deny(DatabasePermissionSet, String)	Denies the specified set of permissions for the specified grantee on the database.
	Deny(DatabasePermissionSet, array<String[])	Denies the specified set of permissions for the specified grantees on the database.
	Deny(DatabasePermissionSet, String, Boolean)	Denies the specified set of permissions for the specified grantee and other users who the grantee granted the specified set of permissions on the database.
	Deny(DatabasePermissionSet, array<String[], Boolean)	Denies the specified set of permissions for the specified grantees and other users who the grantee granted the specified set of permissions on the database.
	DisableAllPlanGuides	Disables all Plan Guides in a database.
	Discover	Discovers a list of type Object. (Inherited from SqlSmoObject.)
	Drop	Drops the database.
	DropAllPlanGuides	Drops all Plan Guides in a database.
	DropBackupHistory	Drops the backup history for the database.
	DropImpl	Drops a SqlSmoObject. (Inherited from SqlSmoObject.)
	DropImplWorker	Calls the drop methods. (Inherited from SqlSmoObject.)
	EnableAllPlanGuides	Enables all Plan Guides in a database.
	EnumBackupSetFiles()	Returns a DataTable listing files contained in a backup set.
	EnumBackupSetFiles(Int32)	Returns a Data table that lists the files in a backup set
	EnumBackupSets	Returns a DataTable listing the backup sets associated with a database.
	EnumCandidateKeys	Enumerates a list of all candidate primary keys in the database, which can be referenced by a foreign key.
	EnumDatabasePermissions()	Enumerates a list of all permissions in the database.
	EnumDatabasePermissions(String)	Enumerates a list of permissions in the database for the specified user.
	EnumDatabasePermissions(DatabasePermissionSet)	Enumerates a list of permissions in the database for the specified permission set.
	EnumDatabasePermissions(String, DatabasePermissionSet)	Enumerates a list of permissions in the database for the specified user and a specified permission set.
	EnumLocks()	Enumerates a list of all current locks held on the database.
	EnumLocks(Int32)	Enumerates a list of current locks held on the database for a specified system process ID.
	EnumLoginMappings	Enumerates a list of SQL Server logins for all the users in the database.
	EnumMatchingSPs(String)	Enumerates a list of stored procedures that contain the specified string in the definition.
	EnumMatchingSPs(String, Boolean)	Enumerates a list of stored procedures that contain the specified string in the definition.
	EnumObjectPermissions()	Enumerates a list of permissions for objects in the database.
	EnumObjectPermissions(String)	Enumerates a list of permissions for objects in the database that belong to the specified user.
	EnumObjectPermissions(ObjectPermissionSet)	Enumerates a list of permissions for objects in the database limited to the specified permission set.
	EnumObjectPermissions(String, ObjectPermissionSet)	Enumerates a list of permissions for objects in the database that belong to the specified user and limited to the specified permission set.
	EnumObjects()	Enumerates a list of objects in the database.
	EnumObjects(DatabaseObjectTypes)	Enumerates a list of objects in the database.
	EnumObjects(DatabaseObjectTypes, SortOrder)	Enumerates a list of objects in the database.
	EnumScriptImpl	Enumerates scripts specified by the so parameter. (Inherited from SqlSmoObject.)
	EnumScriptImplWorker	Calls the methods that enumerate scripts specified by the so parameter. (Inherited from SqlSmoObject.)
	EnumScriptImplWorkerSOChanged	Returns an IEnumerable string describing the scripting options for an object. (Inherited from SqlSmoObject.)
	EnumTransactions()	Enumerates a list of open transactions on the database.
	EnumTransactions(TransactionTypes)	Enumerates a list of open transactions of a specified type on the database.
	EnumWindowsGroups()	Enumerates a list of Windows groups.
	EnumWindowsGroups(String)	Enumerates a list of Windows groups for a specified group.
	Equals	(Inherited from Object.)
	ExecuteNonQuery(StringCollection)	Executes a batch in the context of the database where there are no results returned.
	ExecuteNonQuery(String)	Executes a statement in the context of the database where there are no results returned.
	ExecuteNonQuery(StringCollection, ExecutionTypes)	Runs a collection of batches in the context of the database where there are no results returned for the specified execution type only.
	ExecuteNonQuery(String, ExecutionTypes)	Executes a batch in the context of the database where there are no results returned for the specified execution type only.
	ExecuteNonQuery(StringCollection, Boolean)	Executes a batch in the context of the database where there are no results returned. (Inherited from SqlSmoObject.)
	ExecuteWithResults(StringCollection)	Executes a batch in the context of the database where there are results returned.
	ExecuteWithResults(String)	Executes a collection of batches in the context of the database where there are results returned.
	Finalize	(Inherited from Object.)
	ForceTextModeOnTextBody	Enforces text mode on the text body. (Inherited from ScriptNameObjectBase.)
	FormatSqlVariant	Formats an object as SqlVariant type. (Inherited from SqlSmoObject.)
	GenerateDataSpaceFileStreamScript	Generates a script to create data file. (Inherited from SqlSmoObject.)
	GenerateDataSpaceScript	Generates a script to allocate space in the data file. (Inherited from SqlSmoObject.)
	GetBindDefaultScript	Gets the script that binds defaults specified by the defSchema and defName parameters. (Inherited from SqlSmoObject.)
	GetBindRuleScript	Gets the script that specifies the binding rules. (Inherited from SqlSmoObject.)
	GetBoolParameter(StringBuilder, ScriptingOptions, String, String, Int32%)	Assigns a Boolean parameter of the SqlSmoObject. (Inherited from SqlSmoObject.)
	GetBoolParameter(StringBuilder, ScriptingOptions, String, String, Int32%, Boolean)	Assigns a Boolean property of the SqlSmoObject. (Inherited from SqlSmoObject.)
	GetBraketNameForText	Gets the bracket name. (Inherited from ScriptNameObjectBase.)
	GetDateTimeParameter	Assigns the datetime property of the SqlSmoObject. (Inherited from SqlSmoObject.)
	GetDateTimeParameterAsInt	Assigns the datetime property of the SqlSmoObject as an integer value if the datetime property is not null. (Inherited from SqlSmoObject.)
	GetDBName	Gets the database name that is associated with the object. (Inherited from SqlSmoObject.)
	GetEnumParameter	Assigns an enumeration property of the SqlSmoObject. (Inherited from SqlSmoObject.)
	GetFragOptionString	Gets a FragmentationOption object as a string value. (Inherited from SqlSmoObject.)
	GetGuidParameter	Assigns a Guid property of the SqlSmoObject. (Inherited from SqlSmoObject.)
	GetHashCode	(Inherited from Object.)
	GetIsSystemNamed	Gets a Boolean value that specifies whether the system is named. (Inherited from ScriptNameObjectBase.)
	GetIsTextDirty	Determines whether the text value is consistent with stored value. (Inherited from ScriptNameObjectBase.)
	GetParameter(StringBuilder, ScriptingOptions, String, String, Int32%)	Assigns a parameter of the SqlSmoObject. (Inherited from SqlSmoObject.)
	GetParameter(StringBuilder, ScriptingOptions, String, String, Int32%, Boolean)	Assigns a parameter of the SqlSmoObject. (Inherited from SqlSmoObject.)
	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.)
	GetRealValue	Gets a property value of the SqlSmoObject object. (Inherited from SqlSmoObject.)
	GetScriptIncludeExists	Gets the script including the test for existence of type being scripted. (Inherited from ScriptNameObjectBase.)
	GetScriptingOptionsForCreate	Gets ScriptingOptions for the SqlSmoObject object. (Inherited from SqlSmoObject.)
	GetServerName	Gets the name of the instance of SQL Server with which the object is associated. (Inherited from SqlSmoObject.)
	GetServerObject	Gets the server of the SqlSmoObject object. (Inherited from SqlSmoObject.)
	GetSqlServerVersionName	Gets the version name of the instance of SQL Server with which the object is associated. (Inherited from SqlSmoObject.)
	GetStringParameter(StringBuilder, ScriptingOptions, String, String, Int32%)	Assigns a string parameter of the SqlSmoObject object. (Inherited from SqlSmoObject.)
	GetStringParameter(StringBuilder, ScriptingOptions, String, String, Int32%, Boolean)	Assigns a string parameter of the SqlSmoObject object. (Inherited from SqlSmoObject.)
	GetTextBody()	Returns the text body. (Inherited from ScriptNameObjectBase.)
	GetTextBody(Boolean)	Returns the text body. (Inherited from ScriptNameObjectBase.)
	GetTextForScript(ScriptingOptions, Boolean, array<String[])	Gets the text for scripting. (Inherited from ScriptNameObjectBase.)
	GetTextForScript(ScriptingOptions, Boolean, array<String[], Boolean)	Gets the text of script object. (Inherited from ScriptNameObjectBase.)
	GetTextHeader	Returns the text header. (Inherited from ScriptNameObjectBase.)
	GetTextMode	Determines whether the script name is using text mode. (Inherited from ScriptNameObjectBase.)
	GetTextProperty(String)	Gets the property as text. (Inherited from ScriptNameObjectBase.)
	GetTextProperty(String, ScriptingOptions)	Gets the property as text. (Inherited from ScriptNameObjectBase.)
	GetTimeSpanParameterAsInt	Assigns a time span parameter of the SqlSmoObject object. (Inherited from SqlSmoObject.)
	GetTransactionCount()	Gets the number of open transactions on the database.
	GetTransactionCount(TransactionTypes)	Gets the number of open transactions of a specified type on the database.
	GetType	(Inherited from Object.)
	GetUrnRecursive(StringBuilder)	Assigns an Urn object of the SqlSmoObject object. (Inherited from SqlSmoObject.)
	GetUrnRecursive(StringBuilder, UrnIdOption)	Assigns an Urn object of the SqlSmoObject object. (Inherited from SqlSmoObject.)
	Grant(DatabasePermissionSet, String)	Grants the specified set of permissions to the specified grantee on the database.
	Grant(DatabasePermissionSet, array<String[])	Grants the specified set of permissions to the specified grantees on the database.
	Grant(DatabasePermissionSet, String, Boolean)	Grants access to the specified permission to the grantee and the ability to grant access to other users on the database.
	Grant(DatabasePermissionSet, array<String[], Boolean)	Grants access to the specified permission to the grantees and the ability to grant access to other users on the database.
	Grant(DatabasePermissionSet, String, Boolean, String)	Grants the specified set of permissions to the grantee and the ability to grant the set of permissions to other users on the database under an assumed role.
	Grant(DatabasePermissionSet, array<String[], Boolean, String)	Grants the specified set of permissions to the grantees and the ability to grant the set of permissions to other users on the database under an assumed role.
	ImplInitialize	Initializes the fields of the SqlSmoObject object. (Inherited from SqlSmoObject.)
	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.)
	IsMember	Determines whether the specified group or role belongs to the database.
	IsObjectDirty	Determines whether the referenced object is consistent with the stored object. (Inherited from ScriptNameObjectBase.)
	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.)
	IsVersion80SP3	Determines whether the version of SQL Server is SQL Server 2000 with SP3. (Inherited from SqlSmoObject.)
	IsVersion90AndAbove	Determines whether the version of SQL Server is SQL Server 2005 or later. (Inherited from SqlSmoObject.)
	MarkDropped	Sets the SqlSmoState to dropped. (Inherited from SqlSmoObject.)
	MarkForDropImpl	Sets the SqlSmoState to dropped. (Inherited from SqlSmoObject.)
	MemberwiseClone	(Inherited from Object.)
	PostAlter	Method activated after the SqlSmoObject is altered. (Inherited from SqlSmoObject.)
	PostCreate	Method activated after the SqlSmoObject is created. (Inherited from SqlSmoObject.)
	PostDrop	Method activated after the SqlSmoObject is dropped. (Inherited from SqlSmoObject.)
	PrefetchObjects()	Prefetches database objects.
	PrefetchObjects(Type)	Prefetches database objects of a specified type.
	PrefetchObjects(Type, ScriptingOptions)	Prefetches database objects of a specified type with scripting options.
	RecalculateSpaceUsage	Recalculates space usage.
	Refresh	Updates the Database object. (Overrides ScriptNameObjectBase.Refresh().)
	RemoveFullTextCatalogs	Removes full-text catalogs from the database.
	Rename	Renames the database.
	RenameImpl	Identified for informational purposes only. Not supported. Future compatibility is not guaranteed. (Inherited from NamedSmoObject.)
	RenameImplWorker	Identified for informational purposes only. Not supported. Future compatibility is not guaranteed. (Inherited from NamedSmoObject.)
	Revoke(DatabasePermissionSet, String)	Revokes a previously granted set of permissions from a grantee on the database.
	Revoke(DatabasePermissionSet, array<String[])	Revokes a previously granted set of permissions from a list of grantees on the database.
	Revoke(DatabasePermissionSet, String, Boolean, Boolean)	Revokes previously granted permissions from a grantee on the database and any other users to whom the grantee has granted the specified set of permissions. The grantee is also given the ability to revoke the specified set of permissions from other users under an assumed role.
	Revoke(DatabasePermissionSet, array<String[], Boolean, Boolean)	Revokes previously granted permissions from grantees on the database and any other users to whom the grantees have granted the specified set of permissions. The grantees are also given the ability to revoke the specified set of permissions from other users under an assumed role.
	Revoke(DatabasePermissionSet, String, Boolean, Boolean, String)	Revokes previously granted permissions from a grantee on the database and any other users to whom the grantee has granted the specified set of permissions. The grantee is also given the ability to revoke the specified set of permissions from other users under an assumed role.
	Revoke(DatabasePermissionSet, array<String[], Boolean, Boolean, String)	Revokes previously granted permissions from grantees on the database and any other users to whom the grantees have granted the specified set of permissions. The grantees are also given the ability to revoke the specified set of permissions from other users under an assumed role.
	Script()	Generates a Transact-SQL script that can be used to re-create the database.
	Script(ScriptingOptions)	Generates a Transact-SQL script that can be used to re-create the database as specified by the script options.
	ScriptAlter	Alters the SqlSmoObject according to the parameters. (Inherited from SqlSmoObject.)
	ScriptAnsiQI	Scripts the database object in ANSI text. (Inherited from ScriptNameObjectBase.)
	ScriptChangeOwner	This method supports the SMO infrastructure and is not intended to be used directly from your code. (Inherited from NamedSmoObject.)
	ScriptCreate	Alters the SqlSmoObject according to the parameters. (Inherited from SqlSmoObject.)
	ScriptDdl	Throws InvalidSmoOperationException. (Inherited from SqlSmoObject.)
	ScriptDrop	Throws InvalidSmoOperationException. (Inherited from SqlSmoObject.)
	ScriptImpl()	Gets a collection of scripts of the SqlSmoObject. (Inherited from SqlSmoObject.)
	ScriptImpl(ScriptingOptions)	Gets a collection of scripts of the SqlSmoObject. (Inherited from SqlSmoObject.)
	ScriptImplWorker	Gets a collection of scripts of the SqlSmoObject. (Inherited from SqlSmoObject.)
	ScriptInformativeHeaders	Scripts the information headers. (Inherited from ScriptNameObjectBase.)
	ScriptOwner	Alters the script owner authorization. (Inherited from NamedSmoObject.)
	ScriptRename	This method supports the SMO infrastructure and is not intended to be used directly from your code. (Inherited from NamedSmoObject.)
	SetCollectionTextMode	Sets the collection text mode. (Inherited from ScriptNameObjectBase.)
	SetDefaultFileGroup	Sets the default file group for the database.
	SetDefaultFileStreamFileGroup	Sets the default filestream group.
	SetDefaultFullTextCatalog	Sets the default full-text catalog for the database.
	SetIsSystemNamed	Sets a Boolean value that specifies whether the system is named. (Inherited from ScriptNameObjectBase.)
	SetOffline	Sets the database offline.
	SetOnline	Sets the database online.
	SetOwner(String)	Sets the database owner.
	SetOwner(String, Boolean)	Sets the database owner.
	SetParentImpl	Sets the parent of the SqlSmoObject to the newParent parameter. (Inherited from SqlSmoObject.)
	SetSchemaOwned	Sets the schema owned value. (Inherited from NamedSmoObject.)
	SetSnapshotIsolation	Sets the snapshot isolation level.
	SetTextBody	Specifies the text body. (Inherited from ScriptNameObjectBase.)
	SetTextHeader	Specifies the text header. (Inherited from ScriptNameObjectBase.)
	SetTextMode	Specifies the text mode. (Inherited from ScriptNameObjectBase.)
	Shrink	Shrinks the database.
	SwitchTextMode	Switches the text mode. (Inherited from ScriptNameObjectBase.)
	ThrowIfTextIsDirtyForAlter	Throws an exception of text has been modified and not persisted. (Inherited from ScriptNameObjectBase.)
	ToString	Returns a String that represents the referenced object. (Inherited from SqlSmoObject.)
	TouchImpl	Not implemented. (Inherited from SqlSmoObject.)
	TruncateLog	Truncates the database log.
	UnbindDefaultImpl	Unbinds the default columns of the SqlSmoObject. (Inherited from SqlSmoObject.)
	UnbindRuleImpl	Unbinds rules of the SqlSmoObject. (Inherited from SqlSmoObject.)
	UpdateIndexStatistics	Updates index statistics.
	Validate	Validates the state of an object. (Inherited from SmoObjectBase.)
	ValidateAllPlanGuides()	Verifies the validity of the execution plans associated with the database.
	ValidateAllPlanGuides(DataTable%)	Verifies the validity of the execution plans associated with the database and returns validation report.

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

Fields

	Name	Description
	m_ExtendedProperties	Represents a property that is defined to extend the properties provided by a SqlSmoObject. (Inherited from SqlSmoObject.)
	singletonParent	Represents the singleton parent. (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 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 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. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SqlSmoObject.)
	ISfcSupportsDesignMode.IsDesignMode	Gets a Boolean value that indicates whether the object supports design mode. Identified for informational purposes only. Not supported. Future compatibility is not guaranteed.

Top

Remarks

The Database class represents databases, either system or user-defined, on the instance of SQL Server. The Server class is the parent of the Database class.

By using the Database class, you can do the following:

Create a new database or drop and existing database.
Register the database in the Active Directory directory service.
Reference database objects in collections, such as tables, users, and triggers.
Set up database mirroring.
Create a master database key.
Set up a full-text search catalog.
Check data, allocations, catalogs, and tables.
Issue a checkpoint.
Grant, revoke, and deny permissions to users on the database.
Run Transact-SQL statements.
Enumerate database information, such as locks or object permissions.
Remove the backup history.
Monitor the number of transactions.
Set the database offline or online.
Change the owner of the database.
Update statistics.
Shrink the database.
Truncate the log.
Script the database.

To get Database object properties, a login must be a member of the public fixed server role and the user mapped to this login in the database must be a member of the public database role.

To set Database object properties and run the Alter method, users must have ALTER permission on the database, or be a member of the db_owner fixed database role.

To create a database, users must have CREATE DATABASE, CREATE ANY DATABASE, or ALTER ANY DATABASE permission on the parent server.

To drop a database, users must have CONTROL permission on the database, or be a member of the db_owner fixed database role.

To grant, revoke, or deny other users permission on the database, users must have CONTROL permission on the database or be a member of the db_owner fixed database role.

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

'Connect to the local, default instance of SQL Server.
Dim srv As Server
srv = New Server
'Define a Database object variable by supplying the server and the database name arguments in the constructor.
Dim db As Database
db = New Database(srv, "Test_SMO_Database")
'Create the database on the instance of SQL Server.
db.Create()
'Reference the database and display the date when it was created.
db = srv.Databases("Test_SMO_Database")
Console.WriteLine(db.CreateDate)
'Remove the database.
db.Drop()

PowerShell

$srv = new-Object Microsoft.SqlServer.Management.Smo.Server("(local)")
$db = New-Object Microsoft.SqlServer.Management.Smo.Database($srv, "Test_SMO_Database")
$db.Create()
Write-Host $db.CreateDate
$db.Drop()

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.

Share via

Database Class

Inheritance Hierarchy

Syntax

Constructors

Properties

Methods

Events

Fields

Explicit Interface Implementations

Remarks

Thread Safety

Examples

Thread Safety

See Also

Reference

Other Resources

Additional resources