Class LocalIndexApi

API to query an index.

Hierarchy

LocalIndexApi

Implements

IndexApi

Index

Constructors

Properties

Methods

close convertModelDataToIndexModelsArgs count indexModels indexStream indexedModels init query setSyncQueryApi shouldIndexStream stopIndexingModels

Constructors

constructor

new LocalIndexApi(indexingConfig: undefined | IndexingConfig, reader: StreamReader, loader: StreamStateLoader, logger: DiagnosticsLogger, networkName: Networks): LocalIndexApi
Parameters
- indexingConfig: undefined | IndexingConfig
- reader: StreamReader
- loader: StreamStateLoader
- logger: DiagnosticsLogger
- networkName: Networks
Returns LocalIndexApi
- Defined in packages/indexing/src/local-index-api.ts:69

Properties

`Readonly` enabled

enabled: boolean

Methods

close

close(): Promise<void>
Returns Promise<void>
- Defined in packages/indexing/src/local-index-api.ts:213

convertModelDataToIndexModelsArgs

convertModelDataToIndexModelsArgs(modelsNoLongerIndexed: ModelData[], modelData: ModelData, loading?: LoadingInterfaceImplements): Promise<IndexModelArgs>
Parameters
- modelsNoLongerIndexed: ModelData[]
- modelData: ModelData
- loading: LoadingInterfaceImplements = {}
Returns Promise<IndexModelArgs>
- Defined in packages/indexing/src/local-index-api.ts:162

count

count(query: BaseQuery): Promise<number>
Parameters
- query: BaseQuery
Returns Promise<number>
Implementation of IndexApi.count
- Defined in packages/indexing/src/local-index-api.ts:108

indexModels

indexModels(models: ModelData[]): Promise<void>
Parameters
- models: ModelData[]
Returns Promise<void>
- Defined in packages/indexing/src/local-index-api.ts:183

indexStream

indexStream(args: IndexStreamArgs): Promise<void>
Add stream to index in appropriate model table
Parameters
- args: IndexStreamArgs
Returns Promise<void>
- Defined in packages/indexing/src/local-index-api.ts:100

indexedModels

indexedModels(): ModelData[]
Returns ModelData[]
- Defined in packages/indexing/src/local-index-api.ts:158

init

init(): Promise<void>
Returns Promise<void>
- Defined in packages/indexing/src/local-index-api.ts:201

query

query(query: PaginationQuery): Promise<Page<null | StreamState<StreamMetadata>>>
Query the index. Ask an indexing database for a list of StreamIDs, and convert them to corresponding StreamState instances via Repository::streamState.

We assume that a state store always contains StreamState for an indexed stream, but we return null iff it's not to avoid throwing errors at DApps
Parameters
- query: PaginationQuery
Returns Promise<Page<null | StreamState<StreamMetadata>>>
Implementation of IndexApi.query
- Defined in packages/indexing/src/local-index-api.ts:118

setSyncQueryApi

setSyncQueryApi(api: ISyncQueryApi): void
Parameters
- api: ISyncQueryApi
Returns void
- Defined in packages/indexing/src/local-index-api.ts:80

shouldIndexStream

shouldIndexStream(args: StreamID): boolean
Parameters
- args: StreamID
Returns boolean
- Defined in packages/indexing/src/local-index-api.ts:86

stopIndexingModels

stopIndexingModels(models: ModelData[]): Promise<void>
Parameters
- models: ModelData[]
Returns Promise<void>
- Defined in packages/indexing/src/local-index-api.ts:196