Store

Store

Bases: Engine[TOptions]

Abstract base class for store engines.

Error

Bases: Error

Base class for store errors.

__init__(store_name, *args, base_filter=None, debug=None, distinct=None, distinct_window_size=None, extra_references=None, limit=None, lookahead=None, omega=None, page_size=None, timeout=None, context=None, **kwargs)

Initializes :class:Store.

Parameters:

• store_name (str) –

  Name of the store plugin to instantiate.

• args (Any, default: () ) –

  Arguments.

• base_filter (Filter | None, default: None ) –

  Base filter.

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

  Whether to enable debugging mode.

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

  Whether to suppress duplicates.

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

  Size of distinct look-back window.

• extra_references (TReferenceRecordSet | None, default: None ) –

  Extra references to attach to statements.

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

  Limit (maximum number) of responses.

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

  Number of pages to lookahead asynchronously.

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

  Maximum number of disjoint subqueries.

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

  Page size of paginated responses.

• timeout (float | None, default: None ) –

  Timeout of responses (in seconds).

• context (Context | None, default: None ) –

  Context.

• kwargs (Any, default: {} ) –

  Other keyword arguments.

aask(subject=None, property=None, value=None, snak_mask=None, subject_mask=None, property_mask=None, value_mask=None, rank_mask=None, best_ranked=None, language=None, annotated=None, snak=None, filter=None, base_filter=None, debug=None, distinct=None, distinct_window_size=None, extra_references=None, limit=None, lookahead=None, omega=None, page_size=None, timeout=None, **kwargs) async

Async version of :meth:Store.ask.

acontains(stmt) async

Async version of :meth:Store.contains.

acount(subject=None, property=None, value=None, snak_mask=None, subject_mask=None, property_mask=None, value_mask=None, rank_mask=None, best_ranked=None, language=None, annotated=None, snak=None, filter=None, base_filter=None, debug=None, distinct=None, distinct_window_size=None, extra_references=None, limit=None, lookahead=None, omega=None, page_size=None, timeout=None, **kwargs) async

Async version of :meth:Store.count.

acount_p(subject=None, property=None, value=None, snak_mask=None, subject_mask=None, property_mask=None, value_mask=None, rank_mask=None, best_ranked=None, language=None, annotated=None, snak=None, filter=None, base_filter=None, debug=None, distinct=None, distinct_window_size=None, extra_references=None, limit=None, lookahead=None, omega=None, page_size=None, timeout=None, **kwargs) async

:meth:Store.acount with projection on property.

acount_pv(subject=None, property=None, value=None, snak_mask=None, subject_mask=None, property_mask=None, value_mask=None, rank_mask=None, best_ranked=None, language=None, annotated=None, snak=None, filter=None, base_filter=None, debug=None, distinct=None, distinct_window_size=None, extra_references=None, limit=None, lookahead=None, omega=None, page_size=None, timeout=None, **kwargs) async

:meth:Store.acount with projection on property and value.

acount_s(subject=None, property=None, value=None, snak_mask=None, subject_mask=None, property_mask=None, value_mask=None, rank_mask=None, best_ranked=None, language=None, annotated=None, snak=None, filter=None, base_filter=None, debug=None, distinct=None, distinct_window_size=None, extra_references=None, limit=None, lookahead=None, omega=None, page_size=None, timeout=None, **kwargs) async

:meth:Store.acount with projection on subject.

acount_sp(subject=None, property=None, value=None, snak_mask=None, subject_mask=None, property_mask=None, value_mask=None, rank_mask=None, best_ranked=None, language=None, annotated=None, snak=None, filter=None, base_filter=None, debug=None, distinct=None, distinct_window_size=None, extra_references=None, limit=None, lookahead=None, omega=None, page_size=None, timeout=None, **kwargs) async

:meth:Store.acount with projection on subject and property.

acount_sv(subject=None, property=None, value=None, snak_mask=None, subject_mask=None, property_mask=None, value_mask=None, rank_mask=None, best_ranked=None, language=None, annotated=None, snak=None, filter=None, base_filter=None, debug=None, distinct=None, distinct_window_size=None, extra_references=None, limit=None, lookahead=None, omega=None, page_size=None, timeout=None, **kwargs) async

:meth:Store.acount with projection on subject and value.

acount_v(subject=None, property=None, value=None, snak_mask=None, subject_mask=None, property_mask=None, value_mask=None, rank_mask=None, best_ranked=None, language=None, annotated=None, snak=None, filter=None, base_filter=None, debug=None, distinct=None, distinct_window_size=None, extra_references=None, limit=None, lookahead=None, omega=None, page_size=None, timeout=None, **kwargs) async

:meth:Store.acount with projection on value.

afilter(subject=None, property=None, value=None, snak_mask=None, subject_mask=None, property_mask=None, value_mask=None, rank_mask=None, best_ranked=None, language=None, annotated=None, snak=None, filter=None, base_filter=None, debug=None, distinct=None, distinct_window_size=None, extra_references=None, limit=None, lookahead=None, omega=None, page_size=None, timeout=None, **kwargs)

Async version of :meth:Store.filter.

afilter_annotated(subject=None, property=None, value=None, snak_mask=None, subject_mask=None, property_mask=None, value_mask=None, rank_mask=None, best_ranked=None, language=None, annotated=None, snak=None, filter=None, base_filter=None, debug=None, distinct=None, distinct_window_size=None, extra_references=None, limit=None, lookahead=None, omega=None, page_size=None, timeout=None, _annotate=lambda stmt: stmt.annotate(), **kwargs)

:meth:Store.afilter with annotations.

afilter_p(subject=None, property=None, value=None, snak_mask=None, subject_mask=None, property_mask=None, value_mask=None, rank_mask=None, best_ranked=None, language=None, annotated=None, snak=None, filter=None, base_filter=None, debug=None, distinct=None, distinct_window_size=None, extra_references=None, limit=None, lookahead=None, omega=None, page_size=None, timeout=None, **kwargs)

:meth:Store.afilter with projection on property.

afilter_pv(subject=None, property=None, value=None, snak_mask=None, subject_mask=None, property_mask=None, value_mask=None, rank_mask=None, best_ranked=None, language=None, annotated=None, snak=None, filter=None, base_filter=None, debug=None, distinct=None, distinct_window_size=None, extra_references=None, limit=None, lookahead=None, omega=None, page_size=None, timeout=None, **kwargs)

:meth:Store.afilter with projection on property and value.

afilter_s(subject=None, property=None, value=None, snak_mask=None, subject_mask=None, property_mask=None, value_mask=None, rank_mask=None, best_ranked=None, language=None, annotated=None, snak=None, filter=None, base_filter=None, debug=None, distinct=None, distinct_window_size=None, extra_references=None, limit=None, lookahead=None, omega=None, page_size=None, timeout=None, **kwargs)

:meth:Store.afilter with projection on subject.

afilter_sp(subject=None, property=None, value=None, snak_mask=None, subject_mask=None, property_mask=None, value_mask=None, rank_mask=None, best_ranked=None, language=None, annotated=None, snak=None, filter=None, base_filter=None, debug=None, distinct=None, distinct_window_size=None, extra_references=None, limit=None, lookahead=None, omega=None, page_size=None, timeout=None, **kwargs)

:meth:Store.afilter with projection on subject and property.

afilter_sv(subject=None, property=None, value=None, snak_mask=None, subject_mask=None, property_mask=None, value_mask=None, rank_mask=None, best_ranked=None, language=None, annotated=None, snak=None, filter=None, base_filter=None, debug=None, distinct=None, distinct_window_size=None, extra_references=None, limit=None, lookahead=None, omega=None, page_size=None, timeout=None, **kwargs)

:meth:Store.afilter with projection on subject and value.

afilter_v(subject=None, property=None, value=None, snak_mask=None, subject_mask=None, property_mask=None, value_mask=None, rank_mask=None, best_ranked=None, language=None, annotated=None, snak=None, filter=None, base_filter=None, debug=None, distinct=None, distinct_window_size=None, extra_references=None, limit=None, lookahead=None, omega=None, page_size=None, timeout=None, **kwargs)

:meth:Store.afilter with projection on value.

amix(*sources, base_filter=None, debug=None, distinct=None, distinct_window_size=None, extra_references=None, limit=None, lookahead=None, omega=None, page_size=None, timeout=None, **kwargs) async

Async version of :meth:Store.mix.

ask(subject=None, property=None, value=None, snak_mask=None, subject_mask=None, property_mask=None, value_mask=None, rank_mask=None, best_ranked=None, language=None, annotated=None, snak=None, filter=None, base_filter=None, debug=None, distinct=None, distinct_window_size=None, extra_references=None, limit=None, lookahead=None, omega=None, page_size=None, timeout=None, **kwargs)

Tests whether some statement matches filter.

Parameters:

• subject (TFingerprint | None, default: None ) –

  Entity.

• property (TFingerprint | None, default: None ) –

  Property.

• value (TFingerprint | None, default: None ) –

  Value.

• snak_mask (TSnakMask | None, default: None ) –

  Snak mask.

• subject_mask (TDatatypeMask | None, default: None ) –

  Datatype mask.

• property_mask (TPropertyMask | None, default: None ) –

  Datatype mask.

• value_mask (TDatatypeMask | None, default: None ) –

  Datatype mask.

• rank_mask (TRankMask | None, default: None ) –

  Rank mask.

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

  Best-ranked flag.

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

  Language.

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

  Annotated flag.

• snak (Snak | None, default: None ) –

  Snak.

• filter (Filter | None, default: None ) –

  Filter.

• base_filter (Filter | None, default: None ) –

  Base filter.

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

  Whether to enable debugging mode.

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

  Whether to suppress duplicates.

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

  Size of distinct look-back window.

• extra_references (TReferenceRecordSet | None, default: None ) –

  Extra references to attach to statements.

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

  Limit (maximum number) of responses.

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

  Number of pages to lookahead asynchronously.

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

  Maximum number of disjoint subqueries.

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

  Page size of paginated responses.

• timeout (float | None, default: None ) –

  Timeout of responses (in seconds).

• kwargs (Any, default: {} ) –

  Other keyword arguments.

Returns:

• bool –

  True if successful; False otherwise.

contains(stmt)

Tests whether statement occurs in store.

Parameters:

• stmt (Statement) –

  Statement.

Returns:

• bool –

  True if successful; False otherwise.

count(subject=None, property=None, value=None, snak_mask=None, subject_mask=None, property_mask=None, value_mask=None, rank_mask=None, best_ranked=None, language=None, annotated=None, snak=None, filter=None, base_filter=None, debug=None, distinct=None, distinct_window_size=None, extra_references=None, limit=None, lookahead=None, omega=None, page_size=None, timeout=None, **kwargs)

Counts statements matching filter.

Parameters:

• subject (TFingerprint | None, default: None ) –

  Entity.

• property (TFingerprint | None, default: None ) –

  Property.

• value (TFingerprint | None, default: None ) –

  Value.

• snak_mask (TSnakMask | None, default: None ) –

  Snak mask.

• subject_mask (TDatatypeMask | None, default: None ) –

  Datatype mask.

• property_mask (TPropertyMask | None, default: None ) –

  Datatype mask.

• value_mask (TDatatypeMask | None, default: None ) –

  Datatype mask.

• rank_mask (TRankMask | None, default: None ) –

  Rank mask.

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

  Best-ranked flag.

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

  Language.

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

  Annotated flag.

• snak (Snak | None, default: None ) –

  Snak.

• filter (Filter | None, default: None ) –

  Filter.

• base_filter (Filter | None, default: None ) –

  Base filter.

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

  Whether to enable debugging mode.

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

  Whether to suppress duplicates.

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

  Size of distinct look-back window.

• extra_references (TReferenceRecordSet | None, default: None ) –

  Extra references to attach to statements.

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

  Limit (maximum number) of responses.

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

  Number of pages to lookahead asynchronously.

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

  Maximum number of disjoint subqueries.

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

  Page size of paginated responses.

• timeout (float | None, default: None ) –

  Timeout of responses (in seconds).

• kwargs (Any, default: {} ) –

  Other keyword arguments.

Returns:

• int –

  The number of statements matching filter.

count_p(subject=None, property=None, value=None, snak_mask=None, subject_mask=None, property_mask=None, value_mask=None, rank_mask=None, best_ranked=None, language=None, annotated=None, snak=None, filter=None, base_filter=None, debug=None, distinct=None, distinct_window_size=None, extra_references=None, limit=None, lookahead=None, omega=None, page_size=None, timeout=None, **kwargs)

:meth:Store.count with projection on property.

count_pv(subject=None, property=None, value=None, snak_mask=None, subject_mask=None, property_mask=None, value_mask=None, rank_mask=None, best_ranked=None, language=None, annotated=None, snak=None, filter=None, base_filter=None, debug=None, distinct=None, distinct_window_size=None, extra_references=None, limit=None, lookahead=None, omega=None, page_size=None, timeout=None, **kwargs)

:meth:Store.count with projection on subject and value.

count_s(subject=None, property=None, value=None, snak_mask=None, subject_mask=None, property_mask=None, value_mask=None, rank_mask=None, best_ranked=None, language=None, annotated=None, snak=None, filter=None, base_filter=None, debug=None, distinct=None, distinct_window_size=None, extra_references=None, limit=None, lookahead=None, omega=None, page_size=None, timeout=None, **kwargs)

:meth:Store.count with projection on subject.

count_sp(subject=None, property=None, value=None, snak_mask=None, subject_mask=None, property_mask=None, value_mask=None, rank_mask=None, best_ranked=None, language=None, annotated=None, snak=None, filter=None, base_filter=None, debug=None, distinct=None, distinct_window_size=None, extra_references=None, limit=None, lookahead=None, omega=None, page_size=None, timeout=None, **kwargs)

:meth:Store.count with projection on subject and property.

count_sv(subject=None, property=None, value=None, snak_mask=None, subject_mask=None, property_mask=None, value_mask=None, rank_mask=None, best_ranked=None, language=None, annotated=None, snak=None, filter=None, base_filter=None, debug=None, distinct=None, distinct_window_size=None, extra_references=None, limit=None, lookahead=None, omega=None, page_size=None, timeout=None, **kwargs)

:meth:Store.count with projection on subject and value.

count_v(subject=None, property=None, value=None, snak_mask=None, subject_mask=None, property_mask=None, value_mask=None, rank_mask=None, best_ranked=None, language=None, annotated=None, snak=None, filter=None, base_filter=None, debug=None, distinct=None, distinct_window_size=None, extra_references=None, limit=None, lookahead=None, omega=None, page_size=None, timeout=None, **kwargs)

:meth:Store.count with projection on value.

default_base_filter()

The default value for :attr:Store.base_filter.

default_distinct()

The default value for :attr:Store.distinct.

default_distinct_window_size()

The default value for :attr:Store.distinct_window_size.

default_extra_references()

The default value for :attr:Store.extra_references.

default_omega()

The default value for :attr:Store.omega.

filter(subject=None, property=None, value=None, snak_mask=None, subject_mask=None, property_mask=None, value_mask=None, rank_mask=None, best_ranked=None, language=None, annotated=None, snak=None, filter=None, base_filter=None, debug=None, distinct=None, distinct_window_size=None, extra_references=None, limit=None, lookahead=None, omega=None, page_size=None, timeout=None, **kwargs)

Searches for statements matching filter.

Parameters:

• subject (TFingerprint | None, default: None ) –

  Entity.

• property (TFingerprint | None, default: None ) –

  Property.

• value (TFingerprint | None, default: None ) –

  Value.

• snak_mask (TSnakMask | None, default: None ) –

  Snak mask.

• subject_mask (TDatatypeMask | None, default: None ) –

  Datatype mask.

• property_mask (TPropertyMask | None, default: None ) –

  Datatype mask.

• value_mask (TDatatypeMask | None, default: None ) –

  Datatype mask.

• rank_mask (TRankMask | None, default: None ) –

  Rank mask.

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

  Best-ranked flag.

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

  Language.

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

  Annotated flag.

• snak (Snak | None, default: None ) –

  Snak.

• filter (Filter | None, default: None ) –

  Filter.

• base_filter (Filter | None, default: None ) –

  Base filter.

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

  Whether to enable debugging mode.

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

  Whether to suppress duplicates.

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

  Size of distinct look-back window.

• extra_references (TReferenceRecordSet | None, default: None ) –

  Extra references to attach to statements.

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

  Limit (maximum number) of responses.

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

  Number of pages to lookahead asynchronously.

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

  Maximum number of disjoint subqueries.

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

  Page size of paginated responses.

• timeout (float | None, default: None ) –

  Timeout of responses (in seconds).

• kwargs (Any, default: {} ) –

  Other keyword arguments.

Returns:

• Iterator[Statement] –

  An iterator of statements matching filter.

filter_annotated(subject=None, property=None, value=None, snak_mask=None, subject_mask=None, property_mask=None, value_mask=None, rank_mask=None, best_ranked=None, language=None, annotated=None, snak=None, filter=None, base_filter=None, debug=None, distinct=None, distinct_window_size=None, extra_references=None, limit=None, lookahead=None, omega=None, page_size=None, timeout=None, _annotate=lambda stmt: stmt.annotate(), **kwargs)

:meth:Store.filter with annotations.

filter_p(subject=None, property=None, value=None, snak_mask=None, subject_mask=None, property_mask=None, value_mask=None, rank_mask=None, best_ranked=None, language=None, annotated=None, snak=None, filter=None, base_filter=None, debug=None, distinct=None, distinct_window_size=None, extra_references=None, limit=None, lookahead=None, omega=None, page_size=None, timeout=None, **kwargs)

:meth:Store.filter with projection on property.

filter_pv(subject=None, property=None, value=None, snak_mask=None, subject_mask=None, property_mask=None, value_mask=None, rank_mask=None, best_ranked=None, language=None, annotated=None, snak=None, filter=None, base_filter=None, debug=None, distinct=None, distinct_window_size=None, extra_references=None, limit=None, lookahead=None, omega=None, page_size=None, timeout=None, **kwargs)

:meth:Store.filter with projection on property and value.

filter_s(subject=None, property=None, value=None, snak_mask=None, subject_mask=None, property_mask=None, value_mask=None, rank_mask=None, best_ranked=None, language=None, annotated=None, snak=None, filter=None, base_filter=None, debug=None, distinct=None, distinct_window_size=None, extra_references=None, limit=None, lookahead=None, omega=None, page_size=None, timeout=None, **kwargs)

:meth:Store.filter with projection on subject.

filter_sp(subject=None, property=None, value=None, snak_mask=None, subject_mask=None, property_mask=None, value_mask=None, rank_mask=None, best_ranked=None, language=None, annotated=None, snak=None, filter=None, base_filter=None, debug=None, distinct=None, distinct_window_size=None, extra_references=None, limit=None, lookahead=None, omega=None, page_size=None, timeout=None, **kwargs)

:meth:Store.filter with projection on subject and property.

filter_sv(subject=None, property=None, value=None, snak_mask=None, subject_mask=None, property_mask=None, value_mask=None, rank_mask=None, best_ranked=None, language=None, annotated=None, snak=None, filter=None, base_filter=None, debug=None, distinct=None, distinct_window_size=None, extra_references=None, limit=None, lookahead=None, omega=None, page_size=None, timeout=None, **kwargs)

:meth:Store.filter with projection on subject and value.

filter_v(subject=None, property=None, value=None, snak_mask=None, subject_mask=None, property_mask=None, value_mask=None, rank_mask=None, best_ranked=None, language=None, annotated=None, snak=None, filter=None, base_filter=None, debug=None, distinct=None, distinct_window_size=None, extra_references=None, limit=None, lookahead=None, omega=None, page_size=None, timeout=None, **kwargs)

:meth:Store.filter with projection on value.

get_annotated()

Gets the annotated flag of the base filter of store.

Returns:

• bool –

  Annotated flag.

get_base_filter()

Gets the base filter of store.

Returns:

• Filter –

  Filter.

get_best_ranked()

Gets the best-ranked flag of the base filter of store.

Returns:

• bool –

  Best-ranked flag.

get_default_base_filter()

Gets the default value for :attr:Store.base_filter.

Returns:

• Filter –

  Default filter.

get_default_distinct()

Gets the default value for :attr:Store.distinct.

Returns:

• bool –

  Default distinct flag.

get_default_distinct_window_size()

Gets the default value for :attr:Store.distinct_window_size.

Returns:

• int –

  Default distinct window-size.

get_default_extra_references()

Gets the default value for :attr:Store.extra_references.

Returns:

• ReferenceRecordSet –

  Reference record set.

get_default_omega()

Gets the default value for :attr:Store.omega.

Returns:

• int –

  Default omega value.

get_distinct()

Gets the distinct flag of store.

Returns:

• bool –

  Distinct flag.

get_distinct_window_size()

Gets the distinct window-size of store.

Returns:

• int –

  Page size.

get_extra_references()

Gets the extra references of store.

Returns:

• ReferenceRecordSet –

  Reference record set.

get_language()

Gets the language of the base filter of store.

Returns:

• str | None –

  Language.

get_max_distinct_window_size()

Gets the maximum value for :attr:Store.distinct_window_size.

Returns:

• int –

  Maximum distinct window-size.

get_omega()

Gets the omega of store.

Returns:

• int –

  Omega.

get_property()

Gets the property fingerprint of the base filter of store.

Returns:

• Fingerprint –

  Fingerprint.

get_property_mask()

Gets the property mask of the base filter of store.

Returns:

• PropertyMask –

  Datatype mask.

get_rank_mask()

Gets the rank mask of the base filter of store.

Returns:

• RankMask –

  Datatype mask.

get_snak_mask()

Gets the snak mask of the base filter of store.

Returns:

• SnakMask –

  Snak mask.

get_subject()

Gets the subject fingerprint of the base filter of store.

Returns:

• Fingerprint –

  Fingerprint.

get_subject_mask()

Gets the subject mask of the base filter of store.

Returns:

• DatatypeMask –

  Datatype mask.

get_value()

Gets the value fingerprint of the base filter of store.

Returns:

• Fingerprint –

  Fingerprint.

get_value_mask()

Gets the value mask of the base filter of store.

Returns:

• DatatypeMask –

  Datatype mask.

max_distinct_window_size()

The maximum value for :attr:Store.distinct_window_size.

mix(*sources, base_filter=None, debug=None, distinct=None, distinct_window_size=None, extra_references=None, limit=None, lookahead=None, omega=None, page_size=None, timeout=None, **kwargs)

Mixes sources of statement.

If source is a :class:Filter, evaluates it over store it to obtain a statement iterator.

Parameters:

• sources (Filter | Iterable[Statement], default: () ) –

  Sources to mix.

• base_filter (Filter | None, default: None ) –

  Base filter.

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

  Whether to enable debugging mode.

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

  Whether to suppress duplicates.

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

  Size of distinct look-back window.

• extra_references (TReferenceRecordSet | None, default: None ) –

  Extra references to attach to statements.

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

  Limit (maximum number) of responses.

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

  Number of pages to lookahead asynchronously.

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

  Maximum number of disjoint subqueries.

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

  Page size of paginated responses.

• timeout (float | None, default: None ) –

  Timeout of responses (in seconds).

• kwargs (Any, default: {} ) –

  Other keyword arguments.

Returns:

• Iterator[Statement] –

  An iterator of statements.

set_annotated(annotated)

Sets the annotated flag of the base filter of store.

Parameters:

• annotated (bool) –

  Annotated flag.

set_base_filter(base_filter=None)

Sets the base filter of store.

If filter is None, resets it to the default.

Parameters:

• base_filter (Filter | None, default: None ) –

  Filter.

set_best_ranked(best_ranked)

Sets the best-ranked flag of the base filter of store.

Parameters:

• best_ranked (bool) –

  Best-ranked flag.

set_distinct(distinct=None)

Sets the distinct flag of store.

If distinct is None, resets it to the default.

Parameters:

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

  Distinct flag.

set_distinct_window_size(distinct_window_size=None)

Sets the page size of store.

If distinct_window_size is negative or zero, assumes 1.

If distinct_window_size is None, resets it to the default.

Parameters:

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

  Page size.

set_extra_references(extra_references=None)

Sets the extra references of store.

If extra_references is None, resets it to the default.

Parameters:

• extra_references (TReferenceRecordSet | None, default: None ) –

  Reference record set.

set_language(language)

Sets the language of the base filter of store.

Parameters:

• language (TTextLanguage | None) –

  Language.

set_omega(omega=None)

Sets the omega of store.

If omega is negative, assumes one.

If omega is None, resets it to the default.

Parameters:

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

  Omega.

set_property(property)

Sets the property fingerprint of the base filter of store.

If property is None, assumes the full fingerprint.

Parameters:

• property (TFingerprint) –

  Fingerprint.

set_property_mask(property_mask)

Sets the property mask of the base filter of store.

Parameters:

• property_mask (TPropertyMask) –

  Property mask.

set_rank_mask(rank_mask)

Sets the rank mask of the base filter of store.

Parameters:

• rank_mask (TRankMask) –

  Datatype mask.

set_snak_mask(snak_mask)

Sets the snak mask of the base filter of store.

Parameters:

• snak_mask (TSnakMask) –

  Snak mask.

set_subject(subject=None)

Sets the subject fingerprint of the base filter of store.

If subject is None, assumes the full fingerprint.

Parameters:

• subject (TFingerprint | None, default: None ) –

  Fingerprint.

set_subject_mask(subject_mask)

Sets the subject mask of the base filter of store.

Parameters:

• subject_mask (TDatatypeMask) –

  Datatype mask.

set_value(value)

Sets the value fingerprint of the base filter of store.

If value is None, assumes the full fingerprint.

Parameters:

• value (TFingerprint) –

  Fingerprint.

set_value_mask(value_mask)

Sets the value mask of the base filter of store.

Parameters:

• value_mask (TDatatypeMask) –

  Datatype mask.