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@
# This file contains the database type definitions


displayName = <string>
* A descriptive display name for the database type.

typeClass = <string>
* The FQCN (fully qualified class-name) of a class implementing the com.splunk.dbx.sql.type.DatabaseType interface.

jdbcDriverClass = <string>
* The FQCN of the JDBC Driver class. Only used when no typeClass is specified.

defaultPort = <integer>
* The default TCP port for the database type. Only used when no typeClass is specified.

connectionUrlFormat = <string>
* The JDBC URL as a MessageFormat string. The following values will be replaced:
* {0} the database host
* {1} the database port (the port specified in database.conf or the default port)
* {2} the database name/catalog or SID
* Only used when no typeClass is specified.

testQuery = <string>
* A simple SQL that is used to validate the database connection. Only used when no typeClass is specified.

supportsParameterMetaData = [true|false]
* Whether the given JDBC driver supports metadata for java.sql.PreparedStatement.
* Only used when no typeClass is specified.

quoteChars = <string>
* Override the quote characters for the database type. If not specified the default ANSI-SQL quote characters will be used.
* Only used when no typeClass is specified.

defaultCatalogName = <string>
* Configure the default catalog name for a generic database type. Used for querying the catalog names (ie. databases)

local = true|false
* This flag marks a database type as local (ie. it is accessed via the filesystem instead of TCP)

defaultSchema = <string>
* Set the default schema prefix for the database type (defaults to null)

streamingFetchSize = <n>
* Number of results to be fetched at a time when streaming is enabled for a JDBC statement.

streamingAutoCommit = [true|false]
* Turn auto-commit on or off for java.sql.Connection instances in streaming mode

validationDisabled = [true|false]
* Turn off connection validation for database connections of this type
* Defaults to false
* Caution: this can lead to unpredictable results when using this with connection pooling

This documentation applies to the following versions of Splunk® DB Connect: 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