Add doc for SQLServer connection

chop-dbhi · Jul 31, 2013 · 42ba67c · 42ba67c
1 parent 38c13a7
commit 42ba67c
Showing 1 changed file with 13 additions and 0 deletions.
diff --git a/src/main/scala/edu/chop/cbmi/dataExpress/backends/SqlServerBackend.scala b/src/main/scala/edu/chop/cbmi/dataExpress/backends/SqlServerBackend.scala
@@ -2,6 +2,19 @@ package edu.chop.cbmi.dataExpress.backends
 
 import java.util.Properties
 
+/**
+ * Backend for accessing SqlServer databases. This will use a connection properties file that
+ * should look something like the following:
+ * {{{driverClassName=com.microsoft.sqlserver.jdbc.SQLServerDriver
+jdbcUri=jdbc:sqlserver://server_address:server_port
+database=database_name
+user=user_name
+password=password
+}}}
+ *
+ */
+
+
 class SqlServerBackend(override val connectionProperties : Properties, _sqlDialect : SqlDialect = null,
                        _driverClassName : String = null)
   extends SqlBackend(connectionProperties, if(_sqlDialect==null)SqlServerSqlDialect else _sqlDialect,