Splunk® Enterprise

Search Reference

Download manual as PDF

This documentation does not apply to the most recent version of Splunk. Click here for the latest version.
Download topic as PDF

Command types

There are four broad types for all of the search commands: distributable streaming, centralized streaming, transforming, generating.

The following tables list the commands that fit into each of these types. For detailed explanations about each of the types, see Types of commands in the Search Manual.

Streaming commands

A streaming command operates on each event as the event is returned by a search.

  • A distributable streaming command runs on the indexer or the search head, depending on where in the search the command is invoked. Distributable streaming commands can be applied to subsets of indexed data in a parallel manner.
  • A centralized streaming command applies a transformation to each event returned by a search. Unlike distributable streaming commands, a centralized streaming command only works on the search head.

Command Notes
addinfo Distributable streaming
autoregress Centralized streaming.
bin Streaming if specified with the span argument.
cluster Streaming in some modes.
convert Distributable streaming.
dedup Streaming in some modes.
eval Distributable streaming.
extract Distributable streaming.
fieldformat Distributable streaming.
fields Distributable streaming.
fillnull Streaming with specific arguments.
head Centralized streaming.
highlight Distributable streaming.
iconify Distributable streaming.
iplocation Distributable streaming.
join Centralized streaming, as long as there is a defined set of fields to join to.
lookup Distributable streaming when specified with local=false
makemv Distributable streaming.
multikv Distributable streaming.
mvexpand Distributable streaming.
nomv Distributable streaming.
rangemap Distributable streaming.
regex Distributable streaming.
reltime Distributable streaming.
rename Distributable streaming.
replace Distributed streaming.
rex Distributable streaming.
search Distributable streaming if used further down the search pipeline. Generating when the first command in the search.
spath Distributable streaming.
strcat Distributable streaming.
streamstats Centralized streaming.
tags Distributable streaming.
transaction Centralized streaming.
typer Distributable streaming.
where Distributable streaming.
untable Distributable streaming.
xmlkv Distributable streaming.
xpath Distributable streaming.
xyseries Distributable streaming if the argument grouped=false>, otherwise Transforming

Generating commands

A generating command generates events or reports from one or more indexes without transforming the events.

Command Notes
crawl Report-generating.
datamodel Report-generating
dbinspect Report-generating.
eventcount Report-generating.
from Can be either report-generating or event-generating depending on the search or knowledge object that is referenced by the command.
inputcsv Event-generating (centralized).
Inputlookup Event-generating (centralized) when append=false, which is the default.
loadjob Event-generating (centralized).
makeresults Report-generating.
metadata Report-generating. Although metadata fetches data from all peers, any command run after it runs only on the search head.
multisearch Event-generating.
pivot Report-generating.
search Event-generating (distributable) when the first command in the search, which is the default. Distributable streaming if used as a subsearch.
searchtxn Event-generating.
set Event-generating.
tstats Report-generating.

Transforming commands

A transforming command orders the results into a data table. The command "transforms" the specified cell values for each event into numerical values for statistical purposes.

Note: In earlier versions of Splunk software, transforming commands were referred to as "reporting commands."

Command Notes
addtotals Transforming when used to calculate column totals (not row totals).
xyseries Transforming if grouped=true, otherwise distributable streaming.
Commands by category
Splunk SPL for SQL users

This documentation applies to the following versions of Splunk® Enterprise: 6.5.0, 6.5.1, 6.5.1612 (Splunk Cloud only), 6.5.2, 6.5.3, 6.5.4, 6.5.5, 6.6.0, 6.6.1, 6.6.2, 6.6.3

Was this documentation topic helpful?

Enter your email address, and someone from the documentation team will respond to you:

Please provide your comments here. Ask a question or make a suggestion.

You must be logged into splunk.com in order to post comments. Log in now.

Please try to keep this discussion focused on the content covered in this documentation topic. If you have a more general question about Splunk functionality or are experiencing a difficulty with Splunk, consider posting a question to Splunkbase Answers.

0 out of 1000 Characters