Class SzGrpcDiagnostic

SzGrpcDiagnostic Access the Senzing Diagnostic module via gRPC

Hierarchy

SzGrpcBase
- SzGrpcDiagnostic

Implements

SzDiagnostic

Index

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
Implementation of SzDiagnostic.checkRepositoryPerformance
- Defined in src/szGrpcDiagnostic.ts:93

`Protected`getDeadlineFromNow

getDeadlineFromNow(secondsFromNow?: number): Date
Parameters
- OptionalsecondsFromNow: number
Returns Date
Inherited from SzGrpcBase.getDeadlineFromNow
- Defined in src/abstracts/szGrpcBase.ts:25

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
Implementation of SzDiagnostic.getFeature
- Defined in src/szGrpcDiagnostic.ts:168

getRepositoryInfo

getRepositoryInfo(): Promise<string>
Returns details of the datastore currently in use by Senzing.

Returns Promise<string>
Implementation of SzDiagnostic.getRepositoryInfo
- Defined in src/szGrpcDiagnostic.ts:132

purgeRepository

purgeRepository(): Promise<undefined>
Removes every record in the Senzing repository.

Returns Promise<undefined>
for async flow control.
Implementation of SzDiagnostic.purgeRepository
- Defined in src/szGrpcDiagnostic.ts:203

waitForReady

waitForReady(deadline: Date, cb: (error: Error | null) => 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: Error | null) => void
Returns any
Inherited from SzGrpcBase.waitForReady
- Defined in src/abstracts/szGrpcBase.ts:37