JSDoc: Class: Stardog

Constructor

new Stardog(optionsopt)

Parameters:

Name Type Attributes Default Description

options

Object

{}

Connection params

Properties

Name	Type	Attributes	Default	Description
`user`	string	<optional>	admin	Username
`password`	string	<optional>	admin	Password
`endpoint`	string	<optional>	http://localhost:5820	Endpoint

Source:

stardog.js, line 12

Extends

Store

Classes

Stardog

Methods

(async) ask(dbname, sparql, optionsopt)

Issues an ASK query

Parameters:

Name Type Attributes Description

dbname string

sparql

string

query

options

Object

Properties

Name Type Attributes Default Description

options

Object

Properties

Name	Type	Attributes	Default	Description
`accept`	string	<optional>	application/json

params string <optional> {}

additionalHandlers string <optional> {}

Source:

stardog.js, line 134

(async) clearDb(dbname, optionsopt)

Empties a database

https://github.com/stardog-union/stardog.js/tree/065edf84d92f50dc6ad9a6548d0bc9b16325cd3d#dbdropconn-database-params

Parameters:

Name Type Attributes Description

dbname string

options

Object

Properties

Name	Type	Attributes	Default	Description
`params`	Object	<optional>	{}

Source:

stardog.js, line 78

(async) construct(dbname, sparql, optionsopt)

Issues a CONSTRUCT query

Parameters:

Name Type Attributes Description

dbname string

sparql

string

query

options

Object

Properties

Name Type Attributes Default Description

options

Object

Properties

Name	Type	Attributes	Default	Description
`accept`	string	<optional>	application/json

params string <optional> {}

additionalHandlers string <optional> {}

Source:

stardog.js, line 150

(async) createDb(dbname, optionsopt)

Creates a database

https://github.com/stardog-union/stardog.js/tree/065edf84d92f50dc6ad9a6548d0bc9b16325cd3d#dbcreateconn-database-databaseoptions-options-params

Parameters:

Name Type Attributes Description

dbname string

options

Object

Properties

Name	Type	Attributes	Default
`databaseOptions`	Object	<optional>	{}
`options`	Object	<optional>	{}
`params`	Object	<optional>	{}

Source:

stardog.js, line 42

(async) describe(dbname, sparql, optionsopt)

Issues a DESCRIBE query

Parameters:

Name Type Attributes Description

dbname string

sparql

string

query

options

Object

Properties

Name Type Attributes Default Description

options

Object

Properties

Name	Type	Attributes	Default	Description
`accept`	string	<optional>	application/json

params string <optional> {}

additionalHandlers string <optional> {}

Source:

stardog.js, line 166

(async) dropDb(dbname, optionsopt)

Deletes a database

https://github.com/stardog-union/stardog.js/tree/065edf84d92f50dc6ad9a6548d0bc9b16325cd3d#dbdropconn-database-params

Parameters:

Name Type Attributes Description

dbname string

options

Object

Properties

Name	Type	Attributes	Default	Description
`params`	Object	<optional>	{}

Source:

stardog.js, line 60

(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:

stardog.js, line 241

(async) offline(dbname, optionsopt)

Brings an online database offline.

https://github.com/stardog-union/stardog.js/tree/065edf84d92f50dc6ad9a6548d0bc9b16325cd3d#dbofflineconn-database-params

Parameters:

Name Type Attributes Description

dbname string

options

Object

Properties

Name	Type	Attributes	Default	Description
`params`	Object	<optional>	{}

Source:

stardog.js, line 114

(async) online(dbname, optionsopt)

Brings an offline database back online so that it can accept connections.

https://github.com/stardog-union/stardog.js/tree/065edf84d92f50dc6ad9a6548d0bc9b16325cd3d#dbonlineconn-database-params

Parameters:

Name Type Attributes Description

dbname string

options

Object

Properties

Name	Type	Attributes	Default	Description
`params`	Object	<optional>	{}

Source:

stardog.js, line 96

(async) queries(dbname, sparqlQueries, optionsopt)

Issues many SPARQL queries in a transaction

https://github.com/stardog-union/stardog.js/#queryexecuteconn-database-query-accept-params-additionalhandlers

Parameters:

Name Type Attributes Description

dbname string

sparqlQueries

Array.<string>

queries

options

Object

Properties

Name Type Attributes Default Description

options

Object

Properties

Name	Type	Attributes	Default	Description
`accept`	string	<optional>	application/json

params string <optional> {}

additionalHandlers string <optional> {}

Source:

stardog.js, line 216

(async) select(dbname, sparql, optionsopt)

Issues a SELECT query

Parameters:

Name Type Attributes Description

dbname string

sparql

string

query

options

Object

Properties

Name Type Attributes Default Description

options

Object

Properties

Name	Type	Attributes	Default	Description
`accept`	string	<optional>	application/json

params string <optional> {}

additionalHandlers string <optional> {}

Source:

stardog.js, line 182

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:

stardog.js, line 265

Returns:

Type: SparqlHttpClient

(async) update(dbname, sparql, optionsopt)

Issues a SPARQL UPDATE query

https://github.com/stardog-union/stardog.js/#queryexecuteconn-database-query-accept-params-additionalhandlers

Parameters:

Name Type Attributes Description

dbname string

sparql

string

query

options

Object

Properties

Name Type Attributes Default Description

options

Object

Properties

Name	Type	Attributes	Default	Description
`accept`	string	<optional>	application/json

params string <optional> {}

additionalHandlers string <optional> {}

Source:

stardog.js, line 199