Interface IQueryBuilder

Interface for building SPARQL queries.

Namespace: VDS.RDF.Query.Builder
Assembly: dotNetRdf.dll
Syntax
public interface IQueryBuilder

Properties

| Edit this page View Source

Prefixes

Gets the prefix manager, which allows adding prefixes to the query or graph pattern.

Declaration
INamespaceMapper Prefixes { get; set; }
Property Value
Type Description
INamespaceMapper
| Edit this page View Source

QueryType

Gets the query type of the generated SPARQL query.

Declaration
SparqlQueryType QueryType { get; }
Property Value
Type Description
SparqlQueryType
| Edit this page View Source

Root

Gets the builder associated with the root graph pattern.

Declaration
IGraphPatternBuilder Root { get; }
Property Value
Type Description
IGraphPatternBuilder
| Edit this page View Source

RootGraphPatternBuilder

Gets the builder associated with the root graph pattern.

Declaration
[Obsolete("Please use Root property", true)]
GraphPatternBuilder RootGraphPatternBuilder { get; }
Property Value
Type Description
GraphPatternBuilder

Methods

| Edit this page View Source

Bind(Func<INonAggregateExpressionBuilder, SparqlExpression>)

Adds a BIND variable assignment to the root graph pattern.

Declaration
IAssignmentVariableNamePart<IQueryBuilder> Bind(Func<INonAggregateExpressionBuilder, SparqlExpression> buildAssignmentExpression)
Parameters
Type Name Description
Func<INonAggregateExpressionBuilder, SparqlExpression> buildAssignmentExpression
Returns
Type Description
IAssignmentVariableNamePart<IQueryBuilder>
| Edit this page View Source

BuildQuery(bool, IQueryOptimiser)

Builds and returns a SparqlQuery.

Declaration
SparqlQuery BuildQuery(bool applyOptimisation = true, IQueryOptimiser queryOptimiser = null)
Parameters
Type Name Description
bool applyOptimisation

Whether to apply query optimisation to the generated SparqlQuery before returning it.
IQueryOptimiser queryOptimiser

The optimiser to apply to the query if applyOptimisation is set to true. If not specified, defaults to the globally scoped SPARQL query optimiser.
Returns
Type Description
SparqlQuery
| Edit this page View Source

GroupBy(Func<INonAggregateExpressionBuilder, SparqlExpression>)

Adds a GROUP BY clause to the query.

Declaration
IQueryBuilder GroupBy(Func<INonAggregateExpressionBuilder, SparqlExpression> buildGroupingExpression)
Parameters
Type Name Description
Func<INonAggregateExpressionBuilder, SparqlExpression> buildGroupingExpression
Returns
Type Description
IQueryBuilder
| Edit this page View Source

GroupBy(string)

Adds a GROUP BY clause to the query.

Declaration
IQueryBuilder GroupBy(string variableName)
Parameters
Type Name Description
string variableName
Returns
Type Description
IQueryBuilder
| Edit this page View Source

GroupBy(SparqlVariable)

Adds a GROUP BY clause to the query.

Declaration
IQueryBuilder GroupBy(SparqlVariable variable)
Parameters
Type Name Description
SparqlVariable variable
Returns
Type Description
IQueryBuilder
| Edit this page View Source

Having(Func<IExpressionBuilder, BooleanExpression>)

Adds a HAVING clause to the query.

Declaration
IQueryBuilder Having(Func<IExpressionBuilder, BooleanExpression> buildHavingConstraint)
Parameters
Type Name Description
Func<IExpressionBuilder, BooleanExpression> buildHavingConstraint
Returns
Type Description
IQueryBuilder
| Edit this page View Source

InlineDataOverQuery(params string[])

Adds a VALUES inline data block to the entire query (outside graph patterns).

Declaration
IInlineDataBuilder InlineDataOverQuery(params string[] variables)
Parameters
Type Name Description
string[] variables
Returns
Type Description
IInlineDataBuilder
| Edit this page View Source

Limit(int)

Applies a LIMIT.

Declaration
IQueryBuilder Limit(int limit)
Parameters
Type Name Description
int limit

Limit value. Pass negative to disable LIMIT.
Returns
Type Description
IQueryBuilder
| Edit this page View Source

Offset(int)

Applies an OFFSET.

Declaration
IQueryBuilder Offset(int offset)
Parameters
Type Name Description
int offset
Returns
Type Description
IQueryBuilder
| Edit this page View Source

OrderBy(Func<IExpressionBuilder, SparqlExpression>)

Adds ascending ordering by an expression to the query.

Declaration
IQueryBuilder OrderBy(Func<IExpressionBuilder, SparqlExpression> buildOrderExpression)
Parameters
Type Name Description
Func<IExpressionBuilder, SparqlExpression> buildOrderExpression
Returns
Type Description
IQueryBuilder
| Edit this page View Source

OrderBy(string)

Adds ascending ordering by a variable to the query.

Declaration
IQueryBuilder OrderBy(string variableName)
Parameters
Type Name Description
string variableName
Returns
Type Description
IQueryBuilder
| Edit this page View Source

OrderBy(SparqlVariable)

Adds ascending ordering by a variable to the query.

Declaration
IQueryBuilder OrderBy(SparqlVariable variable)
Parameters
Type Name Description
SparqlVariable variable
Returns
Type Description
IQueryBuilder
| Edit this page View Source

OrderByDescending(Func<IExpressionBuilder, SparqlExpression>)

Adds descending ordering by an expression to the query.

Declaration
IQueryBuilder OrderByDescending(Func<IExpressionBuilder, SparqlExpression> buildOrderExpression)
Parameters
Type Name Description
Func<IExpressionBuilder, SparqlExpression> buildOrderExpression
Returns
Type Description
IQueryBuilder
| Edit this page View Source

OrderByDescending(string)

Adds descending ordering by a variable to the query.

Declaration
IQueryBuilder OrderByDescending(string variableName)
Parameters
Type Name Description
string variableName
Returns
Type Description
IQueryBuilder
| Edit this page View Source

OrderByDescending(SparqlVariable)

Adds descending ordering by a variable to the query.

Declaration
IQueryBuilder OrderByDescending(SparqlVariable variable)
Parameters
Type Name Description
SparqlVariable variable
Returns
Type Description
IQueryBuilder

Extension Methods