LibTmux.Get-TmuxQueryPlan
Inspect how a query will run against a known tmux version.
Source and package
- Qualified name
-
LibTmux\ Get-Tmux Query Plan - Declared in
LibTmux- Package
- LibTmux
- Source
- src/LibTmux.PowerShell/GetTmuxQueryPlanCommand.cs
- Get-TmuxQueryPlan [-Query] <Lib
Tmux > -Daemon.Query .Query Document Version <LibTmux > [-Pushdown <Lib.Tmux Version Tmux >] [<Common.Query .Query Pushdown Parameters >] -
Description#
Prepare a native query plan without contacting tmux. The plan exposes pushed and residual predicates, required fields, snapshot depth and fallback reasons. Displaying the plan or reading its properties performs no I/O. Pass it to
Invoke-TmuxQuerywith an explicit server to execute it.Autoevaluates supported conditions inside tmux and the remainder locally.Neverevaluates the complete predicate locally.Requirerejects predicates that need local evaluation.Allmodes retain the complete acquired graph; source evaluation does not reduce the captured rows.Notes
Invalid or unsupported planning terminates with
Tmux.QueryPlanFailed. Planning does not discover the installed client or daemon version.Command details#
- Command type
cmdlet- Positional binding
- Enabled.
- Pipeline inputs
LibTmux.Query.QueryDocument: A query document.- Outputs
LibTmux.Query.QueryPlan[LibTmux.Session],LibTmux.Query.QueryPlan[LibTmux.Window],LibTmux.Query.QueryPlan[LibTmux.Pane]
Examples#
Example 1 Prepare an exact pane-ID query for tmux 3.3a without opening a connection. Use the observed daemon version when preparing a plan for execution. View source
Terminal window $version = [LibTmux.TmuxVersion]::Parse('3.3a')LibTmux\New-TmuxQuery -Target Pane -Criteria @{ Id = '%0' } |LibTmux\Get-TmuxQueryPlan -DaemonVersion $version -Pushdown Require- Parameters
-
-
-Query(LibTmux ) #.Query .Query Document A native
Session,WindoworPanedocument.- Required
- Yes
- Position
- 0
- Pipeline input
- By value
- Validation
ValidateNotNull()
-
-DaemonVersion(LibTmux ) #.Tmux Version The known daemon version. Execution verifies it against the selected endpoint.
- Required
- Yes
- Position
- Named
- Pipeline input
- No
-
-Pushdown(LibTmux ) #.Query .Query Pushdown Where predicates may be evaluated.
Requireconcerns predicate evaluation; parsing and object construction still occur locally.- Required
- No
- Position
- Named
- Pipeline input
- No
- Default
Auto- Validation
ValidateSet(["Auto","Never","Require"])
Common parameters 12
PowerShell supplies these parameters. See common parameter behavior for their effects.
-
-Verbose(System.Management ) #.Automation .Switch Parameter Display verbose messages produced by this command.
Aliases:vbMicrosoft Learn reference -
-Debug(System.Management ) #.Automation .Switch Parameter Display debug messages produced by this command.
Aliases:dbMicrosoft Learn reference -
-ErrorAction(System.Management ) #.Automation .Action Preference Choose how this command responds to non-terminating errors.
Aliases:eaMicrosoft Learn reference -
-WarningAction(System.Management ) #.Automation .Action Preference Choose how this command responds to warning messages.
Aliases:waMicrosoft Learn reference -
-InformationAction(System.Management ) #.Automation .Action Preference Choose how this command handles information messages.
Aliases:infaMicrosoft Learn reference -
-ProgressAction(System.Management ) #.Automation .Action Preference Choose how this command handles progress updates.
Aliases:progaMicrosoft Learn reference -
-ErrorVariable(System.String ) #Store the command's error records in the named variable.
Aliases:evMicrosoft Learn reference -
-WarningVariable(System.String ) #Store the command's warning records in the named variable.
Aliases:wvMicrosoft Learn reference -
-InformationVariable(System.String ) #Store the command's information records in the named variable.
Aliases:ivMicrosoft Learn reference -
-OutVariable(System.String ) #Save output in the named variable while passing it down the pipeline.
Aliases:ovMicrosoft Learn reference -
Buffer output before passing it to the next pipeline command.
Aliases:obMicrosoft Learn reference -
-PipelineVariable(System.String ) #Make the most recent output object available through a named variable within the pipeline.
Aliases:pvMicrosoft Learn reference
-
- Returns
-
LibTmux.Query.QueryPlan<T>:Onenative plan targetingSession,WindoworPane.
Guides#
Pages that discuss Get-TmuxQueryPlan.