Adding a Connection to Splunk

To add a connection to Splunk:

1. In the application console, navigate to the Connections page.
2. At the Add Connections panel, select the icon for the connection you want to add.
3. If the Splunk icon is not available, click the Add More icon to download and install the Splunk connector from the CData site.

For required properties, see the Settings tab.

For connection properties that are not typically required, see the Advanced tab.

Connecting to Splunk APIs

You must specify the URL to a valid Splunk server. By default the Sync App makes requests on port 8089.

By default, the Sync App attempts to negotiate TLS/SSL with the server.

Authenticating to Splunk

There are two ways to authenticate to Splunk data: logging in with Splunk credentials, or using a Splunk authentication token.

Splunk Credentials

To authenticate with Splunk credentials, set User and Password to your login credentials.

Splunk Token

When you access Splunk via an authentication token, you can access the Splunk platform using Representational State Transfer (REST) calls. On Splunk Enterprise, you can also use the CLI. Both of these methods enable you to access the instance and make requests without having to authenticate via credentials.

Note: Unless you are accessing a search head cluster (where you can use the same token to access all available head clusters), you must have a separate token for each instance being accessed.

To authenticate with a Splunk token:

1. In the Splunk UI, navigate to Users and Authentication > Tokens to access your assigned authentication token. If you do not have one, request one from the administrator of the instance you want to access.
2. Set the AuthScheme to AccessToken; and the AccessToken property to your Splunk token.

This section details a selection of advanced features of the Splunk Sync App.

User Defined Views

The Sync App allows you to define virtual tables, called user defined views, whose contents are decided by a pre-configured query. These views are useful when you cannot directly control queries being issued to the drivers. See User Defined Views for an overview of creating and configuring custom views.

SSL Configuration

Use SSL Configuration to adjust how Sync App handles TLS/SSL certificate negotiations. You can choose from various certificate formats; see the SSLServerCert property under "Connection String Options" for more information.

Firewall and Proxy

Configure the Sync App for compliance with Firewall and Proxy, including Windows proxies and HTTP proxies. You can also set up tunnel connections.

Query Processing

The Sync App offloads as much of the SELECT statement processing as possible to Splunk and then processes the rest of the query in memory (client-side).

See Query Processing for more information.

Logging

See Logging for an overview of configuration settings that can be used to refine CData logging. For basic logging, you only need to set two connection properties, but there are numerous features that support more refined logging, where you can select subsets of information to be logged using the LogModules connection property.

Customizing the SSL Configuration

By default, the Sync App attempts to negotiate SSL/TLS by checking the server's certificate against the system's trusted certificate store.

To specify another certificate, see the SSLServerCert property for the available formats to do so.

Connecting Through a Firewall or Proxy

HTTP Proxies

To connect through the Windows system proxy, you do not need to set any additional connection properties. To connect to other proxies, set ProxyAutoDetect to false.

In addition, to authenticate to an HTTP proxy, set ProxyAuthScheme, ProxyUser, and ProxyPassword, in addition to ProxyServer and ProxyPort.

Other Proxies

Set the following properties:

• To use a proxy-based firewall, set FirewallType, FirewallServer, and FirewallPort.
• To tunnel the connection, set FirewallType to TUNNEL.
• To authenticate, specify FirewallUser and FirewallPassword.
• To authenticate to a SOCKS proxy, additionally set FirewallType to SOCKS5.

The Sync App models Splunk reports, searches, datasets, and data models as tables in a relational database that you can read from/write to with SQL-92 queries.

Dynamic Schema Generation

You can work with all of the tables in your account: when you connect the Sync App retrieves the metadata from Splunk and dynamically reflects any changes in the table schemas.

You can call the CreateSchema stored procedure to persist a static schema across connections. The stored procedure saves the schema to a text file; the text file has a simple format that also makes schemas easy to customize.

Tables

See Tables for more details on updating and querying datasets, data models, and searches.

Views

The Sync App also surfaces data through Views representing the following Splunk objects:

• Reports: See LookUpReport for an example of a view representing a saved report in Splunk.
• Data-model datasets: See AlertsInInternalServer for an example of a view representing a dataset. See Datasets to retrieve a list of dataset views.
• Table-type datasets: See UploadedModel for an example of a view representing a table dataset in Splunk.

The Sync App models the data in Splunk as a list of tables in a relational database that can be queried using standard SQL statements.

Splunk Connector for CData Sync Tables

Name	Description
DataModels	Create, query, update, and delete data models in Splunk.
Datasets	Create, query, update, and delete datasets in Splunk.
SearchJobs	Create, query, update, and delete search jobs in Splunk.

Create, query, update, and delete data models in Splunk.

Select

The Sync App will use the Splunk API to process search criteria that refer to the Id column. This column supports server-side processing for the = operator. The Sync App processes other filters client-side within the Sync App.

For example, the following query is processed server side by the Splunk APIs:

SELECT * FROM DataModels WHERE Id = 'SampleModel' 

Insert

The Id column is the minimum requirement for an insert. In an insert, the DataModels table allows only the Id and Acceleration columns.

INSERT INTO DataModels (Id, Acceleration) VALUES ('initialname', '{"enabled":false,"earliest_time":"","hunk.file_format":"","hunk.dfs_block_size":0,"hunk.compression_codec":""}' )

Update

The DataModels table allows updates for the Acceleration column when Id is specified. You can also set the Provisional pseudocolumn.

UPDATE DataModels SET Provisional = 'true', Acceleration = '{"enabled":false,"earliest_time": "-1mon", "cron_schedule": "0 */12 * * *","hunk.file_format":"","hunk.dfs_block_size":0,"hunk.compression_codec":""}' WHERE Id = 'initialname' 

Delete

The DataModels table allows deleting a record when Id is specified.

DELETE FROM Datamodels WHERE Id = 'initialname' 

Columns

Name	Type	ReadOnly	References	Description
Id [KEY]	String	True		Link of the data model.
Disabled	Boolean	True		Indicates if the data model is disabled/enabled.
UpdatedAt	Datetime	True		Datetime of the last update of the data model.
Description	String	True		Description of the data model.
Name	String	False		The name of the data model in Splunk.
DisplayName	String	True		The name displayed for the data model in Splunk.
Author	String	True		Splunk user who created the data model.
App	String	True		Splunk app where the data model is shared.
Owner	String	True		Splunk user who owns the data model.
CanShareApp	Boolean	True		Boolean indicating whether the data model can be shared in an app.
CanShareGlobal	Boolean	True		Boolean indicating whether the data model can be shared globally.
CanShareUser	Boolean	True		Boolean indicating whether the data model can be shared by the user.
CanWrite	Boolean	True		Boolean indicating whether the data model can be extended by the user.
Modifiable	Boolean	True		Boolean indicating whether the data model can be modified.
Removable	Boolean	True		Boolean indicating whether the data model can be removed.
Acceleration	String	False		Acceleration settings for the data model. Supply JSON to specify any or all of the following settings: enabled (true or false), earliest_time (time modifier), or cron_schedule (cron string).
AccelerationAllowed	Boolean	True		Boolean indicating that acceleration is allowed or not for the data model.
AccelerationHunkCompression	String	True		Specifies the compression codec to be used for the accelerated orc or parquet format files.
DatasetCommands	String	True		Data model commands.
DatasetDescription	String	True		The JSON describing the data model.
DatasetCurrentCommand	Integer	True		Current command of the data model.
DatasetEarliestTime	Datetime	True		Earliest time of data model events being processed.
DatasetLatestTime	Datetime	True		Latest time of data model events being processed.
DatasetDiversity	String	True		Diversity of events being processed.
DatasetLimiting	Integer	True		Limitations of events being processed.
DatasetMode	String	True		Search mode events being processed.
DatasetSampleRatio	String	True		Sample ratio of the data model.
DatasetFields	String	True		Indexed fields the data model has.
DatasetType	String	True		Dataset type.
Type	String	True		Data model type.
Digest	String	True		Content digest type.
TagsWhitelist	String	True		Whitelist of data model tags.
ReadPermitions	String	True		Permissions to read this data model.
WritePermitions	String	True		Permissions to write to this data model.
Sharing	String	True		Data model sharing type.
Username	String	True		Username of the Splunk user.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name	Type	Description
Provisional	Boolean	Indicates whether the data model is provisional. Provisional data models are not saved. Specify true to validate a data model before saving it.

Create, query, update, and delete datasets in Splunk.

Select

The Datasets table requires DataModelId in the WHERE clause. The DataModelId column supports server-side processing for the = operator. The Sync App processes other search criteria client-side within the Sync App.

SELECT * FROM DataSets  WHERE DataModelId = 'SampleModel' 

Insert

Splunk allows inserts only when DataModelId, ParentName, and ObjectName are all specified.

INSERT INTO [Datasets] (ObjectName, ParentName, DataModelId) VALUES ('SampleSet', 'BaseEvent', 'SampleModel')

Update

The Datasets table allows updates when DataModelId is specified. The columns that can be updated in this case are the following: Description and DisplayName.

When ObjectName is also specified, you can update the following columns: ObjectDisplayName, ParentName, Comment, Fields, Calculations, Constraints, Lineage, ObjectSearchNoFields, ObjectSearch, AutoextractSearch, PreviewSearch, AccelerationSearch, BaseSearch, and TsidxNamespace.

UPDATE Datasets SET Description = 'model description', DisplayName = 'Model Display Name' WHERE DataModelId = 'SampleModel' 

UPDATE Datasets SET ParentName = 'BaseEvent', BaseSearch = '| search (index=* OR index=_*) | fields _time, RootObject', AccelerationSearch = ' search (index=* OR index=_*) ' WHERE DataModelId = 'SampleModel' AND ObjectName = 'SampleSet' 

Delete

Datasets can be deleted by providing the DataModelId and the ObjectName of the dataset.

DELETE FROM Datasets WHERE DataModelId = 'SampleModel' AND ObjectName = 'SampleSet'

Columns

Name	Type	ReadOnly	References	Description
ObjectName [KEY]	String	False		Name of the dataset object.
DatamodelId [KEY]	String	False	DataModels.Id	Id of the data model the object belongs to.
DisplayName	String	False		Name of the data model the object belongs to.
Description	String	False		Dataset description.
ObjectNameList	String	True		List of the objects in the data model.
ObjectDisplayName	String	False		Name displayed in Splunk for the object.
ParentName	String	False		Name of the Parent Event.
Comment	String	False		Dataset comments.
Fields	String	False		Dataset events indexed fields.
Calculations	String	False		Saved calculations for dataset fields.
Constraints	String	False		Saved constraints for dataset fields.
Lineage	String	False		Dataset lineage.
ObjectSearchNoFields	String	False		Object search query without fields.
ObjectSearch	String	False		Saved search query for the object.
AutoextractSearch	String	False		Search query for autoextraction.
PreviewSearch	String	False		Search preview query.
AccelerationSearch	String	False		Search query including acceleration.
BaseSearch	String	False		Basic search query.
TsidxNamespace	String	False		Allocated namespace.
EventBased	Integer	True		Number of Event-Based objects in the data model.
TransactionBased	Integer	True		Number of Transaction-Based objects in the data model.
SearchBased	Integer	True		Number of Search-Based objects in the data model.

Create, query, update, and delete search jobs in Splunk.

Select

The Sync App will use the Splunk APIs to process the search Id (Sid) criteria specified in the WHERE clause. The Sid column supports server-side processing for the = operator. The Sync App processes other search criteria client-side within the Sync App.

SELECT * FROM SearchJobs
SELECT * FROM SearchJobs WHERE Sid = '123456789.1234' 

Insert

Splunk allows inserts only when EventSearch is specified. You can insert the Custom, EarliestTime, LatestTime, Label, and StatusBuckets columns and all pseudocolumns.

INSERT INTO SearchJobs (Custom, EventSearch, LatestTime, Timeout) VALUES ('custom1=test1, custom2=test2', ' from datamodel SampleModel', 'now', '60')

Update

The SearchJobs table allows updates of the Custom column only when Sid is specified.

UPDATE SearchJobs SET Custom = 'custom1=test3, custom2=test4' WHERE sid = '123456789.1234' 

Delete

SearchJobs can be deleted by providing the Sid.

DELETE FROM SearchJobs WHERE Sid = '123456789.1234'

Columns

Name	Type	ReadOnly	References	Description
Sid [KEY]	String	False		The search Id number.
EventSearch	String	False		Subset of the entire search that is before any transforming commands.
Custom	String	False		Custom job property. In an INSERT operation, pass the values as a comma-separated list of pairs of keys and values.
EarliestTime	String	False		The earliest time a search job is configured to start.
LatestTime	String	False		The latest time a search job is configured to start.
CursorTime	String	True		The earliest time from which no events are later scanned. Can be used to indicate progress.
Delegate	String	True		For saved searches, specifies jobs that were started by the user. Defaults to scheduler.
DiskUsage	Long	True		The total amount of disk space used, in bytes.
DispatchState	String	True		The state of the search. Can be any of QUEUED, PARSING, RUNNING, PAUSED, FINALIZING, FAILED, or DONE.
DoneProgress	Double	True		A number between 0 and 1.0 that indicates the approximate progress of the search. doneProgress = (latestTime-cursorTime) / (latestTime-earliestTime)
DropCount	Integer	True		For real-time searches only, the number of possible events that were dropped due to the rt_queue_size (defaults to 100000).
EventAvailableCount	Integer	True		The number of events that are available for export.
EventCount	Integer	True		The number of events returned by the search.
EventFieldCount	Integer	True		The number of fields found in the search results.
EventIsStreaming	Boolean	True		Indicates if the events of this search are being streamed.
EventIsTruncated	Boolean	True		Indicates if the events of the search are not stored, making them unavailable from the events endpoint for the search.
EventPreviewableCount	Integer	True		Number of in-memory events that are not yet committed to disk.
EventSorting	String	True		Indicates if the events of this search are sorted, and in which order.
IsDone	Boolean	True		Indicates if the search has completed.
IsEventsPreviewEnabled	String	True		Indicates if the timeline_events_preview setting is enabled in limits.conf.
IsFailed	Boolean	True		Indicates if there was a fatal error executing the search. For example, invalid search string syntax.
IsFinalized	Boolean	True		Indicates if the search was finalized (stopped before completion).
IsPaused	Boolean	True		Indicates if the search is paused.
IsPreviewEnabled	Boolean	True		Indicates if previews are enabled.
IsRealTimeSearch	Boolean	True		Indicates if the search is a real-time search.
IsRemoteTimeline	Boolean	True		Indicates if the remote timeline feature is enabled.
IsSaved	Boolean	True		Indicates that the search job is saved on disk. Search artifacts are saved on disk for 7 days from the last time that the job was viewed or touched.
IsSavedSearch	Boolean	True		Indicates if this is a saved search run using the scheduler.
IsZombie	Boolean	True		Indicates if the process running the search died without finishing the search.
Keywords	String	True		All positive keywords used by this search. A positive keyword is a keyword that is not in a NOT clause.
Label	String	False		Custom name created for this search.
Messages	String	True		Errors and debug messages.
NumPreviews	Integer	True		Number of previews generated so far for this search job.
Performance	String	True		A representation of the execution costs.
Priority	Integer	True		An integer between 0-10 that indicates the search priority.
RemoteSearch	String	True		The search string that is sent to every search peer.
ReportSearch	String	True		If reporting commands are used, the reporting search.
ResultCount	Integer	True		The total number of results returned by the search. In other words, this is the subset of scanned events (represented by the ScanCount) that actually matches the search terms.
ResultIsStreaming	Boolean	True		Indicates if the final results of the search are available using streaming (for example, no transforming operations).
ResultPreviewCount	Integer	True		The number of result rows in the latest preview results.
RunDuration	Decimal	True		Time in seconds that the search took to complete.
ScanCount	Integer	True		The number of events that are scanned or read off disk.
SearchEarliestTime	Datetime	True		Specifies the earliest time for a search, as specified in the search command rather than the EarliestTime parameter. It does not snap to the indexed data time bounds for all-time searches.
SearchLatestTime	Datetime	True		Specifies the latest time for a search, as specified in the search command rather than the LatestTime parameter. It does not snap to the indexed data time bounds for all-time searches.
SearchProviders	String	True		A list of all the search peers that were contacted.
StatusBuckets	Integer	False		Maximum number of timeline buckets.
TTL	String	True		The time to live, or the time before the search job expires after it completes.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name	Type	Description
SearchMode	String	Searching mode, realtime or normal. If set to realtime, the search runs over the live data. The allowed values are normal, realtime.
EnableLookups	Boolean	Indicates whether lookups should be applied to events.
AutoPause	Integer	If specified, the search job pauses after this many seconds of inactivity. (0 means never autopause.)
AutoCancel	Integer	If specified, the job automatically cancels after this many seconds of inactivity. (0 means never autocancel.)
AdhocSearchLevel	Integer	Specify a search mode. Use one of the following search modes: verbose, fast, or smart. The allowed values are verbose, fast, smart.
ForceBundleReplication	Boolean	Specifies whether this search should cause (and wait depending on the value of SyncBundleReplication) for bundle synchronization with all search peers.
IndexEarliest	String	Specify a time string. Sets the earliest inclusive time bounds for the search, based on the index time bounds.
IndexLatest	String	Specify a time string. Sets the latest exclusive time bounds for the search, based on the index time bounds.
IndexedRealtime	Boolean	Indicates whether or not to use the indexed-realtime mode for real-time searches.
IndexedRealtimeOffset	Integer	Sets disk sync delay for indexed real-time search (seconds).
MaxCount	Integer	The number of events that can be accessible in any given status bucket.
MaxTime	Integer	Comma-separated list of (possibly wildcarded) servers from which raw events should be pulled.
Namespace	String	The application namespace in which to restrict searches.
Now	String	Specify a time string to set the absolute time used for any relative time specifier in the search. Defaults to the current system time. You can specify a relative time modifier for this parameter. For example, specify +2d to specify the current time plus two days.
ReduceFrequency	Integer	Determines how frequently to run the MapReduce reduce phase on accumulated map values.
ReloadMacros	Boolean	Specifies whether to reload macro definitions from the configuration file.
RemoteServerList	Integer	The number of seconds to run this search before finalizing. Specify 0 to never finalize.
ReplaySpeed	Integer	Indicate a real-time search replay speed factor. For example, 1 indicates normal speed, 0.5 indicates half of normal speed, and 2 indicates twice as fast as normal.
ReplayStartTime	String	Relative wall-clock start time for the replay.
ReplayEndTime	String	Relative end time for the replay clock. The replay stops when the clock time reaches this time.
ReuseMaxSecondsAgo	Integer	Specifies the number of seconds ago to check when an identical search is started and return the search Id of the job instead of starting a new job.
RequiredField	String	Adds a required field to the search.
RealTimeBlocking	Boolean	For a real-time search, indicates if the indexer blocks if the queue for this search is full.
RealTimeIndexFilter	Boolean	For a real-time search, indicates if the indexer prefilters events.
RealTimeMaxBlockSecs	Integer	For a real-time search with RealTimeBlocking set to true, the maximum time to block. Specify 0 to indicate no limit.
RealTimeQueueSize	Integer	For a real-time search, the queue size (in events) that the indexer should use for this search.
Timeout	Integer	The number of seconds to keep this search after processing has stopped.
SyncBundleReplication	String	Specifies whether this search should wait for bundle replication to complete.

Views are similar to tables in the way that data is represented; however, views are read-only.

Queries can be executed against a view as if it were a normal table.

Splunk Connector for CData Sync Views

Name	Description
AlertsInInternalServer	A dataset object in the example InternalServer data model.
LookUpReport	An example lookup report representing a view based on a saved report in Splunk.
UploadedModel	An example of a table object inside a data model.

A dataset object in the example InternalServer data model.

Select

This is an example of a dataset view. These views are generated from dataset objects inside a data model. The Sync App will use the Splunk APIs to process the following query components; the Sync App processes other parts of the query client-side in memory.

All columns support server-side processing for the following operators and functions:

• Operators: =, <, >, >=, <=, IN, IS NULL, IS NOT NULL, NOT
• Functions: AVG, SUM, MIN, MAX, COUNT, STDEV, STDEVP, VAR, VARP

LIMIT, ORDER BY, GROUP BY, and HAVING are also processed server-side. An exception is the case when in the selected columns, there are fields that are not in the GROUP BY, and GROUP BY, criteria, and limiting are handled client-side.

In the case when an unsupported criteria or function is used, all processing will be completed client-side (except selecting specified fields). This is also the case when a SELECT statement has a column that is not in the GroupBy clause.

For example, the Sync App uses the Splunk APIs to process the following queries.

SELECT Component, Timeendpos as Timeend FROM [AlertsInInternalServer] WHERE Component = 'Saved' OR EventType != '' AND Priority IS NOT NULL AND Linecount NOT IN ('1', '2') ORDER BY Priority DESC LIMIT 5 

SELECT AVG(Suppressed), Priority FROM [AlertsInInternalServer] GROUP BY Priority HAVING AVG(Suppressed) > 0 

Columns

Name	Type	Description
_time	Datetime
component	String
date_hour	Int
date_mday	Int
date_minute	Int
date_month	String
date_second	Int
date_wday	String
date_year	Int
date_zone	Int
digest_mode	Int
dispatch_time	Int
host	String
linecount	Int
log_level	String
priority	String
punct	String
savedsearch_id	String
scheduled_time	Int
search_type	String
server_alert_actions	String
server_app	String
server_message	String
server_result_count	Int
server_run_time	Double
server_savedsearch_name	String
server_sid	String
server_status	String
server_user	String
source	String
sourcetype	String
splunk_server	String
suppressed	Int
thread_id	String
timeendpos	Int
timestartpos	Int
window_time	Int

An example lookup report representing a view based on a saved report in Splunk.

Select

This is an example of a report view. These views are generated from saved reports in Splunk.

The Sync App will use the Splunk APIs to process the following query components; the Sync App processes other parts of the query client-side in memory.

Saved Search

Runs a saved search, or report, and returns the search results of a saved search. If the search contains replacement placeholder terms, such as $replace_me$, the search processor replaces the placeholders with the strings you specify.

For example:

• SELECT * FROM mysearch WHERE replace_me = 'value'

Will generate the following search statement:

• | savedsearch mysearch replace_me="value"

All replacement placeholder terms will be dynamic and saved as Pseudo-Columns.

All columns support server-side processing for the following operators and functions:

• Operators: =, <, >, >=, <=, IN, IS NULL, IS NOT NULL, NOT, LIKE
• Functions: AVG, SUM, MIN, MAX, COUNT, STDEV, STDEVP, VAR, VARP

LIMIT, ORDER BY, GROUP BY, and HAVING are also processed server-side. An exception is the case when in the selected columns, there are fields that are not in the GROUP BY, and GROUP BY, criteria, and limiting are handled client-side.

In the case when an unsupported criteria or function is used, all processing will be completed client-side (except selecting specified fields). This is also the case when a SELECT statement has a column that is not in the GROUP BY clause.

For example, the Sync App processes the following queries server-side:

SELECT Country, Subregion as Sub FROM LookUpReport WHERE Iso2 != '123' OR continent = 'Europe' AND iso3 NOT IN ('example_1', 'example_2') ORDER BY Country DESC LIMIT 5 

SELECT AVG(Iso2), Subregion FROM LookUpReport GROUP BY Subregion HAVING AVG(Iso2) > 0 

Columns

Name	Type	Description
continent	String
country	String
iso2	String
iso3	String
region_un	String
region_wb	String
subregion	String

An example of a table object inside a data model.

Select

This is an example of a view generated from a table object inside a data model. The Sync App will use the Splunk APIs to process the following query components; the Sync App processes other parts of the query client-side in memory.

All columns support server-side processing for the following operators and functions.

• Operators: =, <, >, >=, <=, IN, IS NULL, IS NOT NULL, NOT
• Functions: AVG, SUM, MIN, MAX, COUNT, STDEV, STDEVP, VAR, VARP

LIMIT, ORDER BY, GROUP BY, and HAVING are also processed server-side. An exception is the case when in the selected columns, there are fields that are not in the GROUP BY, and GROUP BY, criteria, and limiting are handled client-side.

In the case when an unsupported criteria or function is used, all processing will be completed client-side (except selecting specified fields). This is also the case when a SELECT statement has a column that is not in the GROUP BY clause.

For example, the following queries are processed server side:

SELECT Component, Timeendpos as Timeend FROM [UploadedModel] WHERE Component = 'Saved' OR DEST_CITY_MARKET_ID != '' AND DEST_AIRPORT_ID NOT IN ('1', '2') ORDER BY ORIGIN_AIRPORT_ID DESC LIMIT 5 

SELECT AVG(DEST_AIRPORT_ID), ORIGIN_AIRPORT_ID FROM [UploadedModel] GROUP BY ORIGIN_AIRPORT_ID HAVING AVG(DEST_AIRPORT_ID) > 0 

Columns

Name	Type	Description
_time	Datetime
DEST_AIRPORT_ID	Int
DEST_AIRPORT_SEQ_ID	Int
DEST_CITY_MARKET_ID	Int
host	String
linecount	Int
ORIGIN_AIRPORT_ID	Int
ORIGIN_AIRPORT_SEQ_ID	Int
ORIGIN_CITY_MARKET_ID	Int
punct	String
source	String
sourcetype	String
splunk_server	String
timestamp	String

The connection string properties are the various options that can be used to establish a connection. This section provides a complete list of the options you can configure in the connection string for this provider. Click the links for further details.

For more information on establishing a connection, see Establishing a Connection.

Authentication

---

Property	Description
AuthScheme	Whether to use Basic Authentication, AccessToken or HTTPEventCollectorToken Authentication when connecting to Splunk.
AccessToken	The Access Token used for accessing your Splunk account.
HTTPEventCollectorToken	The HTTP Event Collector Token is used for accessing the HTTP Event Controller feature on your Splunk account.
URL	The URL to your Splunk endpoint.
User	The Splunk user account used to authenticate.
Password	The password used to authenticate the user.

SSL

---

Property	Description
SSLServerCert	The certificate to be accepted from the server when connecting using TLS/SSL.

Firewall

---

Property	Description
FirewallType	The protocol used by a proxy-based firewall.
FirewallServer	The name or IP address of a proxy-based firewall.
FirewallPort	The TCP port for a proxy-based firewall.
FirewallUser	The user name to use to authenticate with a proxy-based firewall.
FirewallPassword	A password used to authenticate to a proxy-based firewall.

Proxy

---

Property	Description
ProxyAutoDetect	This indicates whether to use the system proxy settings or not.
ProxyServer	The hostname or IP address of a proxy to route HTTP traffic through.
ProxyPort	The TCP port the ProxyServer proxy is running on.
ProxyAuthScheme	The authentication type to use to authenticate to the ProxyServer proxy.
ProxyUser	A user name to be used to authenticate to the ProxyServer proxy.
ProxyPassword	A password to be used to authenticate to the ProxyServer proxy.
ProxySSLType	The SSL type to use when connecting to the ProxyServer proxy.
ProxyExceptions	A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the ProxyServer .

Logging

---

Property	Description
LogModules	Core modules to be included in the log file.

Schema

---

Property	Description
Location	A path to the directory that contains the schema files defining tables, views, and stored procedures.
BrowsableSchemas	This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC.
Tables	This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC.
Views	Restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC.

Miscellaneous

---

Property	Description
IncludeInternalFields	Whether or not the CData ADO.NET Provider for Splunk should push the internal fields. These fields include: user, eventtype, etc.
MaxRows	Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.
MaxThreads	Specifies the number of concurrent requests. Only used when UseJobs is true.
Other	These hidden properties are used only in specific use cases.
Pagesize	The maximum number of results to return per page from Splunk.
PseudoColumns	This property indicates whether or not to include pseudo columns as columns to the table.
RowScanDepth	Set this property to control the number of rows scanned when TypeDetectionScheme is set to RowScan.
Timeout	The value in seconds until the timeout error is thrown, canceling the operation.
TypeDetectionScheme	Determines how to determine the data type of columns.
UseJobs	Specifies whether to use the jobs endpoint instead of the export endpoint. If set to true, the maximum number of returned rows is configured Splunk's limit.conf file.
UserDefinedViews	A filepath pointing to the JSON configuration file containing your custom views.

This section provides a complete list of the Authentication properties you can configure in the connection string for this provider.

---

Property	Description
AuthScheme	Whether to use Basic Authentication, AccessToken or HTTPEventCollectorToken Authentication when connecting to Splunk.
AccessToken	The Access Token used for accessing your Splunk account.
HTTPEventCollectorToken	The HTTP Event Collector Token is used for accessing the HTTP Event Controller feature on your Splunk account.
URL	The URL to your Splunk endpoint.
User	The Splunk user account used to authenticate.
Password	The password used to authenticate the user.

Whether to use Basic Authentication, AccessToken or HTTPEventCollectorToken Authentication when connecting to Splunk.

Remarks

• Basic: Set this to perform Basic authentication.
• AccessToken: Set this to perform Token Based Authentication via the AccessToken property.
• HTTPEventCollectorToken: Set this to perform Token Based Authentication for Event Controller via the HTTPEventCollectorToken property.

The Access Token used for accessing your Splunk account.

Remarks

The Access Token used for accessing your Splunk account.

The HTTP Event Collector Token is used for accessing the HTTP Event Controller feature on your Splunk account.

Remarks

The HTTP Event Collector Token is used for accessing the HTTP Event Controller feature on your Splunk account.

The URL to your Splunk endpoint.

Remarks

The URL to your Splunk endpoint; for example, https://yoursitename.splunk.com:8089.

The port should be set to the Splunk management port (default 8089).

The Splunk user account used to authenticate.

Remarks

Together with Password, this field is used to authenticate against the Splunk server.

The password used to authenticate the user.

Remarks

The User and Password are together used to authenticate with the server.

This section provides a complete list of the SSL properties you can configure in the connection string for this provider.

---

Property	Description
SSLServerCert	The certificate to be accepted from the server when connecting using TLS/SSL.

The certificate to be accepted from the server when connecting using TLS/SSL.

Remarks

If using a TLS/SSL connection, this property can be used to specify the TLS/SSL certificate to be accepted from the server. Any other certificate that is not trusted by the machine is rejected.

This property can take the following forms:

Description	Example
A full PEM Certificate (example shortened for brevity)	-----BEGIN CERTIFICATE----- MIIChTCCAe4CAQAwDQYJKoZIhv......Qw== -----END CERTIFICATE-----
A path to a local file containing the certificate	C:\cert.cer
The public key (example shortened for brevity)	-----BEGIN RSA PUBLIC KEY----- MIGfMA0GCSq......AQAB -----END RSA PUBLIC KEY-----
The MD5 Thumbprint (hex values can also be either space or colon separated)	ecadbdda5a1529c58a1e9e09828d70e4
The SHA1 Thumbprint (hex values can also be either space or colon separated)	34a929226ae0819f2ec14b4a3d904f801cbb150d

If not specified, any certificate trusted by the machine is accepted.

Use '*' to signify to accept all certificates. Note that this is not recommended due to security concerns.

This section provides a complete list of the Firewall properties you can configure in the connection string for this provider.

---

Property	Description
FirewallType	The protocol used by a proxy-based firewall.
FirewallServer	The name or IP address of a proxy-based firewall.
FirewallPort	The TCP port for a proxy-based firewall.
FirewallUser	The user name to use to authenticate with a proxy-based firewall.
FirewallPassword	A password used to authenticate to a proxy-based firewall.

The protocol used by a proxy-based firewall.

Remarks

This property specifies the protocol that the Sync App will use to tunnel traffic through the FirewallServer proxy. Note that by default, the Sync App connects to the system proxy; to disable this behavior and connect to one of the following proxy types, set ProxyAutoDetect to false.

Type	Default Port	Description
TUNNEL	80	When this is set, the Sync App opens a connection to Splunk and traffic flows back and forth through the proxy.
SOCKS4	1080	When this is set, the Sync App sends data through the SOCKS 4 proxy specified by FirewallServer and FirewallPort and passes the FirewallUser value to the proxy, which determines if the connection request should be granted.
SOCKS5	1080	When this is set, the Sync App sends data through the SOCKS 5 proxy specified by FirewallServer and FirewallPort. If your proxy requires authentication, set FirewallUser and FirewallPassword to credentials the proxy recognizes.

To connect to HTTP proxies, use ProxyServer and ProxyPort. To authenticate to HTTP proxies, use ProxyAuthScheme, ProxyUser, and ProxyPassword.

The name or IP address of a proxy-based firewall.

Remarks

This property specifies the IP address, DNS name, or host name of a proxy allowing traversal of a firewall. The protocol is specified by FirewallType: Use FirewallServer with this property to connect through SOCKS or do tunneling. Use ProxyServer to connect to an HTTP proxy.

Note that the Sync App uses the system proxy by default. To use a different proxy, set ProxyAutoDetect to false.

The TCP port for a proxy-based firewall.

Remarks

This specifies the TCP port for a proxy allowing traversal of a firewall. Use FirewallServer to specify the name or IP address. Specify the protocol with FirewallType.

The user name to use to authenticate with a proxy-based firewall.

Remarks

The FirewallUser and FirewallPassword properties are used to authenticate against the proxy specified in FirewallServer and FirewallPort, following the authentication method specified in FirewallType.

A password used to authenticate to a proxy-based firewall.

Remarks

This property is passed to the proxy specified by FirewallServer and FirewallPort, following the authentication method specified by FirewallType.

This section provides a complete list of the Proxy properties you can configure in the connection string for this provider.

---

Property	Description
ProxyAutoDetect	This indicates whether to use the system proxy settings or not.
ProxyServer	The hostname or IP address of a proxy to route HTTP traffic through.
ProxyPort	The TCP port the ProxyServer proxy is running on.
ProxyAuthScheme	The authentication type to use to authenticate to the ProxyServer proxy.
ProxyUser	A user name to be used to authenticate to the ProxyServer proxy.
ProxyPassword	A password to be used to authenticate to the ProxyServer proxy.
ProxySSLType	The SSL type to use when connecting to the ProxyServer proxy.
ProxyExceptions	A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the ProxyServer .

This indicates whether to use the system proxy settings or not.

Remarks

This takes precedence over other proxy settings, so you'll need to set ProxyAutoDetect to FALSE in order use custom proxy settings.

To connect to an HTTP proxy, see ProxyServer. For other proxies, such as SOCKS or tunneling, see FirewallType.

The hostname or IP address of a proxy to route HTTP traffic through.

Remarks

The hostname or IP address of a proxy to route HTTP traffic through. The Sync App can use the HTTP, Windows (NTLM), or Kerberos authentication types to authenticate to an HTTP proxy.

If you need to connect through a SOCKS proxy or tunnel the connection, see FirewallType.

By default, the Sync App uses the system proxy. If you need to use another proxy, set ProxyAutoDetect to false.

The TCP port the ProxyServer proxy is running on.

Remarks

The port the HTTP proxy is running on that you want to redirect HTTP traffic through. Specify the HTTP proxy in ProxyServer. For other proxy types, see FirewallType.

The authentication type to use to authenticate to the ProxyServer proxy.

Remarks

This value specifies the authentication type to use to authenticate to the HTTP proxy specified by ProxyServer and ProxyPort.

Note that the Sync App will use the system proxy settings by default, without further configuration needed; if you want to connect to another proxy, you will need to set ProxyAutoDetect to false, in addition to ProxyServer and ProxyPort. To authenticate, set ProxyAuthScheme and set ProxyUser and ProxyPassword, if needed.

The authentication type can be one of the following:

• BASIC: The Sync App performs HTTP BASIC authentication.
• DIGEST: The Sync App performs HTTP DIGEST authentication.
• NEGOTIATE: The Sync App retrieves an NTLM or Kerberos token based on the applicable protocol for authentication.
• PROPRIETARY: The Sync App does not generate an NTLM or Kerberos token. You must supply this token in the Authorization header of the HTTP request.

If you need to use another authentication type, such as SOCKS 5 authentication, see FirewallType.

A user name to be used to authenticate to the ProxyServer proxy.

Remarks

The ProxyUser and ProxyPassword options are used to connect and authenticate against the HTTP proxy specified in ProxyServer.

You can select one of the available authentication types in ProxyAuthScheme. If you are using HTTP authentication, set this to the user name of a user recognized by the HTTP proxy. If you are using Windows or Kerberos authentication, set this property to a user name in one of the following formats:

user@domain
domain\user

A password to be used to authenticate to the ProxyServer proxy.

Remarks

This property is used to authenticate to an HTTP proxy server that supports NTLM (Windows), Kerberos, or HTTP authentication. To specify the HTTP proxy, you can set ProxyServer and ProxyPort. To specify the authentication type, set ProxyAuthScheme.

If you are using HTTP authentication, additionally set ProxyUser and ProxyPassword to HTTP proxy.

If you are using NTLM authentication, set ProxyUser and ProxyPassword to your Windows password. You may also need these to complete Kerberos authentication.

For SOCKS 5 authentication or tunneling, see FirewallType.

By default, the Sync App uses the system proxy. If you want to connect to another proxy, set ProxyAutoDetect to false.

The SSL type to use when connecting to the ProxyServer proxy.

Remarks

This property determines when to use SSL for the connection to an HTTP proxy specified by ProxyServer. This value can be AUTO, ALWAYS, NEVER, or TUNNEL. The applicable values are the following:

AUTO	Default setting. If the URL is an HTTPS URL, the Sync App will use the TUNNEL option. If the URL is an HTTP URL, the component will use the NEVER option.
ALWAYS	The connection is always SSL enabled.
NEVER	The connection is not SSL enabled.
TUNNEL	The connection is through a tunneling proxy. The proxy server opens a connection to the remote host and traffic flows back and forth through the proxy.

A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the ProxyServer .

Remarks

The ProxyServer is used for all addresses, except for addresses defined in this property. Use semicolons to separate entries.

Note that the Sync App uses the system proxy settings by default, without further configuration needed; if you want to explicitly configure proxy exceptions for this connection, you need to set ProxyAutoDetect = false, and configure ProxyServer and ProxyPort. To authenticate, set ProxyAuthScheme and set ProxyUser and ProxyPassword, if needed.

This section provides a complete list of the Logging properties you can configure in the connection string for this provider.

---

Property	Description
LogModules	Core modules to be included in the log file.

Core modules to be included in the log file.

Remarks

Only the modules specified (separated by ';') will be included in the log file. By default all modules are included.

See the Logging page for an overview.

This section provides a complete list of the Schema properties you can configure in the connection string for this provider.

---

Property	Description
Location	A path to the directory that contains the schema files defining tables, views, and stored procedures.
BrowsableSchemas	This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC.
Tables	This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC.
Views	Restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC.

A path to the directory that contains the schema files defining tables, views, and stored procedures.

Remarks

The path to a directory which contains the schema files for the Sync App (.rsd files for tables and views, .rsb files for stored procedures). The folder location can be a relative path from the location of the executable. The Location property is only needed if you want to customize definitions (for example, change a column name, ignore a column, and so on) or extend the data model with new tables, views, or stored procedures.

If left unspecified, the default location is "%APPDATA%\\CData\\Splunk Data Provider\\Schema" with %APPDATA% being set to the user's configuration directory:

Platform	%APPDATA%
Windows	The value of the APPDATA environment variable
Linux	~/.config

This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC.

Remarks

Listing the schemas from databases can be expensive. Providing a list of schemas in the connection string improves the performance.

This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC.

Remarks

Listing the tables from some databases can be expensive. Providing a list of tables in the connection string improves the performance of the Sync App.

This property can also be used as an alternative to automatically listing views if you already know which ones you want to work with and there would otherwise be too many to work with.

Specify the tables you want in a comma-separated list. Each table should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Tables=TableA,[TableB/WithSlash],WithCatalog.WithSchema.`TableC With Space`.

Note that when connecting to a data source with multiple schemas or catalogs, you will need to provide the fully qualified name of the table in this property, as in the last example here, to avoid ambiguity between tables that exist in multiple catalogs or schemas.

Restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC.

Remarks

Listing the views from some databases can be expensive. Providing a list of views in the connection string improves the performance of the Sync App.

This property can also be used as an alternative to automatically listing views if you already know which ones you want to work with and there would otherwise be too many to work with.

Specify the views you want in a comma-separated list. Each view should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Views=ViewA,[ViewB/WithSlash],WithCatalog.WithSchema.`ViewC With Space`.

Note that when connecting to a data source with multiple schemas or catalogs, you will need to provide the fully qualified name of the table in this property, as in the last example here, to avoid ambiguity between tables that exist in multiple catalogs or schemas.

This section provides a complete list of the Miscellaneous properties you can configure in the connection string for this provider.

---

Property	Description
IncludeInternalFields	Whether or not the CData ADO.NET Provider for Splunk should push the internal fields. These fields include: user, eventtype, etc.
MaxRows	Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.
MaxThreads	Specifies the number of concurrent requests. Only used when UseJobs is true.
Other	These hidden properties are used only in specific use cases.
Pagesize	The maximum number of results to return per page from Splunk.
PseudoColumns	This property indicates whether or not to include pseudo columns as columns to the table.
RowScanDepth	Set this property to control the number of rows scanned when TypeDetectionScheme is set to RowScan.
Timeout	The value in seconds until the timeout error is thrown, canceling the operation.
TypeDetectionScheme	Determines how to determine the data type of columns.
UseJobs	Specifies whether to use the jobs endpoint instead of the export endpoint. If set to true, the maximum number of returned rows is configured Splunk's limit.conf file.
UserDefinedViews	A filepath pointing to the JSON configuration file containing your custom views.

Whether or not the CData ADO.NET Provider for Splunk should push the internal fields. These fields include: user, eventtype, etc.

Remarks

Whether or not the CData Sync App should push the internal fields. These fields include: user, eventtype, etc.

Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.

Remarks

Limits the number of rows returned when no aggregation or GROUP BY is used in the query. This takes precedence over LIMIT clauses.

Specifies the number of concurrent requests. Only used when UseJobs is true.

Remarks

This property allows you to issue multiple requests simultaneously, thereby improving performance. Default value is 5 threads. Setting a higher value can result in OutOfMemory issues.

These hidden properties are used only in specific use cases.

Remarks

The properties listed below are available for specific use cases. Normal driver use cases and functionality should not require these properties.

Specify multiple properties in a semicolon-separated list.

Integration and Formatting

DefaultColumnSize	Sets the default length of string fields when the data source does not provide column length in the metadata. The default value is 2000.
ConvertDateTimeToGMT	Determines whether to convert date-time values to GMT, instead of the local time of the machine.
RecordToFile=filename	Records the underlying socket data transfer to the specified file.

The maximum number of results to return per page from Splunk.

Remarks

The Pagesize property affects the maximum number of results to return per page from Splunk. Setting a higher value may result in better performance at the cost of additional memory allocated per page consumed.

This property indicates whether or not to include pseudo columns as columns to the table.

Remarks

This setting is particularly helpful in Entity Framework, which does not allow you to set a value for a pseudo column unless it is a table column. The value of this connection setting is of the format "Table1=Column1, Table1=Column2, Table2=Column3". You can use the "*" character to include all tables and all columns; for example, "*=*".

Set this property to control the number of rows scanned when TypeDetectionScheme is set to RowScan.

Remarks

Determines the number of rows used to determine the column data types.

Setting a high value may decrease performance. Setting a low value may prevent the data type from being determined properly, especially when there is null data.

The value in seconds until the timeout error is thrown, canceling the operation.

Remarks

If Timeout = 0, operations do not time out. The operations run until they complete successfully or until they encounter an error condition.

If Timeout expires and the operation is not yet complete, the Sync App throws an exception.

Determines how to determine the data type of columns.

Remarks

None	Setting TypeDetectionScheme to None will return all columns as the string type.
RowScan	Setting TypeDetectionScheme to RowScan will scan rows to heuristically determine the data type. The RowScanDepth determines the number of rows to be scanned.

Specifies whether to use the jobs endpoint instead of the export endpoint. If set to true, the maximum number of returned rows is configured Splunk's limit.conf file.

Remarks

Whether to use the jobs endpoint instead of the export endpoint. While Jobs generally provide higher performance, the initial response time may be longer. If a Timeout error occurs, set the Timeout connection property to a higher value.

A filepath pointing to the JSON configuration file containing your custom views.

Remarks

User Defined Views are defined in a JSON-formatted configuration file called UserDefinedViews.json. The Sync App automatically detects the views specified in this file.

You can also have multiple view definitions and control them using the UserDefinedViews connection property. When you use this property, only the specified views are seen by the Sync App.

This User Defined View configuration file is formatted as follows:

• Each root element defines the name of a view.
• Each root element contains a child element, called query, which contains the custom SQL query for the view.

For example:

{
	"MyView": {
		"query": "SELECT * FROM DataModels WHERE MyColumn = 'value'"
	},
	"MyView2": {
		"query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)"
	}
}

Use the UserDefinedViews connection property to specify the location of your JSON configuration file. For example:

"UserDefinedViews", C:\Users\yourusername\Desktop\tmp\UserDefinedViews.json

Note that the specified path is not embedded in quotation marks.