Skip to content

history ¤

Classes:

HistoryBuilderImpl dataclass ¤

HistoryBuilderImpl(
    *,
    endpoint: str,
    ledger: str,
    context: dict[str, Any] | None = None,
    history: HistoryClause | None = None,
    t: TimeClause | None = None,
    commit_details: bool | None = None,
)

Bases: RequestMixin, WithContextMixin['HistoryBuilderImpl'], CommitableMixin['HistoryBuilderImpl'], HistoryBuilder

Implementation of a history query builder.

Methods:

  • acommit –

    Executes the transaction asynchronously.

  • build_request_payload –

    Build the request payload for the history query operation.

  • commit –

    Executes the transaction synchronously.

  • get_url –

    Get the endpoint URL for the history query operation.

  • with_commit_details –

    Add commit details flag to the query.

  • with_history –

    Add history clause to the query.

  • with_t –

    Add time clause to the query.

acommit async ¤

acommit() -> FlureeResponse

Executes the transaction asynchronously.

Raises:

  • RequestError –

    If the HTTP request fails.

  • TypeError –

    If the type parameter cannot be resolved.

build_request_payload ¤

build_request_payload() -> dict[str, Any]

Build the request payload for the history query operation.

commit ¤

commit() -> FlureeResponse

Executes the transaction synchronously.

Raises:

  • RequestError –

    If the HTTP request fails.

  • TypeError –

    If the type parameter cannot be resolved.

get_url ¤

get_url() -> str

Get the endpoint URL for the history query operation.

with_commit_details ¤

with_commit_details(commit_details: bool) -> HistoryBuilderImpl

Add commit details flag to the query.

with_history ¤

with_history(history: HistoryClause) -> HistoryBuilderImpl

Add history clause to the query.

with_t ¤

with_t(t: TimeClause) -> HistoryBuilderImpl

Add time clause to the query.