WORKERS AHEAD!
You are viewing the development documentation for the Apereo CAS server. The functionality presented here is not officially released yet. This is a work in progress and will be continually updated as development moves forward. To view the documentation for a specific Apereo CAS server release, please choose an appropriate version. The release schedule is also available here.
JDBC Drivers
While in most cases this is unnecessary and handled by CAS automatically, you may need to also include the following module to account for various database drivers:
implementation "org.apereo.cas:cas-server-support-jdbc-drivers:${project.'cas.version'}"
<dependency>
<groupId>org.apereo.cas</groupId>
<artifactId>cas-server-support-jdbc-drivers</artifactId>
<version>${cas.version}</version>
</dependency>
dependencyManagement {
imports {
mavenBom "org.apereo.cas:cas-server-support-bom:${project.'cas.version'}"
}
}
dependencies {
implementation "org.apereo.cas:cas-server-support-jdbc-drivers"
}
Database Support
Automatic support for drivers includes the following databases. All other drivers need to be manually added to the build configuration.
Control global properties that are relevant to Hibernate, when CAS attempts to employ and utilize database resources, connections and queries.
cas.jdbc.case-insensitive=false
When choosing physical table names, determine whether names should be considered case-insensitive. |
cas.jdbc.gen-ddl=true
Whether to generate DDL after the EntityManagerFactory has been initialized creating/updating all relevant tables. |
cas.jdbc.physical-table-names=
Indicate a physical table name to be used by the hibernate naming strategy in case table names need to be customized for the specific type of database. The key here indicates the CAS-provided table name and the value is the translate physical name for the database. If a match is not found for the CAS-provided table name, then that name will be used by default. |
cas.jdbc.show-sql=false
Whether SQL queries should be displayed in the console/logs. |
H2
Available drivers are:
org.h2.Driver
Dialects |
---|
org.hibernate.dialect.H2Dialect |
HSQLDB
Available drivers are:
org.hsqldb.jdbcDriver
Dialects |
---|
org.hibernate.dialect.HSQLDialect |
Oracle
Available drivers are:
oracle.jdbc.driver.OracleDriver
Dialects |
---|
org.hibernate.dialect.Oracle8iDialect |
org.hibernate.dialect.Oracle9iDialect |
org.hibernate.dialect.Oracle10gDialect |
org.hibernate.dialect.Oracle12cDialect |
MYSQL
Available drivers are:
com.mysql.jdbc.Driver
com.mysql.cj.jdbc.Driver
Dialects |
---|
org.hibernate.dialect.MySQLDialect |
org.hibernate.dialect.MySQL5Dialect |
org.hibernate.dialect.MySQLInnoDBDialect |
org.hibernate.dialect.MySQLMyISAMDialect |
org.hibernate.dialect.MySQL5InnoDBDialect |
org.hibernate.dialect.MySQL57InnoDBDialect |
org.hibernate.dialect.MySQL8Dialect |
PostgreSQL
Available drivers are:
org.postgresql.Driver
Dialects |
---|
org.hibernate.dialect.PostgreSQL81Dialect |
org.hibernate.dialect.PostgreSQL82Dialect |
org.hibernate.dialect.PostgreSQL9Dialect |
org.hibernate.dialect.PostgreSQL91Dialect |
org.hibernate.dialect.PostgreSQL92Dialect |
org.hibernate.dialect.PostgreSQL93Dialect |
org.hibernate.dialect.PostgreSQL94Dialect |
org.hibernate.dialect.PostgreSQL95Dialect |
org.hibernate.dialect.PostgresPlusDialect |
MariaDB
Available drivers are:
org.mariadb.jdbc.Driver
Dialects |
---|
org.hibernate.dialect.MariaDBDialect |
org.hibernate.dialect.MariaDB53Dialect |
org.hibernate.dialect.MariaDB10Dialect |
org.hibernate.dialect.MariaDB102Dialect |
org.hibernate.dialect.MariaDB103Dialect |
Microsoft SQL Server
Available drivers are:
net.sourceforge.jtds.jdbc.Driver
com.microsoft.sqlserver.jdbc.SQLServerDriver
Dialects |
---|
org.hibernate.dialect.SQLServerDialect |
org.hibernate.dialect.SQLServer2005Dialect |
org.hibernate.dialect.SQLServer2008Dialect |
org.hibernate.dialect.SQLServer2012Dialect |