DatabaseEngineInstance Class

 

Represents a SQL Server database engine instance.

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

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.DatabaseEngineInstance

Syntax

public sealed class DatabaseEngineInstance : ScriptNameObjectBase
public ref class DatabaseEngineInstance sealed : ScriptNameObjectBase
[<Sealed>]
type DatabaseEngineInstance = 
    class
        inherit ScriptNameObjectBase
    end
Public NotInheritable Class DatabaseEngineInstance
    Inherits ScriptNameObjectBase

Constructors

Name Description
System_CAPS_pubmethod DatabaseEngineInstance()

Initializes a new instance of the DatabaseEngineInstance class with the default values.

System_CAPS_pubmethod DatabaseEngineInstance(Server, String)

Initializes a new instance of the DatabaseEngineInstance class with the specified server and name.

Properties

Name Description
System_CAPS_pubproperty BuildClrVersion

Gets the CLR build of the instance of SQL Server.

System_CAPS_pubproperty BuildClrVersionString

Gets a string which contains the CLR build of the instance of SQL Server.

System_CAPS_pubproperty ComputerNamePhysicalNetBIOS

Gets the name of the computer which is running the instance of SQL Server.

System_CAPS_pubproperty ErrorLogPath

Gets the file path for error logging on the instance of SQL Server.

System_CAPS_pubproperty ID

Gets the identifier for the instance of SQL Server.

System_CAPS_pubproperty InstanceName

Gets the name of the instance of SQL Server.

System_CAPS_pubproperty InstanceState

Gets the state of the instance of SQL Server.

System_CAPS_pubproperty Language

Gets the language used by the instance of SQL Server.

System_CAPS_pubproperty MachineName

Gets the machine name for the instance of SQL Server.

System_CAPS_pubproperty MasterDBLogPath

Gets the log file directory for the master database on the instance of SQL Server.

System_CAPS_pubproperty MasterDBPath

Gets the database file directory for the master database on the instance of SQL Server.

System_CAPS_pubproperty Name

Gets or sets the name of the object.(Inherited from NamedSmoObject.)

System_CAPS_pubproperty OSVersion

Gets the version of the operating system for the computer running the instance of SQL Server.

System_CAPS_pubproperty Parent

Gets the Server which represents the computer running the instance of SQL Server.

System_CAPS_pubproperty PhysicalMemory

Gets the total RAM installed, in megabytes on the computer running the instance of SQL Server.

System_CAPS_pubproperty Platform

Gets the hardware platform for the computer containing the instance of SQL Server.

System_CAPS_pubproperty PortNumber

Gets the port number of the instance of SQL Server.

System_CAPS_pubproperty Processors

Gets the number of processors on the computer running the instance of SQL Server.

System_CAPS_pubproperty Product

Gets the name of the product associated with the instance of SQL Server.

System_CAPS_pubproperty Properties

Gets a collection of Property objects that represent the object properties.(Inherited from SqlSmoObject.)

System_CAPS_pubproperty ResourceLastUpdateDateTime

Gets the last update time of the resource.

System_CAPS_pubproperty ResourceVersion

Gets the version of the resource.

System_CAPS_pubproperty ResourceVersionString

Gets a string which corresponds to the version of the resource.

System_CAPS_pubproperty RootDirectory

Gets the path of the root directory for the instance of SQL Server.

System_CAPS_pubproperty ServiceName

Gets the service name for the instance of SQL Server.

System_CAPS_pubproperty State

Gets the state of the referenced object.(Inherited from SmoObjectBase.)

System_CAPS_pubproperty Urn

Gets the Uniform Resource Name (URN) address value that uniquely identifies the object.(Inherited from SqlSmoObject.)

System_CAPS_pubproperty UserData

Gets or sets user-defined data associated with the referenced object.(Inherited from SmoObjectBase.)

System_CAPS_pubproperty Version

Gets the version of the instance of SQL Server.

System_CAPS_pubproperty VersionString

Gets a string which corresponds to the version of the instance of SQL Server.

Methods

Name Description
System_CAPS_pubmethod Discover()

Discovers a list of type Object.(Inherited from SqlSmoObject.)

System_CAPS_pubmethod Equals(Object)

(Inherited from Object.)

System_CAPS_protmethod FormatSqlVariant(Object)

Formats an object as T: Microsoft.Data.Schema.Sql.DataGenerator.SqlVariant type.(Inherited from SqlSmoObject.)

System_CAPS_protmethod GetContextDB()

Gets the context database that is associated with this object.(Inherited from SqlSmoObject.)

System_CAPS_protmethod GetDBName()

Gets the database name that is associated with the object.(Inherited from SqlSmoObject.)

System_CAPS_pubmethod GetHashCode()

(Inherited from Object.)

System_CAPS_protmethod GetPropValue(String)

Gets a property value of the SqlSmoObject object.(Inherited from SqlSmoObject.)

System_CAPS_protmethod GetPropValueOptional(String)

Gets a property value of the SqlSmoObject object.(Inherited from SqlSmoObject.)

System_CAPS_protmethod GetPropValueOptionalAllowNull(String)

Gets a property value of the SqlSmoObject object.(Inherited from SqlSmoObject.)

System_CAPS_protmethod GetServerObject()

Gets the server of the SqlSmoObject object.(Inherited from SqlSmoObject.)

System_CAPS_pubmethod GetType()

(Inherited from Object.)

System_CAPS_pubmethod Initialize()

Initializes the object and forces the properties be loaded.(Inherited from SqlSmoObject.)

System_CAPS_pubmethod Initialize(Boolean)

Initializes the object and forces the properties be loaded.(Inherited from SqlSmoObject.)

System_CAPS_protmethod IsObjectInitialized()

Verifies whether the object has been initialized.(Inherited from SqlSmoObject.)

System_CAPS_protmethod IsObjectInSpace()

Verifies whether the object is isolated or connected to the instance of SQL Server.(Inherited from SqlSmoObject.)

System_CAPS_pubmethod Refresh()

Refreshes the script name.(Inherited from ScriptNameObjectBase.)

System_CAPS_protmethod SetParentImpl(SqlSmoObject)

Sets the parent of the SqlSmoObject to the newParent parameter.(Inherited from SqlSmoObject.)

System_CAPS_pubmethod ToString()

Returns a String that represents the referenced object.(Inherited from SqlSmoObject.)

System_CAPS_pubmethod Validate(String, Object[])

Validates the state of an object.(Inherited from SmoObjectBase.)

Events

Name Description
System_CAPS_pubevent PropertyChanged

Represents the event that occurs when a property is changed.(Inherited from SqlSmoObject.)

System_CAPS_pubevent PropertyMetadataChanged

Represents the event that occurs when property metadata changes.(Inherited from SqlSmoObject.)

Explicit Interface Implementations

Name Description
System_CAPS_pubinterfaceSystem_CAPS_privmethod IAlienObject.Discover()

Discovers any dependencies.

Do not reference this member directly in your code. It supports the SQL Server infrastructure.(Inherited from SqlSmoObject.)

System_CAPS_pubinterfaceSystem_CAPS_privmethod IAlienObject.GetDomainRoot()

Returns the root of the domain.(Inherited from SqlSmoObject.)

System_CAPS_pubinterfaceSystem_CAPS_privmethod 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.)

System_CAPS_pubinterfaceSystem_CAPS_privmethod IAlienObject.GetPropertyType(String)

Gets the type of the specified property.(Inherited from SqlSmoObject.)

System_CAPS_pubinterfaceSystem_CAPS_privmethod IAlienObject.GetPropertyValue(String, Type)

Gets the value of the specified property.(Inherited from SqlSmoObject.)

System_CAPS_pubinterfaceSystem_CAPS_privmethod 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.)

System_CAPS_pubinterfaceSystem_CAPS_privmethod IAlienObject.Resolve(String)

Gets the instance that contains the information about the object from the Unified Resource Name (URN) of the object.(Inherited from SqlSmoObject.)

System_CAPS_pubinterfaceSystem_CAPS_privmethod IAlienObject.SetObjectState(SfcObjectState)

Sets the object state to the specified SfcObjectState value.(Inherited from SqlSmoObject.)

System_CAPS_pubinterfaceSystem_CAPS_privmethod IAlienObject.SetPropertyValue(String, Type, Object)

Sets the property value.(Inherited from SqlSmoObject.)

System_CAPS_pubinterfaceSystem_CAPS_privmethod 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.)

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

Microsoft.SqlServer.Management.Smo Namespace

Return to top