Core LibraryunreleasedAPI Reference

Choose documentation 1

latest

Current version

latest
English

Unreleased libtmux_erlang has not been released. Its API may change during development. This site's structure and URLs may change too.

typealias libtmux-erlang latest

tmux_query:plan/0

Pure explanation of a query. pushdown reports whether candidate exclusion is enabled (disabled by default). residual is the full portable predicate, required lists coverage requirements, and limit applies after residual evaluation. ordering and deduplication name the identity policy, not arbitrary map order. capabilities describes the planner baseline without probing a live endpoint.

Source and package
Qualified name
tmux_query:plan/0
Declared in
tmux_query
Package
libtmux_erlang
Source
apps/libtmux_erlang/src/tmux_query.erl
-type plan() :: #{entity := tmux_schema:entity(), pushdown := boolean(), candidate := candidate(), residual := tmux_filter:wire_document(), required := [tmux_snapshot:requirement()], limit := infinity | 0..65536, commands := command_plan(), hydration := complete_graph, ordering := session_index_window | numeric_id, deduplication := membership | physical_id, capabilities := #{minimum_tmux := binary(), transport := one_shot}, consistency := observed, atomic := false, candidate_scalars := same_row_checked_against_spine, text_and_relations := later_observations, temporal_limit := excluded_rows_cannot_be_recovered}.

Description#

Capture spans commands. Candidate scalar values are checked against the first scan; text and relationships are later observations. Excluded rows cannot be recovered after state changes. Even an exact candidate is not an atomic query.

Esc

Type to search.

Reference previewOpen reference