SPUsageDatabase members

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

The SPUsageDatabase type exposes the following members.

Constructors

	Name	Description
	SPUsageDatabase()	Initializes a new instance of the [Microsoft.SharePoint.Administration.SPUsageDatabase] class.
	SPUsageDatabase(String, SPDatabaseServiceInstance)	Initializes a new instance of the [Microsoft.SharePoint.Administration.SPUsageDatabase] class based on values of the given name and serviceInstance parameters.
	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
	AvailabilityGroup	(Inherited from SPDatabase.)
	BackupLocation	(Inherited from SPDatabase.)
	BackupTimeoutOverride	(Inherited from SPDatabase.)
	BuildVersion	Gets the cached build version of the database. (Inherited from SPDatabase.)
	CanRenameOnRestore	Gets a Boolean value that indicates whether the database can be renamed when it is restored. (Inherited from SPDatabase.)
	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.)
	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.)
	CanUpgrade	Gets a value that indicates whether the object can be upgraded. (Inherited from SPPersistedUpgradableObject.)
	DatabaseConnectionString	Gets the connection string that is used to connect to the database. (Inherited from SPDatabase.)
	DBAccessPassword	(Inherited from SPDatabase.)
	DBAccessUsername	(Inherited from SPDatabase.)
	DeploymentLocked	(Inherited from SPPersistedObject.)
	DiskSizeRequired	Gets the amount of disk space that is required for a backup. (Inherited from SPDatabase.)
	DisplayName	Gets the display name that describes the persisted object instance within the administrative user interface. (Inherited from SPPersistedObject.)
	Exists	Gets a Boolean value that indicates whether the database exists. (Inherited from SPDatabase.)
	FailoverServer	Gets the SPServer object that represents the server that is hosting the mirror of the database. (Inherited from SPDatabase.)
	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.)
	Farm	Gets the server farm where the object resides. (Inherited from SPPersistedObject.)
	Id	Gets or sets the GUID that is associated with the object. (Inherited from SPPersistedObject.)
	IncludeInVssBackup	Gets a Boolean value that indicates whether the database is included in the Microsoft Visual SourceSafe component list. (Inherited from SPDatabase.)
	IsBackwardsCompatible	Gets or sets a value that indicates whether the current object is backward compatible. (Inherited from SPPersistedUpgradableObject.)
	IsReadOnly	Gets a value that indicates whether the database is read-only. (Inherited from SPDatabase.)
	IsSqlAzure	(Inherited from SPDatabase.)
	LegacyDatabaseConnectionString	Gets a string that contains the OLEDB connection string. (Inherited from SPDatabase.)
	MultiSubnetFailover	(Inherited from SPDatabase.)
	Name	Gets or sets a name that is used to uniquely identify two objects that have the same parent and class. (Inherited from SPPersistedObject.)
	NeedsUpgrade	(Inherited from SPDatabase.)
	NeedsUpgradeIncludeChildren	Gets a Boolean value that indicates whether the object should be upgraded, considering the children of the object. (Inherited from SPPersistedUpgradableObject.)
	NormalizedDataSource	Gets the normalized data source of the database. (Inherited from SPDatabase.)
	Parent	Gets the parent in the logical hierarchy of the configuration object tree. (Inherited from SPPersistedObject.)
	Password	Gets or sets the password that is used for SQL authentication. (Inherited from SPDatabase.)
	Properties	Gets metadata for the persisted object. (Inherited from SPPersistedObject.)
	SchemaVersionXml	Gets information about the schema versions associated with this [c] derived class. (Inherited from SPDatabase.)
	Server	Gets the server that contains the database. (Inherited from SPDatabase.)
	ServiceInstance	Gets an instance of the SQL service that owns the database. (Inherited from SPDatabase.)
	ShouldDeferUpgradeActions	(Inherited from SPPersistedUpgradableObject.)
	ShouldSkipUpgradeForHigherSchemaVersion	(Inherited from SPDatabase.)
	Snapshots	Gets the snapshots of the database. (Inherited from SPDatabase.)
	Status	Gets or sets the status of the object that the class represents. (Inherited from SPPersistedObject.)
	TypeName	Gets the display name that describes the object type in the administrative user interface. (Inherited from SPPersistedObject.)
	UpgradeContext	Gets the SPUpgradeContext for the current upgrade operation. (Inherited from SPPersistedUpgradableObject.)
	UpgradedPersistedProperties	Gets the collection of field names and values for fields that were deleted or changed. (Inherited from SPAutoSerializingObject.)
	Username	Gets or sets the user name that is used for SQL authentication login. (Inherited from SPDatabase.)
	Version	Gets a value that is incremented each time the object is updated. (Inherited from SPPersistedObject.)
	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
	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).)
	AddFailoverServiceInstance(String)	Identifies to SharePoint Foundation a server and a database service instance that hosts the mirror of the database. (Inherited from SPDatabase.)
	AddFailoverServiceInstance(String, Boolean, Boolean)	(Inherited from SPDatabase.)
	AddLogon(String, SecureString, String)	(Inherited from SPDatabase.)
	AddLogon(String, SecureString, String, Boolean)	(Inherited from SPDatabase.)
	AddLogon(String, SecureString, String, Boolean, Boolean)	(Inherited from SPDatabase.)
	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.)
	ChangeDatabaseInstance(SPDatabaseServiceInstance)	Modifies the specified database service instance for each connection string that is used to access the database. (Inherited from SPDatabase.)
	CleanupAfterMount	(Inherited from SPDatabase.)
	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.)
	Delete	Deletes the object. (Inherited from SPPersistedObject.)
	DropRoleMember	(Inherited from SPDatabase.)
	Equals	Determines whether the current persisted object equals the specified object. (Inherited from SPPersistedObject.)
	Finalize	(Inherited from Object.)
	GetChild<T>()	Returns the child of the persisted object based on the specified type. (Inherited from SPPersistedObject.)
	GetChild<T>(String)	Returns the child object of the persisted object based on the specified name. (Inherited from SPPersistedObject.)
	GetHashCode	Serves as a hash function for the persisted object. (Inherited from SPPersistedObject.)
	GetObjectData	Gets the serialized state of the object. (Inherited from SPAutoSerializingObject.)
	GetType	(Inherited from Object.)
	GetVersionForId	Returns the schema version associated with the upgrade sequence specified by ID. (Inherited from SPDatabase.)
	GrantAccess(SecurityIdentifier)	Grants the specified user access to the database. (Inherited from SPDatabase.)
	GrantAccess(SecurityIdentifier, String)	Grants the specified user access to the database and adds the user to the specified role. (Inherited from SPDatabase.)
	GrantAccess(String, String)	Grants the specified user or group access to the database and adds them to the specified sql server role.
	GrantOwnerAccessToDatabaseAccount	Grants the database owner permissions to the database access account. (Inherited from SPDatabase.)
	HasAdditionalUpdateAccess	Override this method to allow more users to update the object. (Inherited from SPPersistedObject.)
	Invalidate	Invalidates the cached version stamp and other flags that are related to upgrade. (Inherited from SPDatabase.)
	IsEmpty	Determines if the database is empty. (Inherited from SPDatabase.)
	IsRoleMember	(Inherited from SPDatabase.)
	LegacyUpdate	(Inherited from SPPersistedObject.)
	MemberwiseClone	(Inherited from Object.)
	Migrate	(Inherited from SPDatabase.)
	OnAbort	Raises the Abort (backup) event. (Inherited from SPDatabase.)
	OnBackup	Raises the Backup event. (Inherited from SPDatabase.)
	OnBackupComplete	Raises the BackupComplete event. (Inherited from SPDatabase.)
	OnDeserialization	(Inherited from SPDatabase.)
	OnPostCreate	(Inherited from SPPersistedObject.)
	OnPostRestore	Raises the PostRestore event. (Inherited from SPDatabase.)
	OnPreCreate	(Inherited from SPPersistedObject.)
	OnPrepareBackup	Raises the PrepareBackup event. (Inherited from SPDatabase.)
	OnPreRestore	Raises the PreRestore event. (Inherited from SPDatabase.)
	OnRestore	Raises the Restore event. (Inherited from SPDatabase.)
	PreventConnectionDuringUpgrade	(Inherited from SPDatabase.)
	Provision	Provisions this SPUsageDatabase() object. (Overrides SPPersistedObject.Provision().)
	RunWithConcurrencyRetries	(Inherited from SPPersistedObject.)
	ToString	Returns the type and name of an object and of all its ancestors (parent, grandparent, and so on). (Inherited from SPPersistedObject.)
	Uncache	Frees the memory cache that is used by the object. (Inherited from SPPersistedObject.)
	Unprovision	Makes the necessary changes to the local server to clean up after deleting the database. (Inherited from SPDatabase.)
	Update()	Causes the database to save its state and propagate changes to all the computers in the server farm. (Inherited from SPDatabase.)
	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.)
	UpdateParent	Causes the containing SPPersistedObject, if one exists, to update its state. (Inherited from SPAutoSerializingObject.)
	UpdateWithNoObjectCallbackCheck	(Inherited from SPPersistedObject.)
	Upgrade()	Upgrades the object. (Inherited from SPPersistedUpgradableObject.)
	Upgrade(Boolean)	(Inherited from SPDatabase.)
	Validate	Validates the state of all fields before persisting the object. (Inherited from SPPersistedObject.)
	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.)
	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