Types of commands
As you learn about Splunk SPL, you might hear the terms streaming, generating, transforming, orchestrating, and data processing used to describe the types of search commands. This topic explains what these terms mean and lists the commands that fall into each category.
There are six broad categorizations for almost all of the search commands:
- distributable streaming
- centralized streaming
- dataset processing
These categorizations are not mutually exclusive. Some commands fit into only one categorization. The
stats command is an example of a command that fits only into the transforming categorization. Other commands can fit into multiple categorizations. For example a command can be streaming and also generating.
For a complete list of commands that are in each type, see Command types in the Search Reference.
Streaming and non-streaming commands
A streaming command operates on each event as it is returned by a search. Essentially one event in and one (or no) event out.
For example, the
eval command can create a new field,
full_name, to contain the concatenation of the value in the
first_name field, a space, and the value in the
... | eval full_name = first_name." ".last_name
eval command evaluates each event without considering the other events.
A non-streaming command requires the events from all of the indexers before the command can operate on the entire set of events. Many transforming commands are non-streaming commands. There are also several commands that are not transforming commands but that are non-streaming. These non-transforming, non-streaming commands are sometimes referred to as event based non-streaming commands.
For example, before the
sort command can begin to sort the events, the entire set of events must be received by the
sort command. Other examples of non-streaming commands include
dedup (in some modes),
Non-streaming commands force the entire set of events to the search head. This requires a lot of data movement and a loss of parallelism.
For information on how to mitigate the cost of non-streaming commands, see Write better searches in this manual.
The following table describes the processing differences between some of the types of commands.
|Distributable streaming||Centralized streaming||Data processing (non-streaming)||Transforming|
|Can run on indexers||Y||N||N||N|
|Can output before final input||Y||Y||N||N|
|Outputs events if inputs are events||Y||Y||Y||N|
When a command is run it outputs either events or results, based on the type of command. For example, when you run the
sort command, the input is events and the output is events in the sort order you specify. However, transforming commands do not output events. Transforming commands output results. For example the
stats command outputs a table of calculated results. The events used to calculate those results are no longer available. After you run a transforming command, you can't run a command that expects events as an input.
Data processing commands are non-streaming commands that require the entire dataset before the command can run. These commands are not transforming, not distributable, not streaming, and not orchestrating. The
sort command is an example of a data processing command. See Data processing commands.
A streaming command operates on each event returned by a search. For distributable streaming, the order of the events does not matter. A distributable streaming command is a command that can be run on the indexer, which improves processing time. The other commands in a search determine if the distributable streaming command is run on the indexer:
- If all of the commands before the distributable streaming command can be run on the indexer, the distributable streaming command is run on the indexer.
- If any one of the commands before the distributable streaming command must be run on the search head, the remaining commands in the search must be run on the search head. When the search processing moves to the search head, it cannot move back to the indexer.
Distributable streaming commands can be applied to subsets of indexed data in a parallel manner. For example, the
rex command is streaming. It extracts fields and adds them to events at search time.
For a complete list of distributable streaming commands, see Streaming commands in the Search Reference.
For centralized streaming commands, the order of the events matters. A centralized streaming command applies a transformation to each event returned by a search. But unlike distributable streaming commands, a centralized streaming command only works on the search head. You might also hear the term "stateful streaming" to describe these commands.
A transforming command orders the search results into a data table. These commands "transform" the specified cell values for each event into numerical values that Splunk software can use for statistical purposes. Transforming commands are not streaming. Also, transforming commands are required to transform search result data into the data structures that are required for visualizations such as column, bar, line, area, and pie charts.
For more information about transforming commands and their role in create statistical tables and chart visualizations, see About transforming commands and searches in the this manual.
For a complete list of transforming commands, see Transforming commands in the Search Reference.
A generating command fetches information from the indexes, without any transformations. Generating commands are either event-generating (distributable or centralized) or report-generating. Most report-generating commands are also centralized. Depending on which type the command is, the results are returned in a list or a table.
Generating commands do not expect or require an input. Generating commands are usually invoked at the beginning of the search and with a leading pipe. That is, there cannot be a search piped into a generating command. The exception to this is the
search command, because it is implicit at the start of a search and does not need to be invoked.
For a complete list of generating commands, see Generating commands in the Search Reference.
An orchestrating command is a command that controls some aspect of how the search is processed. It does not directly affect the final result set of the search. For example, you might apply an orchestrating command to a search to enable or disable a search optimization that helps the overall search complete faster.
There are a handful of commands that require the entire dataset before the command can run. These commands are referred to as dataset processing commands. These commands are not transforming, not distributable, not streaming, and not orchestrating. Some of these commands fit into other types in specific situations or when specific arguments are used.
For a complete list of dataset processing commands, see Dataset processing commands in the Search Reference.
Types of searches
Search with Splunk Web, CLI, or REST API
This documentation applies to the following versions of Splunk® Enterprise: 7.1.0, 7.1.1, 7.1.2, 7.1.3, 7.1.4, 7.1.5, 7.1.6, 7.1.7, 7.1.8, 7.2.0, 7.2.1, 7.2.2, 7.2.3, 7.2.4, 7.2.5, 7.2.6, 7.2.7, 7.3.0