Comments SQL Store component

Table of contents 

Description

The Comments SQL Store component adds the ability to connect your Runtime to a database for storing comments. It's an addition to the comment containers which are provided by the Dashboard component (see Container types), which use an in-memory DAO (for development purpose only) by default.

Requirements

This component persists data in a database, that must be provided. See platform support for the supported databases.

Installation

The Comments SQL Store component can be used together with the Dashboard component. In this case the comments from the dashboard will be saved using the CommentDao implementation from the Comments SQL Store component.

Add the artifact with groupId "com.blueriq" and artifactId "blueriq-component-comments-sql-store" as a dependency to your Blueriq runtime POM file if you want to depend on it.

In order to use this component, the comments-sql-store profile must be active. More information on how to configure the application using Spring Profiles can be found here : Application configuration with Spring Profiles.

Configuration

Database

Scripts to create the required database content are provided for the following databases:

• Microsoft SQL Server
• Oracle
• H2 (we do not recommend using a H2 database in production environments)

Use the following steps to configure the datasource:

1. If necessary, create a new datasource. See Configuring JDBC database drivers for information on how to do this.
2. Comments SQL Store component is using the comments-sql-store datasource to store data. The comments-sql-store datasource can be configured using JDBC or JNDI.
   

   1. Using JDBC datasource : this can be configured in the  application-externaldatasources.properties file. When configuring external datasources, the externaldatasources profile should be enabled.

      application-externaldatasources.properties

      blueriq.datasource.comments-sql-store.url=jdbc:sqlserver://<database_url>:<port>;databaseName=bq_comments;instance=SQL_EXPRESS
      blueriq.datasource.comments-sql-store.username=<username>
      blueriq.datasource.comments-sql-store.password=<password>
      blueriq.datasource.comments-sql-store.driverClassName=com.microsoft.sqlserver.jdbc.SQLServerDriver
      blueriq.hibernate.comments-sql-store.hbm2ddl.auto=validate
      blueriq.hibernate.comments-sql-store.dialect=org.hibernate.dialect.SQLServer2012Dialect

   2. Using JNDI datasource : this can be configured in the  application-jndidatasources.properties file When configuring JNDI datasources the jndidatasources profile should be enabled.

      application-jndidatasources.properties

      blueriq.datasource.comments-sql-store.jndiName=java:/comp/env/jdbc/main
      blueriq.hibernate.comments-sql-store.hbm2ddl.auto=validate
      blueriq.hibernate.comments-sql-store.dialect=org.hibernate.dialect.SQLServer2012Dialect

3. Configuring the datasource from the Development Dashboard
   Go to Settings Widget → Datasources tab → On the left side menu : select comments-sql-store datasource. The same properties are available for configuration as from the properties file. Make sure the corresponding profile is enabled (externaldatasources or jndidatasources)
4. Hibernate settings
   These settings are done for each datasource type in the corresponding properties file, as in the examples above.
   
   

Supported dialects:

• org.hibernate.dialect.SQLServer2012Dialect (for SQL Server)
• org.hibernate.dialect.Oracle12cDialect (for Oracle)
• org.hibernate.dialect.H2Dialect (for H2) (we do not recommend using a H2 database in production environments)

Supported hbm2ddl.auto values:

• none
• validate