Package com.senzing.sdk

Interface SzDiagnostic

public interface SzDiagnostic
Defines the Java interface to the Senzing diagnostic functions. The Senzing diagnostic functions provide diagnostics and statistics pertaining to the host system and the Senzing repository.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    checkDatastorePerformance(int secondsToRun)
    Runs non-destruction DB performance tests and returns detail of the result as a JSON String.
    String
    getDatastoreInfo()
    Gathers detailed information on the data store and returns it as a JSON String.
    String
    getFeature(long featureId)
    Experimental/internal method for obtaining diagnostic feature definition for the specified feature identifier.
    void
    purgeRepository()
    Purges all data in the configured repository.

  • Method Details

    • getDatastoreInfo

      String getDatastoreInfo() throws SzException
      Gathers detailed information on the data store and returns it as a JSON String.
      Returns:
      A JSON String describing the datastore.
      Throws:
      SzException - If a failure occurs.

    • checkDatastorePerformance

      String checkDatastorePerformance(int secondsToRun) throws SzException
      Runs non-destruction DB performance tests and returns detail of the result as a JSON String.
      Parameters:
      secondsToRun - How long to run the database performance test.
      Returns:
      The JSON String describing the results of the performance test.
      Throws:
      SzException - If a failure occurs.

    • purgeRepository

      void purgeRepository() throws SzException
      Purges all data in the configured repository.

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

      Throws:
      SzException - If a failure occurs.

    • getFeature

      String getFeature(long featureId) throws SzException
      Experimental/internal method for obtaining diagnostic feature definition for the specified feature identifier.
      Parameters:
      featureId - The identifier for the feature.
      Returns:
      The feature definition describing the feature for the specified feature ID.
      Throws:
      SzException - If a failure occurs.