Database Members
The Database object represents a Microsoft SQL Server database.
The following tables list the members exposed by the Database type.
Public Constructors
Name | Description | |
---|---|---|
Database | Overloaded. Initializes a new instance of the Database class. |
Top
Protected Fields
Name | Description | |
---|---|---|
m_ExtendedProperties | (inherited from SqlSmoObject ) |
Top
Public Properties
(see also Protected 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. | |
ApplicationRoles | Represents a collection of ApplicationRole objects. Each ApplicationRole object represents an application role defined on the database. | |
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. | |
AutoCreateStatisticsEnabled | Gets a Boolean property value that specifies whether statistics are automatically created for the database. | |
AutoUpdateStatisticsEnabled | Gets a Boolean property value that specifies whether statistics are automatically updated for the database. | |
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. | |
Collation | Gets or sets the default collation used by the database. | |
CompatibilityLevel | Gets or sets the compatibility level for the database. | |
CreateDate | Gets the date that the database was created. | |
DatabaseGuid | Gets the Guid value that uniquely identifies the database. | |
DatabaseOptions | Gets the DatabaseOptions object that contains configuration options for the database. | |
DatabaseSnapshotBaseName | Gets the name of the snapshot base for the database. | |
DataSpaceUsage | Gets the space used by the data in the database. | |
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. | |
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. | |
Events | Gets the events associated with the database. | |
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. | |
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. | |
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. | |
IsMailHost | Gets the Boolean value that specifies whether the database is configured as a mail host. | |
IsMirroringEnabled | Gets the Boolean value that specifies whether mirroring is enabled on the database. | |
IsSystemObject | Gets the Boolean value that specifies whether the database is a system object or a user-defined database. | |
IsUpdateable | Gets the Boolean value that specifies whether the database can be updated. | |
LastBackupDate | Gets the date and time when the database was last backed up. | |
LastLogBackupDate | Gets the date and time when the transaction log was last backed up. | |
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 on. | |
MasterKey | Gets the master key 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. | |
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. | |
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 object. (inherited from NamedSmoObject) | |
Owner | Gets the database principal that is the owner of the database. | |
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. | |
PrimaryFilePath | Gets the path and name of 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) | |
RecoveryForkGuid | Gets the GUID value that specifies the recovery fork on which the database is currently active. | |
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. | |
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 Microsoft Service Broker. | |
ServiceBrokerGuid | Gets the Guid object that uniquely identifies the instance of Microsoft Service Broker. | |
Size | Gets the size of the database in megabytes. | |
SpaceAvailable | Gets the available space in the database in kilobytes. | |
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. | |
Urn | Gets the Uniform Resource Name (URN) address value that uniquely identifies the object. (inherited from SqlSmoObject) | |
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. | |
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
Protected Properties
Name | Description | |
---|---|---|
ExecuteForScalar | Gets or sets the Boolean property value that specifies whether the object is set to the execute for scalar option. (inherited from SqlSmoObject) | |
ObjectInSpace | Gets the Boolean property value that specifies whether the object exists in isolation or whether it is connected to the instance of Microsoft SQL Server directly or indirectly. (inherited from SqlSmoObject) | |
PresetProperties | Gets or sets the preset properties of the referenced object. (inherited from SqlSmoObject) | |
ScalarResult | Gets the scalar result for the referenced object. (inherited from SqlSmoObject) |
Top
Public Methods
(see also Protected Methods )
Name | Description | |
---|---|---|
Alter | Overloaded. Updates any Database object property changes on an instance of Microsoft SQL Server. | |
ChangeMirroringState | Changes the mirroring configuration as specified by the options. | |
CheckAllocations | Scans all pages of the referenced database and tests pages to guarantee integrity. | |
CheckAllocationsDataOnly | Scans all pages of the referenced database and tests only the data to guarantee integrity. | |
CheckCatalog | Tests the integrity of the database catalog. | |
CheckIdentityValues | Verifies the integrity of all identity columns in tables in the database. | |
Checkpoint | Issues a checkpoint. | |
CheckTables | Tests the integrity of database pages for all tables and indexes defined on the tables of the database. | |
CheckTablesDataOnly | Tests integrity of pages that store data for all tables and indexes defined on the tables of the referenced database. | |
Create | Overloaded. Creates a database on the instance of Microsoft SQL Server as defined by the Database object. | |
Deny | Overloaded. Denies the specified set of permissions for the specified grantees on the database. | |
Drop | Drops the database. | |
DropBackupHistory | Drops the backup history for the database. | |
EnumCandidateKeys | Enumerates a list of all candidate primary keys in the database, which may be referenced by a foreign key. | |
EnumDatabasePermissions | Overloaded. Enumerates a list of all database permissions in the database. | |
EnumLocks | Overloaded. Enumerates a list of current locks on the database. | |
EnumLoginMappings | Enumerates a list of Microsoft SQL Server logins for all the users in the database. | |
EnumMatchingSPs | Overloaded. Enumerates a list of stored procedures that contain the specified string in the definition. | |
EnumObjectPermissions | Overloaded. Enumerates a list of permissions for objects in the database. | |
EnumObjects | Overloaded. Enumerates a list of objects in the database. | |
EnumTransactions | Overloaded. Enumerates a list of open transactions on the database. | |
EnumWindowsGroups | Overloaded. Enumerates a list of Microsoft Windows groups. | |
Equals | Overloaded. (inherited from Object ) | |
ExecuteNonQuery | Overloaded. Executes a collection of batches in the context of the database where there are no results returned. | |
ExecuteWithResults | Overloaded. Executes a collection of batches in the context of the database where there are results returned. | |
GetHashCode | (inherited from Object ) | |
GetTransactionCount | Overloaded. Gets the number of open transactions on the database. | |
GetType | (inherited from Object ) | |
Grant | Overloaded. Grants the specified set of permissions to the specified grantees on the database. | |
Initialize | Overloaded. Initializes the object and forces the properties be loaded. (inherited from SqlSmoObject) | |
IsMember | Determines whether the specified group or role belongs to the database. | |
PrefetchObjects | Overloaded. Prefetches database objects. | |
RecalculateSpaceUsage | Recalculates space usage. | |
ReferenceEquals | (inherited from Object ) | |
Refresh | Overridden. Updates the Database object. | |
RemoveFullTextCatalogs | Removes full-text catalogs from the database. | |
Rename | Renames the database. | |
Revoke | Overloaded. Revokes a previously granted set of permissions from a grantee or grantees on the database. | |
Script | Overloaded. Generates a Transact-SQL script that can be used to re-create the database. | |
SetDefaultFileGroup | Sets the default file group for the database. | |
SetDefaultFullTextCatalog | Sets the default full-text catalog for the database. | |
SetOffline | Sets the database offline. | |
SetOnline | Sets the database online. | |
SetOwner | Overloaded. Sets the database owner. | |
Shrink | Shrinks the database. | |
ToString | Returns a String that represents the referenced object. (inherited from SqlSmoObject) | |
TruncateLog | Truncates the database log. | |
UpdateIndexStatistics | Updates index statistics. |
Top
Protected Methods
Name | Description | |
---|---|---|
AlterImpl | (inherited from SqlSmoObject ) | |
AlterImplFinish | (inherited from SqlSmoObject ) | |
AlterImplInit | (inherited from SqlSmoObject ) | |
AlterImplWorker | (inherited from SqlSmoObject ) | |
AppendCommaText | (inherited from ScriptNameObjectBase ) | |
AppendWithCommaText | (inherited from ScriptNameObjectBase ) | |
AppendWithOption | (inherited from ScriptNameObjectBase ) | |
BindDefaultImpl | (inherited from SqlSmoObject ) | |
BindRuleImpl | (inherited from SqlSmoObject ) | |
CheckCollation | (inherited from SqlSmoObject ) | |
CheckObjectState | Overloaded. Validates the state of the referenced object. (inherited from SqlSmoObject) | |
CheckObjectStateImpl | (inherited from SqlSmoObject ) | |
CheckTextCorectness | (inherited from ScriptNameObjectBase ) | |
CheckTextModeSupport | (inherited from ScriptNameObjectBase ) | |
CheckVersion80 | Checks the validity of the object on Microsoft SQL Server 2000. (inherited from SqlSmoObject) | |
CheckVersion80SP3 | Checks the validity of the object on Microsoft SQL Server 2000 SP3. (inherited from SqlSmoObject) | |
CheckVersion90 | Check the validity of the object on Microsoft SQL Server 2005. (inherited from SqlSmoObject) | |
CheckVersionBelow90 | (inherited from SqlSmoObject ) | |
CleanObject | Cleans the referenced object. (inherited from ScriptNameObjectBase) | |
CreateImpl | (inherited from SqlSmoObject ) | |
CreateImplFinish | (inherited from SqlSmoObject ) | |
CreateImplInit | (inherited from SqlSmoObject ) | |
DropImpl | (inherited from SqlSmoObject ) | |
DropImplWorker | (inherited from SqlSmoObject ) | |
Finalize | (inherited from Object ) | |
ForceTextModeOnTextBody | Enforces text mode on the text body. (inherited from ScriptNameObjectBase) | |
FormatSqlVariant | (inherited from SqlSmoObject ) | |
GenerateDataSpaceScript | (inherited from SqlSmoObject ) | |
GetBindDefaultScript | (inherited from SqlSmoObject ) | |
GetBindRuleScript | (inherited from SqlSmoObject ) | |
GetBoolParameter | Overloaded. (inherited from SqlSmoObject ) | |
GetBraketNameForText | (inherited from ScriptNameObjectBase ) | |
GetDateTimeParameter | (inherited from SqlSmoObject ) | |
GetDateTimeParameterAsInt | (inherited from SqlSmoObject ) | |
GetDBName | Gets the database name associated with the object. (inherited from SqlSmoObject) | |
GetEnumParameter | (inherited from SqlSmoObject ) | |
GetFragOptionString | (inherited from SqlSmoObject ) | |
GetGuidParameter | (inherited from SqlSmoObject ) | |
GetIsTextDirty | Determines whether the text value is consistent with stored value. (inherited from ScriptNameObjectBase) | |
GetParameter | Overloaded. (inherited from SqlSmoObject ) | |
GetPropValue | (inherited from SqlSmoObject ) | |
GetPropValueOptional | (inherited from SqlSmoObject ) | |
GetPropValueOptionalAllowNull | (inherited from SqlSmoObject ) | |
GetRealValue | (inherited from SqlSmoObject ) | |
GetScriptIncludeExists | (inherited from ScriptNameObjectBase ) | |
GetScriptingOptionsForCreate | (inherited from SqlSmoObject ) | |
GetServerName | Gets the name of the instance of Microsoft SQL Server with which the object is associated. (inherited from SqlSmoObject) | |
GetSqlServerVersionName | Gets the version name of the instance of Microsoft SQL Server with which the object is associated. (inherited from SqlSmoObject) | |
GetStringParameter | Overloaded. (inherited from SqlSmoObject ) | |
GetTextBody | Overloaded. Returns the text body. (inherited from ScriptNameObjectBase) | |
GetTextForScript | (inherited from ScriptNameObjectBase ) | |
GetTextHeader | (inherited from ScriptNameObjectBase ) | |
GetTextMode | Determines whether the script name is using text mode. (inherited from ScriptNameObjectBase) | |
GetTextProperty | (inherited from ScriptNameObjectBase ) | |
GetTimeSpanParameterAsInt | (inherited from SqlSmoObject ) | |
GetUrnRecursive | Overloaded. (inherited from SqlSmoObject ) | |
ImplInitialize | (inherited from SqlSmoObject ) | |
IsCollectionDirty | (inherited from SqlSmoObject ) | |
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 Microsoft SQL Server. (inherited from SqlSmoObject) | |
IsVersion80SP3 | (inherited from SqlSmoObject ) | |
MarkDropped | This method supports the SQL Server Management Objects infrastructure and is not intended to be used directly from your code. (inherited from SqlSmoObject) | |
MarkForDropImpl | (inherited from SqlSmoObject ) | |
MemberwiseClone | (inherited from Object ) | |
PostAlter | (inherited from SqlSmoObject ) | |
PostCreate | This method supports the SQL Server Management Objects infrastructure and is not intended to be used directly from your code. (inherited from SqlSmoObject) | |
PostDrop | (inherited from SqlSmoObject ) | |
RenameImpl | (inherited from NamedSmoObject ) | |
RenameImplWorker | (inherited from NamedSmoObject ) | |
ScriptAlter | This method supports the SQL Server Management Objects infrastructure and is not intended to be used directly from your code. (inherited from SqlSmoObject) | |
ScriptAnsiQI | (inherited from ScriptNameObjectBase ) | |
ScriptChangeOwner | (inherited from NamedSmoObject ) | |
ScriptCreate | (inherited from SqlSmoObject ) | |
ScriptDdl | (inherited from SqlSmoObject ) | |
ScriptDrop | (inherited from SqlSmoObject ) | |
ScriptImpl | Overloaded. (inherited from SqlSmoObject ) | |
ScriptImplWorker | (inherited from SqlSmoObject ) | |
ScriptInformativeHeaders | (inherited from ScriptNameObjectBase ) | |
ScriptRename | (inherited from NamedSmoObject ) | |
SetCollectionTextMode | (inherited from ScriptNameObjectBase ) | |
SetParentImpl | (inherited from SqlSmoObject ) | |
SetTextBody | (inherited from ScriptNameObjectBase ) | |
SetTextHeader | (inherited from ScriptNameObjectBase ) | |
SetTextMode | (inherited from ScriptNameObjectBase ) | |
SwitchTextMode | (inherited from ScriptNameObjectBase ) | |
ThrowIfTextIsDirtyForAlter | (inherited from ScriptNameObjectBase ) | |
Trace | (inherited from SqlSmoObject ) | |
UnbindDefaultImpl | (inherited from SqlSmoObject ) | |
UnbindRuleImpl | (inherited from SqlSmoObject ) | |
UpdateCollectionState2 | (inherited from SqlSmoObject ) |
Top
See Also
Reference
Database Class
Microsoft.SqlServer.Management.Smo Namespace
Other Resources
How to: Create, Alter, and Remove a Database in Visual Basic .NET
Creating, Altering, and Removing Databases
CREATE DATABASE (Transact-SQL)