Share via

SPDatabaseServiceInstance members

  • Article

Represents a named SQL Server instance.

The SPDatabaseServiceInstance type exposes the following members.

Constructors

  Name Description
Public method SPDatabaseServiceInstance() Reserved for internal use only.
Public method SPDatabaseServiceInstance(String, SPServer, SPDatabaseService) Initializes a new instance of the SPDatabaseServiceInstance class based on the specified database service instance name, server, and database service.

Top

Properties

  Name Description
Public property AuthMode
Public property CanUpgrade Gets a value that indicates whether the object can be upgraded. (Inherited from SPPersistedUpgradableObject.)
Public property Databases Gets the collection of databases that are used in the database service instance.
Public property DeploymentLocked (Inherited from SPPersistedObject.)
Public property Description Gets the description of the service that is used in the Administration user interface. (Inherited from SPServiceInstance.)
Public property DisplayName Gets the display name that is used to describe the instance in the administration user interface. (Overrides SPPersistedObject.DisplayName.)
Public property EnsurePermissionsOnUpdate
Public property Farm Gets the server farm where the object resides. (Inherited from SPPersistedObject.)
Public property Hidden Gets a Boolean value that indicates whether the service instance is displayed in the user interface. (Inherited from SPServiceInstance.)
Public property Id Gets or sets the GUID that is associated with the object. (Inherited from SPPersistedObject.)
Public property Instance Gets the name of this instance. (Inherited from SPServiceInstance.)
Public property IsBackwardsCompatible Gets or sets a value that indicates whether the current object is backward compatible. (Inherited from SPPersistedUpgradableObject.)
Public property ManageLink Gets a link object that represents the action that manages the service on the Services on Server page in SharePoint Central Administration. (Inherited from SPServiceInstance.)
Public property Name Gets or sets a name that is used to uniquely identify two objects that have the same parent and class. (Inherited from SPPersistedObject.)
Public property NeedsUpgrade Gets or sets a Boolean value that specifies whether the object needs to be upgraded. (Inherited from SPPersistedUpgradableObject.)
Public property NeedsUpgradeIncludeChildren Gets a Boolean value that indicates whether the object should be upgraded, considering the children of the object. (Inherited from SPPersistedUpgradableObject.)
Public property NormalizedDataSource Gets the names of the database server and database server instance.
Public property Parent Gets the parent in the logical hierarchy of the configuration object tree. (Inherited from SPPersistedObject.)
Public property Properties Gets metadata for the persisted object. (Inherited from SPPersistedObject.)
Public property ProvisionLink Gets a link object that represents the action that starts the service on the Services on Server page in SharePoint Central Administration. (Inherited from SPServiceInstance.)
Protected property ProvisionUpdateStatus Gets a Boolean value that indicates whether the object status is set to Online when the Provision method is called. (Inherited from SPServiceInstance.)
Public property ReprovisionLink (Inherited from SPServiceInstance.)
Public property Roles Obsolete. Gets a list of the roles to which the service instance belongs, for classification on the Services on Server page in SharePoint Central Administration. (Inherited from SPServiceInstance.)
Public property SecureDBCredential
Public property Server Gets the server on which the service instance is installed. (Inherited from SPServiceInstance.)
Public property Service Gets the service that owns this service instance. (Inherited from SPServiceInstance.)
Public property ShouldDeferUpgradeActions (Inherited from SPPersistedUpgradableObject.)
Public property Status Gets or sets the status of the object that the class represents. (Inherited from SPPersistedObject.)
Public property SystemService Gets a Boolean value that indicates whether the service is a system service. (Inherited from SPServiceInstance.)
Public property TypeName Gets the display name that describes the service instance in the Administration user interface. (Inherited from SPServiceInstance.)
Public property UnprovisionLink Gets a link object that represents the action that stops the service on the Services on Server page in SharePoint Central Administration. (Inherited from SPServiceInstance.)
Public property UpgradeContext Gets the SPUpgradeContext for the current upgrade operation. (Inherited from SPPersistedUpgradableObject.)
Public property UpgradedPersistedProperties Gets the collection of field names and values for fields that were deleted or changed. (Inherited from SPAutoSerializingObject.)
Public property Version Gets a value that is incremented each time the object is updated. (Inherited from SPPersistedObject.)
Protected property WasCreated Gets a Boolean value that indicates whether the object is initialized and can be found in the database. (Inherited from SPPersistedObject.)

Top

Methods

  Name Description
Public method ChangeSQLAuthUserCredentialForDBs
Public method Clone Returns a clone of the object that does not come from the in-memory cache, which enables calling code to help ensure thread safety. (Inherited from SPPersistedObject.)
Public method Delete Deletes the object. (Inherited from SPPersistedObject.)
Public method EnsureSQLAuthUser
Public method Equals Determines whether the current persisted object equals the specified object. (Inherited from SPPersistedObject.)
Protected method Finalize (Inherited from Object.)
Public method GetChild<T>() Returns the child of the persisted object based on the specified type. (Inherited from SPPersistedObject.)
Public method GetChild<T>(String) Returns the child object of the persisted object based on the specified name. (Inherited from SPPersistedObject.)
Public method GetHashCode Serves as a hash function for the persisted object. (Inherited from SPPersistedObject.)
Public method GetObjectData Gets the serialized state of the object. (Inherited from SPAutoSerializingObject.)
Public method GetType (Inherited from Object.)
Public method GrantControlServerPermission Grant the permission to control server for a user
Public method GrantViewServerStatePermission Grants the specified user permission to view the server state.
Protected method HasAdditionalUpdateAccess Override this method to allow more users to update the object. (Inherited from SPPersistedObject.)
Public method Invalidate Invalidates computed property values. (Inherited from SPPersistedUpgradableObject.)
Public method LegacyUpdate (Inherited from SPPersistedObject.)
Protected method MemberwiseClone (Inherited from Object.)
Protected method OnDeserialization Called immediately after the base class deserializes itself to do additional work. (Inherited from SPPersistedObject.)
Protected method OnPostCreate (Inherited from SPPersistedObject.)
Protected method OnPreCreate (Inherited from SPPersistedObject.)
Public method Provision Starts the service instance on the server. (Inherited from SPServiceInstance.)
Public method RevokeControlServerPermission Grant the permission to control server for a user
Public method RevokeViewServerStatePermission Revokes from the specified user permission to view the server state.
Public method RunWithConcurrencyRetries (Inherited from SPPersistedObject.)
Public method ShouldProvision (Overrides SPServiceInstance.ShouldProvision(SPServerRole).)
Public method ToString Returns the type and name of an object and of all its ancestors (parent, grandparent, and so on). (Inherited from SPPersistedObject.)
Public method Uncache Frees the memory cache that is used by the object. (Inherited from SPPersistedObject.)
Public method Unprovision Stops the service instance on the server. (Inherited from SPServiceInstance.)
Public method Update() Saves the state of the SPDatabaseServiceInstance object to the configuration database. (Overrides SPPersistedObject.Update().)
Public method Update(Boolean) Causes the object to save its state and propagate changes to all the computers in the server farm, optionally throwing an exception if the object already exists in the configuration store. (Inherited from SPPersistedObject.)
Protected method UpdateParent Causes the containing SPPersistedObject, if one exists, to update its state. (Inherited from SPAutoSerializingObject.)
Public method UpdateWithNoObjectCallbackCheck (Inherited from SPPersistedObject.)
Public method Upgrade() Upgrades the object. (Inherited from SPPersistedUpgradableObject.)
Public method Upgrade(Boolean) Upgrades the object, and if a Boolean parameter equals true, recursively upgrades all descendants of the current object. (Inherited from SPPersistedUpgradableObject.)
Protected method Validate Validates the state of all fields before persisting the object. (Inherited from SPPersistedObject.)
Public method ValidateBackwardsCompatibility Validates the backward compatibility of the content database schema for the DLLs on the Web front end. This method is called each time a connection is made to the content database to verify that the database schema is compatible. (Inherited from SPPersistedUpgradableObject.)

Top

See also

Reference

SPDatabaseServiceInstance class

Microsoft.SharePoint.Administration namespace