Class: GraphDB

GraphDB(optionsopt)

Class to interact with a GraphDB store

Constructor

new GraphDB(optionsopt)

Parameters:
Name Type Attributes Default Description
options Object <optional>
 {}

Connection params

Properties
Name Type Attributes Default Description
user string <optional>

Username
password string <optional>

Password
endpoint string <optional>
 http://localhost:7200

Endpoint
Source:

Extends

  • Store

Classes

GraphDB

Methods

(async) ask(dbname, sparql, optionsopt)

Issues an ASK query

Parameters:
Name Type Attributes Description
dbname string
sparql string

query
options Object <optional>
Properties
Name Type Attributes Default Description
responseType string <optional>
 application/sparql-results+json
Source:

(async) clearDb(dbname)

Empties a database

Parameters:
Name Type Description
dbname string
Source:

(async) construct(dbname, sparql, optionsopt)

Issues a CONSTRUCT query

Parameters:
Name Type Attributes Description
dbname string
sparql string

query
options Object <optional>
Properties
Name Type Attributes Default Description
responseType string <optional>
 application/ld+json
Source:

(async) createDb(dbname)

Creates a database

Parameters:
Name Type Description
dbname string
Source:

(async) describe(dbname, sparql, optionsopt)

Issues a DESCRIBE query

Parameters:
Name Type Attributes Description
dbname string
sparql string

query
options Object <optional>
Properties
Name Type Attributes Default Description
responseType string <optional>
 application/ld+json
Source:

(async) dropDb(dbname)

Deletes a database

Parameters:
Name Type Description
dbname string
Source:

(async) import(dbname, ntriples, graphopt)

Loads triples or quads into a database

Parameters:
Name Type Attributes Description
dbname string
ntriples string | Buffer

triples or quads
graph string <optional>

named graph to insert to, defaults to default graph
Source:

(async) select(dbname, sparql, optionsopt)

Issues a SELECT query

Parameters:
Name Type Attributes Description
dbname string
sparql string

query
options Object <optional>
Properties
Name Type Attributes Default Description
responseType string <optional>
 application/sparql-results+json
Source:

sparqlClientFor(dbname, options) → {SparqlHttpClient}

Creates a SPARQL HTTP Client for a database

Parameters:
Name Type Description
dbname string
options Object
Properties
Name Type Attributes Default Description
headers HeadersInit <optional>

HTTP headers to send with every endpoint request
user string <optional>
 username set when instantiating the store

user used for basic authentication
password string <optional>
 password set when instantiating the store

password used for basic authentication
endpointUrl string <optional>
 URL generated based on the store endpoint

SPARQL Query endpoint URL
updateUrl string <optional>
 URL generated based on the store endpoint

SPARQL Update endpoint URL
storeUrl string <optional>

Graph Store URL
fetch fetch <optional>
 nodeify-fetch

fetch implementation
factory factory <optional>
 uses @rdfjs/data-model by default

RDF/JS DataFactory
Source:
Returns:
Type
SparqlHttpClient

(async) update(dbname, sparql, optionsopt)

Issues a SPARQL UPDATE query

Parameters:
Name Type Attributes Description
dbname string
sparql string

query
options Object <optional>
Properties
Name Type Attributes Default Description
inference Object <optional>
 false
timeout string <optional>
 30_000
responseType string <optional>
 application/sparql-results+json
Source: