Related Answers
Download topic as PDF
datamodel
Description
Examine data model or data model object and search a data model object.
Use the datamodel command to return the JSON for all or a specified data model and its objects. You can also search against the specified data model object.
A data model is a hierarchically-structured search-time mapping of semantic knowledge about one or more datasets. A data model encodes the domain knowledge necessary to build a variety of specialized searches of those datasets. These specialized searches are in turn used by the search to generate reports for Pivot users. For more information, see "About data models" and "Design data model objects" in the Knowledge Manager Manual.
The datamodel search command lets you search existing data models and their objects from the search interface.
The datamodel command is a generating command and should be the first command in the search. Generating commands use a leading pipe character.
Syntax
| datamodel [<data model name>] [<object name>] [<search>]
Required arguments
None
Optional arguments
- data model name
- Syntax: <string>
- Description: The name of the data model to search. When only the data model is specified, the search returns the JSON for the single data model.
- object name
- Syntax: <string>
- Description: The name of a data model object to search. Must be specified after the data model name. The search returns the JSON for the single object.
- search
- Syntax: <search>
- Description: Indicates to run the search associated with the specified data model and object. For more information, see the search command.
Usage
The datamodel command is a generating command and should be the first command in the search. Generating commands use a leading pipe character.
Examples
The following examples are created using data from the "Data Model and Pivot Tutorial".
Example 1:
Return JSON for all data models available in the current app context.
| datamodel
Example 2:
Return JSON for the "Buttercup Games" data model, which has the model ID "Tutorial".
| datamodel Tutorial
Example 3:
Return JSON for Buttercup Games's Client_errors object.
| datamodel Tutorial Client_errors
Example 4:
Run the search for Buttercup Games's Client_errors.
| datamodel Tutorial Client_errors search
Example 5:
Search Buttercup Games's Client_errors object for 404 errors and count the number of events.
| datamodel Tutorial Client_errors search | search status=404 | stats count
See also
Answers
Have questions? Visit Splunk Answers and see what questions and answers the Splunk community has about using the datamodel command.
|
PREVIOUS ctable |
NEXT dbinspect |
This documentation applies to the following versions of Splunk® Enterprise: 6.3.0, 6.3.1, 6.3.2, 6.3.3, 6.3.4, 6.3.5, 6.3.6, 6.3.7, 6.3.8, 6.3.9, 6.3.10, 6.3.11, 6.3.12, 6.3.13, 6.3.14, 6.4.0, 6.4.1, 6.4.2, 6.4.3, 6.4.4, 6.4.5, 6.4.6, 6.4.7, 6.4.8, 6.4.9, 6.4.10, 6.4.11
Feedback submitted, thanks!