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 supports the use of user defined views, virtual tables whose contents are decided by a pre-configured user defined query. These views are useful when you cannot directly control queries being issued to the drivers. For an overview of creating and configuring custom views, see User Defined Views .

SSL Configuration

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

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).

For further information, see Query Processing.

Logging

For an overview of configuration settings that can be used to refine CData logging, see Logging. Only two connection properties are required for basic logging, but there are numerous features that support more refined logging, which enables you to use the LogModules connection property to specify subsets of information to be logged.

Customizing the SSL Configuration

To enable TLS, set the following:

• URL: Prefix the connection string with https://

With this configuration, the Sync App attempts to negotiate TLS with the server. The server certificate is validated against the default system trusted certificate store. You can override how the certificate gets validated using the SSLServerCert connection property.

To specify another certificate, see the SSLServerCert connection property.

Connecting Through a Firewall or Proxy

HTTP Proxies

To authenticate to an HTTP proxy, set the following:

• ProxyServer: the hostname or IP address of the proxy server that you want to route HTTP traffic through.
• ProxyPort: the TCP port that the proxy server is running on.
• ProxyAuthScheme: the authentication method the Sync App uses when authenticating to the proxy server.
• ProxyUser: the username of a user account registered with the proxy server.
• ProxyPassword: the password associated with the ProxyUser.

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

Stored procedures are function-like interfaces that extend the functionality of the Sync App beyond simple SELECT/INSERT/UPDATE/DELETE operations with Splunk.

Stored procedures accept a list of parameters, perform their intended function, and then return any relevant response data from Splunk, along with an indication of whether the procedure succeeded or failed.

Splunk Connector for CData Sync Stored Procedures

Name	Description
CreateHTTPEvent	The HTTP Event Collector (HEC) lets you send data and application events to a Splunk deployment over the HTTP and Secure HTTP (HTTPS) protocols.
CreateIndex	Create a data index.
CreateSavedSearch	Create a saved search.
DeleteIndex	Delete a data index.
ReadJobResults	Read the results of a job given a search ID.
UpdateIndex	Update a data index.
UpdateSavedSearch	Update a saved search.

The HTTP Event Collector (HEC) lets you send data and application events to a Splunk deployment over the HTTP and Secure HTTP (HTTPS) protocols.

Input

Name	Type	Required	Description
EventContent	String	True	The name of the table or view.
ContentType	String	False	The type of the content specified on the EventContent input. Allowed values: JSON, RAWTEXT.
ChannelGUID	String	False	The GUID of the channel used for the event. This is requeired in case of ContentType=RAWTEXT.

Result Set Columns

Name	Type	Description
Success	String	Returns the success status of the created event.

Create a data index.

Input

Name	Type	Required	Description
Name	String	True	The name of the index to create.
BlockSignSize	String	False	Controls how many events make up a block for block signatures. If this is set to 0, block signing is disabled for this index. A recommended value is 100.
BucketRebuildMemoryHint	String	False	Suggestion for the bucket rebuild process for the size of the time-series (tsidx) file to make. Default value, auto, varies by the amount of physical RAM on the host.
ColdPath	String	False	An absolute path that contains the colddbs for the index. The path must be readable and writable.
ColdToFrozenDir	String	False	Destination path for the frozen archive. Use as an alternative to a ColdToFrozenScript.
ColdToFrozenScript	String	False	Path to the archiving script.
DataType	String	False	Specifies the type of index.
EnableOnlineBucketRepair	String	False	Enables asynchronous 'online fsck' bucket repair, which runs concurrently with splunk software. When enabled, you do not have to wait until buckets are repaired to start the splunk platform.
FrozenTimePeriodInSecs	String	False	Number of seconds after which indexed data rolls to frozen. Defaults to 188697600 (6 years).
HomePath	String	False	An absolute path that contains the hot and warm buckets for the index.
MaxBloomBackfillBucketAge	String	False	Valid values are: integer[m|s|h|d] if a warm or cold bucket is older than the specified age, do not create or rebuild its bloomfilter. Specify 0 to never rebuild bloomfilters.
MaxConcurrentOptimizes	String	False	The number of concurrent optimize processes that can run against a hot bucket.
MaxDataSize	String	False	The maximum size in MB for a hot DB to reach before a roll to warm is triggered. Specifying 'auto' or 'auto_high_volume' causes Splunk software to autotune this parameter (recommended).
MaxHotBuckets	String	False	Maximum hot buckets that can exist per index.
MaxHotIdleSecs	String	False	Maximum life, in seconds, of a hot bucket.
MaxHotSpanSecs	String	False	Upper bound of target maximum timespan of hot/warm buckets in seconds.
MaxMemMB	String	False	The amount of memory, expressed in MB, to allocate for buffering a single tsidx file into memory before flushing to disk.
MaxMetaEntries	String	False	Sets the maximum number of unique lines in . data files in a bucket, which may help to reduce memory consumption.
MaxTimeUnreplicatedNoAcks	String	False	Upper limit, in seconds, on how long an event can sit in raw slice. Applies only if replication is enabled for this index.
MaxTimeUnreplicatedWithAcks	String	False	Upper limit, in seconds, on how long events can sit unacknowledged in a raw slice. Applies only if you have enabled acks on forwarders and have replication enabled (with clustering).
MaxTotalDataSizeMB	String	False	The maximum size of an index (in MB). If an index grows larger than the maximum size, the oldest data is frozen.
MaxWarmDBCount	String	False	The maximum number of warm buckets. If this number is exceeded, the warm bucket/s with the lowest value for their latest times is moved to cold.
MinRawFileSyncSecs	String	False	Specify an integer (or 'disable') for this parameter. This parameter sets how frequently splunkd forces a filesystem sync while compressing journal slices.
MinStreamGroupQueueSize	String	False	Minimum size of the queue that stores events in memory before committing them to a tsidx file.
PartialServiceMetaPeriod	String	False	Related to serviceMetaPeriod. If set, it enables metadata sync every SPECIFIED seconds, but only for records where the sync can be done efficiently in-place, without requiring a full re-write of the metadata file.
ProcessTrackerServiceInterval	String	False	Specifies, in seconds, how often the indexer checks the status of the child OS processes it launched to see if it can launch new processes for queued requests. If set to 0, the indexer checks child process status every second.
QuarantineFutureSecs	String	False	Events with timestamp of QuarantineFutureSecs newer than 'now' are dropped into quarantine bucket.
QuarantinePastSecs	String	False	Events with timestamp of quarantinePastSecs older than 'now' are dropped into quarantine bucket.
RawChunkSizeBytes	String	False	Target uncompressed size in bytes for individual raw slice in the rawdata journal of the index. 0 is not a valid value. If 0 is specified, rawChunkSizeBytes is set to the default value.
RepFactor	String	False	Index replication control. This parameter applies to only clustering slaves. auto = Use the master index replication configuration value. 0 = Turn off replication for this index.
RotatePeriodInSecs	String	False	How frequently (in seconds) to check if a new hot bucket needs to be created. Also, how frequently to check if there are any warm/cold buckets that should be rolled/frozen.
ServiceMetaPeriod	String	False	Defines how frequently metadata is synced to disk, in seconds.
SyncMeta	String	False	When true, a sync operation is called before file descriptor is closed on metadata file updates. This functionality improves integrity of metadata files, especially in regards to operating system crashes/machine failures.
ThawedPath	String	False	An absolute path that contains the thawed (resurrected) databases for the index. Cannot be defined in terms of a volume definition.
ThrottleCheckPeriod	String	False	Defines how frequently Splunk software checks for index throttling condition, in seconds.
TstatsHomePath	String	False	Location to store datamodel acceleration TSIDX data for this index. If specified, it must be defined in terms of a volume definition. Path must be writable.
WarmToColdScript	String	False	Path to a script to run when moving data from warm to cold.

Result Set Columns

Name	Type	Description
AssureUTF8	Boolean	Boolean value indicating wheter all data retreived from the index is proper UTF8.
BlockSignSize	Integer	Controls how many events make up a block for block signatures. If this is set to 0, block signing is disabled for this index. A recommended value is 100.
BlockSignatureDatabase	String	The index that stores block signatures of events. This is a global setting, not a per index setting.
BucketRebuildMemoryHint	String	Suggestion for the bucket rebuild process for the size of the time-series (tsidx) file to make.
ColdPath	String	Filepath to the cold databases for the index.
ColdPathExpanded	String	Absoute filepath to the cold databases.
ColdToFrozenDir	String	Destination path for the frozen archive. Use as an alternative to a ColdToFrozenScript.
ColdToFrozenScript	String	Path to the archiving script.
CurrentDBSizeMB	Integer	Total size, in MB, of data stored in the index. The total incudes data in the home, cold and thawed paths.
DataType	String	The type of index.
DefaultDatabase	String	If no index destination information is available in the input data, the index shown here is the destination of such data.
EnableOnlineBucketRepair	Boolean	Enables asynchronous 'online fsck' bucket repair, which runs concurrently with splunk software. When enabled, you do not have to wait until buckets are repaired to start the splunk platform.
FrozenTimePeriodInSecs	Integer	Number of seconds after which indexed data rolls to frozen.
HomePath	String	An absolute path that contains the hot and warm buckets for the index.
HomePathExpanded	String	An absolute filepath to the hot and warm buckets for the index.
IndexThreads	String	Number of threads used for indexing. This is a global setting, not a per index setting.
IsInternal	Boolean	Indicates if this is an internal index.
IsReady	Boolean	Indicates if an index is properly initialized.
LastInitTime	Datetime	Last time the index processor was successfully initialized. This is a global setting, not a per index setting.
MaxBloomBackfillBucketAge	String	If a bucket (warm or cold) is older than this, Splunk software does not create (or re-create) its bloom filter.
MaxConcurrentOptimizes	Integer	The number of concurrent optimize processes that can run against a hot bucket.
MaxDataSize	String	The maximum size in MB for a hot DB to reach before a roll to warm is triggered. Specifying 'auto' or 'auto_high_volume' causes Splunk software to autotune this parameter (recommended).
MaxHotBuckets	String	Maximum hot buckets that can exist per index.
MaxHotIdleSecs	Integer	Maximum life, in seconds, of a hot bucket.
MaxHotSpanSecs	Integer	Upper bound of target maximum timespan of hot/warm buckets in seconds.
MaxMemMB	Integer	The amount of memory, expressed in MB, to allocate for buffering a single tsidx file into memory before flushing to disk.
MaxMetaEntries	Integer	Sets the maximum number of unique lines in . data files in a bucket, which may help to reduce memory consumption.
MaxTime	Datetime	ISO8601 timestamp ofThis setting is valid only when tsidxWritingLevel is at 4 or higher. This maximum term limit sets an upper bound on the number of terms kept inside an in-memory hash table that serves to improve tsidx compression.
MaxTimeUnreplicatedNoAcks	Integer	Upper limit, in seconds, on how long an event can sit in raw slice. Applies only if replication is enabled for this index.
MaxTimeUnreplicatedWithAcks	Integer	Upper limit, in seconds, on how long events can sit unacknowledged in a raw slice. Applies only if you have enabled acks on forwarders and have replication enabled (with clustering).
MaxTotalDataSizeMB	Integer	The maximum size of an index (in MB). If an index grows larger than the maximum size, the oldest data is frozen.
MaxWarmDBCount	String	The maximum number of warm buckets. If this number is exceeded, the warm bucket/s with the lowest value for their latest times is moved to cold.
MemPoolMB	String	Determines how much memory is given to the indexer memory pool. This is a global setting, not a per-index setting.
MinRawFileSyncSecs	String	Specify an integer (or 'disable') for this parameter. This parameter sets how frequently splunkd forces a filesystem sync while compressing journal slices.
MinStreamGroupQueueSize	Integer	Minimum size of the queue that stores events in memory before committing them to a tsidx file.
MinTime	Datetime	ISO8601 timestamp of the oldest event time in the index.
PartialServiceMetaPeriod	Integer	Related to serviceMetaPeriod. If set, it enables metadata sync every SPECIFIED seconds, but only for records where the sync can be done efficiently in-place, without requiring a full re-write of the metadata file.
ProcessTrackerServiceInterval	Integer	Specifies, in seconds, how often the indexer checks the status of the child OS processes it launched to see if it can launch new processes for queued requests. If set to 0, the indexer checks child process status every second.
QuarantineFutureSecs	Integer	Events with timestamp of QuarantineFutureSecs newer than 'now' are dropped into quarantine bucket.
QuarantinePastSecs	Integer	Events with timestamp of quarantinePastSecs older than 'now' are dropped into quarantine bucket.
RawChunkSizeBytes	Integer	Target uncompressed size in bytes for individual raw slice in the rawdata journal of the index. 0 is not a valid value. If 0 is specified, rawChunkSizeBytes is set to the default value.
RepFactor	String	Index replication control. This parameter applies to only clustering slaves. auto = Use the master index replication configuration value. 0 = Turn off replication for this index.
RotatePeriodInSecs	Integer	How frequently (in seconds) to check if a new hot bucket needs to be created. Also, how frequently to check if there are any warm/cold buckets that should be rolled/frozen.
ServiceMetaPeriod	Integer	Defines how frequently metadata is synced to disk, in seconds.
SuppressBannerList	String	List of indexes for which we suppress 'index missing' warning banner messages. This is a global setting, not a per index setting.
Sync	String	Specifies the number of events that trigger the indexer to sync events. This is a global setting, not a per index setting.
SyncMeta	Boolean	When true, a sync operation is called before file descriptor is closed on metadata file updates. This functionality improves integrity of metadata files, especially in regards to operating system crashes/machine failures.
ThawedPath	String	An absolute path that contains the thawed (resurrected) databases for the index. Cannot be defined in terms of a volume definition.
ThawedPathExpanded	String	Absolute filepath to the thawed (resurrected) databases.
ThrottleCheckPeriod	Integer	Defines how frequently Splunk software checks for index throttling condition, in seconds.
TotalEventCount	Integer	Total number of events in the index.
TsidxDedupPostingsListMaxTermsLimit	Integer	This setting is valid only when tsidxWritingLevel is at 4 or higher. This maximum term limit sets an upper bound on the number of terms kept inside an in-memory hash table that serves to improve tsidx compression.
TstatsHomePath	String	Location to store datamodel acceleration TSIDX data for this index. If specified, it must be defined in terms of a volume definition. Path must be writable.
WarmToColdScript	String	Path to a script to run when moving data from warm to cold.
Success	Boolean	Boolean indicating whether the stored procedure was executed successfully.
ErrorCode	Integer	The error code in case the procedure is not executed successfully.
ErrorMessage	String	The error message in case the procedure is not executed successfully.

Create a saved search.

Input

Name	Type	Required	Description
Name	String	True	A name for the search
Search	String	True	The search query to save
Description	String	False	Description of this saved search.
CronSchedule	String	False	The cron schedule to execute this search. For example: */5 * * * * causes the search to execute every 5 minutes.
Disabled	Boolean	False	Indicates if this saved search is disabled.
IsScheduled	Boolean	False	Indicates if this search is to be run on a schedule.
IsVisible	Boolean	False	Indicates if this saved search appears in the visible saved search list.
RealTimeSchedule	Boolean	False	If this value is set to 1, the scheduler bases its determination of the next scheduled search execution time on the current time. If this value is set to 0, it is determined based on the last search execution time.
RunOnStartup	Boolean	False	Indicates whether this search runs on startup. If it does not run on startup, it runs at the next scheduled time.
SchedulePriority	String	False	Indicates the scheduling priority of a specific search. The allowed values are default, higher, highest.
UserContext	String	False	If user context is provided, servicesNS node will be used (/servicesNS/[UserContext]/search), otherwise it defaults to the general endpoint /services.

Result Set Columns

Name	Type	Description
Success	Boolean	Returns the success status of the created saved search.
Message	String	Warnings from the server.

Creates a schema file for the specified table or view.

CreateSchema

Creates a local schema file (.rsd) from an existing table or view in the data model.

The schema file is created in the directory set in the Location connection property when this procedure is executed. You can edit the file to include or exclude columns, rename columns, or adjust column datatypes.

The Sync App checks the Location to determine if the names of any .rsd files match a table or view in the data model. If there is a duplicate, the schema file will take precedence over the default instance of this table in the data model. If a schema file is present in Location that does not match an existing table or view, a new table or view entry is added to the data model of the Sync App.

Input

Name	Type	Required	Description
TableName	String	True	The name of the table or view.
FileName	String	False	The full file path and name of the schema to generate. The Location connection property specifies the default output directory.

Result Set Columns

Name	Type	Description
Result	String	Returns Success or Failure.
FileData	String	If the FileName input is empty.

Delete a data index.

Input

Name	Type	Required	Description
Name	String	True	The name of the index to delete.

Result Set Columns

Name	Type	Description
Success	Boolean	Boolean indicating whether the stored procedure was executed successfully.
ErrorCode	Integer	The error code in case the procedure is not executed successfully.
ErrorMessage	String	The error code in case the procedure is not executed successfully.

Read the results of a job given a search ID.

Input

Name	Type	Required	Description
SID	String	True	The Search ID for which to get the results.
UserContext	String	False	Set this value to make use of /servicesNS/{UserContext}/{AppContext} node. Required if AppContext is present. If left unspecified, the node /services will be utilized.
AppContext	String	False	Set this value to make use of /servicesNS/{UserContext}/{AppContext} node. Required if UserContext is present. If left unspecified, the node /services will be utilized.
Offset	Integer	False	The starting point for the results to be returned. If tis not set, defaults to 0.
Count	Integer	False	The number of results to be returned. If not set the value of Pagesize connection property will be used.
Rows@next	String	False

Result Set Columns

Name	Type	Description
*	String

Update a data index.

Input

Name	Type	Required	Description
Name	String	True	The name of the index to update.
BlockSignSize	String	False	Controls how many events make up a block for block signatures. If this is set to 0, block signing is disabled for this index. A recommended value is 100.
BucketRebuildMemoryHint	String	False	Suggestion for the bucket rebuild process for the size of the time-series (tsidx) file to make. Default value, auto, varies by the amount of physical RAM on the host.
ColdToFrozenDir	String	False	Destination path for the frozen archive. Use as an alternative to a ColdToFrozenScript.
ColdToFrozenScript	String	False	Path to the archiving script.
EnableOnlineBucketRepair	String	False	Enables asynchronous 'online fsck' bucket repair, which runs concurrently with splunk software. When enabled, you do not have to wait until buckets are repaired to start the splunk platform.
FrozenTimePeriodInSecs	String	False	Number of seconds after which indexed data rolls to frozen. Defaults to 188697600 (6 years).
MaxBloomBackfillBucketAge	String	False	Valid values are: integer[m|s|h|d] if a warm or cold bucket is older than the specified age, do not create or rebuild its bloomfilter. Specify 0 to never rebuild bloomfilters.
MaxConcurrentOptimizes	String	False	The number of concurrent optimize processes that can run against a hot bucket.
MaxDataSize	String	False	The maximum size in MB for a hot DB to reach before a roll to warm is triggered. Specifying 'auto' or 'auto_high_volume' causes Splunk software to autotune this parameter (recommended).
MaxHotBuckets	String	False	Maximum hot buckets that can exist per index.
MaxHotIdleSecs	String	False	Maximum life, in seconds, of a hot bucket.
MaxHotSpanSecs	String	False	Upper bound of target maximum timespan of hot/warm buckets in seconds.
MaxMemMB	String	False	The amount of memory, expressed in MB, to allocate for buffering a single tsidx file into memory before flushing to disk.
MaxMetaEntries	String	False	Sets the maximum number of unique lines in . data files in a bucket, which may help to reduce memory consumption.
MaxTimeUnreplicatedNoAcks	String	False	Upper limit, in seconds, on how long an event can sit in raw slice. Applies only if replication is enabled for this index.
MaxTimeUnreplicatedWithAcks	String	False	Upper limit, in seconds, on how long events can sit unacknowledged in a raw slice. Applies only if you have enabled acks on forwarders and have replication enabled (with clustering).
MaxTotalDataSizeMB	String	False	The maximum size of an index (in MB). If an index grows larger than the maximum size, the oldest data is frozen.
MaxWarmDBCount	String	False	The maximum number of warm buckets. If this number is exceeded, the warm bucket/s with the lowest value for their latest times is moved to cold.
MinRawFileSyncSecs	String	False	Specify an integer (or 'disable') for this parameter. This parameter sets how frequently splunkd forces a filesystem sync while compressing journal slices.
MinStreamGroupQueueSize	String	False	Minimum size of the queue that stores events in memory before committing them to a tsidx file.
PartialServiceMetaPeriod	String	False	Related to serviceMetaPeriod. If set, it enables metadata sync every n seconds, but only for records where the sync can be done efficiently in-place, without requiring a full re-write of the metadata file.
ProcessTrackerServiceInterval	String	False	Specifies, in seconds, how often the indexer checks the status of the child OS processes it launched to see if it can launch new processes for queued requests. If set to 0, the indexer checks child process status every second.
QuarantineFutureSecs	String	False	Events with timestamp of QuarantineFutureSecs newer than 'now' are dropped into quarantine bucket.
QuarantinePastSecs	String	False	Events with timestamp of quarantinePastSecs older than 'now' are dropped into quarantine bucket.
RawChunkSizeBytes	String	False	Target uncompressed size in bytes for individual raw slice in the rawdata journal of the index. 0 is not a valid value. If 0 is specified, rawChunkSizeBytes is set to the default value.
RepFactor	String	False	Index replication control. This parameter applies to only clustering slaves. auto = Use the master index replication configuration value. 0 = Turn off replication for this index.
RotatePeriodInSecs	String	False	How frequently (in seconds) to check if a new hot bucket needs to be created. Also, how frequently to check if there are any warm/cold buckets that should be rolled/frozen.
ServiceMetaPeriod	String	False	Defines how frequently metadata is synced to disk, in seconds.
SyncMeta	String	False	When true, a sync operation is called before file descriptor is closed on metadata file updates. This functionality improves integrity of metadata files, especially in regards to operating system crashes/machine failures.
ThrottleCheckPeriod	String	False	Defines how frequently Splunk software checks for index throttling condition, in seconds.
TstatsHomePath	String	False	Location to store datamodel acceleration TSIDX data for this index. If specified, it must be defined in terms of a volume definition. Path must be writable.
WarmToColdScript	String	False	Path to a script to run when moving data from warm to cold.

Result Set Columns

Name	Type	Description
AssureUTF8	Boolean	Boolean value indicating wheter all data retreived from the index is proper UTF8.
BlockSignSize	Integer	Controls how many events make up a block for block signatures. If this is set to 0, block signing is disabled for this index. A recommended value is 100.
BlockSignatureDatabase	String	The index that stores block signatures of events. This is a global setting, not a per index setting.
BucketRebuildMemoryHint	String	Suggestion for the bucket rebuild process for the size of the time-series (tsidx) file to make.
ColdPath	String	Filepath to the cold databases for the index.
ColdPathExpanded	String	Absoute filepath to the cold databases.
ColdToFrozenDir	String	Destination path for the frozen archive. Use as an alternative to a ColdToFrozenScript.
ColdToFrozenScript	String	Path to the archiving script.
CurrentDBSizeMB	Integer	Total size, in MB, of data stored in the index. The total incudes data in the home, cold and thawed paths.
DefaultDatabase	String	If no index destination information is available in the input data, the index shown here is the destination of such data.
EnableOnlineBucketRepair	Boolean	Enables asynchronous 'online fsck' bucket repair, which runs concurrently with splunk software. When enabled, you do not have to wait until buckets are repaired to start the splunk platform.
EnableRealtimeSearch	Boolean	Indicates if this is a real-time search. This is a global setting, not a per index setting.
FrozenTimePeriodInSecs	Integer	Number of seconds after which indexed data rolls to frozen.
HomePath	String	An absolute path that contains the hot and warm buckets for the index.
HomePathExpanded	String	An absolute filepath to the hot and warm buckets for the index.
IndexThreads	String	Number of threads used for indexing. This is a global setting, not a per index setting.
IsInternal	Boolean	Indicates if this is an internal index.
LastInitTime	Datetime	Last time the index processor was successfully initialized. This is a global setting, not a per index setting.
MaxBloomBackfillBucketAge	String	If a bucket (warm or cold) is older than this, Splunk software does not create (or re-create) its bloom filter.
MaxConcurrentOptimizes	Integer	The number of concurrent optimize processes that can run against a hot bucket.
MaxDataSize	String	The maximum size in MB for a hot DB to reach before a roll to warm is triggered. Specifying 'auto' or 'auto_high_volume' causes Splunk software to autotune this parameter (recommended).
MaxHotBuckets	String	Maximum hot buckets that can exist per index.
MaxHotIdleSecs	Integer	Maximum life, in seconds, of a hot bucket.
MaxHotSpanSecs	Integer	Upper bound of target maximum timespan of hot/warm buckets in seconds.
MaxMemMB	Integer	The amount of memory, expressed in MB, to allocate for buffering a single tsidx file into memory before flushing to disk.
MaxMetaEntries	Integer	Sets the maximum number of unique lines in . data files in a bucket, which may help to reduce memory consumption.
MaxTime	Datetime	ISO8601 timestamp ofThis setting is valid only when tsidxWritingLevel is at 4 or higher. This maximum term limit sets an upper bound on the number of terms kept inside an in-memory hash table that serves to improve tsidx compression.
MaxTimeUnreplicatedNoAcks	Integer	Upper limit, in seconds, on how long an event can sit in raw slice. Applies only if replication is enabled for this index.
MaxTimeUnreplicatedWithAcks	Integer	Upper limit, in seconds, on how long events can sit unacknowledged in a raw slice. Applies only if you have enabled acks on forwarders and have replication enabled (with clustering).
MaxTotalDataSizeMB	Integer	The maximum size of an index (in MB). If an index grows larger than the maximum size, the oldest data is frozen.
MaxWarmDBCount	String	The maximum number of warm buckets. If this number is exceeded, the warm bucket/s with the lowest value for their latest times is moved to cold.
MemPoolMB	String	Determines how much memory is given to the indexer memory pool. This is a global setting, not a per-index setting.
MinRawFileSyncSecs	String	Specify an integer (or 'disable') for this parameter. This parameter sets how frequently splunkd forces a filesystem sync while compressing journal slices.
MinStreamGroupQueueSize	Integer	Minimum size of the queue that stores events in memory before committing them to a tsidx file.
MinTime	Datetime	ISO8601 timestamp of the oldest event time in the index.
PartialServiceMetaPeriod	Integer	Related to serviceMetaPeriod. If set, it enables metadata sync every SPECIFIED seconds, but only for records where the sync can be done efficiently in-place, without requiring a full re-write of the metadata file.
ProcessTrackerServiceInterval	Integer	Specifies, in seconds, how often the indexer checks the status of the child OS processes it launched to see if it can launch new processes for queued requests. If set to 0, the indexer checks child process status every second.
QuarantineFutureSecs	Integer	Events with timestamp of QuarantineFutureSecs newer than 'now' are dropped into quarantine bucket.
QuarantinePastSecs	Integer	Events with timestamp of quarantinePastSecs older than 'now' are dropped into quarantine bucket.
RawChunkSizeBytes	Integer	Target uncompressed size in bytes for individual raw slice in the rawdata journal of the index. 0 is not a valid value. If 0 is specified, rawChunkSizeBytes is set to the default value.
RepFactor	String	Index replication control. This parameter applies to only clustering slaves. auto = Use the master index replication configuration value. 0 = Turn off replication for this index.
RotatePeriodInSecs	Integer	How frequently (in seconds) to check if a new hot bucket needs to be created. Also, how frequently to check if there are any warm/cold buckets that should be rolled/frozen.
ServiceMetaPeriod	Integer	Defines how frequently metadata is synced to disk, in seconds.
SuppressBannerList	String	List of indexes for which we suppress 'index missing' warning banner messages. This is a global setting, not a per index setting.
Sync	String	Specifies the number of events that trigger the indexer to sync events. This is a global setting, not a per index setting.
SyncMeta	Boolean	When true, a sync operation is called before file descriptor is closed on metadata file updates. This functionality improves integrity of metadata files, especially in regards to operating system crashes/machine failures.
ThawedPath	String	An absolute path that contains the thawed (resurrected) databases for the index. Cannot be defined in terms of a volume definition.
ThawedPathExpanded	String	Absolute filepath to the thawed (resurrected) databases.
ThrottleCheckPeriod	Integer	Defines how frequently Splunk software checks for index throttling condition, in seconds.
TotalEventCount	Integer	Total number of events in the index.
TsidxDedupPostingsListMaxTermsLimit	Integer	This setting is valid only when tsidxWritingLevel is at 4 or higher. This maximum term limit sets an upper bound on the number of terms kept inside an in-memory hash table that serves to improve tsidx compression.
TstatsHomePath	String	Location to store datamodel acceleration TSIDX data for this index. If specified, it must be defined in terms of a volume definition. Path must be writable.
WarmToColdScript	String	Path to a script to run when moving data from warm to cold.
Success	Boolean	Boolean indicating whether the stored procedure was executed successfully.
ErrorCode	Integer	The error code in case the procedure is not executed successfully.
ErrorMessage	String	The error message in case the procedure is not executed successfully.

Update a saved search.

Input

Name	Type	Required	Description
Name	String	True	A name for the search
Search	String	False	The search query to save
Description	String	False	Description of this saved search.
CronSchedule	String	False	The cron schedule to execute this search. For example: */5 * * * * causes the search to execute every 5 minutes.
Disabled	Boolean	False	Indicates if this saved search is disabled.
IsScheduled	Boolean	False	Indicates if this search is to be run on a schedule.
IsVisible	Boolean	False	Indicates if this saved search appears in the visible saved search list.
RealTimeSchedule	Boolean	False	If this value is set to 1, the scheduler bases its determination of the next scheduled search execution time on the current time. If this value is set to 0, it is determined based on the last search execution time.
RunOnStartup	Boolean	False	Indicates whether this search runs on startup. If it does not run on startup, it runs at the next scheduled time.
SchedulePriority	String	False	Indicates the scheduling priority of a specific search. The allowed values are default, higher, highest.

Result Set Columns

Name	Type	Description
Success	Boolean	Returns the success status of the created saved search.
Message	String	Warnings from the server.

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	Specifies the authenticating user's user ID.
Password	Specifies the authenticating user's password.

SSL

---

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

Firewall

---

Property	Description
FirewallType	Specifies the protocol the provider uses to tunnel traffic through a proxy-based firewall.
FirewallServer	Identifies the IP address, DNS name, or host name of a proxy used to traverse a firewall and relay user queries to network resources.
FirewallPort	Specifies the TCP port to be used for a proxy-based firewall.
FirewallUser	Identifies the user ID of the account authenticating to a proxy-based firewall.
FirewallPassword	Specifies the password of the user account authenticating to a proxy-based firewall.

Proxy

---

Property	Description
ProxyAutoDetect	Specifies whether the provider checks your system proxy settings for existing proxy server configurations, rather than using a manually specified proxy server.
ProxyServer	Identifies the hostname or IP address of the proxy server through which you want to route HTTP traffic.
ProxyPort	Identifies the TCP port on your specified proxy server that has been reserved for routing HTTP traffic to and from the client.
ProxyAuthScheme	Specifies the authentication method the provider uses when authenticating to the proxy server specified in the ProxyServer connection property.
ProxyUser	Provides the username of a user account registered with the proxy server specified in the ProxyServer connection property.
ProxyPassword	Specifies the password of the user specified in the ProxyUser connection property.
ProxySSLType	Specifies the SSL type to use when connecting to the proxy server specified in the ProxyServer connection property.
ProxyExceptions	Specifies a semicolon-separated list of destination hostnames or IPs that are exempt from connecting through the proxy server set in the ProxyServer connection property.

Logging

---

Property	Description
LogModules	Specifies the core modules to include in the log file. Use a semicolon-separated list of module names. By default, all modules are logged.

Schema

---

Property	Description
Location	Specifies the location of a directory containing schema files that define tables, views, and stored procedures. Depending on your service's requirements, this may be expressed as either an absolute path or a relative path.
BrowsableSchemas	Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC .
Tables	Optional setting that restricts the tables reported to a subset of all available tables. For example, Tables=TableA,TableB,TableC .
Views	Optional setting that restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC .

Miscellaneous

---

Property	Description
ExcludeObjectTypes	A comma delimited list of object types to exclude during metadata retrieval.
IncludeInternalFields	Whether or not the CData ADO.NET Provider for Splunk should push the internal fields. These fields include: user, eventtype, etc.
MaxRows	Specifies the maximum number of rows returned for queries that do not include either aggregation or GROUP BY.
MaxThreads	Specifies the number of concurrent requests. Only used when UseJobs is true.
Other	Specifies advanced connection properties for specialized scenarios. Use this property only under the guidance of our Support team to address specific issues.
Pagesize	Specifies the maximum number of records per page the provider returns when requesting data from Splunk.
PseudoColumns	Specifies the pseudocolumns to expose as table columns, expressed as a string in the format 'TableName=ColumnName;TableName=ColumnName'.
RowScanDepth	Set this property to control the number of rows scanned when TypeDetectionScheme is set to RowScan.
Timeout	Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error.
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	Specifies a filepath to a JSON configuration file that defines custom views. The provider automatically detects and uses the views specified in this file.

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	Specifies the authenticating user's user ID.
Password	Specifies the authenticating user's password.

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).

Specifies the authenticating user's user ID.

Remarks

The authenticating server requires both User and Password to validate the user's identity.

Specifies the authenticating user's password.

Remarks

The authenticating server requires both User and Password to validate the user's identity.

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

---

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

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

Remarks

If you are using a TLS/SSL connection, use this property to specify the TLS/SSL certificate to be accepted from the server. If you specify a value for this property, all other certificates that are not trusted by the machine are 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

Note: It is possible to use '*' to signify that all certificates should be accepted, but due to security concerns this is not recommended.

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

---

Property	Description
FirewallType	Specifies the protocol the provider uses to tunnel traffic through a proxy-based firewall.
FirewallServer	Identifies the IP address, DNS name, or host name of a proxy used to traverse a firewall and relay user queries to network resources.
FirewallPort	Specifies the TCP port to be used for a proxy-based firewall.
FirewallUser	Identifies the user ID of the account authenticating to a proxy-based firewall.
FirewallPassword	Specifies the password of the user account authenticating to a proxy-based firewall.

Specifies the protocol the provider uses to tunnel traffic through a proxy-based firewall.

Remarks

A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.

Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.

Note: 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.

The following table provides port number information for each of the supported protocols.

Protocol	Default Port	Description
TUNNEL	80	The port where the Sync App opens a connection to Splunk. Traffic flows back and forth via the proxy at this location.
SOCKS4	1080	The port where the Sync App opens a connection to Splunk. SOCKS 4 then passes theFirewallUser value to the proxy, which determines whether the connection request should be granted.
SOCKS5	1080	The port where the Sync App sends data to Splunk. If the SOCKS 5 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.

Identifies the IP address, DNS name, or host name of a proxy used to traverse a firewall and relay user queries to network resources.

Remarks

A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.

Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.

Specifies the TCP port to be used for a proxy-based firewall.

Remarks

A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.

Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.

Identifies the user ID of the account authenticating to a proxy-based firewall.

Remarks

A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.

Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.

Specifies the password of the user account authenticating to a proxy-based firewall.

Remarks

A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.

Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.

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

---

Property	Description
ProxyAutoDetect	Specifies whether the provider checks your system proxy settings for existing proxy server configurations, rather than using a manually specified proxy server.
ProxyServer	Identifies the hostname or IP address of the proxy server through which you want to route HTTP traffic.
ProxyPort	Identifies the TCP port on your specified proxy server that has been reserved for routing HTTP traffic to and from the client.
ProxyAuthScheme	Specifies the authentication method the provider uses when authenticating to the proxy server specified in the ProxyServer connection property.
ProxyUser	Provides the username of a user account registered with the proxy server specified in the ProxyServer connection property.
ProxyPassword	Specifies the password of the user specified in the ProxyUser connection property.
ProxySSLType	Specifies the SSL type to use when connecting to the proxy server specified in the ProxyServer connection property.
ProxyExceptions	Specifies a semicolon-separated list of destination hostnames or IPs that are exempt from connecting through the proxy server set in the ProxyServer connection property.

Specifies whether the provider checks your system proxy settings for existing proxy server configurations, rather than using a manually specified proxy server.

Remarks

When this connection property is set to True, the Sync App checks your system proxy settings for existing proxy server configurations (no need to manually supply proxy server details).

This connection property takes precedence over other proxy settings. If you want to configure the Sync App to connect to a specific proxy server, set ProxyAutoDetect to False.

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

Identifies the hostname or IP address of the proxy server through which you want to route HTTP traffic.

Remarks

The Sync App only routes HTTP traffic through the proxy server specified in this connection property when ProxyAutoDetect is set to False.

If ProxyAutoDetect is set to True (the default), the Sync App instead routes HTTP traffic through the proxy server specified in your system proxy settings.

Identifies the TCP port on your specified proxy server that has been reserved for routing HTTP traffic to and from the client.

Remarks

The Sync App only routes HTTP traffic through the ProxyServer port specified in this connection property when ProxyAutoDetect is set to False.

If ProxyAutoDetect is set to True (the default), the Sync App instead routes HTTP traffic through the proxy server port specified in your system proxy settings.

For other proxy types, see FirewallType.

Specifies the authentication method the provider uses when authenticating to the proxy server specified in the ProxyServer connection property.

Remarks

Supported authentication types :

• BASIC: The Sync App performs HTTP basic authentication.
• DIGEST: The Sync App performs HTTP digest authentication.
• NTLM: The Sync App retrieves an NTLM token.
• NEGOTIATE: The Sync App retrieves an NTLM or Kerberos token based on the applicable protocol for authentication.
• NONE: Signifies that the ProxyServer does not require authentication.

For all values other than NONE, you must also set the ProxyUser and ProxyPassword connection properties.

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

Provides the username of a user account registered with the proxy server specified in the ProxyServer connection property.

Remarks

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

After selecting one of the available authentication types in ProxyAuthScheme, set this property as follows:

ProxyAuthScheme Value	Value to set for ProxyUser
BASIC	The username of a user registered with the proxy server.
DIGEST	The username of a user registered with the proxy server.
NEGOTIATE	The username of a Windows user who is a valid user in the domain or trusted domain that the proxy server is part of, in the format user@domain or domain\user.
NTLM	The username of a Windows user who is a valid user in the domain or trusted domain that the proxy server is part of, in the format user@domain or domain\user.
NONE	Do not set the ProxyPassword connection property.

Note: The Sync App only uses this username if ProxyAutoDetect is set to False. If ProxyAutoDetect is set to True (the default), the Sync App instead uses the username specified in your system proxy settings.

Specifies the password of the user specified in the ProxyUser connection property.

Remarks

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

After selecting one of the available authentication types in ProxyAuthScheme, set this property as follows:

ProxyAuthScheme Value	Value to set for ProxyPassword
BASIC	The password associated with the proxy server user specified in ProxyUser.
DIGEST	The password associated with the proxy server user specified in ProxyUser.
NEGOTIATE	The password associated with the Windows user account specified in ProxyUser.
NTLM	The password associated with the Windows user account specified in ProxyUser.
NONE	Do not set the ProxyPassword connection property.

For SOCKS 5 authentication or tunneling, see FirewallType.

Note: The Sync App only uses this password if ProxyAutoDetect is set to False. If ProxyAutoDetect is set to True (the default), the Sync App instead uses the password specified in your system proxy settings.

Specifies the SSL type to use when connecting to the proxy server specified in the ProxyServer connection property.

Remarks

This property determines when to use SSL for the connection to the HTTP proxy specified by ProxyServer. You can set this connection property to the following values :

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

Specifies a semicolon-separated list of destination hostnames or IPs that are exempt from connecting through the proxy server set in the ProxyServer connection property.

Remarks

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

Note: 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, set ProxyAutoDetect to False.

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

---

Property	Description
LogModules	Specifies the core modules to include in the log file. Use a semicolon-separated list of module names. By default, all modules are logged.

Specifies the core modules to include in the log file. Use a semicolon-separated list of module names. By default, all modules are logged.

Remarks

The Sync App writes details about each operation it performs into the logfile specified by the Logfile connection property.

Each of these logged operations are assigned to a themed category called a module, and each module has a corresponding short code used to labels individual Sync App operations as belonging to that module.

When this connection property is set to a semicolon-separated list of module codes, only operations belonging to the specified modules are written to the logfile. Note that this only affects which operations are logged moving forward and doesn't retroactively alter the existing contents of the logfile. For example: INFO;EXEC;SSL;META;

By default, logged operations from all modules are included.

You can explicitly exclude a module by prefixing it with a "-". For example: -HTTP

To apply filters to submodules, identify them with the syntax <module name>.<submodule name>. For example, the following value causes the Sync App to only log actions belonging to the HTTP module, and further refines it to exclude actions belonging to the Res submodule of the HTTP module: HTTP;-HTTP.Res

Note that the logfile filtering triggered by the Verbosity connection property takes precedence over the filtering imposed by this connection property. This means that operations of a higher verbosity level than the level specified in the Verbosity connection property are not printed in the logfile, even if they belong to one of the modules specified in this connection property.

The available modules and submodules are:

Module Name	Module Description	Submodules
INFO	General Information. Includes the connection string, product version (build number), and initial connection messages.	Connec – Information related to creating or destroying connections. Messag – Generic label for messages pertaining to connections, the connection string, and product version. These messages are typically specific to the Sync App, rather than being received and passed along directly from the service.
EXEC	Query Execution. Includes execution messages for user-written SQL queries, parsed SQL queries, and normalized SQL queries. Success/failure messages for queries and query pages appear here as well.	Messag – Messages pertaining to query execution. These messages are typically specific to the Sync App, rather than being received and passed along directly from the service. Normlz – Query normalization steps. Query normalization is when the product takes the user-submitted query and rewrites the query to get the same results with optimal performance. Origin – This label applies to any messages recording a user's original query (the exact, unaltered, non-normalized query executed by the user). Page – Messages related to query paging. Parsed – Query parsing steps. Parsing is the process of converting the user-submitted query into a standardized format for easier processing.
HTTP	HTTP protocol messages. Includes HTTP requests/responses (including POST messages), as well as Kerberos related messages.	KERB – HTTP requests related to Kerberos. Messag – Messages pertaining to HTTP protocols. These messages are typically specific to the Sync App, rather than being received and passed along directly from the service. Unpack – This label applies to messages about zipped data being returned from the service API and unpacked by the product. Res – Messages containing HTTP responses. Req – Messages containing HTTP requests.
WSDL	Messages pertaining to the generation of WSDL/XSD files.	—
SSL	SSL certificate messages.	Certif – Messages pertaining to SSL certificates.
AUTH	Authentication related failure/success messages.	Messag – Messages pertaining to authentication. These messages are typically specific to the Sync App, rather than being received and passed along directly from the service. OAuth – Messages related to OAuth authentication. Krbros – Kerberos-related authentication messages.
SQL	Includes SQL transactions, SQL bulk transfer messages, and SQL result set messages.	Bulk – Messages pertaining to bulk query execution. Cache – Messages related to reading row data from and writing row data to the product's cache for better performance. Messag – Messages pertaining to SQL transactions. These messages are typically specific to the Sync App, rather than being received and passed along directly from the service. ResSet – Query resultsets. Transc – Messages related to handling transactions, including information about the number of jobs executed and backup table handling.
META	Metadata cache and schema messages.	Cache – Messages related to reading from and modifying column and table definitions in the product's cache for better performance. Schema – Messages related to retrieving metadata from or modifying the service schema. MemSto – Messages related to writing to or reading from in-memory metadata cache. Storag – Messages relating to storing metadata on disk or in an external data store, rather than in memory.
FUNC	Information related to executing SQL functions.	Errmsg – Error messages related to executing SQL functions.
TCP	Incoming and outgoing raw bytes on TCP transport layer messages.	Send – Raw data sent via the TCP protocol. Receiv – Raw data received via the TCP protocol.
FTP	Messages pertaining to the File Transfer Protocol.	Info – Status messages related to communication in the FTP protocol. Client – Messages related to actions taken by the FTP client (the product) during FTP communication. Server – Messages related to actions taken by the FTP server during FTP communication.
SFTP	Messages pertaining to the Secure File Transfer Protocol.	Info – Status messages related to communication in the SFTP protocol. To_Server – Messages related to actions taken by the SFTP client (the product) during SFTP communication. From_Server – Messages related to actions taken by the SFTP server during SFTP communication.
POP	Messages pertaining to data transferred via the Post Office Protocol.	Client – Messages related to actions taken by the POP client (the product) during POP communication. Server – Messages related to actions taken by the POP server during POP communication. Status – Status messages related to communication in the POP protocol.
SMTP	Messages pertaining to data transferred via the Simple Mail Transfer Protocol.	Client – Messages related to actions taken by the SMTP client (the product) during SMTP communication. Server – Messages related to actions taken by the SMTP server during SMTP communication. Status – Status messages related to communication in the SMTP protocol.
CORE	Messages relating to various internal product operations not covered by other modules.	—
DEMN	Messages related to SQL remoting.	—
CLJB	Messages about bulk data uploads (cloud job).	Commit – Submissions for bulk data uploads.
SRCE	Miscellaneous messages produced by the product that don't belong in any other module.	—
TRANCE	Advanced messages concerning low-level product operations.	—

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

---

Property	Description
Location	Specifies the location of a directory containing schema files that define tables, views, and stored procedures. Depending on your service's requirements, this may be expressed as either an absolute path or a relative path.
BrowsableSchemas	Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC .
Tables	Optional setting that restricts the tables reported to a subset of all available tables. For example, Tables=TableA,TableB,TableC .
Views	Optional setting that restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC .

Specifies the location of a directory containing schema files that define tables, views, and stored procedures. Depending on your service's requirements, this may be expressed as either an absolute path or a relative path.

Remarks

The Location property is only needed if you want to either customize definitions (for example, change a column name, ignore a column, etc.) 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, where %APPDATA% is set to the user's configuration directory:

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

Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC .

Remarks

Listing all available database schemas can take extra time, thus degrading performance. Providing a list of schemas in the connection string saves time and improves performance.

Optional setting that restricts the tables reported to a subset of all available tables. For example, Tables=TableA,TableB,TableC .

Remarks

Listing all available tables from some databases can take extra time, thus degrading performance. Providing a list of tables in the connection string saves time and improves performance.

If there are lots of tables available and you already know which ones you want to work with, you can use this property to restrict your viewing to only those tables. To do this, 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: If you are connecting to a data source with multiple schemas or catalogs, you must specify each table you want to view by its fully qualified name. This avoids ambiguity between tables that may exist in multiple catalogs or schemas.

Optional setting that restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC .

Remarks

Listing all available views from some databases can take extra time, thus degrading performance. Providing a list of views in the connection string saves time and improves performance.

If there are lots of views available and you already know which ones you want to work with, you can use this property to restrict your viewing to only those views. To do this, 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: If you are connecting to a data source with multiple schemas or catalogs, you must specify each view you want to examine by its fully qualified name. This avoids ambiguity between views that may 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
ExcludeObjectTypes	A comma delimited list of object types to exclude during metadata retrieval.
IncludeInternalFields	Whether or not the CData ADO.NET Provider for Splunk should push the internal fields. These fields include: user, eventtype, etc.
MaxRows	Specifies the maximum number of rows returned for queries that do not include either aggregation or GROUP BY.
MaxThreads	Specifies the number of concurrent requests. Only used when UseJobs is true.
Other	Specifies advanced connection properties for specialized scenarios. Use this property only under the guidance of our Support team to address specific issues.
Pagesize	Specifies the maximum number of records per page the provider returns when requesting data from Splunk.
PseudoColumns	Specifies the pseudocolumns to expose as table columns, expressed as a string in the format 'TableName=ColumnName;TableName=ColumnName'.
RowScanDepth	Set this property to control the number of rows scanned when TypeDetectionScheme is set to RowScan.
Timeout	Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error.
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	Specifies a filepath to a JSON configuration file that defines custom views. The provider automatically detects and uses the views specified in this file.

A comma delimited list of object types to exclude during metadata retrieval.

Remarks

A comma delimited list of object types to exclude during metadata retrieval. Supported object types: Report, Dataset, Indexes.

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.

Specifies the maximum number of rows returned for queries that do not include either aggregation or GROUP BY.

Remarks

The default value for this property, -1, means that no row limit is enforced unless the query explicitly includes a LIMIT clause. (When a query includes a LIMIT clause, the value specified in the query takes precedence over the MaxRows setting.)

Setting MaxRows to a whole number greater than 0 ensures that queries do not return excessively large result sets by default.

This property is useful for optimizing performance and preventing excessive resource consumption when executing queries that could otherwise return very large datasets.

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.

Specifies advanced connection properties for specialized scenarios. Use this property only under the guidance of our Support team to address specific issues.

Remarks

This property allows advanced users to configure hidden properties for specialized situations, with the advice of our Support team. These settings are not required for normal use cases but can address unique requirements or provide additional functionality. To define multiple properties, use a semicolon-separated list.

Note: It is strongly recommended to set these properties only when advised by the Support team to address specific scenarios or issues.

Integration and Formatting

Property	Description
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=True	Converts date-time values to GMT, instead of the local time of the machine. The default value is False (use local time).
RecordToFile=filename	Records the underlying socket data transfer to the specified file.

Specifies the maximum number of records per page the provider returns when requesting data from Splunk.

Remarks

When processing a query, instead of requesting all of the queried data at once from Splunk, the Sync App can request the queried data in pieces called pages.

This connection property determines the maximum number of results that the Sync App requests per page.

Note: Setting large page sizes may improve overall query execution time, but doing so causes the Sync App to use more memory when executing queries and risks triggering a timeout.

Specifies the pseudocolumns to expose as table columns, expressed as a string in the format 'TableName=ColumnName;TableName=ColumnName'.

Remarks

This property allows you to define which pseudocolumns the Sync App exposes as table columns.

To specify individual pseudocolumns, use the following format:

Table1=Column1;Table1=Column2;Table2=Column3

To include all pseudocolumns for all tables use:

*=*

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.

Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error.

Remarks

The timeout applies to each individual communication with the server rather than the entire query or operation. For example, a query could continue running beyond 60 seconds if each paging call completes within the timeout limit.

Timeout is set to 60 seconds by default. To disable timeouts, set this property to 0.

Disabling the timeout allows operations to run indefinitely until they succeed or fail due to other conditions such as server-side timeouts, network interruptions, or resource limits on the server.

Note: Use this property cautiously to avoid long-running operations that could degrade performance or result in unresponsive behavior.

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.

Specifies a filepath to a JSON configuration file that defines custom views. The provider automatically detects and uses the views specified in this file.

Remarks

UserDefinedViews allows you to define and manage custom views through a JSON-formatted configuration file called UserDefinedViews.json. These views are automatically recognized by the Sync App and enable you to execute custom SQL queries as if they were standard database views. The JSON file defines each view as a root element with a child element called "query", which contains the 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)"
	}
}

You can use this property to define multiple views in a single file and specify the filepath. For example:

UserDefinedViews=C:\Path\To\UserDefinedViews.json

When you specify a view in UserDefinedViews, the Sync App only sees that view.

For further information, see User Defined Views.

LZMA from 7Zip LZMA SDK

LZMA SDK is placed in the public domain.

Anyone is free to copy, modify, publish, use, compile, sell, or distribute the original LZMA SDK code, either in source code form or as a compiled binary, for any purpose, commercial or non-commercial, and by any means.

LZMA2 from XZ SDK

Version 1.9 and older are in the public domain.

Xamarin.Forms

Xamarin SDK

The MIT License (MIT)

Copyright (c) .NET Foundation Contributors

All rights reserved.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

NSIS 3.10

Copyright (C) 1999-2025 Contributors THE ACCOMPANYING PROGRAM IS PROVIDED UNDER THE TERMS OF THIS COMMON PUBLIC LICENSE ("AGREEMENT"). ANY USE, REPRODUCTION OR DISTRIBUTION OF THE PROGRAM CONSTITUTES RECIPIENT'S ACCEPTANCE OF THIS AGREEMENT.

1. DEFINITIONS

"Contribution" means:

a) in the case of the initial Contributor, the initial code and documentation distributed under this Agreement, and b) in the case of each subsequent Contributor:

i) changes to the Program, and

ii) additions to the Program;

where such changes and/or additions to the Program originate from and are distributed by that particular Contributor. A Contribution 'originates' from a Contributor if it was added to the Program by such Contributor itself or anyone acting on such Contributor's behalf. Contributions do not include additions to the Program which: (i) are separate modules of software distributed in conjunction with the Program under their own license agreement, and (ii) are not derivative works of the Program.

"Contributor" means any person or entity that distributes the Program.

"Licensed Patents " mean patent claims licensable by a Contributor which are necessarily infringed by the use or sale of its Contribution alone or when combined with the Program.

"Program" means the Contributions distributed in accordance with this Agreement.

"Recipient" means anyone who receives the Program under this Agreement, including all Contributors.

2. GRANT OF RIGHTS

a) Subject to the terms of this Agreement, each Contributor hereby grants Recipient a non-exclusive, worldwide, royalty-free copyright license to reproduce, prepare derivative works of, publicly display, publicly perform, distribute and sublicense the Contribution of such Contributor, if any, and such derivative works, in source code and object code form.

b) Subject to the terms of this Agreement, each Contributor hereby grants Recipient a non-exclusive, worldwide, royalty-free patent license under Licensed Patents to make, use, sell, offer to sell, import and otherwise transfer the Contribution of such Contributor, if any, in source code and object code form. This patent license shall apply to the combination of the Contribution and the Program if, at the time the Contribution is added by the Contributor, such addition of the Contribution causes such combination to be covered by the Licensed Patents. The patent license shall not apply to any other combinations which include the Contribution. No hardware per se is licensed hereunder.

c) Recipient understands that although each Contributor grants the licenses to its Contributions set forth herein, no assurances are provided by any Contributor that the Program does not infringe the patent or other intellectual property rights of any other entity. Each Contributor disclaims any liability to Recipient for claims brought by any other entity based on infringement of intellectual property rights or otherwise. As a condition to exercising the rights and licenses granted hereunder, each Recipient hereby assumes sole responsibility to secure any other intellectual property rights needed, if any. For example, if a third party patent license is required to allow Recipient to distribute the Program, it is Recipient's responsibility to acquire that license before distributing the Program.

d) Each Contributor represents that to its knowledge it has sufficient copyright rights in its Contribution, if any, to grant the copyright license set forth in this Agreement.

3. REQUIREMENTS

A Contributor may choose to distribute the Program in object code form under its own license agreement, provided that:

a) it complies with the terms and conditions of this Agreement; and

b) its license agreement:

i) effectively disclaims on behalf of all Contributors all warranties and conditions, express and implied, including warranties or conditions of title and non-infringement, and implied warranties or conditions of merchantability and fitness for a particular purpose;

ii) effectively excludes on behalf of all Contributors all liability for damages, including direct, indirect, special, incidental and consequential damages, such as lost profits;

iii) states that any provisions which differ from this Agreement are offered by that Contributor alone and not by any other party; and

iv) states that source code for the Program is available from such Contributor, and informs licensees how to obtain it in a reasonable manner on or through a medium customarily used for software exchange.

When the Program is made available in source code form:

a) it must be made available under this Agreement; and

b) a copy of this Agreement must be included with each copy of the Program.

Contributors may not remove or alter any copyright notices contained within the Program.

Each Contributor must identify itself as the originator of its Contribution, if any, in a manner that reasonably allows subsequent Recipients to identify the originator of the Contribution.

4. COMMERCIAL DISTRIBUTION

Commercial distributors of software may accept certain responsibilities with respect to end users, business partners and the like. While this license is intended to facilitate the commercial use of the Program, the Contributor who includes the Program in a commercial product offering should do so in a manner which does not create potential liability for other Contributors. Therefore, if a Contributor includes the Program in a commercial product offering, such Contributor ("Commercial Contributor") hereby agrees to defend and indemnify every other Contributor ("Indemnified Contributor") against any losses, damages and costs (collectively "Losses") arising from claims, lawsuits and other legal actions brought by a third party against the Indemnified Contributor to the extent caused by the acts or omissions of such Commercial Contributor in connection with its distribution of the Program in a commercial product offering. The obligations in this section do not apply to any claims or Losses relating to any actual or alleged intellectual property infringement. In order to qualify, an Indemnified Contributor must: a) promptly notify the Commercial Contributor in writing of such claim, and b) allow the Commercial Contributor to control, and cooperate with the Commercial Contributor in, the defense and any related settlement negotiations. The Indemnified Contributor may participate in any such claim at its own expense.

For example, a Contributor might include the Program in a commercial product offering, Product X. That Contributor is then a Commercial Contributor. If that Commercial Contributor then makes performance claims, or offers warranties related to Product X, those performance claims and warranties are such Commercial Contributor's responsibility alone. Under this section, the Commercial Contributor would have to defend claims against the other Contributors related to those performance claims and warranties, and if a court requires any other Contributor to pay any damages as a result, the Commercial Contributor must pay those damages.

5. NO WARRANTY

EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, THE PROGRAM IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED INCLUDING, WITHOUT LIMITATION, ANY WARRANTIES OR CONDITIONS OF TITLE, NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Each Recipient is solely responsible for determining the appropriateness of using and distributing the Program and assumes all risks associated with its exercise of rights under this Agreement, including but not limited to the risks and costs of program errors, compliance with applicable laws, damage to or loss of data, programs or equipment, and unavailability or interruption of operations.

6. DISCLAIMER OF LIABILITY

EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, NEITHER RECIPIENT NOR ANY CONTRIBUTORS SHALL HAVE ANY LIABILITY FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING WITHOUT LIMITATION LOST PROFITS), HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OR DISTRIBUTION OF THE PROGRAM OR THE EXERCISE OF ANY RIGHTS GRANTED HEREUNDER, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.

7. GENERAL

If any provision of this Agreement is invalid or unenforceable under applicable law, it shall not affect the validity or enforceability of the remainder of the terms of this Agreement, and without further action by the parties hereto, such provision shall be reformed to the minimum extent necessary to make such provision valid and enforceable.

If Recipient institutes patent litigation against a Contributor with respect to a patent applicable to software (including a cross-claim or counterclaim in a lawsuit), then any patent licenses granted by that Contributor to such Recipient under this Agreement shall terminate as of the date such litigation is filed. In addition, if Recipient institutes patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Program itself (excluding combinations of the Program with other software or hardware) infringes such Recipient's patent(s), then such Recipient's rights granted under Section 2(b) shall terminate as of the date such litigation is filed.

All Recipient's rights under this Agreement shall terminate if it fails to comply with any of the material terms or conditions of this Agreement and does not cure such failure in a reasonable period of time after becoming aware of such noncompliance. If all Recipient's rights under this Agreement terminate, Recipient agrees to cease use and distribution of the Program as soon as reasonably practicable. However, Recipient's obligations under this Agreement and any licenses granted by Recipient relating to the Program shall continue and survive.

Everyone is permitted to copy and distribute copies of this Agreement, but in order to avoid inconsistency the Agreement is copyrighted and may only be modified in the following manner. The Agreement Steward reserves the right to publish new versions (including revisions) of this Agreement from time to time. No one other than the Agreement Steward has the right to modify this Agreement. IBM is the initial Agreement Steward. IBM may assign the responsibility to serve as the Agreement Steward to a suitable separate entity. Each new version of the Agreement will be given a distinguishing version number. The Program (including Contributions) may always be distributed subject to the version of the Agreement under which it was received. In addition, after a new version of the Agreement is published, Contributor may elect to distribute the Program (including its Contributions) under the new version. Except as expressly stated in Sections 2(a) and 2(b) above, Recipient receives no rights or licenses to the intellectual property of any Contributor under this Agreement, whether expressly, by implication, estoppel or otherwise. All rights in the Program not expressly granted under this Agreement are reserved.

This Agreement is governed by the laws of the State of New York and the intellectual property laws of the United States of America. No party to this Agreement will bring a legal action under this Agreement more than one year after the cause of action arose. Each party waives its rights to a jury trial in any resulting litigation.