Share via


SPUsageDatabase members

Stores settings for usage logging and processing in a SharePoint Services deployment.

The SPUsageDatabase type exposes the following members.

Constructors

  Name Description
Public method SPUsageDatabase() Initializes a new instance of the [Microsoft.SharePoint.Administration.SPUsageDatabase] class.
Public method SPUsageDatabase(String, SPDatabaseServiceInstance) Initializes a new instance of the [Microsoft.SharePoint.Administration.SPUsageDatabase] class based on values of the given name and serviceInstance parameters.
Public method SPUsageDatabase(String, SPDatabaseServiceInstance, String, String) Initializes a new instance of the [Microsoft.SharePoint.Administration.SPUsageDatabase] class based on values of the given name, serviceInstance, username, and password parameters. This constructor is for a usage database.

Top

Properties

  Name Description
Public property AvailabilityGroup (Inherited from SPDatabase.)
Public property BackupLocation (Inherited from SPDatabase.)
Public property BackupTimeoutOverride (Inherited from SPDatabase.)
Public property BuildVersion Gets the cached build version of the database. (Inherited from SPDatabase.)
Public property CanRenameOnRestore Gets a Boolean value that indicates whether the database can be renamed when it is restored. (Inherited from SPDatabase.)
Public property CanSelectForBackup Gets or sets a Boolean value that specifies whether the database object and its children can be selected for a backup operation in the Central Administration user interface. (Inherited from SPDatabase.)
Public property CanSelectForRestore Gets or sets a Boolean value that specifies whether this object and its children can be selected for a restore operation in the Central Administration user interface. (Inherited from SPDatabase.)
Public property CanUpgrade Gets a value that indicates whether the object can be upgraded. (Inherited from SPPersistedUpgradableObject.)
Public property DatabaseConnectionString Gets the connection string that is used to connect to the database. (Inherited from SPDatabase.)
Public property DBAccessPassword (Inherited from SPDatabase.)
Public property DBAccessUsername (Inherited from SPDatabase.)
Public property DeploymentLocked (Inherited from SPPersistedObject.)
Public property DiskSizeRequired Gets the amount of disk space that is required for a backup. (Inherited from SPDatabase.)
Public property DisplayName Gets the display name that describes the persisted object instance within the administrative user interface. (Inherited from SPPersistedObject.)
Public property Exists Gets a Boolean value that indicates whether the database exists. (Inherited from SPDatabase.)
Public property FailoverServer Gets the SPServer object that represents the server that is hosting the mirror of the database. (Inherited from SPDatabase.)
Public property FailoverServiceInstance Gets or sets the SPDatabaseServiceInstance object that represents the instance of the database service that is hosting the mirror of the database. (Inherited from SPDatabase.)
Public property Farm Gets the server farm where the object resides. (Inherited from SPPersistedObject.)
Public property Id Gets or sets the GUID that is associated with the object. (Inherited from SPPersistedObject.)
Public property IncludeInVssBackup Gets a Boolean value that indicates whether the database is included in the Microsoft Visual SourceSafe component list. (Inherited from SPDatabase.)
Public property IsBackwardsCompatible Gets or sets a value that indicates whether the current object is backward compatible. (Inherited from SPPersistedUpgradableObject.)
Public property IsReadOnly Gets a value that indicates whether the database is read-only. (Inherited from SPDatabase.)
Public property IsSqlAzure (Inherited from SPDatabase.)
Public property LegacyDatabaseConnectionString Gets a string that contains the OLEDB connection string. (Inherited from SPDatabase.)
Public property MultiSubnetFailover (Inherited from SPDatabase.)
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 (Inherited from SPDatabase.)
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 normalized data source of the database. (Inherited from SPDatabase.)
Public property Parent Gets the parent in the logical hierarchy of the configuration object tree. (Inherited from SPPersistedObject.)
Public property Password Gets or sets the password that is used for SQL authentication. (Inherited from SPDatabase.)
Public property Properties Gets metadata for the persisted object. (Inherited from SPPersistedObject.)
Public property SchemaVersionXml Gets information about the schema versions associated with this [c] derived class. (Inherited from SPDatabase.)
Public property Server Gets the server that contains the database. (Inherited from SPDatabase.)
Public property ServiceInstance Gets an instance of the SQL service that owns the database. (Inherited from SPDatabase.)
Public property ShouldDeferUpgradeActions (Inherited from SPPersistedUpgradableObject.)
Public property ShouldSkipUpgradeForHigherSchemaVersion (Inherited from SPDatabase.)
Public property Snapshots Gets the snapshots of the database. (Inherited from SPDatabase.)
Public property Status Gets or sets the status of the object that the class represents. (Inherited from SPPersistedObject.)
Public property TypeName Gets the display name that describes the object type in the administrative user interface. (Inherited from SPPersistedObject.)
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 Username Gets or sets the user name that is used for SQL authentication login. (Inherited from SPDatabase.)
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 AddBackupObjects Adds backup objects to the backup restore collection. Objects include the usage database name, the usage database backup & restore type name, and the usage database backup & restore description. (Overrides SPDatabase.AddBackupObjects(SPBackupRestoreObject).)
Public method AddFailoverServiceInstance(String) Identifies to SharePoint Foundation a server and a database service instance that hosts the mirror of the database. (Inherited from SPDatabase.)
Public method AddFailoverServiceInstance(String, Boolean, Boolean) (Inherited from SPDatabase.)
Public method AddLogon(String, SecureString, String) (Inherited from SPDatabase.)
Public method AddLogon(String, SecureString, String, Boolean) (Inherited from SPDatabase.)
Public method AddLogon(String, SecureString, String, Boolean, Boolean) (Inherited from SPDatabase.)
Public method ChangeDatabaseInstance(String) Modifies the database service instance with the specified name for each connection string that is used to access the database. (Inherited from SPDatabase.)
Public method ChangeDatabaseInstance(SPDatabaseServiceInstance) Modifies the specified database service instance for each connection string that is used to access the database. (Inherited from SPDatabase.)
Protected method CleanupAfterMount (Inherited from SPDatabase.)
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.)
Protected method DropRoleMember (Inherited from SPDatabase.)
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.)
Protected method GetVersionForId Returns the schema version associated with the upgrade sequence specified by ID. (Inherited from SPDatabase.)
Protected method GrantAccess(SecurityIdentifier) Grants the specified user access to the database. (Inherited from SPDatabase.)
Protected method GrantAccess(SecurityIdentifier, String) Grants the specified user access to the database and adds the user to the specified role. (Inherited from SPDatabase.)
Public method GrantAccess(String, String) Grants the specified user or group access to the database and adds them to the specified sql server role.
Public method GrantOwnerAccessToDatabaseAccount Grants the database owner permissions to the database access account. (Inherited from SPDatabase.)
Protected method HasAdditionalUpdateAccess Override this method to allow more users to update the object. (Inherited from SPPersistedObject.)
Public method Invalidate Invalidates the cached version stamp and other flags that are related to upgrade. (Inherited from SPDatabase.)
Public method IsEmpty Determines if the database is empty. (Inherited from SPDatabase.)
Protected method IsRoleMember (Inherited from SPDatabase.)
Public method LegacyUpdate (Inherited from SPPersistedObject.)
Protected method MemberwiseClone (Inherited from Object.)
Public method Migrate (Inherited from SPDatabase.)
Public method OnAbort Raises the Abort (backup) event. (Inherited from SPDatabase.)
Public method OnBackup Raises the Backup event. (Inherited from SPDatabase.)
Public method OnBackupComplete Raises the BackupComplete event. (Inherited from SPDatabase.)
Protected method OnDeserialization (Inherited from SPDatabase.)
Protected method OnPostCreate (Inherited from SPPersistedObject.)
Public method OnPostRestore Raises the PostRestore event. (Inherited from SPDatabase.)
Protected method OnPreCreate (Inherited from SPPersistedObject.)
Public method OnPrepareBackup Raises the PrepareBackup event. (Inherited from SPDatabase.)
Public method OnPreRestore Raises the PreRestore event. (Inherited from SPDatabase.)
Public method OnRestore Raises the Restore event. (Inherited from SPDatabase.)
Protected method PreventConnectionDuringUpgrade (Inherited from SPDatabase.)
Public method Provision Provisions this SPUsageDatabase() object. (Overrides SPPersistedObject.Provision().)
Public method RunWithConcurrencyRetries (Inherited from SPPersistedObject.)
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 Makes the necessary changes to the local server to clean up after deleting the database. (Inherited from SPDatabase.)
Public method Update() Causes the database to save its state and propagate changes to all the computers in the server farm. (Inherited from SPDatabase.)
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) (Inherited from SPDatabase.)
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.)
Protected method WarnAboutRemoteBlobStorageSettings Returns a Boolean value that specifies whether the administrator is warned that external binary large object (BLOB) storage is installed. (Inherited from SPDatabase.)

Top

See also

Reference

SPUsageDatabase class

Microsoft.SharePoint.Administration namespace