common

Functions:

• is_time_commit –

  Checks if a value is a valid time commit.

• is_time_constraint –

  Checks if a value is a valid time constraint.

Attributes:

• Context (TypeAlias) –

  A W3C JSON-LD context for a FlureeQL request.

• LedgerName (TypeAlias) –

  A textal name for the ledger.

• Predicate (TypeAlias) –

  A predicate identifier in a FlureeQL query.

• Subject (TypeAlias) –

  A textual identifier for a subject.

• TimeClause (TypeAlias) –

  A time clause for a FlureeQL query. It is either a commit number or a constraint on the commit.

• Wildcard (TypeAlias) –

  A wildcard character in a FlureeQL query.

Context module-attribute

Context: TypeAlias = JsonObject

A W3C JSON-LD context for a FlureeQL request.

LedgerName module-attribute

LedgerName: TypeAlias = str

A textal name for the ledger.

Predicate module-attribute

Predicate: TypeAlias = str

A predicate identifier in a FlureeQL query.
A predicate is a string that identifies a property or relationship in the database.

Examples:

"schema:name"
"schema:age"
"schema:friend"

Subject module-attribute

Subject: TypeAlias = str

A textual identifier for a subject.

TimeClause module-attribute

TimeClause: TypeAlias = TimeConstraint | TimeCommit

A time clause for a FlureeQL query. It is either a commit number or a constraint on the commit.

Examples:

• {"t": {"at": 123}}
• {"t": {"from": 123, "to": 456}}
• {"t": 123}

Wildcard module-attribute

Wildcard: TypeAlias = Literal['*']

A wildcard character in a FlureeQL query.
The wildcard character is used to select all predicates of a subject.

Examples:

"*"

is_time_commit

is_time_commit(t: Any) -> TypeGuard[TimeCommit]

Checks if a value is a valid time commit.

is_time_constraint

is_time_constraint(t: Any) -> TypeGuard[TimeConstraint]

Checks if a value is a valid time constraint.