Types in signatures

Method signatures name these types. They describe what an argument accepts; pass the plain values shown.

Query

str | dict: SPARQL or Cypher text, or a JSON-LD query.

Data

str | dict | list | os.PathLike: JSON-LD (a dict, a list, or JSON text), Turtle or TriG text, or a path to a file holding any of them.

Format

"jsonld" | "turtle" | "trig": the format of written data, when the text or file extension does not settle it.

ExportFormat

"turtle" | "trig" | "ntriples" | "nquads" | "jsonld".

Language

"sparql" | "cypher" | "jsonld": a query’s language, when its text does not settle it.

SelectLanguage

"sparql" | "cypher": the languages whose queries return a table.

SqlDialect

"trino" | "postgres" | "mysql" | "sqlite".

MergeStrategy

"take-both" | "abort" | "take-source" | "take-branch": how a merge settles a property both branches changed; see fluree.Ledger.merge().

RebaseStrategy

"take-both" | "abort" | "take-source" | "take-branch" | "skip"; see fluree.Ledger.rebase().

RevertStrategy

"abort" | "take-source" | "take-branch"; see fluree.Ledger.revert().

CommitRef

int | str | Commit: a commit’s t, its id, a prefix of its hex digest, or a fluree.Commit.

Secret

str | EnvVar: a value, or a fluree.EnvVar naming the environment variable to read it from.

Auth

fluree.Bearer or fluree.OAuth2.