Natively Connect to Splunk Data in PHP

Drop the CData ODBC Driver for Splunk into your LAMP or WAMP stack to build Splunk-connected Web applications. This article shows how to use PHP's ODBC built-in functions to connect to Splunk data, execute queries, and output the results.

Configure a DSN

If you have not already, first specify connection properties in an ODBC DSN (data source name). This is the last step of the driver installation. You can use the Microsoft ODBC Data Source Administrator to create and configure ODBC DSNs.

To authenticate requests, set the , , and properties to valid Splunk credentials. The port on which the requests are made to Splunk is port 8089.

The data provider uses plain-text authentication by default, since the data provider attempts to negotiate TLS/SSL with the server.

If you need to manually configure TLS/SSL, see Getting Started -> Advanced Settings in the data provider help documentation.

Establish a Connection

Open the connection to Splunk by calling the or methods. To close connections, use or .

$conn = odbc_connect("CData ODBC Splunk Source","user","password");

Connections opened with are closed when the script ends. Connections opened with the method are still open after the script ends. This enables other scripts to share that connection when they connect with the same credentials. By sharing connections among your scripts, you can save system resources, and queries execute faster.

$conn = odbc_pconnect("CData ODBC Splunk Source","user","password");
...
odbc_close($conn); //persistent connection must be closed explicitly

Create Prepared Statements

Create prepared statements and parameterized queries with the function.

$query = odbc_prepare($conn, "SELECT * FROM DataModels WHERE Id = ?");

Execute Queries

Execute prepared statements with .

$conn = odbc_connect("CData ODBC Splunk Source","user","password");
$query = odbc_prepare($conn, "SELECT * FROM DataModels WHERE Id = ?");
$success = odbc_execute($query, array('SampleDataset'));
 

Execute nonparameterized queries with .

$conn = odbc_connect("CData ODBC Splunk Source","user","password");
$query = odbc_exec($conn, "SELECT Name, Owner FROM DataModels");
 

Process Results

Access a row in the result set as an array with the function.

$conn = odbc_connect("CData ODBC Splunk data Source","user","password");
$query = odbc_exec($conn, "SELECT Name, Owner FROM DataModels");
while($row = odbc_fetch_array($query)){
 echo $row["Name"] . "\n";
}

Display the result set in an HTML table with the function.

$conn = odbc_connect("CData ODBC Splunk data Source","user","password");
$query = odbc_prepare($conn, "SELECT * FROM DataModels WHERE Id = ?");
$success = odbc_execute($query, array('SampleDataset'));
if($success)
 odbc_result_all($query);

More Example Queries

You will find complete information on the driver's supported SQL in the help documentation. The code examples above are Splunk-specific adaptations of the PHP community documentation for all ODBC functions.