Splunk® DB Connect

Deploy and Use Splunk DB Connect

Acrobat logo Download manual as PDF


Acrobat logo Download topic as PDF

app-migration.conf.spec

The app-migration.conf file specifies options for migrating from DB Connect v1 to DB Connect v2 using the migration scripts.

[<migrationId>]
# splunk identifies stanzas by their migrationId
# splunk uses a migrationId to decide which migration business logic to load and apply

STATE = <string>
# JSON encoded state store for all migrations of type <migrationId>

DEST_CONF = <string>
# by default the DEST_CONF is <migrationId>. Use if you need to override,
# for example mi_input:// , mi_output://, and mi_lookup:// are all in inputs.conf but
# require different business logic for migration.

db_connection_types.conf.spec

The db_connection_types.conf file lists the supported database types, driver parameters, and test queries.

Compared to version 2.x, in DB Connect 3, the fields

  • cwallet_location and oracle_cipher_suites get merged into connection_properties.
  • Splunk has removed the sslConnectionType.
# @copyright@
# The file contains the specification for database connection types

[<name>]

serviceClass = <string>
# required
# Splunk Java class that provides JDBC support for this database connection type.


supportedVersions = <string>
# optional
# list (comma separated) supported versions(majorVersion.minorVersion) of JDBC driver implemented by serviceClass
# installed driver major version must == MajorVersion and minor version >= MinorVersion for Splunk to consider a driver as supported.


jdbcUrlFormat = <string>
# required
# JDBC Connection URL used for this database connection type. Supported variables: host, port, database, informixserver.


jdbcUrlSSLFormat = <string>
# optional
# JDBC Connection URL used for this database connection type if you enabled jdbcUseSSL. Supported variables: host, port, database, informixserver.


jdbcUseSSL = [true | false]
# optional
# default is false, whether this type of connection uses SSL connection.


jdbcDriverClass = <string>
# optional
# Driver vendor Java class that provides JDBC support for this database connection type.


testQuery = <string>
# optional
# simple SQL to test validation for this database type.
# JDBC 4 compliant drivers do not need this parameter.


displayName = <string>
# optional
# Describe the database connection type for end users.


database = <string>
# required if used in jdbcUrlFormat or jdbcUrlSSLFormat.
# JDBC URL variable for the default database or schema used for this database connection type.


port = <integer>
# required if used in jdbcUrlFormat or jdbcUrlSSLFormat.
# JDBC URL variable for the network port used for this database connection type.


useConnectionPool = [true | false]
# optional, default is true.
# The connection pooling uses Hikari, see https://github.com/brettwooldridge/HikariCP


ui_default_catalog = <string>
# optional
# ignored since 3.0


ui_default_schema = <string>
# optional
# ignored since 3.0


maxConnLifetimeMillis = <integer>
# optional, default is 120000 = 120 seconds
# valid when useConnectionPool = true
# The maximum lifetime in milliseconds of a connection in the connection pool.
# Splunk never retires an in-use connection, but only removes a connection when it gets closed.
# A value of zero means the connection has an infinite lifetime.


maxWaitMillis = <integer>
# optional, default is 30000 = 30 seconds
# valid when useConnectionPool = true
# The maximum number of milliseconds that the pool waits (when there are no
# available connections) for Splunk to return a connection before throwing an exception.
# [250, 300000] milliseconds is a reasonable value to wait to establish a connection.
# The max wait time is 300000 milliseconds (300 seconds).


maxTotalConn = <integer>
# optional, default is 8 connections
# valid when useConnectionPool = true
# The maximum number of active connections that Splunk allocates from this pool at the same time, or negative for no limit.


connection_properties = <string>
# optional
# Set JDBC variables for this database connection type.
# For example: {"useLegacyDatetimeCode": false}
Last modified on 30 September, 2022
PREVIOUS
Configuration file reference
  NEXT
db_connections.conf.spec

This documentation applies to the following versions of Splunk® DB Connect: 3.11.0, 3.11.1


Was this documentation topic helpful?


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