Share via


SPUsageProvider Members

Include Protected Members
Include Inherited Members

Common public abstract class for defining a usage type that is hosted in the logging database.

The SPUsageProvider type exposes the following members.

Constructors

  Name Description
Protected method SPUsageProvider() Initializes a new instance of the [Microsoft.SharePoint.Administration.SPUsageProvider] class.
Protected method SPUsageProvider(SPFarm) Initializes a new instance of the [Microsoft.SharePoint.Administration.SPUsageProvider] class within the specified SharePoint farm.

Top

Properties

  Name Description
Public property Columns A list that defines the columns used to store data for this usage provider.
Public property DaysToKeepData Gets or sets the number of days to keep data. (Inherited from SPUsageDefinition.)
Public property DaysToKeepDetailedData The number of days to keep data. (Overrides SPUsageDefinition.DaysToKeepDetailedData.)
Public property Description (Inherited from SPUsageDefinition.)
Public property DisplayName Gets the display name that describes the persisted object instance within the administrative user interface. (Inherited from SPPersistedObject.)
Public property Enabled Gets or sets a value specifying whether usage logging has been enabled for this type. (Inherited from SPUsageDefinition.)
Public property EnableReceivers Gets or sets a value indicating whether usage receivers are enabled for this usage type. (Inherited from SPUsageDefinition.)
Public property Farm Gets the server farm where the object resides. (Inherited from SPPersistedObject.)
Public property Hidden (Inherited from SPUsageDefinition.)
Public property Id Gets or sets the GUID that is associated with the object. (Inherited from SPPersistedObject.)
Public property MaxTotalSizeInBytes (Inherited from SPUsageDefinition.)
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 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 ProvisionSchema Indicates whether this usage provider should have schema provision in the logging store.
Public property Receivers Gets this usage definition's collection of receivers. (Inherited from SPUsageDefinition.)
Public property RetentionPeriod The number of days to keep data for this provider.
Public property Status Gets or sets the status of the object that the class represents. (Inherited from SPPersistedObject.)
Public property TableName Primary unique name given to objects created in the logging store for this usage provider.
Public property TypeName Gets the display name that describes the object type in the administrative user interface. (Inherited from SPPersistedObject.)
Public property UpgradedPersistedProperties Gets the collection of field names and values for fields that were deleted or changed. (Inherited from SPAutoSerializingObject.)
Public property UsageEntryType (Inherited from SPUsageDefinition.)
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 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 CreateTable Creates a table in the logging store.
Public method Delete Deletes the object. (Inherited from SPPersistedObject.)
Public method Equals Determines whether the current persisted object equals the specified object. (Inherited from SPPersistedObject.)
Public method ExecuteNonQuery Executes a Transact-SQL query that does not return any rows.
Public method ExecuteReader Executes a Transact-SQL query that returns a rowset.
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 HasAdditionalUpdateAccess Override this method to allow more users to update the object. (Inherited from SPPersistedObject.)
Public method ImportEntries Uploads page request usage entries to corresponding import table in Usage Database. (Overrides SPUsageDefinition.ImportEntries(IEnumerator<SPUsageEntry>).)
Protected method MemberwiseClone (Inherited from Object.)
Protected method OnDeserialization Called immediately after the base class deserializes itself to do additional work. (Inherited from SPPersistedObject.)
Public method OnProvisioning This method is called to allow providers to perform any kind of SQL database initialization such as creation of tables or stored procedures.
Public method OnUnprovisioning This method is called to allow providers to revert any actions performed during provisioning of the provider.
Public method ProcessData (Inherited from SPUsageDefinition.)
Public method Provision Makes the changes to the local server that are needed before the object can be used. (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 TruncateData (Inherited from SPUsageDefinition.)
Public method Uncache Frees the memory cache that is used by the object. (Inherited from SPPersistedObject.)
Public method Unprovision Makes the changes to the local server that are needed to clean up after deleting the object. (Inherited from SPPersistedObject.)
Public method Update() Updates this usage provider in 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.)
Protected method Validate (Inherited from SPUsageDefinition.)
Public method WriteDataRowToServer Writes a row of data into a table in the logging store.

Top

See Also

Reference

SPUsageProvider Class

Microsoft.SharePoint.Administration Namespace