The Engines.ODBC object provides access to the ODBC APIs.

The following example prints out the data source in the Debug Window.

 var odbc = 0;
 function onRefresh()
 {
	if (!odbc)
	{
 	// Set the connection string
 	var odbc = Engines.ODBC.newDataSource("Provider=sqloledb;
 		Data Source=myServerAddress;Initial Catalog=myDataBase;
		User Id=myUsername;Password=myPassword");

	// Or, in case of Active Directory:
 	// var odbc = Engines.ODBC.newDataSource("Provider=sqloledb;
	//	Data Source=myServerAddress;Initial Catalog=myDataBase;
	//	Integrated Security=SSPI;");

	 }

	// If connection to the database is successful, proceed with the query
 	if (odbc.connect ())
 	{
		// Set up the database object with a query
 		odbc.setQuery("SELECT * FROM Production.Product
				WHERE ProductID < 300");

 		// Or, for a stored procedure:
 		// odbc.setQuery( "EXEC dbo.uspGetEmployeeManagers 6" );

		// Send the query to the database
 		if (odbc.sendQuery ())
 		{
			// If the query is successfully sent, get the response object
			// in XML format
 			var query_resp = odbc.response.xml;

			// Print out the XML data in Debug Window
			trace( query_resp );
 		}

		// Disconnect from the database
 		odbc.disconnect ();
 	}

	// Return the XML data for Klipfolio Dashboard to parse using
	// stylesheet settings
	return Engines.Data.process (query_resp);

 }
 

Stylesheet Format

 <style>
 	z:row::attribute( columnHeaderName ) {
  		...
  		}
 	z:row::attribute( columnHeaderName ) {
  		...
  		}
 	z:row {
  		type: item;
  		definition: all;
  		}
 </style>
 

The order of the style entries is important. The item definition must follow the entry definitions.

See also:
How-to article on developing an ODBC Klip.

Properties Summary
Engines.ODBC.ODBCResponse	response            The response instance.

Function Summary
function	connect()            Connects to a specified database.
boolean	disconnect()            Disconnects from a specified database.
String	getLastError()            Gets the description of the most recent error.
function	newDataSource( <String> connectionstring )            Configures a new data source.
boolean	sendQuery()            Sends a query to the database.
function	setQuery( <String> query )            Sets up the database object with a query.

Properties Detail

response

Engines.ODBC.ODBCResponse response

The response instance.

connect

function connect()

Connects to a specified database.

Returns:
true on success; otherwise false

disconnect

boolean disconnect()

Disconnects from a specified database.

Returns:
true on success; otherwise false

getLastError

String getLastError()

Gets the description of the most recent error. Useful for debugging connection and query problems.

Example:


 var odbc = Engines.ODBC.newDataSource (..);
 if (!odbc.connect ()) {
 	alert (odbc.getLastError ());
 } 
 

Since:
5.3

Returns:
the description of the last error

newDataSource

function newDataSource( <String> connectionstring )

Configures a new data source.

Parameters:
connectionstring - semicolon-separated keyword=value pairs for a given ODBC driver

sendQuery

boolean sendQuery()

Sends a query to the database.

Returns:
true on success; otherwise false

setQuery

function setQuery( <String> query )

Sets up the database object with a query.

Parameters:
query - query string passed to the ODBC driver