SparqlQuery Class

Represents a SPARQL Query.

Inheritance Hierarchy

SystemObject
VDS.RDFNodeFactory
VDS.RDF.QuerySparqlQuery

Namespace: VDS.RDF.Query
Assembly: dotNetRDF (in dotNetRDF.dll) Version:

Syntax

Copy

public sealed class SparqlQuery : NodeFactory

Public NotInheritable Class SparqlQuery
	Inherits NodeFactory

The SparqlQuery type exposes the following members.

Properties

	Name	Description
	AlgebraOptimisers	Gets/Sets the locally scoped Algebra Optimisers that are used to optimise the Query Algebra in addition to (but before) any global optimisers (specified by SparqlOptimiser.AlgebraOptimisers) that are applied.
	BaseUri	Gets/Sets the Base Uri for the Query.
	Bindings	Gets/Sets the VALUES Clause for the Query which are bindings that should be applied.
	ConstructTemplate	Gets/Sets the Construct Template for a Construct Query.
	DefaultGraphs	Gets the Default Graph URIs for the Query.
	Describer	Gets/Sets the ISparqlDescribe which provides the Describe algorithm you wish to use.
	DescribeVariables	Gets the Variables, QNames and URIs used in the Describe Query.
	ExpressionFactories	Gets/Sets the locally scoped Expression Factories that may be used if the query is using the CALL() function to do dynamic function invocation.
	GroupBy	Gets/Sets the Grouping for the Query.
	HasDistinctModifier	Gets whether a Query has a DISTINCT modifier.
	HasSolutionModifier	Gets whether the Query has a Solution Modifier (a GROUP BY, HAVING, ORDER BY, LIMIT or OFFSET).
	Having	Gets/Sets the Having Clause for the Query.
	IsAggregate	Gets whether the Query has an Aggregate as its Result.
	IsOptimised	Gets whether Optimisation has been applied to the query.
	IsSubQuery	Gets whether this Query is a Sub-Query in another Query.
	Limit	Gets the Result Set Limit for the Query.
	NamedGraphs	Gets the Named Graph URIs for the Query.
	NamespaceMap	Gets the Namespace Map for the Query.
	Offset	Gets/Sets the Result Set Offset for the Query.
	OrderBy	Gets/Sets the Ordering for the Query.
	PartialResultsOnTimeout	Gets/Sets whether Partial Results should be returned in the event of Query Timeout.
	PropertyFunctionFactories	Gets/Sets the locally scoped Property Function factories that may be used by the PropertyFunctionOptimiser when generating the algebra for the query.
	QueryExecutionTime	Gets the Time taken to execute a Query.
	QueryType	Gets the type of the Query.
	RootGraphPattern	Gets the top level Graph Pattern of the Query.
	SpecialType	Gets the Special Type of the Query (if any).
	Timeout	Gets/Sets the Query Execution Timeout in milliseconds.
	UsesDefaultDataset	Gets whether a Query uses the Default Dataset against which it is evaluated.
	Variables	Gets the Variables used in the Query.
	VirtualCount	The number of results that would be returned without any limit clause to a query or -1 if not supported. Defaults to the same value as the Count member.

Top

Methods

	Name	Description
	AddDefaultGraph	Adds a Default Graph URI.
	AddNamedGraph	Adds a Named Graph URI.
	ClearDefaultGraphs	Removes all Default Graph URIs.
	ClearNamedGraphs	Removes all Named Graph URIs.
	Copy	Creates a copy of the query.
	CreateBlankNode	Creates a Blank Node with a new automatically generated ID. (Inherited from NodeFactory.)
	CreateBlankNode(String)	Creates a Blank Node with the given Node ID. (Inherited from NodeFactory.)
	CreateGraphLiteralNode	Creates a Graph Literal Node which represents the empty Subgraph. (Inherited from NodeFactory.)
	CreateGraphLiteralNode(IGraph)	Creates a Graph Literal Node which represents the given Subgraph. (Inherited from NodeFactory.)
	CreateLiteralNode(String)	Creates a Literal Node with the given Value. (Inherited from NodeFactory.)
	CreateLiteralNode(String, String)	Creates a Literal Node with the given Value and Language. (Inherited from NodeFactory.)
	CreateLiteralNode(String, Uri)	Creates a Literal Node with the given Value and Data Type. (Inherited from NodeFactory.)
	CreateUriNode	Creates a URI Node for the given URI. (Inherited from NodeFactory.)
	CreateVariableNode	Creates a Variable Node for the given Variable Name. (Inherited from NodeFactory.)
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	Evaluate(IInMemoryQueryableStore)	Obsolete. Evaluates the SPARQL Query against the given Triple Store.
	Evaluate(ISparqlDataset)	Obsolete. Evaluates the SPARQL Query against the given Dataset.
	Evaluate(IRdfHandler, ISparqlResultsHandler, IInMemoryQueryableStore)	Obsolete. Evaluates the SPARQL Query against the given Triple Store processing the results with the appropriate handler from those provided.
	Evaluate(IRdfHandler, ISparqlResultsHandler, ISparqlDataset)	Obsolete. Evaluates the SPARQL Query against the given Dataset processing the results with an appropriate handler form those provided.
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetNextBlankNodeID	Creates a new unused Blank Node ID and returns it. (Inherited from NodeFactory.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	Optimise	Applies optimisation to a Query using the default global optimiser.
	Optimise(IQueryOptimiser)	Applies optimisation to a Query using the specific optimiser.
	Process	Processes the Query using the given Query Processor.
	ToAlgebra	Converts the Query into it's SPARQL Algebra representation (as represented in the Leviathan API).
	ToString	Generates a String representation of the Query. (Overrides ObjectToString.)

Top

Remarks

Note: This class is purposefully sealed and most setters are private/protected internal since generally you create a query by using the SparqlQueryParser to parse a query string/file.

To build a query programmatically you can use the QueryBuilder class to generate a new query and then various extension methods to modify that query using a fluent style API. A query is not immutable so if you use that API you are modifying the query, if you want to generate new queries by modifying an existing query consider using the Copy method to take a copy of the existing query.

Reference

VDS.RDF.Query Namespace