Configuring the repository to use an external database

By default, the repository contains an embedded database. You can enable high availability for the repository by configuring the repository to use an external database and leveraging the clustering features of the external database to provide failover.

Use the procedures in this topic to configure the following databases as external databases for the repository:

Important

External databases specified in the following list are the only supported databases that can be configured for the repository.

Before you begin

For advanced database configuration information, refer to the documentation for your database type.

To configure the repository to use a MySQL database

  1. Create an external database:
    1. In the external database, set the max_allowed_packet variable to a value between 512 MB and 1 GB.
      For information about how to set this variable, see the product documentation for your database.
    2. Set up the database user:
      • Create the user and user password.
      • Set up read and write permissions for the user.
    3. In the external database, create a new database (for example, repository), using the credentials created in step 1b.
  2. Extract the contents of the repository .war file into a new baorepo directory:
    1. Under the repoInstallationDirectory/tomcat/webapps/ directory, create the baorepo subdirectory.
    2. In the baorepo subdirectory, unzip the repoInstallationDirectory/tomcat/webapps/baorepo.war file.
  3. Place the database's connector/driver jar file in the repoInstallationDirectory/tomcat/webapps/baorepo/WEB-INF/lib directory.
    Example:
    You could place the mysql-connector-<compatibleVersion>-bin.jar file in the repoInstallationDirectory/tomcat/webapps/baorepo/WEB-INF/lib directory.
  4. Open the repoInstallationDirectory/tomcat/webapps/baorepo/WEB-INF/classes/META-INF/repository.xml file in a text editor and replace the existing PersistenceManagersection with the connection information for the external database.

    Note

    The repository.xml file typically contains two PersistenceManager sections. Modify the first section, located under workspace. Do not change the section under Versioning.

    MySQL database connection properties for PersistenceManager

    Parameter

    Description

    MySQL values

    class

    org.apache.jackrabbit.core.state.db
    .SimpleDbPersistenceManager

    driver

    <MySQLDriver>

    URL

    URL and port number for the external database
    You can omit the port number if you use the default port for the database.

    jdbc:mysql://host:port/database

    user

    Database user name that you created in step 1

    userName

    password

    Password that you assigned to the database user

    password

    schema

    The string value that indicates the database type. Use the exact string value.

    This is not the name of the database schema.

    mysql

    schemaObjectPrefix

    ${wsp.name}

    externalBLOBs

    false

    Persistence Manager for MySQL
    <PersistenceManager class="org.apache.jackrabbit.core.state.db.SimpleDbPersistenceManager">
    <param name="driver" value="MySQLDriver"/>
    <param name="url" value="jdbc:mysql://bao.bmc.com/repository" />
    <param name="user" value="baouser"/>
    <param name="password" value="baopass"/>
    <param name="schema" value="mysql"/>
    <param name="schemaObjectPrefix" value="${wsp.name}"/>
    <param name="externalBLOBs" value="false"/>
    </PersistenceManager>
  5. Start the repository server.

    Notes

    If you want to update any configuration values after the repository server is started, you must update the repository.xml file located at the repoInstallationDirectory/repository/config directory and restart the repository server. Also, you must update the workspace.xml file located at the repoInstallationDirectory/workspaces/default and the repoInstallationDirectory/workspaces/securitydirectories, and then restart the repository server.

    If you want to point to a different database, you must delete the repository's workspace (delete the repoInstallationDirectory/repository folder) and restart the repository. Cluster the external database to provide high-availability for the repository.

To configure the repository to use an Oracle database

  1. Create an external database:
    1. Set up the database user:
      • Create the user and user password.
      • Set up read and write permissions for the user. Permissions must include:
        • CREATE SESSION
        • CREATE TABLE
        • CREATE SEQUENCE
    2. In the external database, create a new database (for example, repository), using the credentials created in Step 1a.
  2. Extract the contents of the repository .war file into a new baorepo directory:
    1. Under the repoInstallationDirectory/tomcat/webapps/ directory, create the baorepo subdirectory.
    2. In the baorepo subdirectory, unzip the repoInstallationDirectory/tomcat/webapps/baorepo.war file.
  3. Place the database's connector/driver jar file in the repoInstallationDirectory/tomcat/webapps/baorepo/WEB-INF/lib directory.
    Example:
    You would place the ojdbc<compatibleVersion>.jar file in repoInstallationDirectory/tomcat/webapps/baorepo/WEB-INF/lib directory.
  4. Open the repoInstallationDirectory/tomcat/webapps/baorepo/WEB-INF/classes/META-INF/repository.xml file in a text editor and replace the existing PersistenceManagersection with the connection information for the external database.

    Note

    The repository.xml file typically contains two PersistenceManager sections. Modify the first section, located under workspace. Do not change the section under Versioning.

    Oracle database connection properties for PersistenceManager

    Parameter

    Description

    Values

    class

    org.apache.jackrabbit.core.persistence.db
    .OraclePersistenceManager

    driverJDBC driver class name

    <oracle.jdbc.OracleDriver>

    URL

    URL and port number for the external database
    You can omit the port number if you use the default port for the database.

    jdbc:oracle:thin:@host:port:sid

    user

    Database user name that you created in step 1

    userName

    password

    Password that you assigned to the database user

    password

    schema

    The string value that indicates the database type. Use the exact string value.

    This is not the name of the database schema.

    oracle

    schemaObjectPrefix

    ${wsp.name}

    externalBLOBs

    false

    Persistence Manager for Oracle
    <PersistenceManager class="org.apache.jackrabbit.core.persistence.db.OraclePersistenceManager">
    <param name="url" value="jdbc:oracle:thin:@bao.bmc.com:1521:repository"/>
    <param name="driver" value="oracle.jdbc.OracleDriver"/>
    <param name="user" value="baouser"/>
    <param name="password" value="baopass"/>
    <param name="schema" value="oracle"/>
    <param name="schemaObjectPrefix" value="${wsp.name}"/>
    <param name="externalBLOBs" value="false"/>
    </PersistenceManager>
    
  5. Start the repository server.

    Notes

    If you want to update any configuration values after the repository server is started, you must update the repository.xml file located at the repoInstallationDirectory/repository/config directory and restart the repository server. Also, you must update the workspace.xml file located at the repoInstallationDirectory/workspaces/default and the repoInstallationDirectory/workspaces/securitydirectories, and then restart the repository server.

    If you want to point to a different database, you must delete the repository's workspace (delete the repoInstallationDirectory/repository folder) and restart the repository. Cluster the external database to provide high-availability for the repository.

To configure the repository to use a DB2 Express-C 10.1 edition database

  1. Create an external database:
    1. Set up the database user:
      • Create the user and user password.
      • Set up read and write permissions for the user. Permissions must include:
        • CREATE SESSION
        • CREATE TABLE
        • CREATE SEQUENCE
    2. In the external database, create a new database (for example, repository), using the credentials created in Step 1a.
  2. Extract the contents of the repository .war file into a new baorepo directory:
    1. Under the repoInstallationDirectory/tomcat/webapps/ directory, create the baorepo subdirectory.
    2. In the baorepo subdirectory, unzip the repoInstallationDirectory/tomcat/webapps/baorepo.war file.
  3. Place the database's connector/driver jar file in the directory repoInstallationDirectory/tomcat/webapps/baorepo/WEB-INF/lib directory.
    Example:
    You could place the DB2Driver.jar file in the repoInstallationDirectory/tomcat/webapps/baorepo/WEB-INF/lib directory.
  4. Open the repoInstallationDirectory/tomcat/webapps/baorepo/WEB-INF/classes/META-INF/repository.xml file in a text editor and replace the existing PersistenceManagersection with the connection information for the external database.

    Note

    The repository.xml file typically contains two PersistenceManager sections. Modify the first section, located under workspace. Do not change the section under Versioning.

    DB2 database connection properties for PersistenceManager

    Parameter

    Description

    DB2 values

    class

    org.apache.jackrabbit.core.state.db
    .SimpleDbPersistenceManager

    driver

    <DB2Driver>

    URL

    URL and port number for the external database
    You can omit the port number if you use the default port for the database.

    jdbc:db2://host:port/database

    user

    Database user name that you created in step 1

    userName

    password

    Password that you assigned to the database user

    password

    schema

    The string value that indicates the database type. Use the exact string value.

    This is not the name of the database schema.

    db2

    schemaObjectPrefix

    ${wsp.name}

    externalBLOBs

    false

    Persistence Manager for DB2
    <PersistenceManager class="org.apache.jackrabbit.core.state.db.SimpleDbPersistenceManager">
    <param name="driver" value="DB2Driver"/>
    <param name="url" value="jdbc:oracle:thin:@bao.bmc.com:1521:repository" />
    <param name="user" value="baouser"/>
    <param name="password" value="baopass"/>
    <param name="schema" value="db2"/>
    <param name="schemaObjectPrefix" value="${wsp.name}"/>
    <param name="externalBLOBs" value="false"/>
    </PersistenceManager>
    
  5. Start the repository server.

    Notes

    If you want to update any configuration values after the repository server is started, you must update the repository.xml file located at the repoInstallationDirectory/config directory and restart the repository server. Also, you must update the workspace.xml file located at the repoInstallationDirectory/workspaces/default and the repoInstallationDirectory/workspaces/securitydirectories, and then restart the repository server.

    If you want to point to a different database, you must delete the repository's workspace (delete the repoInstallationDirectory/repository folder) and restart the repository. Cluster the external database to provide high-availability for the repository.

To configure the repository to use a Microsoft SQL Server 2012 database

  1. Create an external database:
    1. Set up the database user:
      • Create the user and user password.
      • Set up read and write permissions for the user. Permissions must include:
        • CREATE SESSION
        • CREATE TABLE
        • CREATE SEQUENCE
    2. In the external database, create a new database (for example, repository), using the credentials created in Step 1a.
  2. Extract the contents of the repository .war file into a new baorepo directory:
    1. Under the repoInstallationDirectory/tomcat/webapps/ directory, create the baorepo subdirectory.
    2. In the baorepo subdirectory, unzip the repoInstallationDirectory/tomcat/webapps/baorepo.war file.
  3. Place the database's connector/driver jar file in the directory repoInstallationDirectory/tomcat/webapps/baorepo/WEB-INF/lib directory.
    Example:
    You could place the sqljdbc.jar file in the repoInstallationDirectory/tomcat/webapps/baorepo/WEB-INF/lib directory.
  4. Open the repoInstallationDirectory/tomcat/webapps/baorepo/WEB-INF/classes/META-INF/repository.xml file in a text editor and replace the existing PersistenceManagersection with the connection information for the external database.

    Note

    The repository.xml file typically contains two PersistenceManager sections. Modify the first section, located under workspace. Do not change the section under Versioning.

    Microsoft SQL Server 2012 database connection properties for PersistenceManager

    Parameter

    Description

    Values

    class

    org.apache.jackrabbit.core.state.db
    .SimpleDbPersistenceManager

    driver

    com.microsoft.sqlserver.jdbc.SQLServerDriver

    URL

    URL and port number for the external database
    You can omit the port number if you use the default port for the database.

    jdbc:sqlserver://host:port;database

    user

    Database user name that you created in step 1

    userName

    password

    Password that you assigned to the database user

    password

    schema

    The string value that indicates the database type. Use the exact string value.

    This is not the name of the database schema.

    mssql

    schemaObjectPrefix

    ${wsp.name}

    externalBLOBs

    false

    Persistence Manager for Microsoft SQL Server 2012
    <PersistenceManager class="org.apache.jackrabbit.core.state.db.SimpleDbPersistenceManager">
    <param name="driver" value="com.microsoft.sqlserver.jdbc.SQLServerDriver"/>
    <param name="url" value="jdbc:sqlserver://vw-aus-rem-qa17.bmc.com:1433;databaseName=repository"/>
    <param name="user" value="baouser"/>
    <param name="password" value="baopass"/>
    <param name="schema" value="mssql"/>
    <param name="schemaObjectPrefix" value="${wsp.name}"/>
    <param name="externalBLOBs" value="false"/>
    </PersistenceManager>
  5. Start the repository server.

    Notes

    If you want to update any configuration values after the repository server is started, you must update the repository.xml file located at the repoInstallationDirectory/repository/config directory and restart the repository server. Also, you must update the workspace.xml file located at the repoInstallationDirectory/workspaces/default and the repoInstallationDirectory/workspaces/security directories, and then restart the repository server.

    If you want to point to a different database, you must delete the repository's workspace (delete the repoInstallationDirectory/repository folder) and restart the repository. Cluster the external database to provide high-availability for the repository.

Related topic

User permissions