SPARQL Query Builder

builder

Aggregate

Bases: UnaryBuiltInCall

Abstract base class for aggregates.

And

Bases: LogicExpression

Conjunction.

AskClause

Bases: Clause

ASK clause.

AskQuery

Bases: Query

ASK query.

AtomicGraphPattern

Bases: GraphPattern

Abstract base class for atomic graph patterns.

BNODE

Bases: ZeroAryBuiltInCall

The BNODE built-in.

See https://www.w3.org/TR/sparql11-query/#func-bnode.

BOUND

Bases: UnaryBuiltInCall

The BOUND built-in.

See https://www.w3.org/TR/sparql11-query/#func-bound.

BinaryBuiltInCall

Bases: BuiltInCall

Abstract base class for 2-ary built-in calls.

Bind

Bases: Pattern

Bind pattern.

BooleanExpression

Bases: Expression

Abstract base class for boolean expressions.

BuiltInCall

Bases: Call

Abstract base class for built-in function calls.

COALESCE

Bases: BuiltInCall

The COALESCE built-in.

See https://www.w3.org/TR/sparql11-query/#func-coalesce.

COUNT

Bases: Aggregate

The COUNT aggregate built-in.

COUNT_STAR

Bases: COUNT

The COUNT aggregate built-in with argument set to star (*).

Call

Bases: NumericExpression

Abstract base class for function calls.

Clause

Bases: Encodable

Abstract base class for clauses.

Coerce

Type-checking and coercion functions.

Comment

Bases: Pattern

Comment pattern.

CommentsBlock

Bases: AtomicGraphPattern

Comments block.

CompoundGraphPattern

Bases: GraphPattern

Abstract base class for compound graph patterns.

Encodable

Bases: ABC

Abstract base class for "encodable" objects.

Equal

Bases: RelationalExpression

Equality test.

Expression

Bases: Encodable

Abstract base class for expressions.

Filter

Bases: Pattern

Filter pattern.

FilterNotExistsGraphPattern

Bases: CompoundGraphPattern

FILTER NOT EXISTS graph pattern.

GraphPattern

Bases: Pattern

Abstract base class for graph patterns.

GreaterThan

Bases: RelationalExpression

Greater-than test.

GreaterThanOrEqual

Bases: RelationalExpression

Greater-than-or-equal test.

GroupGraphPattern

Bases: CompoundGraphPattern

Group graph pattern.

IF

Bases: TernaryBuiltInCall

The IF built-in.

See https://www.w3.org/TR/sparql11-query/#func-if.

IsBlank

Bases: UnaryBuiltInCall

The isURI built-in.

See https://www.w3.org/TR/sparql11-query/#func-isBlank.

IsLiteral

Bases: UnaryBuiltInCall

The isLiteral built-in.

See https://www.w3.org/TR/sparql11-query/#func-isLiteral.

IsURI

Bases: UnaryBuiltInCall

The isURI built-in.

See https://www.w3.org/TR/sparql11-query/#func-isIRI.

LANG

Bases: UnaryBuiltInCall

The LANG built-in.

See https://www.w3.org/TR/sparql11-query/#func-lang.

LessThan

Bases: RelationalExpression

Less-than test.

LessThanOrEqual

Bases: RelationalExpression

Less-than-or-equal test.

LimitClause

Bases: Clause

LIMIT clause.

LogicExpression

Bases: BooleanExpression

Abstract base class for logic expressions.

NamedSubSelectBlock

Bases: SubSelectBlock

Named sub-select block.

This is an extension supported by Blazegraph.

See https://github.com/blazegraph/database/wiki/NamedSubquery.

Not

Bases: LogicExpression

Negation.

NotEqual

Bases: RelationalExpression

Not-equal test.

NumericExpression

Bases: BooleanExpression

Abstract base class for numeric expressions.

NumericLiteral

Bases: NumericExpression

Numeric literal.

OffsetClause

Bases: Clause

OFFSET clause.

OptionalGraphPattern

Bases: CompoundGraphPattern

OPTIONAL graph pattern.

Or

Bases: LogicExpression

Disjunction.

OrderByClause

Bases: Clause

ORDER BY clause.

Pattern

Bases: Encodable

Abstract base class for patterns.

Query

Bases: Encodable

Abstract base class for queries.

limit property writable

The value of the LIMIT modifier.

offset property writable

The value of the OFFSET modifier.

order_by property writable

The value of the ORDER BY modifier.

ask(limit=None, offset=None, fresh_var_prefix=None, fresh_var_counter=None, deepcopy=True)

Converts query to an ASK query.

Parameters:

• limit (int | None, default: None ) –

  Limit.

• offset (int | None, default: None ) –

  Offset.

• fresh_var_prefix (_str | None, default: None ) –

  Prefix of fresh variables.

• deepcopy (bool, default: True ) –

  Whether to deep-copy the common clauses.

Returns:

• AskQuery –

  class:AskQuery.

begin_filter_not_exists()

Pushes FILTER NOT EXISTS graph pattern.

Returns:

• FilterNotExistsGraphPattern –

  class:FilterNotExistsGraphPattern.

begin_group()

Pushes group graph pattern.

Returns:

• GroupGraphPattern –

  class:GroupGraphPattern.

begin_optional()

Pushes OPTIONAL graph pattern.

Returns:

• OptionalGraphPattern –

  class:OptionalGraphPattern.

begin_union()

Pushes UNION graph pattern.

Returns:

• UnionGraphPattern –

  class:UnionGraphPattern.

bind(expression, variable)

Pushes BIND.

Parameters:

• expression (TExpression) –

  Expression.

• variable (TVariable) –

  Variable.

Returns:

• Query –

  class:Query.

bnode() classmethod

Constructs :class:BNode.

Returns:

• BNode –

  class:BNode.

clear_user_data()

Clears user-data attached to query.

comments()

Constructs comments block.

Returns:

• CommentsBlock –

  class:CommentsBlock owned by clause.

end_filter_not_exists()

Pops FILTER NOT EXISTS graph pattern.

Returns:

• FilterNotExistsGraphPattern –

  class:FilterNotExistsGraphPattern.

end_group()

Pops group graph pattern.

Returns:

• GroupGraphPattern –

  class:GroupGraphPattern.

end_optional()

Pops OPTIONAL graph pattern.

Returns:

• OptionalGraphPattern –

  class:OptionalGraphPattern.

end_union()

Pops UNION graph pattern.

Returns:

• UnionGraphPattern –

  class:UnionGraphPattern.

filter(expression)

Pushes FILTER.

Parameters:

• expression (TExpression) –

  Expression.

Returns:

• Query –

  class:Query.

filter_not_exists()

Constructs FILTER NOT EXISTS graph pattern.

Returns:

• FilterNotExistsGraphPattern –

  class:FilterNotExistsGraphPattern owned by clause.

fresh_var()

Constructs fresh variable.

Returns:

• Variable –

  class:Variable.

fresh_vars(n)

Constructs one or more fresh variables.

Parameters:

• n (int) –

  The number of fresh variables to construct.

Returns:

• Iterator[Variable] –

  Iterator of :class:Variable.

get_limit()

Gets the value of the LIMIT modifier.

Returns:

• int | None –

  Limit or None.

get_offset()

Gets the value of the OFFSET modifier.

Returns:

• int | None –

  Offset or None.

get_order_by()

Gets the value of the ORDER BY modifier.

Returns:

• Expression | None –

  Order by expression.

get_user_data(key)

Gets the user-data value attached to key in query.

Parameters:

• key (str) –

  Key.

Returns:

• Any –

  Value or None.

group()

Constructs group graph pattern.

Returns:

• GroupGraphPattern –

  class:GroupGraphPattern owned by clause.

literal(content, language=None, datatype=None) classmethod

Constructs :class:Literal.

Parameters:

• content (TLiteral) –

  Literal content.

• language (str | None, default: None ) –

  Literal language.

• datatype (str | None, default: None ) –

  Literal datatype.

Returns:

• Literal –

  class:Literal.

named_subquery(name, query)

Constructs a named sub-select block.

Returns:

• NamedSubSelectBlock –

  class:NamedSubSelectBlock owned by clause.

optional()

Constructs OPTIONAL graph pattern.

Returns:

• OptionalGraphPattern –

  class:OptionalGraphPattern owned by clause.

optional_if(condition)

Constructs OPTIONAL or graph pattern depending on condition.

Parameters:

• condition (bool) –

  Boolean condition.

Returns:

• OptionalGraphPattern | GroupGraphPattern –

  class:OptionalGraphPattern if condition is True;

• OptionalGraphPattern | GroupGraphPattern –

  class:GroupGraphPattern otherwise.

select(*variables, distinct=None, reduced=None, limit=None, offset=None, order_by=None, fresh_var_prefix=None, fresh_var_counter=None, deepcopy=True)

Converts query to a SELECT query.

Parameters:

• variables (TVariable | TInlineBind, default: () ) –

  Variables or inline binds.

• distinct (bool | None, default: None ) –

  Whether to enable distinct modifier.

• reduced (bool | None, default: None ) –

  Whether to enable reduced modifier.

• limit (int | None, default: None ) –

  Limit.

• offset (int | None, default: None ) –

  Offset.

• order_by (TExpression | None, default: None ) –

  Order-by expression.

• fresh_var_prefix (_str | None, default: None ) –

  Prefix of fresh variables.

• deepcopy (bool, default: True ) –

  Whether to deep-copy the common clauses.

Returns:

• SelectQuery –

  class:SelectQuery.

set_limit(limit)

Sets the value of the LIMIT modifier.

Parameters:

• limit (int | None) –

  Limit or None.

set_offset(offset)

Sets the value of the OFFSET modifier.

Parameters:

• offset (int | None) –

  Offset or None.

set_order_by(expression)

Sets the value of the ORDER BY modifier.

Parameters:

• expression (TExpression | None) –

  Expression or None.

set_user_data(key, value)

Attaches user-data value to key in query.

Parameters:

• key (str) –

  Key.

• value (T) –

  Value.

Returns:

• T –

  value.

subquery(query)

Constructs a sub-select block.

Returns:

• SubSelectBlock –

  class:SubSelectBlock owned by clause.

triples()

Constructs triples block.

Returns:

• TriplesBlock –

  class:TriplesBlock owned by clause.

union()

Constructs UNION graph pattern.

Returns:

• UnionGraphPattern –

  class:UnionGraphPattern owned by clause.

unset_user_data(key)

Detaches user-data value from key in query.

Parameters:

• key (str) –

  Key.

Returns:

• Any –

  The detached value or None.

uri(content) classmethod

Constructs :class:URIRef.

Parameters:

• content (T_URI) –

  URI content.

Returns:

• URIRef –

  class:URIRef.

values(*variables)

Constructs VALUES block

Parameters:

• variables (TVariable, default: () ) –

  Variables.

Returns:

• ValuesBlock –

  class:ValuesBlock owned by clause.

var(name) classmethod

Constructs :class:Variable.

Parameters:

• name (TVariable) –

  Variable name.

Returns:

• Variable –

  class:Variable.

vars(name, *names) classmethod

Constructs one or more variables.

Parameter

name: Variable name. names: Variable names.

Returns:

• Iterator[Variable] –

  Iterator of :class:Variable.

where_is_empty()

Tests whether the WHERE clause of query is empty.

Returns:

• bool –

  True if successful; False otherwise.

where_is_nonempty()

Tests whether the WHERE clause of query is nonempty.

Returns:

• bool –

  True if successful; False otherwise.

RelationalExpression

Bases: BooleanExpression

Abstract base class for relational expressions.

STR

Bases: UnaryBuiltInCall

The STR built-in.

See https://www.w3.org/TR/sparql11-query/#func-str.

STRDT

Bases: BinaryBuiltInCall

The STRDT built-in.

See https://www.w3.org/TR/sparql11-query/#func-strdt.

STRLANG

Bases: BinaryBuiltInCall

The STRLANG built-in.

See https://www.w3.org/TR/sparql11-query/#func-strlang.

STRSTARTS

Bases: BinaryBuiltInCall

The STRSTARTS built-in.

See https://www.w3.org/TR/sparql11-query/#func-strstarts.

SelectClause

Bases: Clause

SELECT clause.

SelectQuery

Bases: Query

SELECT query.

distinct property writable

The DISTINCT modifier.

reduced property writable

The REDUCED modifier.

SubSelectBlock

Bases: GraphPattern

Sub-select block.

Symbol

Symbol table.

TernaryBuiltInCall

Bases: BuiltInCall

Abstract base class for 3-ary built-in calls.

Triple

Bases: Pattern

Triple pattern.

TriplesBlock

Bases: AtomicGraphPattern

Triple block.

URI_Call

Bases: Call

URI function call.

UnaryBuiltInCall

Bases: BuiltInCall

Abstract base class for 1-ary built-in calls.

UnionGraphPattern

Bases: CompoundGraphPattern

UNION graph pattern.

ValuesBlock

Bases: AtomicGraphPattern

VALUES block.

ValuesLine

Bases: Pattern

Values line pattern.

WhereClause

Bases: Clause

WHERE clause.

ZeroAryBuiltInCall

Bases: BuiltInCall

Abstract base class for 0-ary built-in calls.