Interface SzDiagnostic

Namespace

Senzing.Sdk

Assembly

Senzing.Sdk.dll

Defines the interface to the Senzing diagnostic functions.

public interface SzDiagnostic

Remarks

The Senzing diagnostic functions provide diagnostics and statistics pertaining to the host system and the Senzing repository.

Methods

CheckDatastorePerformance(int)

Runs non-destruction DB performance tests and returns detail of the result as a JSON string.

string CheckDatastorePerformance(int secondsToRun)

Parameters

secondsToRun int

How long to run the database performance test.

Returns

string

The JSON string describing the results of the performance test.

Exceptions

SzException

Thrown if a failure occurs.

GetDatastoreInfo()

Gathers detailed information on the data store and returns it as a JSON string.

string GetDatastoreInfo()

Returns

string

A JSON string describing the datastore.

Exceptions

SzException

Thrown if a failure occurs.

GetFeature(long)

Experimental/internal method for obtaining diagnostic feature definition for the specified feature identifier.

string GetFeature(long featureID)

Parameters

featureID long

The identifier for the feature.

Returns

string

The feature definition describing the feature for the specified feature ID.

Exceptions

SzException

Thrown if a failure occurs.

PurgeRepository()

Purges all data in the configured repository.

void PurgeRepository()

Remarks

WARNING: There is no undoing from this. Make sure your repository is regularly backed up.

Exceptions

SzException

Thrown if a failure occurs.