Class AsyncOxigraph

Index

Methods

addQueryDefinitions close dump execute init load query size getInstance

Methods

addQueryDefinitions

addQueryDefinitions(queryDefs?: QueryDefinition[]): void
Add a query definition that can easily be executed
Parameters
- queryDefs: QueryDefinition[] = []
  array of query definitions
Returns void
- Defined in packages/async-oxigraph/src/index.ts:119

close

close(): void
Returns void
- Defined in packages/async-oxigraph/src/index.ts:157

dump

dump(mimetype?: RDFMimetype, graphURI?: string): Promise<WorkerResult>
Create a dump of the store (serialize)
Parameters
- mimetype: RDFMimetype = RDFMimetype.NQUADS
  describes the RDF serialization. Supported options are text/turtle, application/trig, application/n-triples, application/n-quads and application/rdf+xml
- OptionalgraphURI: string
  optianally describes the URI of the named graph to dump
Returns Promise<WorkerResult>
- Defined in packages/async-oxigraph/src/index.ts:95

execute

execute(queryId: string, params?: TemplateData): Promise<WorkerResult>
Execute a saved query
Parameters
- queryId: string
  the id of the query
- Optionalparams: TemplateData
  optional query params to replace in the query
Returns Promise<WorkerResult>
- Defined in packages/async-oxigraph/src/index.ts:131

init

init(wasmPath?: string): Promise<WorkerResult>
Initialize Oxigraph store
Parameters
- wasmPath: string = "./web_bg.wasm"
  path to the webassembly file relative to the path where the worker.js file is located
Returns Promise<WorkerResult>
a worker result with a message
- Defined in packages/async-oxigraph/src/index.ts:44

load

load(
    triples: string,
    mimetype: RDFMimetype,
    baseURI?: string,
    graphURI?: string,
): Promise<WorkerResult>
Load triples into the store
Parameters
- triples: string
  a string containing the RDF triples in a serialization according to the provided mimetype
- mimetype: RDFMimetype
  describes the RDF serialization. Supported options are text/turtle, application/trig, application/n-triples, application/n-quads and application/rdf+xml
- OptionalbaseURI: string
  optionally describes the base namespace
- OptionalgraphURI: string
  optionally describes a named graph in which the triples should be loaded. Default is the main graph
Returns Promise<WorkerResult>
- Defined in packages/async-oxigraph/src/index.ts:59

query

query(
    query: string,
    responseMimetype?: ResponseMimetype,
    timeoutInMS?: number,
): Promise<WorkerResult>
Query the store
Parameters
- query: string
  SPARQL query
- OptionalresponseMimetype: ResponseMimetype
  optionally describe the serialization of the returned facts of a construct query
- OptionaltimeoutInMS: number
Returns Promise<WorkerResult>
- Defined in packages/async-oxigraph/src/index.ts:77

size

size(): Promise<number>
Get store size

Returns Promise<number>
the size as a number
- Defined in packages/async-oxigraph/src/index.ts:109

`Static`getInstance

getInstance(workerPath?: string): AsyncOxigraph
Parameters
- workerPath: string = "./assets/oxigraph/worker.js"
Returns AsyncOxigraph
- Defined in packages/async-oxigraph/src/index.ts:31