Difference between revisions of "MySQL"

From OpenKM Documentation
Jump to: navigation, search
(→‎Workflow engine)
(→‎Change MySQL default engine to InnoDB)
 
(20 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 
{{TOCright}} __TOC__
 
{{TOCright}} __TOC__
  
−
Download MySQL JDBC driver from [http://www.mysql.com/products/connector/ MySQL Home Page] and move it to ''$JBOSS_HOME/server/default/lib''.
+
Download MySQL JDBC driver from [http://www.mysql.com/products/connector/ MySQL Home Page] and move it to ''$TOMCAT_HOME/lib'' or ''$JBOSS_HOME/server/default/lib'' depending on your OpenKM version..
  
 
{{Note|If you get an error like this:
 
{{Note|If you get an error like this:
  
 
  Packet for query is too large (1708726 > 1048576).
 
  Packet for query is too large (1708726 > 1048576).
−
  You can change this value on the server by setting the max_allowed_packet' variable.
+
  You can change this value on the server by setting the 'max_allowed_packet' variable.
  
 
You need to modify your MySQL server configuration file and increase the value of the '''max_allowed_packet''' property. Don't forget to restart the MySQL after any change in this file. In Debian based distros like Ubuntu, this configuration file is located at ''/etc/mysql/my.cnf''.}}
 
You need to modify your MySQL server configuration file and increase the value of the '''max_allowed_packet''' property. Don't forget to restart the MySQL after any change in this file. In Debian based distros like Ubuntu, this configuration file is located at ''/etc/mysql/my.cnf''.}}
  
−
== Database creation ==
+
* [[MySQL-OpenKM 6.0 | OpenKM 6.0]] (also valid for OpenKM 6.X+)
−
The first thing to do is create the required databases where the tables will be created:
+
* [[MySQL-OpenKM 5.0 | OpenKM 5.0]] (also valid for OpenKM 5.X+)
 +
* [[MySQL-OpenKM 4.1 | OpenKM 4.1]]
  
−
<source lang="sql">
+
== Change MySQL default engine to InnoDB ==
−
DROP DATABASE IF EXISTS okm_repository;
+
Check if your MySQL installation has InnoDB engin enabled:
−
DROP DATABASE IF EXISTS okm_activity;
 
−
DROP DATABASE IF EXISTS okm_auth;
 
−
DROP DATABASE IF EXISTS okm_dashboard;
 
−
DROP DATABASE IF EXISTS okm_workflow;
 
  
−
CREATE DATABASE okm_repository DEFAULT CHARACTER SET utf8;
+
  $ mysql -h localhost -u root -p
−
CREATE DATABASE okm_activity DEFAULT CHARACTER SET utf8;
+
  mysql> show engines;
−
CREATE DATABASE okm_auth DEFAULT CHARACTER SET utf8;
 
−
CREATE DATABASE okm_dashboard DEFAULT CHARACTER SET utf8;
 
−
CREATE DATABASE okm_workflow DEFAULT CHARACTER SET utf8;
 
−
 
 
−
GRANT USAGE ON *.* TO 'openkm'@'%' IDENTIFIED BY '*secret*';
 
−
GRANT ALL PRIVILEGES ON *.* TO 'openkm'@'%';
 
−
</source>
 
  
−
== Repository configuration ==
+
In order to change the default storage engine edit '''/etc/mysql/my.cnf''' and under '''[mysqld]''' section in your ini file, and add:
  
−
<source lang="xml">
+
   default-storage-engine = innodb
−
<?xml version="1.0" encoding="UTF-8"?>
 
−
<!DOCTYPE Repository PUBLIC "-//The Apache Software Foundation//DTD Jackrabbit 1.4//EN"
 
−
                            "http://jackrabbit.apache.org/dtd/repository-1.4.dtd">
 
−
<Repository>
 
−
  <FileSystem class="org.apache.jackrabbit.core.fs.local.LocalFileSystem">
 
−
    <param name="path" value="${rep.home}/repository"/>
 
−
  </FileSystem>
 
−
  <Security appName="OpenKM">
 
−
    <AccessManager class="es.git.openkm.core.OKMAccessManager"/>
 
−
  </Security>
 
−
   <Workspaces rootPath="${rep.home}/workspaces" defaultWorkspace="default"/>
 
−
  <Workspace name="${wsp.name}">
 
−
    <FileSystem class="org.apache.jackrabbit.core.fs.local.LocalFileSystem">
 
−
      <param name="path" value="${wsp.home}"/>
 
−
    </FileSystem>
 
−
    <PersistenceManager class="org.apache.jackrabbit.core.persistence.bundle.MySqlPersistenceManager">
 
−
      <param name="driver" value="com.mysql.jdbc.Driver"/>
 
−
      <param name="url" value="jdbc:mysql://localhost:3306/okm_repository?autoReconnect=true"/>
 
−
      <param name="schema" value="mysql"/>
 
−
      <param name="user" value="openkm"/>
 
−
      <param name="password" value="*secret*"/>
 
−
      <param name="schemaObjectPrefix" value="${wsp.name}_"/>
 
−
      <param name="externalBLOBs" value="false"/>
 
−
    </PersistenceManager>
 
−
    <SearchIndex class="org.apache.jackrabbit.core.query.lucene.SearchIndex">
 
−
      <param name="path" value="${wsp.home}/index"/>
 
−
      <param name="useCompoundFile" value="true"/>
 
−
      <param name="minMergeDocs" value="100"/>
 
−
      <param name="volatileIdleTime" value="3"/>
 
−
      <param name="maxMergeDocs" value="100000"/>
 
−
      <param name="mergeFactor" value="10"/>
 
−
      <param name="bufferSize" value="10"/>
 
−
      <param name="cacheSize" value="1000"/>
 
−
      <param name="forceConsistencyCheck" value="false"/>
 
−
      <param name="autoRepair" value="true"/>
 
−
      <param name="analyzer" value="org.apache.lucene.analysis.standard.StandardAnalyzer"/>
 
−
      <param name="respectDocumentOrder" value="false"/>
 
−
      <param name="indexingConfiguration" value="$ {wsp.home}/../../../indexing_configuration.xml"/>
 
−
      <param name="textFilterClasses" value="
 
−
org.apache.jackrabbit.core.query.lucene.TextPlainTextFilter,
 
−
org.apache.jackrabbit.extractor.PdfTextExtractor,
 
−
org.apache.jackrabbit.extractor.HTMLTextExtractor,
 
−
org.apache.jackrabbit.extractor.XMLTextExtractor,
 
−
org.apache.jackrabbit.extractor.RTFTextExtractor,
 
−
org.apache.jackrabbit.extractor.OpenOfficeTextExtractor,
 
−
es.git.openkm.extractor.MsExcelTextExtractor,
 
−
es.git.openkm.extractor.MsPowerPointTextExtractor,
 
−
es.git.openkm.extractor.MsWordTextExtractor,
 
−
es.git.openkm.extractor.MsOffice2007TextExtractor,
 
−
es.git.openkm.extractor.ExifTextExtractor,
 
−
es.git.openkm.extractor.TiffTextExtractor,
 
−
es.git.openkm.extractor.AudioTextExtractor" />
 
−
    </SearchIndex>
 
−
  </Workspace>
 
−
  <Versioning rootPath="${rep.home}/version">
 
−
    <FileSystem class="org.apache.jackrabbit.core.fs.local.LocalFileSystem">
 
−
      <param name="path" value="${rep.home}/version"/>
 
−
    </FileSystem>
 
−
    <PersistenceManager class="org.apache.jackrabbit.core.persistence.bundle.MySqlPersistenceManager">
 
−
      <param name="driver" value="com.mysql.jdbc.Driver"/>
 
−
      <param name="url" value="jdbc:mysql://localhost:3306/okm_repository?autoReconnect=true"/>
 
−
      <param name="schema" value="mysql"/>
 
−
      <param name="user" value="openkm"/>
 
−
      <param name="password" value="*secret*"/>
 
−
      <param name="schemaObjectPrefix" value="version_"/>
 
−
      <param name="externalBLOBs" value="false"/>
 
−
    </PersistenceManager>
 
−
  </Versioning>
 
−
  <!-- Also see DatabaseDataStore-->
 
−
  <DataStore class="org.apache.jackrabbit.core.data.FileDataStore"/>
 
−
</Repository>
 
−
</source>
 
  
−
More info about this at [http://jackrabbit.apache.org/jackrabbit-configuration.html Jackrabbit Configuration].
+
{{Advice|[http://en.wikipedia.org/wiki/InnoDB InnoDB] is the preferred engine because it support transactions. [http://en.wikipedia.org/wiki/MyISAM MyISAM] is more responsive but does not support transactions.}}
  
−
== Table creation ==
+
If you want to show which engine is using every table, do:
−
In this OpenKM 4.1 release you can create the databases automatically configuring the '''system.database''' property in '''OpenKM.cfg'''.
 
  
−
<source lang="java">
+
<source lang="sql">
−
system.database=mysql
+
SHOW TABLE STATUS WHERE name like 'OKM_%';
 
</source>
 
</source>
  
−
{{Warning|This configuration property should be set before the repository creation. Once the document repository has been initialized don't modify it because can damage your documents. If your repository has been already configured with another database (default one is an embedded one called HSQL) you can't switch to another database simply changing this property.}}
+
To see all the tables included in a database:
  
−
=== OpenKM 4.0 and older ===
 
 
<source lang="sql">
 
<source lang="sql">
−
#
+
SHOW FULL TABLES FROM okmdb;
−
# Generic activity database definition
 
−
#
 
−
CREATE TABLE activity(act_date TIMESTAMP, act_user VARCHAR(32), act_token VARCHAR(48), act_action VARCHAR(48), act_item VARCHAR(256), act_params VARCHAR(256));
 
 
</source>
 
</source>
  
−
<source lang="sql">
+
You can also filter by table name:
−
#
 
−
# Generic auth database definition
 
−
#
 
−
CREATE TABLE users(usr_id VARCHAR(32), usr_name VARCHAR(64), usr_pass VARCHAR(32) NOT NULL, usr_email VARCHAR(32) NOT NULL, usr_active BOOLEAN, PRIMARY KEY(usr_id));
 
−
CREATE TABLE roles(rol_id VARCHAR(32), PRIMARY KEY(rol_id));
 
−
CREATE TABLE user_role(ur_user VARCHAR(32), ur_role VARCHAR(32), PRIMARY KEY(ur_user, ur_role));
 
−
CREATE TABLE mail_accounts(ma_id INTEGER AUTO_INCREMENT, ma_user VARCHAR(32), ma_mhost VARCHAR(32), ma_muser VARCHAR(32), ma_mpass VARCHAR(32), ma_mfolder VARCHAR(32), ma_active BOOLEAN, PRIMARY KEY(ma_id));
 
−
CREATE TABLE twitter_accounts(ta_id INTEGER AUTO_INCREMENT, ta_user VARCHAR(32), ta_tuser VARCHAR(32), ta_active BOOLEAN, PRIMARY KEY(ta_id));
 
−
 
 
−
# INSERT DEFAULT USER / ROLES
 
−
INSERT INTO users (usr_id, usr_name, usr_pass, usr_email, usr_active) VALUES ('okmAdmin', 'Administrator', '21232f297a57a5a743894a0e4a801fc3', '', true);
 
−
INSERT INTO roles (rol_id) VALUES ('AdminRole');
 
−
INSERT INTO roles (rol_id) VALUES ('UserRole');
 
−
INSERT INTO user_role (ur_user, ur_role) VALUES ('okmAdmin', 'AdminRole');
 
−
</source>
 
  
 
<source lang="sql">
 
<source lang="sql">
−
#
+
SHOW FULL TABLES FROM okmdb LIKE 'OKM_%'
−
# Generic dashboard stats database definition
 
−
#
 
−
CREATE TABLE dashboard_stats(ds_user VARCHAR(32), ds_source VARCHAR(64), ds_node VARCHAR(256), ds_date TIMESTAMP);
 
 
</source>
 
</source>
  
−
== Workflow engine ==
+
== Database repair ==
−
You have to modify the file ''WEB-INF/classes/hibernate.cfg.xml'' located inside the OpenKM.war archive. These are the entries to change:
+
If you have problems with a database and need to be repaired, you can use this command:
  
−
<source lang="xml">
+
  $ mysqlcheck -u root -p --auto-repair --optimize --all-databases
−
<!-- hibernate dialect -->
 
−
<property name="hibernate.dialect">org.hibernate.dialect.HSQLDialect</property>
 
−
</source>
 
  
−
to
+
See also:
−
 
+
* [http://dev.mysql.com/doc/refman/5.0/en/converting-tables-to-innodb.html Converting Tables from Other Storage Engines to InnoDB]
−
<source lang="xml">
+
* [http://highervisibilitywebsites.com/convert-your-mysql-database-myisam-innodb-and-get-ready-drupal-7-same-time Convert your MySQL database from MyISAM to InnoDB]
−
<!-- hibernate dialect -->
 
−
<property name="hibernate.dialect">org.hibernate.dialect.MySQL5Dialect</property>
 
−
</source>
 
−
 
 
−
And in [[File:Jbpm.jpdl.mysql.sql]] are the sententeces needed to create the tables. More info about this at:
 
−
* [http://docs.jboss.org/jbpm/v3/userguide/thejbpmdatabase.html The jBPM Database]
 
−
* [http://docs.jboss.org/hibernate/core/3.3/reference/en/html/session-configuration.html#configuration-optional-dialects Hibernate: SQL Dialects]
 
−
 
 
−
== JBoss datasources ==
 
−
<source lang="xml">
 
−
<?xml version="1.0" encoding="UTF-8"?>
 
−
<datasources>
 
−
  <!-- OpenKM User Activity -->
 
−
  <local-tx-datasource>
 
−
    <jndi-name>OKMActivityDS</jndi-name>
 
−
    <connection-url>jdbc:mysql://localhost:3306/okm_activity?autoReconnect=true</connection-url>
 
−
    <driver-class>com.mysql.jdbc.Driver</driver-class>
 
−
    <user-name>openkm</user-name>
 
−
    <password>*secret*</password>
 
−
    <min-pool-size>5</min-pool-size>
 
−
    <max-pool-size>20</max-pool-size>
 
−
    <idle-timeout-minutes>0</idle-timeout-minutes>
 
−
    <track-statements/>
 
−
    <prepared-statement-cache-size>32</prepared-statement-cache-size>
 
−
    <metadata>
 
−
      <type-mapping>MySQL</type-mapping>
 
−
    </metadata>
 
−
  </local-tx-datasource>
 
−
 
−
  <!-- OpenKM User Auth -->
 
−
  <local-tx-datasource>
 
−
    <jndi-name>OKMAuthDS</jndi-name>
 
−
    <connection-url>jdbc:mysql://localhost:3306/okm_auth?autoReconnect=true</connection-url>
 
−
    <driver-class>com.mysql.jdbc.Driver</driver-class>
 
−
    <user-name>openkm</user-name>
 
−
    <password>*secret*</password>
 
−
    <min-pool-size>5</min-pool-size>
 
−
    <max-pool-size>20</max-pool-size>
 
−
    <idle-timeout-minutes>0</idle-timeout-minutes>
 
−
    <track-statements/>
 
−
    <prepared-statement-cache-size>32</prepared-statement-cache-size>
 
−
    <metadata>
 
−
      <type-mapping>MySQL</type-mapping>
 
−
    </metadata>
 
−
  </local-tx-datasource>
 
−
 
−
  <!-- OpenKM Dashboard Stats -->
 
−
  <local-tx-datasource>
 
−
    <jndi-name>OKMDashboardStatsDS</jndi-name>
 
−
    <connection-url>jdbc:mysql://localhost:3306/okm_dashboard?autoReconnect=true</connection-url>
 
−
    <driver-class>com.mysql.jdbc.Driver</driver-class>
 
−
    <user-name>openkm</user-name>
 
−
    <password>*secret*</password>
 
−
    <min-pool-size>5</min-pool-size>
 
−
    <max-pool-size>20</max-pool-size>
 
−
    <idle-timeout-minutes>0</idle-timeout-minutes>
 
−
    <track-statements/>
 
−
    <prepared-statement-cache-size>32</prepared-statement-cache-size>
 
−
    <metadata>
 
−
      <type-mapping>MySQL</type-mapping>
 
−
    </metadata>
 
−
  </local-tx-datasource>
 
−
 
−
  <!-- OpenKM Workflow -->
 
−
  <local-tx-datasource>
 
−
    <jndi-name>OKMWorkflowDS</jndi-name>
 
−
    <connection-url>jdbc:mysql://localhost:3306/okm_workflow?autoReconnect=true</connection-url>
 
−
    <driver-class>com.mysql.jdbc.Driver</driver-class>
 
−
    <user-name>openkm</user-name>
 
−
    <password>*secret*</password>
 
−
    <min-pool-size>5</min-pool-size>
 
−
    <max-pool-size>20</max-pool-size>
 
−
    <idle-timeout-minutes>0</idle-timeout-minutes>
 
−
    <track-statements/>
 
−
    <prepared-statement-cache-size>32</prepared-statement-cache-size>
 
−
    <metadata>
 
−
      <type-mapping>MySQL</type-mapping>
 
−
    </metadata>
 
−
  </local-tx-datasource>
 
−
</datasources>
 
−
</source>
 
−
 
 
−
More info about this at [http://www.jboss.org/file-access/default/members/jbossas/freezone/docs/Server_Configuration_Guide/4/html/Connectors_on_JBoss-Configuring_JDBC_DataSources.html Configuring JDBC DataSources].
 
−
 
 
−
== Login configuration ==
 
−
Due to the nature of HSQL database and the booleans, you need a little modification in the ''$JBOSS_HOME/server/default/conf/login-config.xml''. Edit this file and change:
 
−
 
 
−
<source lang="xml" highlight="6">
 
−
<!-- OpenKM -->
 
−
<application-policy name = "OpenKM">
 
−
  <authentication>
 
−
      <login-module code="org.jboss.security.auth.spi.DatabaseServerLoginModule" flag = "required">
 
−
        <module-option name="dsJndiName">java:/OKMAuthDS</module-option>
 
−
        <module-option name="principalsQuery">select usr_pass as PASSWD from users where usr_id=? and usr_active='true'</module-option>
 
−
        <module-option name="rolesQuery">select ur_role as ROLEID, 'Roles' from user_role where ur_user=?</module-option>
 
−
        <module-option name="hashAlgorithm">md5</module-option>
 
−
        <module-option name="hashEncoding">hex</module-option>
 
−
      </login-module>
 
−
  </authentication>
 
−
</application-policy>
 
−
</source>
 
−
 
 
−
to
 
−
 
 
−
<source lang="xml" highlight="6">
 
−
<!-- OpenKM -->
 
−
<application-policy name = "OpenKM">
 
−
  <authentication>
 
−
      <login-module code="org.jboss.security.auth.spi.DatabaseServerLoginModule" flag = "required">
 
−
        <module-option name="dsJndiName">java:/OKMAuthDS</module-option>
 
−
        <module-option name="principalsQuery">select usr_pass as PASSWD from users where usr_id=? and usr_active=true</module-option>
 
−
        <module-option name="rolesQuery">select ur_role as ROLEID, 'Roles' from user_role where ur_user=?</module-option>
 
−
        <module-option name="hashAlgorithm">md5</module-option>
 
−
        <module-option name="hashEncoding">hex</module-option>
 
−
      </login-module>
 
−
  </authentication>
 
−
</application-policy>
 
−
</source>
 
  
 
[[Category: Installation Guide]]
 
[[Category: Installation Guide]]
−
[[Category:OKM Network]]
 

Latest revision as of 10:55, 25 November 2013

Download MySQL JDBC driver from MySQL Home Page and move it to $TOMCAT_HOME/lib or $JBOSS_HOME/server/default/lib depending on your OpenKM version..


Nota clasica.png If you get an error like this: 
Packet for query is too large (1708726 > 1048576).
You can change this value on the server by setting the 'max_allowed_packet' variable.
You need to modify your MySQL server configuration file and increase the value of the max_allowed_packet property. Don't forget to restart the MySQL after any change in this file. In Debian based distros like Ubuntu, this configuration file is located at /etc/mysql/my.cnf.

Change MySQL default engine to InnoDB

Check if your MySQL installation has InnoDB engin enabled: 

 $ mysql -h localhost -u root -p
 mysql> show engines;

In order to change the default storage engine edit /etc/mysql/my.cnf and under [mysqld] section in your ini file, and add: 

 default-storage-engine = innodb

Nota idea.png InnoDB is the preferred engine because it support transactions. MyISAM is more responsive but does not support transactions.

If you want to show which engine is using every table, do: 

SHOW TABLE STATUS WHERE name like 'OKM_%';

To see all the tables included in a database: 

SHOW FULL TABLES FROM okmdb;

You can also filter by table name: 

SHOW FULL TABLES FROM okmdb LIKE 'OKM_%'

Database repair

If you have problems with a database and need to be repaired, you can use this command: 

 $ mysqlcheck -u root -p --auto-repair --optimize --all-databases

See also:

Retrieved from "https://www.openkm.com/wiki/index.php?title=MySQL&oldid=10919"