Premium Feature — Available with all Premium Editions of LabKey Server. Learn more or contact LabKey.

This topic explains how to configure LabKey Server to retrieve and display data from Microsoft SQL Server as an external data source.

Microsoft SQL Server can also be used as LabKey Server's primary data source.

For either use case, check to confirm that your version of SQL Server is compatible with your version of LabKey Server in this topic:

The jTDS JDBC Driver

Use the jTDS JDBC driver, which is included with LabKey Server Premium Editions as part of the BigIron module.

Other JDBC drivers for Microsoft SQL Server have not been tested and have known issues.

Configure the MS SQL Server Data Source

Add a <Resource> element to your installations labkey.xml configuration file. Use the template below as a general starting point, replacing the words in capitals with their appropriate values.

If you will be connecting to more than one data source, be sure that all have unique name parameters, i.e. mssqlDataSource1, mssqlDataSource2, or similar. This value will be used whenever you connect an external schema to this datasource so it must be unambiguous.

<Resource name="jdbc/mssqlDataSource" 
auth="Container"
type="javax.sql.DataSource"
username="USERNAME"
password="PASSWORD"
driverClassName="net.sourceforge.jtds.jdbc.Driver"
url="jdbc:jtds:sqlserver://localhost:1433/DATABASE_NAME"
maxTotal="20"
maxIdle="10"
accessToUnderlyingConnectionAllowed="true"
validationQuery="SELECT 1"/>

Define a New Schema

Now define a new schema from the SQL Server data source. For details see Set Up an External Schema

Related Topics

Discussion

Was this content helpful?

Log in or register an account to provide feedback


previousnext
 
expand all collapse all