• API Docs for Version:

    • APIs

    Show:

    Query Class

    Defined in: src/sparql/query.js:10

    The Query is the root object for all SPARQL requests

    Constructor

    Query

    (
    • endpoint
    )

    Defined in src/sparql/query.js:10

    Parameters:

    • endpoint String
      • URL of the SPARQL endpoint

    Methods

    addPrefix

    (
    • content
    )

    Defined in src/sparql/query.js:44

    Add a prefix to the query

    Parameters:

    • content Prefix | String | Array
      • A single Prefix string or object

    ask

    () Query

    Defined in src/sparql/query.js:102

    Set the current query to ASK

    Returns:

    Query:
    • Returns current instance (chainable)

    base

    (
    • content
    )

    Defined in src/sparql/query.js:22

    Sets the base IRI

    Parameters:

    • content String
      • BASE string

    clearDatasetClauses

    ()

    Defined in src/sparql/query.js:150

    Clear current dataset clauses

    clearPrefixes

    ()

    Defined in src/sparql/query.js:68

    Remove all Prefixes from the Query

    construct

    (
    • triples
    )
    Query

    Defined in src/sparql/query.js:113

    Set the current query to CONSTRUCT

    Parameters:

    • triples Triple | Array
      • One or more Triples to be used for a DESCRIBE GraphPattern

    Returns:

    Query:
    • Returns current instance (chainable)

    describe

    (
    • content
    )
    Query

    Defined in src/sparql/query.js:90

    Set the current query to DESCRIBE

    Parameters:

    • content String
      • Arguments given to the DESCRIBE statement

    Returns:

    Query:
    • Returns current instance (chainable)

    exec

    () Promise

    Defined in src/sparql/query.js:234

    Execute query

    Returns:

    Promise:
    • Returns a Promise with will yield a Result object

    from

    (
    • content
    • named
    )
    Query

    Defined in src/sparql/query.js:125

    Set dataset clause

    Parameters:

    • content String | Array
      • One or more strings with dataset clauses (without FROM or NAMED)
    • named Boolean
      • Optional flag to set clause to NAMED

    Returns:

    Query:
    • Returns current instance (chainable)

    getDatasetClauses

    () Array

    Defined in src/sparql/query.js:140

    Get current dataset clauses

    Returns:

    Array:

    getPrefixes

    () Array

    Defined in src/sparql/query.js:58

    Get the Prefix objects of the Query

    Returns:

    Array:

    getWhereClause

    () GraphPattern | GroupGraphPattern

    Defined in src/sparql/query.js:176

    Get current where clause

    Returns:

    GraphPattern | GroupGraphPattern:

    limit

    (
    • count
    )
    Query

    Defined in src/sparql/query.js:202

    Set limit for query

    Parameters:

    • count Number
      • Limit count

    Returns:

    Query:
    • Returns current instance (chainable)

    offset

    (
    • count
    )
    Query

    Defined in src/sparql/query.js:218

    Set limit for offset

    Parameters:

    • count Number
      • Offset count

    Returns:

    Query:
    • Returns current instance (chainable)

    order

    (
    • content
    )
    Query

    Defined in src/sparql/query.js:186

    Set order for query

    Parameters:

    • content String
      • Order string without ORDER BY

    Returns:

    Query:
    • Returns current instance (chainable)

    prefix

    (
    • content
    )
    Query

    Defined in src/sparql/query.js:32

    Sets the prefix(es) for the query

    Parameters:

    • content Prefix | String | Array
      • A single Prefix string or object or an array of Prefix objects or strings

    Returns:

    Query:
    • Returns current instance (chainable)

    reset

    ()

    Defined in src/sparql/query.js:293

    Reset query (endpoint setting stays)

    select

    (
    • content
    • modifier
    )
    Query

    Defined in src/sparql/query.js:77

    Set the current query to SELECT

    Parameters:

    • content String
      • Arguments given to the SELECT statement
    • modifier String
      • Optional modifier to be added (e.g. DISTINCT)

    Returns:

    Query:
    • Returns current instance (chainable)

    toString

    (
    • isSubquery
    )
    String

    Defined in src/sparql/query.js:244

    Retrieves the SPARQL string representation of the current instance, adding the FILTER keyword.

    Parameters:

    • isSubquery Boolean
      • If set, skips the BASE and PREFIX parts for inclusion as a subquery

    Returns:

    String:

    where

    (
    • content
    )
    Query

    Defined in src/sparql/query.js:159

    Set where clause

    Parameters:

    • content String | Array
      • A GraphPattern or a GroupGraphPattern object

    Returns:

    Query:
    • Returns current instance (chainable)