Class SzDiagnostic

Index

Constructors

Methods

checkRepositoryPerformance getFeature getRepositoryInfo purgeRepository

Constructors

constructor

new SzDiagnostic(): SzDiagnostic
Returns SzDiagnostic

Methods

checkRepositoryPerformance

checkRepositoryPerformance(secondsToRun: number): string
Runs a performance benchmark on the repository for the specified duration.

Returns a JSON string with performance metrics including operations per second.
Parameters
- secondsToRun: number
Returns string
- Defined in packages/sdk/index.d.ts:31
checkRepositoryPerformance(secondsToRun: number): string
Runs a performance benchmark on the repository for the specified duration.
Parameters
- secondsToRun: number
Returns string
Example: Run a 3-second benchmark
```
const diag = env.getDiagnostic();
const result = JSON.parse(diag.checkRepositoryPerformance(3));
console.log("Operations/sec:", result.numRecordsInserted / 3);
```
See
check-datastore-performance snippet
- Defined in packages/sdk/sdk.d.ts:607

getFeature

getFeature(featureId: number): string
Gets detailed information about a specific feature by its internal ID.

Returns a JSON string with feature details including type, value, and usage statistics.
Parameters
- featureId: number
Returns string
- Defined in packages/sdk/index.d.ts:37
getFeature(featureId: number): string
Gets detailed feature information by feature ID.
Parameters
- featureId: number
Returns string
Example: Get feature details
```
const diag = env.getDiagnostic();
const feature = JSON.parse(diag.getFeature(1));
console.log("Feature:", JSON.stringify(feature, null, 2));
```
- Defined in packages/sdk/sdk.d.ts:594

getRepositoryInfo

getRepositoryInfo(): string
Gets repository statistics and information as a JSON string.

Returns string
- Defined in packages/sdk/index.d.ts:39
getRepositoryInfo(): string
Gets repository statistics and information as a JSON string.

Returns string
Example: Check repository info
```
const diag = env.getDiagnostic();
const info = JSON.parse(diag.getRepositoryInfo());
console.log("Data sources:", JSON.stringify(info.dataStores, null, 2));
```
See
check-datastore-performance snippet
- Defined in packages/sdk/sdk.d.ts:635

purgeRepository

purgeRepository(): void
Purges all entity data from the repository while preserving configuration.

Warning: This permanently deletes all entity resolution data.

Returns void
- Defined in packages/sdk/index.d.ts:45
purgeRepository(): void
Purges all entity data from the repository while preserving configuration.

Returns void
Example: Purge all data before a fresh load
```
const diag = env.getDiagnostic();
diag.purgeRepository();
console.log("Repository purged");
```
See
purge-repository snippet
- Defined in packages/sdk/sdk.d.ts:621