Splunk® DB Connect

Deploy and Use Splunk DB Connect

Download manual as PDF

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

Splunk DB Connect terminology

access controls

Also known as role-based access controls (RBAC), access controls comprise a system for defining access policy based on the system rather than the user. Splunk DB Connect uses the RBAC system in Splunk Enterprise, in which you define roles and assign users to them. Users can belong to multiple roles. A user's access to a given resource or action reflects what's specified in the permissive role to which that user belongs. For more information, see Configure security and access controls.

batch input

In batch input mode, the app invokes the same query each time and returns all results. Batch input mode is ideal for use with historical data that will not change and will be consumed and indexed once. For more information, see Create and manage database inputs.

connection

A database connection object contains the necessary information for connecting to a remote database. For more information about connection objects, see Create and manage database connections.

database input

A database input object lets you fetch and index data from a database. Database inputs are what enable Splunk Enterprise to query your database, identify the data to consume, and then tag and index the data. Once you've set up a database input, you can use that input just as you do any other data input you have defined in Splunk Enterprise. For more information, see Create and manage database inputs.

database lookup

A database lookup object enables you to enrich and extend the usefulness of your Splunk Enterprise data by fetching additional data from your external database. For more information, see Create and manage database lookups.

database output

A database output object lets you define how to send data from Splunk Enterprise to a database on a recurring basis. Define database outputs to store your indexed Splunk Enterprise data in a relational database. For more information, see Create and manage database outputs.

identity

An identity object contains database credentials. It comprises the username and obfuscated password that DB Connect uses to access your database. For more information about identity objects, see Create and manage identities.

permissions

Permissions indicate the level of access you assigned to a role. The access specifies how a user with that role can interact with knowledge objects such as identities and connections in Splunk Enterprise. Read access to an object means that Splunk Enterprise roles are able to use the object. Read-write access to an object means that Splunk Enterprise roles are able to use and modify the object. For more information, see Configure security and access controls.

rising column

A rising column input finds the new records you want and returns only those records with each query. When you create a rising column input type, you must specify the rising column. You can specify as rising column any column whose value increases over time, such as a timestamp or sequential ID. The rising column is how DB Connect keeps track of which records are new. For more information, see Create a database input.

role

A role is a collection of permissions and capabilities. You assign roles to users in Splunk Enterprise. The roles a user belongs to determine which identity, connection, input, output, and lookup objects that user is able to see and interact with in Splunk DB Connect. For more information, see Configure security and access controls.

task server

A task server enables Splunk DB Connect to send and receive data via JDBC. The task server is an instance of a web server that listens on a dedicated port (9998 by default) for instructions to connect to a database.

table

A database table is collection of data organized by intersecting vertical columns and horizontal rows. Rows and columns intersect in cells.

PREVIOUS
SQL tips and tricks
 

This documentation applies to the following versions of Splunk® DB Connect: 3.0.0, 3.0.1, 3.0.2, 3.0.3, 3.1.0, 3.1.1, 3.1.2


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