SPDiagnosticsSqlProvider members

Provides methods and properties for working with a SQL-based diagnostics log.

The SPDiagnosticsSqlProvider type exposes the following members.

Constructors

	Name	Description
	SPDiagnosticsSqlProvider()	Constructor intended for internal use only.
	SPDiagnosticsSqlProvider(String, String, String, SPService)	Initializes a new instance the SPDiagnosticsSqlProvider class.

Top

Properties

	Name	Description
	CanRenameOnRestore	Gets a Boolean value that indicates whether this object can be renamed at restore time. (Inherited from SPJobDefinition.)
	CanSelectForBackup	Gets and sets a Boolean value that indicates whether this object can be selected for backup. (Inherited from SPJobDefinition.)
	CanSelectForRestore	Gets and sets a Boolean value that indicates whether this object can be selected for backup. (Inherited from SPJobDefinition.)
	Columns	This method is called to get a 2-dimensional string array representing the column name and data type of the table schema. (Inherited from SPDiagnosticsProvider.)
	DeploymentLocked	(Inherited from SPPersistedObject.)
	Description	Gets a localized description of the job definition. (Inherited from SPJobDefinition.)
	DiskSizeRequired	Gets the disk sized required for backup. (Inherited from SPJobDefinition.)
	DisplayName	Gets the localized name of the job definition. (Inherited from SPJobDefinition.)
	EnableBackup	Gets a Boolean value that indicates whether the job can be involved in the backup/restore process. (Inherited from SPJobDefinition.)
	Farm	Gets the server farm where the object resides. (Inherited from SPPersistedObject.)
	HistoryEntries	Enumerate the job history entries for this job definition. (Inherited from SPJobDefinition.)
	Id	Gets or sets the GUID that is associated with the object. (Inherited from SPPersistedObject.)
	IsDisabled	Gets or sets whether the job definition should be disabled. (Inherited from SPJobDefinition.)
	IsServiceJob	(Inherited from SPJobDefinition.)
	LastRunTime	Gets the last run time of the job definition. (Inherited from SPJobDefinition.)
	LockType	Gets the lock type for the job definition. (Inherited from SPJobDefinition.)
	MaxTotalSizeInBytes	(Inherited from SPDiagnosticsProvider.)
	Name	Gets or sets a name that is used to uniquely identify two objects that have the same parent and class. (Inherited from SPPersistedObject.)
	Parent	Gets the parent in the logical hierarchy of the configuration object tree. (Inherited from SPPersistedObject.)
	PerDatabaseInstanceAzureSql
	PerDatabaseInstanceLocalSql
	Properties	Gets metadata for the persisted object. (Inherited from SPPersistedObject.)
	Query	The SQL query that will be executed against all SQL instances when the provider collects data.
	RetentionPeriod	This property is called to get the retention period (in days) of the provider. (Inherited from SPDiagnosticsProvider.)
	Retry	Gets or sets whether the job definition should be retried if it ends abnormally. (Inherited from SPJobDefinition.)
	RunOnAzureSql
	RunOnLocalSQL
	Schedule	Gets or sets the schedule of the job definition. (Inherited from SPJobDefinition.)
	Server	Gets the server of the job definition. (Inherited from SPJobDefinition.)
	Service	Gets the service for this job definition. (Inherited from SPJobDefinition.)
	Status	Gets or sets the status of the object that the class represents. (Inherited from SPPersistedObject.)
	TableName	This method is called to get the name of table associated with the provider. (Inherited from SPDiagnosticsProvider.)
	Title	Gets or sets the title of the job definition. (Inherited from SPJobDefinition.)
	TypeName	Gets the display name that describes the object type in the administrative user interface. (Inherited from SPPersistedObject.)
	UpgradedPersistedProperties	Gets the collection of field names and values for fields that were deleted or changed. (Inherited from SPAutoSerializingObject.)
	VerboseTracingEnabled	Gets and sets a Boolean value that indicates whether verbose tracing is enabled. (Inherited from SPJobDefinition.)
	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.)
	WebApplication	Gets the web application for this job definition. (Inherited from SPJobDefinition.)

Top

Methods

	Name	Description
	AddBackupObjects	Adds this SPJobDefinition object to the backup/restore operation. (Inherited from SPJobDefinition.)
	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.)
	CreateHelperTable	Creates the helper table in the logging database. (Inherited from SPDiagnosticsProvider.)
	CreateStoredProcedure	Creates or alters the specified stored procedure object. (Inherited from SPDiagnosticsProvider.)
	CreateTable	Creates a table in the logging store. (Inherited from SPDiagnosticsProvider.)
	Delete	When the timer job is deleted, the data associated with that job will be deleted as well. (Inherited from SPDiagnosticsProvider.)
	DropHelperTable	Deletes the helper table from the database. (Inherited from SPDiagnosticsProvider.)
	DropStoredProcedure	Deletes the helper stored procedure from the database. (Inherited from SPDiagnosticsProvider.)
	DropTable	Drop the tables in the logging store (Inherited from SPDiagnosticsProvider.)
	Ensure	Makes sure that the backing data structures are in place. (Inherited from SPDiagnosticsProvider.)
	Equals	Determines whether the current persisted object equals the specified object. (Inherited from SPPersistedObject.)
	Execute	Called by the timer job at scheduled intervals to execute data collection activities associated with this provider. (Inherited from SPDiagnosticsProvider.)
	ExecuteNonQuery	Executes a Transact-SQL query that does not return any rows. (Inherited from SPDiagnosticsProvider.)
	ExecuteReader	Executes a Transact-SQL query that returns a rowset. (Inherited from SPDiagnosticsProvider.)
	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.)
	GetLastSyncUtc(String)	The DateTime of the most recent data written to Usage database in UTC format. (Inherited from SPDiagnosticsProvider.)
	GetLastSyncUtc(String, String)	The DateTime of the most recent data written to Usage database in UTC format. (Inherited from SPDiagnosticsProvider.)
	GetObjectData	Gets the serialized state of the object. (Inherited from SPAutoSerializingObject.)
	GetType	(Inherited from Object.)
	HasAdditionalUpdateAccess	Override this method to allow more users to update the object. (Inherited from SPPersistedObject.)
	LegacyUpdate	(Inherited from SPPersistedObject.)
	MemberwiseClone	(Inherited from Object.)
	OnAbort	Called when a user cancels the operation. (Inherited from SPJobDefinition.)
	OnBackup	Called when the system is being backed up. (Inherited from SPJobDefinition.)
	OnBackupComplete	Called when a backup operation is complete. (Inherited from SPJobDefinition.)
	OnDeserialization	Called immediately after the base class deserializes itself to do additional work. (Inherited from SPPersistedObject.)
	OnPostCreate	(Inherited from SPPersistedObject.)
	OnPostRestore	Called when the system is done restoring a backup. (Inherited from SPJobDefinition.)
	OnPreCreate	(Inherited from SPJobDefinition.)
	OnPrepareBackup	Called when the system is preparing for a backup operation. (Inherited from SPJobDefinition.)
	OnPreRestore	Called when the system is preparing to restore a backup. (Inherited from SPJobDefinition.)
	OnProvisioning	This method is called to allow providers to perform any kind of initialization of SQL database, such as creation of tables and/or stored procedures. (Inherited from SPDiagnosticsProvider.)
	OnRestore	Called when the system is being restored. (Inherited from SPJobDefinition.)
	OnUnprovisioning	This method is called to allow providers to perform any kind of initialization of SQL database, such as creation of tables and/or stored procedures. (Inherited from SPDiagnosticsProvider.)
	Provision	Makes the changes to the local server that are needed before the object can be used. (Inherited from SPPersistedObject.)
	RunNow	Schedules the job for immediate execution. (Inherited from SPJobDefinition.)
	RunWithConcurrencyRetries	(Inherited from SPPersistedObject.)
	Sync	Copies new data from the data source to the data warehouse. (Overrides SPDiagnosticsProvider.Sync().)
	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	This method is called to delete all database objects associated with the provider. (Inherited from SPDiagnosticsProvider.)
	Update()	Causes this SPDiagnosticsProvider to save its state. (Inherited from SPDiagnosticsProvider.)
	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.)
	UpdateProgress	Updates the percentage of the running job that is completed for the job definition running on the current server. (Inherited from SPJobDefinition.)
	UpdateWithNoObjectCallbackCheck	(Inherited from SPPersistedObject.)
	Validate	Validates query last execution date/time. (Overrides SPJobDefinition.Validate().)
	WriteDataRowToServer(DateTime, String, [])	Writes supplied data to Usage database. (Inherited from SPDiagnosticsProvider.)
	WriteDataRowToServer(String, IList<SPColumnDefinition>, DateTime, String, [])	Writes a row of data into a table in the logging store. The table should have been created with CreateTable(String, IList<SPColumnDefinition>)CreateTable(String, IList<SPColumnDefinition>). (Inherited from SPDiagnosticsProvider.)

Top

See also

Reference

SPDiagnosticsSqlProvider class

Microsoft.SharePoint.Diagnostics namespace