@triply/triplydb
    Preparing search index...

    Interface AddQueryOptions

    interface AddQueryOptions {
        accessLevel?: AccessLevel;
        dataset: Dataset;
        description?: string;
        displayName?: string;
        ldFrame?: object;
        output?: string;
        queryString: string;
        serviceType: SparqlQueryServiceType;
        variables?: VariableConfig[];
    }
    Index
    accessLevel? dataset description? displayName? ldFrame? output? queryString serviceType variables?
    accessLevel?: AccessLevel

    Who can reach the query — see AccessLevel. Defaults to private.

    dataset: Dataset

    The dataset the query runs against. Required: a saved query is stored together with its data.

    description?: string

    Free-text description, shown on the query's page.

    displayName?: string

    Title shown in the interface, free of the restrictions that apply to the query's name.

    ldFrame?: object

    JSON-LD frame to shape the results of a construct query.

    Ignored for a select query, and ignored when output is also given — output wins.

    output?: string

    How results are displayed in the interface — "Table" by default, or "Response", "Geo", "Gallery".

    queryString: string

    The SPARQL text to save.

    serviceType: SparqlQueryServiceType

    The kind of service the query needs.

    The dataset must have a service of this kind before the query can run — see Dataset.ensureService.

    variables?: VariableConfig[]

    The variables the query accepts, with their datatypes and defaults.

    Declare a variable here to make it settable when the query is run; Query.results then takes a value for it. A ?var in the text that is not declared here is not a variable a caller can set.

    Settings

    On This Page
    Properties