# Stardog.js

Universal Javascript fetch wrapper for communicating with the Stardog HTTP server.

[![npm](https://img.shields.io/npm/v/stardog.svg?style=flat-square)](https://www.npmjs.com/package/stardog)

<a href="http://stardog.com"><img src="https://d33wubrfki0l68.cloudfront.net/66e9dcff51317cfc11b9f3d4ce2917a11ba81681/543c1/img/stardog-logo-optimized.svg" style="margin: 0 auto; display: block; width: 250px"/></a>

## What is it?

This framework wraps all the functionality of a client for the Stardog DBMS, and provides access to a full set of functions such as executing SPARQL queries, administrative tasks on Stardog, and the use of the Reasoning API.

All the implementation uses the HTTP protocol, since most of Stardog functionality is available using this protocol. For more information, go to the Stardog's [HTTP Programming](http://www.stardog.com/docs/#_network_programming) documentation.

This is a universal library and as such can be used in both the browser and Node.js.

## Installation

To install stardog.js run:

```bash
npm install stardog
```

## Usage

Stardog.js conforms to the [Universal Module Definition](https://github.com/umdjs/umd) API. To use it in Node.js, simply `require` or `import` it as you would any other Node module. To use it in the browser, you can either:

1. Do the same as you would with Node.js, in which case you'll have to use [webpack](https://webpack.js.org/), [parcel](https://parceljs.org/), [browserify](http://browserify.org/), or some other module bundler,
2. Use [require.js](https://requirejs.org/) or some other module loader, or
3. Directly import the built stardog.js file in your HTML (e.g., `<script src="./node_modules/stardog/dist/stardog.js"></script>`) and then reference the global `stardogjs` object (e.g., `stardogjs.query.execute(/* . . . */)`).

## Development

To get started, just clone the project. You'll need a local copy of Stardog to be able to run the tests. For more information on starting the Stardog DB service and how it works, go to [Stardog's documentation](http://docs.stardog.com), where you'll find everything you need to get up and running with Stardog.

Go to [http://stardog.com](http://stardog.com), download and install the database and load the data provided in `data/` using the script in the repository.

1. Start the Stardog server

```bash
stardog-admin server start
```

2. Install `stardog.js` dependencies:

```bash
npm install
```

### Running Tests

In order to contribute changes, all test cases must pass. With the Stardog server running, execute the following command to run all test cases in `test/spec`:

```bash
npm test
```

To test the cluster commands you will need to first start a Stardog cluster then run the cluster suite. The easiest way to do this is to run docker-compose to start a cluster:

```bash
docker-compose -f .circleci/docker-compose.yml up
```

Then run the cluster test suite in `test/cluster`:

```bash
npm run test:cluster
```

### Contributing

Fork, clone and develop, write or amend tests, and then open a PR. All PRs go against "master". This project uses [prettier](https://github.com/prettier/prettier) on file commit, so don't worry about style as it'll just get rewritten when you commit your changes.

### Releasing

First, ensure that there is a milstone for the release version, and that all PRs that you want to appear in the CHANGELOG are tagged with that milestone. The milestone must be closed before publishing.

If you have publishing rights, BE SURE TO RUN `npm version (major|minor|patch)` IMMEDIATELY BEFORE PUBLISHING. This will ensure that the build is up-to-date and will also (1) bump the version number in package.json accordingly, (2) create a git tag matching the version number, and (3) automatically update the README and the CHANGELOG using our type declarations and data from the stardog.js GitHub repo. For this process to work correctly, you will need to have generated a GitHub OAuth token and assigned it to the `MDCHANGELOG_TOKEN` environment variable (the name of the token is a relic of the fact that this repo once used [mdchangelog](https://www.npmjs.com/package/mdchangelog) to generate changelogs; it now uses a custom script). You can then publish by running `npm publish`. In order to ensure that this process is followed, there will be a very annoying alert triggered whenever you publish; if you're all set, just ignore the alert.

After releasing, be sure to push to master, including the tags (so that the release is reflected on GitHub).

## Version/Support Details

Each release of stardog.js is tested against the most recent version of Stardog available at the time of the release. The relationship between versions of stardog.js and versions of Stardog is detailed in the following table:

| stardog.js Version | Supported Stardog Version(s) |
| ------------------ | ---------------------------- |
| 10.x.x             | 12.x.x                       |
| 9.x.x              | 11.1.x                       |
| 8.x.x              | 11.1.x                       |
| 7.x.x              | 11.0.x                       |
| 6.x.x              | 10.x.x                       |
| 5.x.x              | 9.x.x                        |
| 4.x.x              | 8.x.x                        |
| 3.x.x              | 7.x.x                        |
| 2.x.x\*            | 6.x.x                        |
| 1.x.x\*            | 5.x.x                        |
| 0.x.x\*            | any version < 5              |

_\* = No longer supported_

We support and maintain a particular version of stardog.js only if the corresponding Stardog version(s) is (are) officially supported and maintained. For example, we no longer support v0.x.x of stardog.js, as the corresponding Stardog versions are no longer supported. (That said, later versions of stardog.js will often _mostly_ work with earlier Stardog versions. We just don't test this or make any guarantees to that effect.)

## Quick Example

```js
const { Connection, query } = require('stardog');

const conn = new Connection({
  username: 'admin',
  password: 'admin',
  endpoint: 'http://localhost:5820',
});

query
  .execute(
    conn,
    'myDatabaseName',
    'select distinct ?s where { ?s ?p ?o }',
    'application/sparql-results+json',
    {
      limit: 10,
      reasoning: true,
      offset: 0,
    }
  )
  .then(({ body }) => {
    console.log(body.results.bindings);
  });
```

<!--- API Goes Here --->
# API

## <a name="http">HTTP</a>

#### <a name="rdfmimetype">RdfMimeType</a>

One of the following values:

`'application/ld+json'
      | 'text/turtle'
      | 'application/rdf+xml'
      | 'application/n-triples'
      | 'application/n-quads'
      | 'application/trig'`
#### <a name="sparqlmimetype">SparqlMimeType</a>

One of the following values:

`'application/sparql-results+json'
      | 'application/sparql-results+xml'`
#### <a name="acceptmimetype">AcceptMimeType</a>

One of the following values:

`RdfMimeType
      | SparqlMimeType
      | 'text/plain'
      | 'text/boolean'
      | 'application/json'
      | '*/*'`
#### <a name="explainacceptmimetype">ExplainAcceptMimeType</a>

One of the following values:

`'text/plain' | 'application/json'`
#### <a name="body">Body</a>

Object with the following values:

- status (`number`)
- statusText (`string`)
- result (`object | string | boolean | null`)
- ok (`boolean`)
- headers (`Headers`)
- body (`any`)
- url (`string`)

#### <a name="connectionoptions">ConnectionOptions</a>

Object with the following values:

- endpoint (`string`)
- username (`string`)
- password (`string`)
- token (`string`)
- meta (`ConnectionMeta`)

#### <a name="requestconstructor">RequestConstructor</a>

One of the following values:

`{
    new(input: string | Request, init?: RequestInit): Request;
  }`
#### <a name="requestcreator">RequestCreator</a>

One of the following values:

`({
    uri,
    Request,
  }: {
      uri: string;
      Request: Constructor;
    }) => ReturnType`
#### <a name="connectionmeta">ConnectionMeta</a>

Object with the following values:

- createRequest (`RequestCreator<RequestConstructor, string | Request>`)
- createHeaders (`(defaults: { headers: Headers }) => Headers`)

## <a name="connection">Connection</a> (Class)

Constructed with:
- options ([`ConnectionOptions`](#connectionoptions))
### <a name="config">Connection.config(options, meta)</a>

Takes the following params:
- options ([`ConnectionOptions`](#connectionoptions))
- meta ([`ConnectionMeta`](#connectionmeta))

Returns [`void`](#void)
### <a name="headers">Connection.headers()</a>

Returns [`Headers`](#headers)
### <a name="request">Connection.request(resource)</a>

Takes the following params:
- resource (`string[]`)

Returns `string | Request`
### <a name="uri">Connection.uri(resource)</a>

Takes the following params:
- resource (`string[]`)

Returns `string`
## <a name="server">server</a>

#### <a name="shutdown">`server.shutdown(conn, params)`</a>

Shuts down a Stardog server. 

Expects the following parameters:

- conn ([`Connection`](#connection))

- params (`object`)

Returns [`Promise<HTTP.Body>`](#body)

#### <a name="status">`server.status(conn, params)`</a>

Retrieves general status information about a Stardog server. By
default, also includes status information about all databases on
that server. If `params.databases` is `false`, however, then the
information about databases is omitted.

Expects the following parameters:

- conn ([`Connection`](#connection))

- params (`{ databases?: boolean }`)

Returns [`Promise<HTTP.Body>`](#body)

#### <a name="properties">`server.properties(conn, names)`</a>

Retrieves server properties. By default, it will return all server
properties, but you can specify `names` to return specific ones.

Expects the following parameters:

- conn ([`Connection`](#connection))

- names (`string[]`)

Returns [`Promise<HTTP.Body>`](#body)

#### <a name="logs">`server.logs(conn)`</a>

Retrieves a zip file containing log information for an endpoint.

Expects the following parameters:

- conn ([`Connection`](#connection))

Returns [`Promise<Response>`](#response)

## <a name="db">db</a>

#### <a name="create">`db.create(conn, database, databaseOptions, options, params)`</a>

Creates a new database.

Expects the following parameters:

- conn ([`Connection`](#connection))

- database (`string`)

- databaseOptions (`object`)

- options ({
        files: { filename: string }[];
        propertiesFile?: [`Blob;
`](#blob;
)      })

- params (`object`)

Returns [`Promise<HTTP.Body>`](#body)

#### <a name="drop">`db.drop(conn, database, params)`</a>

Deletes a database.

Expects the following parameters:

- conn ([`Connection`](#connection))

- database (`string`)

- params (`object`)

Returns [`Promise<HTTP.Body>`](#body)

#### <a name="get">`db.get(conn, database, params)`</a>

Gets an RDF representation of a database. See: https://www.w3.org/TR/sparql11-http-rdf-update/#http-get

Expects the following parameters:

- conn ([`Connection`](#connection))

- database (`string`)

- params (`object`)

Returns [`Promise<HTTP.Body>`](#body)

#### <a name="offline">`db.offline(conn, database, params)`</a>

Sets a database offline.

Expects the following parameters:

- conn ([`Connection`](#connection))

- database (`string`)

- params (`object`)

Returns [`Promise<HTTP.Body>`](#body)

#### <a name="online">`db.online(conn, database, params)`</a>

Sets a database online.

Expects the following parameters:

- conn ([`Connection`](#connection))

- database (`string`)

- params (`object`)

Returns [`Promise<HTTP.Body>`](#body)

#### <a name="optimize">`db.optimize(conn, database, params)`</a>

Optimizes a database.

Expects the following parameters:

- conn ([`Connection`](#connection))

- database (`string`)

- params (`object`)

Returns [`Promise<HTTP.Body>`](#body)

#### <a name="list">`db.list(conn, params)`</a>

Gets a list of all databases on a Stardog server.

Expects the following parameters:

- conn ([`Connection`](#connection))

- params (`object`)

Returns [`Promise<HTTP.Body>`](#body)

#### <a name="listinfo">`db.listInfo(conn, params)`</a>

Gets a list of databases info on a Stardog server.

Expects the following parameters:

- conn ([`Connection`](#connection))

- params (`object`)

Returns [`Promise<HTTP.Body>`](#body)

#### <a name="size">`db.size(conn, database, params)`</a>

Gets number of triples in a database.

Expects the following parameters:

- conn ([`Connection`](#connection))

- database (`string`)

- params (`object`)

Returns [`Promise<HTTP.Body>`](#body)

#### <a name="model">`db.model(conn, database, options, params)`</a>

Gets the model for a database.

Expects the following parameters:

- conn ([`Connection`](#connection))

- database (`string`)

- options (`object`)

- params (`object`)

Returns [`Promise<HTTP.Body>`](#body)

#### <a name="clear">`db.clear(conn, database, transactionId, params)`</a>

Clears the contents of a database.

Expects the following parameters:

- conn ([`Connection`](#connection))

- database (`string`)

- transactionId (`string`)

- params (`object`)

Returns [`Promise<HTTP.Body>`](#body)

#### <a name="add">`db.add(conn, database, transactionId, content, options, params)`</a>

Adds data within a transaction.

Expects the following parameters:

- conn ([`Connection`](#connection))

- database (`string`)

- transactionId (`string`)

- content (`string`)

- options ([`TransactionOptions`](#transactionoptions))

- params (`object`)

Returns [`Promise<transaction.TransactionResponse>`](#transactionresponse)

#### <a name="remove">`db.remove(conn, database, transactionId, content, options, params)`</a>

Removes data within a transaction.

Expects the following parameters:

- conn ([`Connection`](#connection))

- database (`string`)

- transactionId (`string`)

- content (`string`)

- options ([`TransactionOptions`](#transactionoptions))

- params (`object`)

Returns [`Promise<transaction.TransactionResponse>`](#transactionresponse)

#### <a name="exportdata">`db.exportData(conn, database, options, params)`</a>

Exports the contents of a database.

Expects the following parameters:

- conn ([`Connection`](#connection))

- database (`string`)

- options ({ mimetype: [`RdfMimeType`](#rdfmimetype) })

- params (`{ graphUri: string }`)

Returns [`Promise<HTTP.Body>`](#body)

## <a name="options">options</a>

#### <a name="getavailable">`db.options.getAvailable(conn)`</a>

Gets all available database options with their default values. 

Expects the following parameters:

- conn ([`Connection`](#connection))

Returns [`Promise<HTTP.Body>`](#body)

#### <a name="get">`db.options.get(conn, database, params)`</a>

Gets set of options on a database. 

Expects the following parameters:

- conn ([`Connection`](#connection))

- database (`string`)

- params (`object`)

Returns [`Promise<HTTP.Body>`](#body)

#### <a name="getall">`db.options.getAll(conn, database)`</a>

Gets all options on a database. 

Expects the following parameters:

- conn ([`Connection`](#connection))

- database (`string`)

Returns [`Promise<HTTP.Body>`](#body)

#### <a name="set">`db.options.set(conn, database, databaseOptions, params)`</a>

Sets options on a database. 

Expects the following parameters:

- conn ([`Connection`](#connection))

- database (`string`)

- databaseOptions (`object`)

- params (`object`)

Returns [`Promise<HTTP.Body>`](#body)

## <a name="graph">graph</a>

#### <a name="doget">`db.graph.doGet(conn, database, graphUri, accept, params)`</a>

Retrieves the specified named graph

Expects the following parameters:

- conn ([`Connection`](#connection))

- database (`string`)

- graphUri (`string`)

- accept ([`RdfMimeType`](#rdfmimetype))

- params (`object`)

Returns [`Promise<HTTP.Body>`](#body)

#### <a name="doput">`db.graph.doPut(conn, database, graphData, graphUri, contentType, params)`</a>

Stores the given RDF data in the specified named graph

Expects the following parameters:

- conn ([`Connection`](#connection))

- database (`string`)

- graphData (`string`)

- graphUri (`string`)

- contentType ([`RdfMimeType`](#rdfmimetype))

- params (`object`)

Returns [`Promise<HTTP.Body>`](#body)

#### <a name="dodelete">`db.graph.doDelete(conn, database, graphUri, params)`</a>

Deletes the specified named graph

Expects the following parameters:

- conn ([`Connection`](#connection))

- database (`string`)

- graphUri (`string`)

- params (`object`)

Returns [`Promise<HTTP.Body>`](#body)

#### <a name="dopost">`db.graph.doPost(conn, database, graphUri, options, params)`</a>

Merges the given RDF data into the specified named graph

Expects the following parameters:

- conn ([`Connection`](#connection))

- database (`string`)

- graphUri (`string`)

- options ({ contentType: [`RdfMimeType`](#rdfmimetype) })

- params (`object`)

Returns [`Promise<HTTP.Body>`](#body)

## <a name="transaction">transaction</a>

#### <a name="encodings">Encodings</a>

One of the following values:

`'gzip' | 'compress' | 'deflate' | 'identity' | 'br'`
#### <a name="transactionresponse">TransactionResponse</a> extends [HTTP.Body](#body)

Object with the following values:

- transactionId (`string`)

#### <a name="transactionoptions">TransactionOptions</a>

Object with the following values:

- contentType (`HTTP.RdfMimeType`)
- encoding (`Encodings`)

#### <a name="begin">`db.transaction.begin(conn, database, params)`</a>

Begins a new transaction.

Expects the following parameters:

- conn ([`Connection`](#connection))

- database (`string`)

- params (`object`)

Returns [`Promise<TransactionResponse>`](#transactionresponse)

#### <a name="rollback">`db.transaction.rollback(conn, database, transactionId, params)`</a>

Rolls back a transaction, removing the transaction and undoing all changes

Expects the following parameters:

- conn ([`Connection`](#connection))

- database (`string`)

- transactionId (`string`)

- params (`object`)

Returns [`Promise<TransactionResponse>`](#transactionresponse)

#### <a name="commit">`db.transaction.commit(conn, database, transactionId, params)`</a>

Commits a transaction to the database, removing the transaction and making its changes permanent.

Expects the following parameters:

- conn ([`Connection`](#connection))

- database (`string`)

- transactionId (`string`)

- params (`object`)

Returns [`Promise<TransactionResponse>`](#transactionresponse)

## <a name="icv">icv</a>

#### <a name="get">`db.icv.get(conn, database, params)`</a>

Gets the set of integrity constraints on a given database.

Expects the following parameters:

- conn ([`Connection`](#connection))

- database (`string`)

- params (`object`)

Returns [`Promise<HTTP.Body>`](#body)

#### <a name="add">`db.icv.add(conn, database, icvAxioms, options, params)`</a>

Adds integrity constraints to a given database.

DEPRECATED: Support for storing ICV constraints in the system database is deprecated in Stardog 7.5.0
and removed in Stardog 8.0.0; instead, SHACL constraints can be managed using `db.add`.

Expects the following parameters:

- conn ([`Connection`](#connection))

- database (`string`)

- icvAxioms (`string`)

- options ({ contentType: [`RdfMimeType`](#rdfmimetype) })

- params (`object`)

Returns [`Promise<HTTP.Body>`](#body)

#### <a name="remove">`db.icv.remove(conn, database, icvAxioms, options, params)`</a>

Removes integrity constraints from a given database.

DEPRECATED: Support for storing ICV constraints in the system database is deprecated in Stardog 7.5.0
and removed in Stardog 8.0.0; instead, SHACL constraints can be managed using `db.remove`.

Expects the following parameters:

- conn ([`Connection`](#connection))

- database (`string`)

- icvAxioms (`string`)

- options ({ contentType: [`RdfMimeType`](#rdfmimetype) })

- params (`object`)

Returns [`Promise<HTTP.Body>`](#body)

#### <a name="clear">`db.icv.clear(conn, database, params)`</a>

Removes all integrity constraints from a given database.

DEPRECATED: Support for storing ICV constraints in the system database is deprecated in Stardog 7.5.0
and removed in Stardog 8.0.0; instead, SHACL constraints can be managed using `db.remove`.

Expects the following parameters:

- conn ([`Connection`](#connection))

- database (`string`)

- params (`object`)

Returns [`Promise<HTTP.Body>`](#body)

#### <a name="validate">`db.icv.validate(conn, database, constraints, options, params)`</a>

Checks constraints to see if they are valid

Expects the following parameters:

- conn ([`Connection`](#connection))

- database (`string`)

- constraints (`string`)

- options ({ contentType: [`RdfMimeType`](#rdfmimetype) })

- params (`{ graphUri: string }`)

Returns [`Promise<HTTP.Body>`](#body)

#### <a name="validateintx">`db.icv.validateInTx(conn, database, transactionId, constraints, options, params)`</a>

Checks constraints to see if they are valid within a transaction

Expects the following parameters:

- conn ([`Connection`](#connection))

- database (`string`)

- transactionId (`string`)

- constraints (`string`)

- options ({ contentType: [`RdfMimeType`](#rdfmimetype) })

- params (`{ graphUri: string }`)

Returns [`Promise<HTTP.Body>`](#body)

#### <a name="violations">`db.icv.violations(conn, database, constraints, options, params)`</a>

Accepts integrity constraints as RDF and returns the violation explanations, if any, as RDF.

Expects the following parameters:

- conn ([`Connection`](#connection))

- database (`string`)

- constraints (`string`)

- options ({ contentType: [`RdfMimeType`](#rdfmimetype) })

- params (`{ graphUri: string }`)

Returns [`Promise<HTTP.Body>`](#body)

#### <a name="violationsintx">`db.icv.violationsInTx(conn, database, transactionId, constraints, options, params)`</a>

Accepts integrity constraints as RDF and returns the violation explanations, if any, as RDF.

Expects the following parameters:

- conn ([`Connection`](#connection))

- database (`string`)

- transactionId (`string`)

- constraints (`string`)

- options ({ contentType: [`RdfMimeType`](#rdfmimetype) })

- params (`{ graphUri: string }`)

Returns [`Promise<HTTP.Body>`](#body)

#### <a name="report">`db.icv.report(conn, database, constraints, options, params)`</a>

Accepts integrity constraints as RDF and returns a validation report.

Expects the following parameters:

- conn ([`Connection`](#connection))

- database (`string`)

- constraints (`string`)

- options ({
          contentType?: HTTP.RdfMimeType;
          accept?: [`AcceptMimeType;
`](#acceptmimetype;
)        })

- params (`{ graphUri: string }`)

Returns [`Promise<HTTP.Body>`](#body)

#### <a name="reportintx">`db.icv.reportInTx(conn, database, transactionId, constraints, options, params)`</a>

Accepts integrity constraints as RDF and returns a validation report.

Expects the following parameters:

- conn ([`Connection`](#connection))

- database (`string`)

- transactionId (`string`)

- constraints (`string`)

- options ({
          contentType?: HTTP.RdfMimeType;
          accept?: [`AcceptMimeType;
`](#acceptmimetype;
)        })

- params (`{ graphUri: string }`)

Returns [`Promise<HTTP.Body>`](#body)

## <a name="reasoning">reasoning</a>

#### <a name="consistency">`db.reasoning.consistency(conn, database, options, params)`</a>

Returns if the database is consistent

Expects the following parameters:

- conn ([`Connection`](#connection))

- database (`string`)

- options (`{ namedGraph: string }`)

- params (`object`)

Returns [`Promise<HTTP.Body>`](#body)

#### <a name="explaininference">`db.reasoning.explainInference(conn, database, inference, config, params)`</a>

Provides an explanation for an inference

Expects the following parameters:

- conn ([`Connection`](#connection))

- database (`string`)

- inference (`string`)

- config (`{ contentType: string }`)

- params (`object`)

Returns [`Promise<HTTP.Body>`](#body)

#### <a name="explaininconsistency">`db.reasoning.explainInconsistency(conn, database, options, params)`</a>

Provides the reason why a database is inconsistent, as reported by db.reasoning.consistency

Expects the following parameters:

- conn ([`Connection`](#connection))

- database (`string`)

- options (`{ namedGraph: string }`)

- params (`object`)

Returns [`Promise<HTTP.Body>`](#body)

#### <a name="explaininferenceintransaction">`db.reasoning.explainInferenceInTransaction(conn, database, transactionId, inference, config, params)`</a>

Provides an explanation for an inference within a transaction

Expects the following parameters:

- conn ([`Connection`](#connection))

- database (`string`)

- transactionId (`string`)

- inference (`string`)

- config ([`TransactionOptions`](#transactionoptions))

- params (`object`)

Returns [`Promise<HTTP.Body>`](#body)

#### <a name="explaininconsistencyintransaction">`db.reasoning.explainInconsistencyInTransaction(conn, database, transactionId, options, params)`</a>

Provides the reason why a database is inconsistent, as reported by db.reasoning.consistency

Expects the following parameters:

- conn ([`Connection`](#connection))

- database (`string`)

- transactionId (`string`)

- options (`{ namedGraph: string }`)

- params (`object`)

Returns [`Promise<HTTP.Body>`](#body)

#### <a name="schema">`db.reasoning.schema(conn, database, params)`</a>

Gets the reasoning schema of the database

Expects the following parameters:

- conn ([`Connection`](#connection))

- database (`string`)

- params (`object`)

Returns [`Promise<HTTP.Body>`](#body)

## <a name="docs">docs</a>

#### <a name="size">`db.docs.size(conn, database, params)`</a>

Retrieves the size of the document store

Expects the following parameters:

- conn ([`Connection`](#connection))

- database (`string`)

- params (`object`)

Returns [`Promise<HTTP.Body>`](#body)

#### <a name="clear">`db.docs.clear(conn, database, params)`</a>

Clears the document store

Expects the following parameters:

- conn ([`Connection`](#connection))

- database (`string`)

- params (`object`)

Returns [`Promise<HTTP.Body>`](#body)

#### <a name="add">`db.docs.add(conn, database, fileName, fileContents, params)`</a>

Adds a document to the document store

Expects the following parameters:

- conn ([`Connection`](#connection))

- database (`string`)

- fileName (`string`)

- fileContents (`string`)

- params (`object`)

Returns [`Promise<HTTP.Body>`](#body)

#### <a name="remove">`db.docs.remove(conn, database, fileName, params)`</a>

Removes a document from the document store

Expects the following parameters:

- conn ([`Connection`](#connection))

- database (`string`)

- fileName (`string`)

- params (`object`)

Returns [`Promise<HTTP.Body>`](#body)

#### <a name="get">`db.docs.get(conn, database, fileName, params)`</a>

Retrieves a document from the document store

Expects the following parameters:

- conn ([`Connection`](#connection))

- database (`string`)

- fileName (`string`)

- params (`object`)

Returns [`Promise<HTTP.Body>`](#body)

## <a name="namespaces">namespaces</a>

#### <a name="get">`db.namespaces.get(conn, database)`</a>

Gets a mapping of the namespaces used in a database.

Expects the following parameters:

- conn ([`Connection`](#connection))

- database (`string`)

Returns [`Promise<HTTP.Body>`](#body)

#### <a name="add">`db.namespaces.add(conn, database, fileOrContents, options)`</a>

Extracts namespaces from an RDF file or RDF string and adds new
and updates existing namespaces in the database.

Expects the following parameters:

- conn ([`Connection`](#connection))

- database (`string`)

- fileOrContents ([`Blob | string`](#blob | string))

- options ({ contentType?: [`RdfMimeType`](#rdfmimetype) })

Returns [`Promise<HTTP.Body>`](#body)

## <a name="query">query</a>

#### <a name="querytype">QueryType</a>

One of the following values:

`'select'
      | 'ask'
      | 'construct'
      | 'describe'
      | 'validate'
      | 'update'
      | 'paths'
      | null`
#### <a name="propertyoptions">PropertyOptions</a>

Object with the following values:

- uri (`string`)
- property (`string`)

#### <a name="additionalhandlers">AdditionalHandlers</a>

Object with the following values:

- onResponseStart (`(res: Response) => boolean | void`)

#### <a name="property">`query.property(conn, database, config, params)`</a>

Gets the values for a specific property of a URI individual.

Expects the following parameters:

- conn ([`Connection`](#connection))

- database (`string`)

- config ([`PropertyOptions`](#propertyoptions))

- params (`object`)

Returns [`Promise<HTTP.Body>`](#body)

#### <a name="explain">`query.explain(conn, database, query, accept, params)`</a>

Gets the query plan generated by Stardog for a given SPARQL query.

Expects the following parameters:

- conn ([`Connection`](#connection))

- database (`string`)

- query (`string`)

- accept ([`ExplainAcceptMimeType`](#explainacceptmimetype))

- params (`object`)

Returns [`Promise<HTTP.Body>`](#body)

#### <a name="execute">`query.execute(conn, database, query, accept, params, additionalHandlers)`</a>

Executes a query against a database.

Expects the following parameters:

- conn ([`Connection`](#connection))

- database (`string`)

- query (`string`)

- accept ([`AcceptMimeType`](#acceptmimetype))

- params (`object`)

- additionalHandlers ([`AdditionalHandlers`](#additionalhandlers))

Returns [`Promise<HTTP.Body>`](#body)

#### <a name="executeintransaction">`query.executeInTransaction(conn, database, transactionId, query, options, params)`</a>

Executes a query against a database within a transaction.

Expects the following parameters:

- conn ([`Connection`](#connection))

- database (`string`)

- transactionId (`string`)

- query (`string`)

- options ({ accept: [`RdfMimeType`](#rdfmimetype) })

- params (`object`)

Returns [`Promise<HTTP.Body>`](#body)

#### <a name="list">`query.list(conn)`</a>

Gets a list of actively running queries.

Expects the following parameters:

- conn ([`Connection`](#connection))

Returns [`Promise<HTTP.Body>`](#body)

#### <a name="kill">`query.kill(conn, queryId)`</a>

Kills an actively running query.

Expects the following parameters:

- conn ([`Connection`](#connection))

- queryId (`string`)

Returns [`Promise<HTTP.Body>`](#body)

#### <a name="get">`query.get(conn, queryId)`</a>

Gets information about an actively running query.

Expects the following parameters:

- conn ([`Connection`](#connection))

- queryId (`string`)

Returns [`Promise<HTTP.Body>`](#body)

#### <a name="storedqueryoptions">StoredQueryOptions</a>

Object with the following values:

- name (`string`)
- database (`string`)
- query (`string`)
- shared (`boolean`)
- reasoning (`boolean`)
- description (`boolean`)

## <a name="stored">stored</a>

#### <a name="create">`query.stored.create(conn, storedQuery, options)`</a>

Stores a query in Stardog, either on the system level or for a given database.

Expects the following parameters:

- conn ([`Connection`](#connection))

- storedQuery ([`StoredQueryOptions | object`](#storedqueryoptions | object))

- options (`{ accept?: string; contentType?: string }`)

Returns [`Promise<HTTP.Body>`](#body)

#### <a name="list">`query.stored.list(conn, options)`</a>

Lists all stored queries.

Expects the following parameters:

- conn ([`Connection`](#connection))

- options (`{ accept?: string }`)

Returns [`Promise<HTTP.Body>`](#body)

#### <a name="update">`query.stored.update(conn, storedQuery, options, useUpdateMethod)`</a>

Updates a given stored query and creates it if the name does not refer to an existing stored query.

Expects the following parameters:

- conn ([`Connection`](#connection))

- storedQuery ([`StoredQueryOptions | object`](#storedqueryoptions | object))

- options (`{ accept?: string; contentType?: string }`)

- useUpdateMethod (`boolean`)

Returns [`Promise<HTTP.Body>`](#body)

#### <a name="remove">`query.stored.remove(conn, storedQuery)`</a>

Removes a given stored query.

Expects the following parameters:

- conn ([`Connection`](#connection))

- storedQuery (`string`)

Returns [`Promise<HTTP.Body>`](#body)

#### <a name="get">`query.stored.get(conn, storedQuery)`</a>

Gets a given stored query.

Expects the following parameters:

- conn ([`Connection`](#connection))

- storedQuery (`string`)

Returns [`Promise<HTTP.Body>`](#body)

#### <a name="rename">`query.stored.rename(conn, name, newName)`</a>

Renames a given stored query.

Expects the following parameters:

- conn ([`Connection`](#connection))

- name (`string`)

- newName (`string`)

Returns [`Promise<HTTP.Body>`](#body)

## <a name="graphql">graphql</a>

#### <a name="execute">`query.graphql.execute(conn, database, query, variables, params, additionalHandlers)`</a>

Executes a GraphQL query

Expects the following parameters:

- conn ([`Connection`](#connection))

- database (`string`)

- query (`string`)

- variables (`object`)

- params (`object`)

- additionalHandlers ([`AdditionalHandlers`](#additionalhandlers))

Returns [`Promise<HTTP.Body>`](#body)

#### <a name="listschemas">`query.graphql.listSchemas(conn, database, params)`</a>

Retrieves a list of GraphQL schemas in the database

Expects the following parameters:

- conn ([`Connection`](#connection))

- database (`string`)

- params (`object`)

Returns [`Promise<HTTP.Body>`](#body)

#### <a name="addschema">`query.graphql.addSchema(conn, database, name, schema, params)`</a>

Adds a GraphQL schema to the database

Expects the following parameters:

- conn ([`Connection`](#connection))

- database (`string`)

- name (`string`)

- schema (`object`)

- params (`object`)

Returns [`Promise<HTTP.Body>`](#body)

#### <a name="updateschema">`query.graphql.updateSchema(conn, database, name, schema, params)`</a>

Updates (or adds if non-existent) a GraphQL schema to the database

Expects the following parameters:

- conn ([`Connection`](#connection))

- database (`string`)

- name (`string`)

- schema (`object`)

- params (`object`)

Returns [`Promise<HTTP.Body>`](#body)

#### <a name="getschema">`query.graphql.getSchema(conn, database, name, params)`</a>

Retrieves a GraphQL schema from the database

Expects the following parameters:

- conn ([`Connection`](#connection))

- database (`string`)

- name (`string`)

- params (`object`)

Returns [`Promise<HTTP.Body>`](#body)

#### <a name="removeschema">`query.graphql.removeSchema(conn, database, name, params)`</a>

Removes a GraphQL schemafrom  the database

Expects the following parameters:

- conn ([`Connection`](#connection))

- database (`string`)

- name (`string`)

- params (`object`)

Returns [`Promise<HTTP.Body>`](#body)

#### <a name="clearschemas">`query.graphql.clearSchemas(conn, database, params)`</a>

Clears all GraphQL schemas in the database

Expects the following parameters:

- conn ([`Connection`](#connection))

- database (`string`)

- params (`object`)

Returns [`Promise<HTTP.Body>`](#body)

## <a name="utils">utils</a>

#### <a name="querytype">`query.utils.queryType(query)`</a>

Returns the QueryType (as a string or null) for the given query.

Expects the following parameters:

- query (`string`)

Returns [`QueryType`](#querytyp)

#### <a name="mimetype">`query.utils.mimeType(query)`</a>

Returns the default HTTP `Accept` MIME type for the given query.

Expects the following parameters:

- query (`string`)

Returns [`HTTP.AcceptMimeType`](#acceptmimetyp)

## <a name="user">user</a>

#### <a name="user">User</a>

Object with the following values:

- username (`string`)
- password (`string`)
- superuser (`boolean`)

#### <a name="action">Action</a>

One of the following values:

`'ALL'
      | 'CREATE'
      | 'DELETE'
      | 'EXECUTE'
      | 'GRANT'
      | 'READ'
      | 'REVOKE'
      | 'WRITE'`
#### <a name="resourcetype">ResourceType</a>

One of the following values:

`'*'
      | 'admin'
      | 'cache'
      | 'cache-target'
      | 'data-source'
      | 'db'
      | 'db-export'
      | 'dbms-admin'
      | 'entity-resolution'
      | 'icv-constraints'
      | 'metadata'
      | 'modeling'
      | 'named-graph'
      | 'permission'
      | 'role'
      | 'role-assignment'
      | 'sensitive-properties'
      | 'stored-query'
      | 'user'
      | 'virtual-graph'`
#### <a name="list">`user.list(conn, params)`</a>

Gets a list of users.

Expects the following parameters:

- conn ([`Connection`](#connection))

- params (`object`)

Returns [`Promise<HTTP.Body>`](#body)

#### <a name="listinfo">`user.listInfo(conn)`</a>

Retrieve a list of user info

Expects the following parameters:

- conn ([`Connection`](#connection))

Returns [`Promise<HTTP.Body>`](#body)

#### <a name="get">`user.get(conn, username, params)`</a>

Gets all information for a given user.

Expects the following parameters:

- conn ([`Connection`](#connection))

- username (`string`)

- params (`object`)

Returns [`Promise<HTTP.Body>`](#body)

#### <a name="create">`user.create(conn, user, params)`</a>

Creates a new user.

Expects the following parameters:

- conn ([`Connection`](#connection))

- user ([`User`](#user))

- params (`object`)

Returns [`Promise<HTTP.Body>`](#body)

#### <a name="changepassword">`user.changePassword(conn, username, currentPassword, password, params)`</a>

Changes a user's password.

Expects the following parameters:

- conn ([`Connection`](#connection))

- username (`string`)

- currentPassword (`string`)

- password (`string`)

- params (`object`)

Returns [`Promise<HTTP.Body>`](#body)

#### <a name="valid">`user.valid(conn, params)`</a>

Verifies that a Connection's credentials are valid.

Expects the following parameters:

- conn ([`Connection`](#connection))

- params (`object`)

Returns [`Promise<HTTP.Body>`](#body)

#### <a name="enabled">`user.enabled(conn, username, params)`</a>

Verifies that a user is enabled.

Expects the following parameters:

- conn ([`Connection`](#connection))

- username (`string`)

- params (`object`)

Returns [`Promise<HTTP.Body>`](#body)

#### <a name="enable">`user.enable(conn, username, enabled, params)`</a>

Enables/disables a user.

Expects the following parameters:

- conn ([`Connection`](#connection))

- username (`string`)

- enabled (`boolean`)

- params (`object`)

Returns [`Promise<HTTP.Body>`](#body)

#### <a name="setroles">`user.setRoles(conn, username, roles, params)`</a>

Sets roles for a user. (Overwrites any existing roles)

Expects the following parameters:

- conn ([`Connection`](#connection))

- username (`string`)

- roles (`string[]`)

- params (`object`)

Returns [`Promise<HTTP.Body>`](#body)

#### <a name="assignrole">`user.assignRole(conn, username, role, params)`</a>

Adds a role to a user.

Expects the following parameters:

- conn ([`Connection`](#connection))

- username (`string`)

- role (`string`)

- params (`object`)

Returns [`Promise<HTTP.Body>`](#body)

#### <a name="listroles">`user.listRoles(conn, username, params)`</a>

Gets a list of roles assigned to a user.

Expects the following parameters:

- conn ([`Connection`](#connection))

- username (`string`)

- params (`object`)

Returns [`Promise<HTTP.Body>`](#body)

#### <a name="assignpermission">`user.assignPermission(conn, username, permission, params)`</a>

Creates a new permission for a user over a given resource.

Expects the following parameters:

- conn ([`Connection`](#connection))

- username (`string`)

- permission ([`Permission`](#permission))

- params (`object`)

Returns [`Promise<HTTP.Body>`](#body)

#### <a name="deletepermission">`user.deletePermission(conn, username, permission, params)`</a>

Removes a permission for a user over a given resource.

Expects the following parameters:

- conn ([`Connection`](#connection))

- username (`string`)

- permission ([`Permission`](#permission))

- params (`object`)

Returns [`Promise<HTTP.Body>`](#body)

#### <a name="permissions">`user.permissions(conn, username, params)`</a>

Gets a list of permissions assigned to user.

Expects the following parameters:

- conn ([`Connection`](#connection))

- username (`string`)

- params (`object`)

Returns [`Promise<HTTP.Body>`](#body)

#### <a name="effectivepermissions">`user.effectivePermissions(conn, username, params)`</a>

Gets a list of a user's effective permissions.

Expects the following parameters:

- conn ([`Connection`](#connection))

- username (`string`)

- params (`object`)

Returns [`Promise<HTTP.Body>`](#body)

#### <a name="checkpermission">`user.checkPermission(conn, action, resourceType, resource)`</a>

Checks if the current user has a specific permission.

Expects the following parameters:

- conn ([`Connection`](#connection))

- action ([`Action`](#action))

- resourceType ([`ResourceType`](#resourcetype))

- resource (`string`)

Returns [`Promise<HTTP.Body>`](#body)

#### <a name="superuser">`user.superUser(conn, username, params)`</a>

Specifies whether a user is a superuser.

Expects the following parameters:

- conn ([`Connection`](#connection))

- username (`string`)

- params (`object`)

Returns [`Promise<HTTP.Body>`](#body)

#### <a name="remove">`user.remove(conn, username, params)`</a>

Deletes a user.

Expects the following parameters:

- conn ([`Connection`](#connection))

- username (`string`)

- params (`object`)

Returns [`Promise<HTTP.Body>`](#body)

#### <a name="token">`user.token(conn)`</a>

Returns a token for the user if the connection is valid.

Expects the following parameters:

- conn ([`Connection`](#connection))

Returns [`Promise<HTTP.Body>`](#body)

#### <a name="whoami">`user.whoAmI(conn)`</a>

Returns the username for the given connection.

Expects the following parameters:

- conn ([`Connection`](#connection))

Returns [`Promise<HTTP.Body>`](#body)

#### <a name="permission">Permission</a>

Object with the following values:

- action (`Action`)
- resourceType (`ResourceType`)
- resources (`string[]`)

## <a name="role">role</a>

#### <a name="create">`user.role.create(conn, role, params)`</a>

Creates a new role.

Expects the following parameters:

- conn ([`Connection`](#connection))

- role (`{ name: string }`)

- params (`object`)

Returns [`Promise<HTTP.Body>`](#body)

#### <a name="list">`user.role.list(conn, params)`</a>

Lists all existing roles.

Expects the following parameters:

- conn ([`Connection`](#connection))

- params (`object`)

Returns [`Promise<HTTP.Body>`](#body)

#### <a name="listinfo">`user.role.listInfo(conn)`</a>

Retrieve a list of role info

Expects the following parameters:

- conn ([`Connection`](#connection))

Returns [`Promise<HTTP.Body>`](#body)

#### <a name="remove">`user.role.remove(conn, role, params)`</a>

Deletes an existing role from the system.

Expects the following parameters:

- conn ([`Connection`](#connection))

- role (`string`)

- params (`object`)

Returns [`Promise<HTTP.Body>`](#body)

#### <a name="userswithrole">`user.role.usersWithRole(conn, role, params)`</a>

Lists all users that have been assigned a given role.

Expects the following parameters:

- conn ([`Connection`](#connection))

- role (`string`)

- params (`object`)

Returns [`Promise<HTTP.Body>`](#body)

#### <a name="assignpermission">`user.role.assignPermission(conn, role, permission, params)`</a>

Adds a permission over a given resource to a given role.

Expects the following parameters:

- conn ([`Connection`](#connection))

- role (`string`)

- permission ([`Permission`](#permission))

- params (`object`)

Returns [`Promise<HTTP.Body>`](#body)

#### <a name="deletepermission">`user.role.deletePermission(conn, role, permission, params)`</a>

Removes a permission over a given resource from a given role.

Expects the following parameters:

- conn ([`Connection`](#connection))

- role (`string`)

- permission ([`Permission`](#permission))

- params (`object`)

Returns [`Promise<HTTP.Body>`](#body)

#### <a name="permissions">`user.role.permissions(conn, role, params)`</a>

Lists all permissions assigned to a given role.

Expects the following parameters:

- conn ([`Connection`](#connection))

- role (`string`)

- params (`object`)

Returns [`Promise<HTTP.Body>`](#body)

## <a name="virtualgraphs">virtualGraphs</a>

#### <a name="sharedoptions">SharedOptions</a>

Object with the following values:

- base (`string`)
- mappings.syntax (`string`)
- percent.encode (`boolean`)
- optimize.import (`boolean`)
- query.translation (`'DEFAULT' | 'LEGACY'`)

#### <a name="rdbmsoptions">RdbmsOptions</a> extends [SharedOptions](#sharedoptions)

Object with the following values:

- jdbc.url (`string`)
- jdbc.username (`string`)
- jdbc.password (`string`)
- jdbc.driver (`string`)
- parser.sql.quoting (`'NATIVE' | 'ANSI'`)
- sql.functions (`string`)
- sql.schemas (`string`)
- default.mappings.include.tables (`string`)
- default.mappings.exclude.tables (`string`)

#### <a name="mongooptions">MongoOptions</a> extends [SharedOptions](#sharedoptions)

Object with the following values:

- mongodb.uri (`string`)

#### <a name="csvoptions">CsvOptions</a> extends [SharedOptions](#sharedoptions)

Object with the following values:

- csv.separator (`string`)
- csv.quote (`string`)
- csv.escape (`string`)
- csv.header (`boolean`)
- csv.skip.empty (`boolean`)

#### <a name="allvgoptions">AllVgOptions</a>

One of the following values:

`SharedOptions &
      RdbmsOptions &
      MongoOptions &
      CsvOptions`
#### <a name="mappingsrequestoptions">MappingsRequestOptions</a>

Object with the following values:

- preferUntransformed (`boolean`)
- syntax (`string`)

#### <a name="vgmeta">VgMeta</a>

Object with the following values:

- db (`string`)
- dataSource (`string`)

#### <a name="list">`virtualGraphs.list(conn)`</a>

Retrieve a list of virtual graphs

Expects the following parameters:

- conn ([`Connection`](#connection))

Returns [`Promise<HTTP.Body>`](#body)

#### <a name="listinfo">`virtualGraphs.listInfo(conn)`</a>

Retrieve a list of virtual graphs info

Expects the following parameters:

- conn ([`Connection`](#connection))

Returns [`Promise<HTTP.Body>`](#body)

#### <a name="add">`virtualGraphs.add(conn, name, mappings, options, meta)`</a>

Add a virtual graph to the system

Expects the following parameters:

- conn ([`Connection`](#connection))

- name (`string`)

- mappings (`string`)

- options ([`T`](#t))

- meta ([`VgMeta`](#vgmeta))

Returns [`Promise<HTTP.Body>`](#body)

#### <a name="update">`virtualGraphs.update(conn, name, mappings, options, meta)`</a>

Update a virtual graph in the system

Expects the following parameters:

- conn ([`Connection`](#connection))

- name (`string`)

- mappings (`string`)

- options ([`T`](#t))

- meta ([`VgMeta`](#vgmeta))

Returns [`Promise<HTTP.Body>`](#body)

#### <a name="remove">`virtualGraphs.remove(conn, name)`</a>

Remove a virtual graph from the system

Expects the following parameters:

- conn ([`Connection`](#connection))

- name (`string`)

Returns [`Promise<HTTP.Body>`](#body)

#### <a name="online">`virtualGraphs.online(conn, name)`</a>

Bring a virtual graph online

Expects the following parameters:

- conn ([`Connection`](#connection))

- name (`string`)

Returns [`Promise<HTTP.Body>`](#body)

#### <a name="available">`virtualGraphs.available(conn, name)`</a>

Determine if the named virtual graph is available

Expects the following parameters:

- conn ([`Connection`](#connection))

- name (`string`)

Returns [`Promise<HTTP.Body>`](#body)

#### <a name="options">`virtualGraphs.options(conn, name)`</a>

Retrieve a virtual graph's options

Expects the following parameters:

- conn ([`Connection`](#connection))

- name (`string`)

Returns [`Promise<HTTP.Body>`](#body)

#### <a name="mappings">`virtualGraphs.mappings(conn, name, requestOptions)`</a>

Retrieve a virtual graph's mappings

Expects the following parameters:

- conn ([`Connection`](#connection))

- name (`string`)

- requestOptions ([`MappingsRequestOptions`](#mappingsrequestoptions))

Returns [`Promise<HTTP.Body>`](#body)

#### <a name="importfile">`virtualGraphs.importFile(conn, file, fileType, fileIri, database, importOptions)`</a>

Import a JSON or CSV file into a database via `virtual import`.

Expects the following parameters:

- conn ([`Connection`](#connection))

- file (`object`)

- fileType (`string`)

- fileIri (`string`)

- database (`string`)

- importOptions (`{
        mappings?: string;
        properties?: string;
        namedGraph?: string;
      }`)

Returns [`Promise<HTTP.Body>`](#body)

## <a name="storedfunctions">storedFunctions</a>

#### <a name="add">`storedFunctions.add(conn, functions, params)`</a>

Adds one or more stored functions to the server

Expects the following parameters:

- conn ([`Connection`](#connection))

- functions (`string`)

- params (`object`)

Returns [`Promise<HTTP.Body>`](#body)

#### <a name="get">`storedFunctions.get(conn, name, params)`</a>

Retrieves the specified function definition

Expects the following parameters:

- conn ([`Connection`](#connection))

- name (`string`)

- params (`object`)

Returns [`Promise<HTTP.Body>`](#body)

#### <a name="remove">`storedFunctions.remove(conn, name, params)`</a>

Removes a stored function from the server

Expects the following parameters:

- conn ([`Connection`](#connection))

- name (`string`)

- params (`object`)

Returns [`Promise<HTTP.Body>`](#body)

#### <a name="clear">`storedFunctions.clear(conn, params)`</a>

Removes all stored functions from the server

Expects the following parameters:

- conn ([`Connection`](#connection))

- params (`object`)

Returns [`Promise<HTTP.Body>`](#body)

#### <a name="getall">`storedFunctions.getAll(conn, params)`</a>

Retrieves an export of all stored functions on the server

Expects the following parameters:

- conn ([`Connection`](#connection))

- params (`object`)

Returns [`Promise<HTTP.Body>`](#body)

## <a name="cluster">cluster</a>

#### <a name="info">`cluster.info(conn)`</a>

Retrieves basic information about a Stardog cluster.

Expects the following parameters:

- conn ([`Connection`](#connection))

Returns [`Promise<HTTP.Body>`](#body)

#### <a name="status">`cluster.status(conn)`</a>

Retrieves detailed status information about a Stardog cluster.

Expects the following parameters:

- conn ([`Connection`](#connection))

Returns [`Promise<HTTP.Body>`](#body)

## <a name="catalog">catalog</a>

#### <a name="status">`catalog.status(conn)`</a>

Lists the status of catalog providers

Expects the following parameters:

- conn ([`Connection`](#connection))

Returns [`Promise<HTTP.Body>`](#body)

#### <a name="reload">`catalog.reload(conn, provider)`</a>

Starts a reload of information about a specific provider

Expects the following parameters:

- conn ([`Connection`](#connection))

- provider (`string`)

Returns [`Promise<HTTP.Body>`](#body)

#### <a name="credentials">Credentials</a>

One of the following values:

`{ username: string; password: string }
      | { token: string }
      | { clientId: string; clientSecret: string }`
#### <a name="addcredential">`catalog.addCredential(conn, credentials, label)`</a>

Adds a provider credential

Expects the following parameters:

- conn ([`Connection`](#connection))

- credentials ([`Credentials`](#credentials))

- label (`string`)

Returns [`Promise<HTTP.Body>`](#body)

#### <a name="listcredentials">`catalog.listCredentials(conn)`</a>

Lists stored provider credentials

Expects the following parameters:

- conn ([`Connection`](#connection))

Returns [`Promise<HTTP.Body>`](#body)

#### <a name="removecredential">`catalog.removeCredential(conn, accessKey)`</a>

Removes a stored provider credential

Expects the following parameters:

- conn ([`Connection`](#connection))

- accessKey (`string`)

Returns [`Promise<HTTP.Body>`](#body)

#### <a name="runjob">`catalog.runJob(conn, jobname)`</a>

Manually starts a provider job

Expects the following parameters:

- conn ([`Connection`](#connection))

- jobname (`string`)

Returns [`Promise<HTTP.Body>`](#body)

#### <a name="testconnection">`catalog.testConnection(conn, connectionOptions)`</a>

Tests a provider connection using existing/new credentials.

Expects the following parameters:

- conn ([`Connection`](#connection))

- connectionOptions (`object`)

Returns [`Promise<HTTP.Body>`](#body)

## <a name="datasources">dataSources</a>

#### <a name="list">`dataSources.list(conn)`</a>

Retrieve a list of data sources

Expects the following parameters:

- conn ([`Connection`](#connection))

Returns [`Promise<HTTP.Body>`](#body)

#### <a name="listinfo">`dataSources.listInfo(conn)`</a>

Retrieve a list of data sources info

Expects the following parameters:

- conn ([`Connection`](#connection))

Returns [`Promise<HTTP.Body>`](#body)

#### <a name="info">`dataSources.info(conn, name)`</a>

Retrieve the named data source info

Expects the following parameters:

- conn ([`Connection`](#connection))

- name (`string`)

Returns [`Promise<HTTP.Body>`](#body)

#### <a name="add">`dataSources.add(conn, name, options)`</a>

Add a data source to the system

Expects the following parameters:

- conn ([`Connection`](#connection))

- name (`string`)

- options ([`T`](#t))

Returns [`Promise<HTTP.Body>`](#body)

#### <a name="update">`dataSources.update(conn, name, options, requestOptions)`</a>

Update the named data source in the system

Expects the following parameters:

- conn ([`Connection`](#connection))

- name (`string`)

- options ([`T`](#t))

- requestOptions (`{ delta_options?: boolean; force?: boolean }`)

Returns [`Promise<HTTP.Body>`](#body)

#### <a name="remove">`dataSources.remove(conn, name, params)`</a>

Remove the named data source from the system

Expects the following parameters:

- conn ([`Connection`](#connection))

- name (`string`)

- params (`object`)

Returns [`Promise<HTTP.Body>`](#body)

#### <a name="share">`dataSources.share(conn, name)`</a>

Change a private data source to a shared one

Expects the following parameters:

- conn ([`Connection`](#connection))

- name (`string`)

Returns [`Promise<HTTP.Body>`](#body)

#### <a name="online">`dataSources.online(conn, name)`</a>

Bring the named data source online

Expects the following parameters:

- conn ([`Connection`](#connection))

- name (`string`)

Returns [`Promise<HTTP.Body>`](#body)

#### <a name="available">`dataSources.available(conn, name)`</a>

Determine if the named data source is available

Expects the following parameters:

- conn ([`Connection`](#connection))

- name (`string`)

Returns [`Promise<HTTP.Body>`](#body)

#### <a name="test">`dataSources.test(conn, name)`</a>

Test the connection for the named data source

Expects the following parameters:

- conn ([`Connection`](#connection))

- name (`string`)

Returns [`Promise<HTTP.Body>`](#body)

#### <a name="options">`dataSources.options(conn, name)`</a>

Retrieve the named data source options

Expects the following parameters:

- conn ([`Connection`](#connection))

- name (`string`)

Returns [`Promise<HTTP.Body>`](#body)

#### <a name="getmetadata">`dataSources.getMetadata(conn, name, options)`</a>

Retrieve the named data source metadata

Expects the following parameters:

- conn ([`Connection`](#connection))

- name (`string`)

- options (`object`)

Returns [`Promise<HTTP.Body>`](#body)

#### <a name="updatemetadata">`dataSources.updateMetadata(conn, name, metadata, options)`</a>

Update the named data source metadata

Expects the following parameters:

- conn ([`Connection`](#connection))

- name (`string`)

- metadata ([`T`](#t))

- options (`object`)

Returns [`Promise<HTTP.Body>`](#body)

#### <a name="gettables">`dataSources.getTables(conn, name, options)`</a>

Retrieve tables

Expects the following parameters:

- conn ([`Connection`](#connection))

- name (`string`)

- options (`object`)

Returns [`Promise<HTTP.Body>`](#body)

#### <a name="gettablemetadata">`dataSources.getTableMetadata(conn, name, options)`</a>

Retrieve the named table metadata

Expects the following parameters:

- conn ([`Connection`](#connection))

- name (`string`)

- options (`object`)

Returns [`Promise<HTTP.Body>`](#body)

#### <a name="datasourcequery">DataSourceQuery</a>

One of the following values:

`string | { query: string; options: object }`
#### <a name="query">`dataSources.query(conn, name, dataSourceQuery)`</a>

Query data source

Expects the following parameters:

- conn ([`Connection`](#connection))

- name (`string`)

- dataSourceQuery ([`DataSourceQuery`](#datasourcequery))

Returns [`Promise<HTTP.Body>`](#body)

#### <a name="refreshcounts">`dataSources.refreshCounts(conn, name, tableName)`</a>

Refresh table row-count estimates

Expects the following parameters:

- conn ([`Connection`](#connection))

- name (`string`)

- tableName (`string`)

Returns [`Promise<HTTP.Body>`](#body)

#### <a name="refreshmetadata">`dataSources.refreshMetadata(conn, name, tableName)`</a>

Refresh metadata

Expects the following parameters:

- conn ([`Connection`](#connection))

- name (`string`)

- tableName (`string`)

Returns [`Promise<HTTP.Body>`](#body)

#### <a name="suggestions">`dataSources.suggestions(conn, content, options)`</a>

Get suggestions for property matches on a model.

Expects the following parameters:

- conn ([`Connection`](#connection))

- content (`string`)

- options (`{ accept?: string; contentType?: string }`)

Returns [`Promise<HTTP.Body>`](#body)

#### <a name="typedescription">`dataSources.typeDescription(conn)`</a>

Get information about the data source types supported by the stardog instance, and their options

Expects the following parameters:

- conn ([`Connection`](#connection))

Returns [`Promise<HTTP.Body>`](#body)