Class SzGrpcDiagnostic

SzGrpcDiagnostic Access the Senzing Diagnostic module via gRPC

Hierarchy

  • SzGrpcBase
    • SzGrpcDiagnostic

Implements

  • SzDiagnostic

Properties

grpcConnectionReadyTimeOut productId

Methods

checkRepositoryPerformance getDeadlineFromNow getFeature getRepositoryInfo purgeRepository waitForReady

Properties

grpcConnectionReadyTimeOut

grpcConnectionReadyTimeOut: number = DEFAULT_CONNECTION_READY_TIMEOUT

productId

productId: string = "5052"

See https://github.com/senzing-garage/knowledge-base/blob/main/lists/senzing-component-ids.md

Methods

checkRepositoryPerformance

  • checkRepositoryPerformance(
        secondsToRun: number,
    ): Promise<SzError | CHECK_DATASTORE_PERFORMANCE_RESPONSE>

  • Performs inserts to determine rate of insertion.

    Parameters

    • secondsToRun: number

      Duration of the test in seconds.

    Returns Promise<SzError | CHECK_DATASTORE_PERFORMANCE_RESPONSE>

    A JSON document

ProtectedgetDeadlineFromNow

  • getDeadlineFromNow(secondsFromNow?: number): Date

  • Parameters

    • OptionalsecondsFromNow: number

    Returns Date

getFeature

  • getFeature(featureId: number): Promise<string>
  • Experimental

    Returns diagnostic information of a feature. Not recommended for use.

    Parameters

    • featureId: number

      The identifier of the feature to describe.

    Returns Promise<string>

    A string containing a JSON document

getRepositoryInfo

  • getRepositoryInfo(): Promise<string>

  • Returns details of the datastore currently in use by Senzing.

    Returns Promise<string>

purgeRepository

  • purgeRepository(): Promise<undefined>

  • Removes every record in the Senzing repository.

    Returns Promise<undefined>

    for async flow control.

waitForReady

  • waitForReady(deadline: Date, cb: (error: null | Error) => void): any

  • Wait for the client to be ready. The callback will be called when the client has successfully connected to the server, and it will be called with an error if the attempt to connect to the server has unrecoverablly failed or if the deadline expires. This function will make the channel start connecting if it has not already done so.

    Parameters

    • deadline: Date
    • cb: (error: null | Error) => void

    Returns any

Settings

Member Visibility

On This Page

Properties
Methods