blob: 8d157e92cbdc6125e28b8d96a039a3a57cac9fff [file] [log] [blame]
<?xml version="1.0" encoding="UTF-8" ?>
<!--
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
-->
<document>
<properties>
<title>SQL Howto</title>
<author email="henning@schmiedehausen.org">Henning P. Schmiedehausen</author>
</properties>
<body>
<section name="SQL files for Turbine">
<p>
The Turbine framework uses a database to store the following information:
<ul>
<li>The Scheduler service for persistent events</li>
<li>The Security service for user and related security information</li>
</ul>
The Torque generator can be used to create the SQL files to set up the
necessary database tables.
</p>
</section>
<section name="Source distribution">
<p>
To create the SQL files for a specific database, run the following maven
command from the root of the source distribution:
</p>
<source><![CDATA[
maven -Dtorque.database=<database name> sql
]]></source>
<p>
Default is to create SQL for the MySQL database.
</p>
</section>
<section name="Binary distribution">
<p>
The binary distribution contains the SQL files for various databases in the <code>sql</code>
subdirectory.
</p>
</section>
</body>
</document>