Class SzEngineNative

Wraps a native SzEngine with async JSON-string interface.

Implements

unknown

Constructors

constructor

new SzEngineNative(engine: SzEngine): SzEngineNative
Parameters
- engine: SzEngine
Returns SzEngineNative
- Defined in packages/sdk/js/adapter.d.ts:22

Methods

addRecord

addRecord(
    dataSourceCode: string,
    recordId: string,
    recordDefinition: string,
    flags?: bigint,
): Promise<JsonString>
Parameters
- dataSourceCode: string
- recordId: string
- recordDefinition: string
- Optionalflags: bigint
Returns Promise<JsonString>
- Defined in packages/sdk/js/adapter.d.ts:23

deleteRecord

deleteRecord(
    dataSourceCode: string,
    recordId: string,
    flags?: bigint,
): Promise<JsonString>
Parameters
- dataSourceCode: string
- recordId: string
- Optionalflags: bigint
Returns Promise<JsonString>
- Defined in packages/sdk/js/adapter.d.ts:24

getRecord

getRecord(
    dataSourceCode: string,
    recordId: string,
    flags?: bigint,
): Promise<JsonString>
Parameters
- dataSourceCode: string
- recordId: string
- Optionalflags: bigint
Returns Promise<JsonString>
- Defined in packages/sdk/js/adapter.d.ts:25

getRecordPreview

getRecordPreview(recordDefinition: string, flags?: bigint): Promise<JsonString>
Parameters
- recordDefinition: string
- Optionalflags: bigint
Returns Promise<JsonString>
- Defined in packages/sdk/js/adapter.d.ts:26

reevaluateRecord

reevaluateRecord(
    dataSourceCode: string,
    recordId: string,
    flags?: bigint,
): Promise<JsonString>
Parameters
- dataSourceCode: string
- recordId: string
- Optionalflags: bigint
Returns Promise<JsonString>
- Defined in packages/sdk/js/adapter.d.ts:27

reevaluateEntity

reevaluateEntity(entityId: number, flags?: bigint): Promise<JsonString>
Parameters
- entityId: number
- Optionalflags: bigint
Returns Promise<JsonString>
- Defined in packages/sdk/js/adapter.d.ts:28

getEntityById

getEntityById(entityId: number, flags?: bigint): Promise<JsonString>
Parameters
- entityId: number
- Optionalflags: bigint
Returns Promise<JsonString>
- Defined in packages/sdk/js/adapter.d.ts:29

getEntityByRecord

getEntityByRecord(
    dataSourceCode: string,
    recordId: string,
    flags?: bigint,
): Promise<JsonString>
Parameters
- dataSourceCode: string
- recordId: string
- Optionalflags: bigint
Returns Promise<JsonString>
- Defined in packages/sdk/js/adapter.d.ts:30

searchByAttributes

searchByAttributes(
    attributes: string,
    searchProfile?: string,
    flags?: bigint,
): Promise<JsonString>
Parameters
- attributes: string
- OptionalsearchProfile: string
- Optionalflags: bigint
Returns Promise<JsonString>
- Defined in packages/sdk/js/adapter.d.ts:31

whySearch

whySearch(
    attributes: string,
    entityId: number,
    searchProfile?: string,
    flags?: bigint,
): Promise<JsonString>
Parameters
- attributes: string
- entityId: number
- OptionalsearchProfile: string
- Optionalflags: bigint
Returns Promise<JsonString>
- Defined in packages/sdk/js/adapter.d.ts:32

whyEntities

whyEntities(
    entityId1: number,
    entityId2: number,
    flags?: bigint,
): Promise<JsonString>
Parameters
- entityId1: number
- entityId2: number
- Optionalflags: bigint
Returns Promise<JsonString>
- Defined in packages/sdk/js/adapter.d.ts:33

whyRecords

whyRecords(
    dsCode1: string,
    recId1: string,
    dsCode2: string,
    recId2: string,
    flags?: bigint,
): Promise<JsonString>
Parameters
- dsCode1: string
- recId1: string
- dsCode2: string
- recId2: string
- Optionalflags: bigint
Returns Promise<JsonString>
- Defined in packages/sdk/js/adapter.d.ts:34

whyRecordInEntity

whyRecordInEntity(
    dataSourceCode: string,
    recordId: string,
    flags?: bigint,
): Promise<JsonString>
Parameters
- dataSourceCode: string
- recordId: string
- Optionalflags: bigint
Returns Promise<JsonString>
- Defined in packages/sdk/js/adapter.d.ts:35

howEntity

howEntity(entityId: number, flags?: bigint): Promise<JsonString>
Parameters
- entityId: number
- Optionalflags: bigint
Returns Promise<JsonString>
- Defined in packages/sdk/js/adapter.d.ts:36

getVirtualEntity

getVirtualEntity(recordKeys: RecordKey[], flags?: bigint): Promise<JsonString>
Parameters
- recordKeys: RecordKey[]
- Optionalflags: bigint
Returns Promise<JsonString>
- Defined in packages/sdk/js/adapter.d.ts:37

findInterestingEntitiesById

findInterestingEntitiesById(
entityId: number,
flags?: bigint,
): Promise<JsonString>
Parameters
- entityId: number
- Optionalflags: bigint
Returns Promise<JsonString>
- Defined in packages/sdk/js/adapter.d.ts:38

findInterestingEntitiesByRecord

findInterestingEntitiesByRecord(
    dataSourceCode: string,
    recordId: string,
    flags?: bigint,
): Promise<JsonString>
Parameters
- dataSourceCode: string
- recordId: string
- Optionalflags: bigint
Returns Promise<JsonString>
- Defined in packages/sdk/js/adapter.d.ts:39

findPath

findPath(
    startEntityId: number,
    endEntityId: number,
    maxDegrees: number,
    avoidEntityIds?: number[],
    requiredDataSources?: string[],
    flags?: bigint,
): Promise<JsonString>
Parameters
- startEntityId: number
- endEntityId: number
- maxDegrees: number
- OptionalavoidEntityIds: number[]
- OptionalrequiredDataSources: string[]
- Optionalflags: bigint
Returns Promise<JsonString>
- Defined in packages/sdk/js/adapter.d.ts:40

findNetwork

findNetwork(
    entityIds: number[],
    maxDegrees: number,
    buildOutDegree: number,
    maxEntities: number,
    flags?: bigint,
): Promise<JsonString>
Parameters
- entityIds: number[]
- maxDegrees: number
- buildOutDegree: number
- maxEntities: number
- Optionalflags: bigint
Returns Promise<JsonString>
- Defined in packages/sdk/js/adapter.d.ts:41

getRedoRecord

getRedoRecord(): Promise<string>
Returns Promise<string>
- Defined in packages/sdk/js/adapter.d.ts:42

countRedoRecords

countRedoRecords(): Promise<number>
Returns Promise<number>
- Defined in packages/sdk/js/adapter.d.ts:43

processRedoRecord

processRedoRecord(redoRecord: string, flags?: bigint): Promise<JsonString>
Parameters
- redoRecord: string
- Optionalflags: bigint
Returns Promise<JsonString>
- Defined in packages/sdk/js/adapter.d.ts:44

primeEngine

primeEngine(): Promise<void>
Returns Promise<void>
- Defined in packages/sdk/js/adapter.d.ts:45

getStats

getStats(): Promise<JsonString>
Returns Promise<JsonString>
- Defined in packages/sdk/js/adapter.d.ts:46

exportJsonEntityReport

exportJsonEntityReport(flags?: bigint): Promise<JsonString>
Parameters
- Optionalflags: bigint
Returns Promise<JsonString>
- Defined in packages/sdk/js/adapter.d.ts:47

exportCsvEntityReport

exportCsvEntityReport(csvColumnList: string, flags?: bigint): Promise<string>
Parameters
- csvColumnList: string
- Optionalflags: bigint
Returns Promise<string>
- Defined in packages/sdk/js/adapter.d.ts:48

Class SzEngineNative

Implements

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns SzEngineNative

Methods

addRecord

Parameters

Returns Promise<JsonString>

deleteRecord

Parameters

Returns Promise<JsonString>

getRecord

Parameters

Returns Promise<JsonString>

getRecordPreview

Parameters

Returns Promise<JsonString>

reevaluateRecord

Parameters

Returns Promise<JsonString>

reevaluateEntity

Parameters

Returns Promise<JsonString>

getEntityById

Parameters

Returns Promise<JsonString>

getEntityByRecord

Parameters

Returns Promise<JsonString>

searchByAttributes

Parameters

Returns Promise<JsonString>

whySearch

Parameters

Returns Promise<JsonString>

whyEntities

Parameters

Returns Promise<JsonString>

whyRecords

Parameters

Returns Promise<JsonString>

whyRecordInEntity

Parameters

Returns Promise<JsonString>

howEntity

Parameters

Returns Promise<JsonString>

getVirtualEntity

Parameters

Returns Promise<JsonString>

findInterestingEntitiesById

Parameters

Returns Promise<JsonString>

findInterestingEntitiesByRecord

Parameters

Returns Promise<JsonString>

findPath

Parameters

Returns Promise<JsonString>

findNetwork

Parameters

Returns Promise<JsonString>

getRedoRecord

Returns Promise<string>

countRedoRecords

Returns Promise<number>

processRedoRecord

Parameters

Returns Promise<JsonString>

primeEngine

Returns Promise<void>

getStats

Returns Promise<JsonString>

exportJsonEntityReport

Parameters