inputlookup command to search the contents of a lookup table. The lookup table can be a CSV lookup or a KV store lookup.
The required syntax is in bold.
- | inputlookup
- [<filename> | <tablename>]
- [WHERE <search-query>]
You must specify either a <filename> or a <tablename>.
- Syntax: <string>
- Description: The name of the lookup file must end with
.csv.gz. If the lookup does not exist, a warning message is displayed (but no syntax error is generated).
- Syntax: <string>
- Description: The name of the lookup table as specified by a stanza name in the
transforms.conffile. The lookup table can be configured for any lookup type (CSV, external, or KV store).
- Syntax: append=<bool>
- Description: If set to
true, the data returned from the lookup file is appended to the current set of results rather than replacing it. Defaults to
- Syntax: strict=<bool>
- Description: When set to
truethis argument forces the search to fail completely if
inputlookupraises an error. This happens even when the errors apply to a subsearch. When set to
inputlookuperror conditions return warning messages but do not otherwise cause the search to fail. Certain error conditions cause the search to fail even when
- Default: false
- Syntax max=<int>
- Description: Specify the maximum number of events to be read from the file. Defaults to
- Syntax: start=<int>
- Description: Specify the 0-based offset of the first event to read. If
start=0, it begins with the first event. If
start=4, it begins with the fifth event. Defaults to 0.
- WHERE clause
- Syntax: WHERE <search-query>
- Description: Use this clause to improve search performance by prefiltering data returned from the lookup table. Supports a limited set of search query operators: =, !=, <, >, <=, >=, AND, OR, NOT. Any combination of these operators is permitted. Also supports wildcard string searches.
Generating commands use a leading pipe character and should be the first command in a search.
The lookup can be a file name that ends with
.csv.gz, or a lookup table definition in Settings > Lookups > Lookup definitions.
Appending or replacing results
append=true, data from the lookup file or KV store collection is appended to the current set of results. By default,
append=false which means that the current result set is replaced with the results from the lookup search.
Working with large CSV lookup tables
The WHERE clause allows you to narrow the scope of the query that
inputlookup makes against the lookup table. It restricts
inputlookup to a smaller number of lookup table rows, which can improve search efficiency when you are working with significantly large lookup tables.
Testing geometric lookup files
You can use the
inputlookup command to verify that the geometric features on the map are correct. The syntax is
| inputlookup <your_lookup>.
- For example, to verify that the geometric features in built-in geo_us_states lookup appear correctly on the choropleth map, run the following search:
| inputlookup geo_us_states
- On the Visualizations tab, zoom in to see the geometric features. In this example, the states in the United States.
Strict error handling
strict argument to make
inputlookup searches fail whenever they encounter an error condition. You can set this at the system level for all
inputlookup searches by changing
If you use Cloud, file a request with Cloud support to change the
strict argument to override the
input_errors_fatal setting for an
For more information about creating lookups, see About lookups in the Knowledge Manager Manual.
For more information about the App Key Value store, see About KV store in the Admin Manual.
1. Read in a lookup table
Read in a
usertogroup lookup table that is defined in the
| inputlookup usertogroup
2. Append lookup table fields to the current search results
Read in a
usertogroup lookup table that is defined by a stanza in the
transforms.conf file. Append the fields to any current results.
| inputlookup append=t usertogroup
3. Read in a lookup table in a CSV file
users.csv lookup file, which is in the
| inputlookup users.csv
4. Read in a lookup table from a KV store collection
Search the contents of the KV store collection
kvstorecoll that have a
CustID value greater than 500 and a
CustName value that begins with the letter P. The collection is referenced in a lookup table called
kvstorecoll_lookup. Provide a count of the events received from the table.
| inputlookup kvstorecoll_lookup where (CustID>500) AND (CustName="P*")
| stats count
In this example, the lookup definition explicitly defines the
CustID field as a type of "number". If the field type is not explicitly defined, the where clause does not work. Defining field types is optional.
5. View the internal key ID values for the KV store collection
Example 5: View internal key ID values for the KV store collection
kvstorecoll, using the lookup table
kvstorecoll_lookup. The internal key ID is a unique identifier for each record in the collection. This example uses the
| inputlookup kvstorecoll_lookup
| eval CustKey = _key
| table CustKey, CustName, CustStreet, CustCity, CustState, CustZip
6. Update field values for a single KV store collection record
Update field values for a single KV store collection record. This example uses the
eval commands. The record is indicated by the its internal key ID (the
_key field) and this search updates the record with a new customer name and customer city. The record belongs to the KV store collection
kvstorecoll, which is accessed through the lookup table
| inputlookup kvstorecoll_lookup
| search _key=544948df3ec32d7a4c1d9755
| eval CustName="Claudia Garcia"
| eval CustCity="San Francisco"
| outputlookup kvstorecoll_lookup append=true key_field=_key
7. Write the contents of a CSV file to a KV store collection
Write the contents of a CSV file to the KV store collection
kvstorecoll using the lookup table
kvstorecoll_lookup. The CSV file is in the
| inputlookup customers.csv
| outputlookup kvstorecoll_lookup
This documentation applies to the following versions of Splunk® Enterprise: 8.1.0