Splunk® DB Connect

Deploy and Use Splunk DB Connect

Download manual as PDF

NOTE - Splunk DB Connect version 1.x reached its End of Life on July 28, 2016. Please see the migration information.
This documentation does not apply to the most recent version of DBX. Click here for the latest version.
Download topic as PDF


# Copyright (C) 2005-2012 Splunk Inc. All Rights Reserved.
# The file contains the configured database connections


host = <string>
* The IP address or the hostname of the database.

port = <integer>
* The port number of the database. If omitted the default port number for the given database type is used.

username = <string>
* The username which is used for authenticating against the database.

password = <string>
* The password which is used for authenticating against the database. It will be automatically encrypted if it is set in
* clear-text.

database = <string>
* The database name or SID.

type = <database_type>
* The database type. References a stanza in database_types.conf

readonly = true|false
* Whether the database connection is read-only. If it is readonly, any modifying SQL statement will be blocked

database.sid = true|false
* Only applies to Oracle database connections (ie. type=oracle). Set to *true* if the Oracle database is only reachable
* using an SID. By default the the service name format is used.

default.schema = <string>
* Sets the default schema for the database connection if the database type supports it (Currently only Oracle supports
* it).

testQuery = <string>
* Supply a specific test query for validating connections to this database
* If defined it overrides the testQuery of the database type (see database_types.conf)

validationDisabled = true|false
* Turn off connection validation for this database connection
* If defined it overrides the validationDisabled of the database type (see database_types.conf)
* Caution: disabling validation can lead to unpredictable results when using it with connection pooling

arg.ssl = request|require
* Allows SSL connection to MSSQL database
Configuration file reference

This documentation applies to the following versions of Splunk® DB Connect: 1.0.6, 1.0.7, 1.0.8, 1.0.9, 1.0.10, 1.0.11, 1.1, 1.1.1, 1.1.2, 1.1.3, 1.1.4, 1.1.5, 1.1.6, 1.1.7, 1.2.0, 1.2.1, 1.2.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