Files
Jailer/docs/quicktour.htm
2023-07-25 13:36:26 +02:00

399 lines
18 KiB
HTML

<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<title>Jailer - Quick Tour</title>
<meta http-equiv="Content-Type" content="text/html; charset=us-ascii" />
<meta name="keywords" content="Data Export Tool" />
<meta name="description" content="data export referential integrity java jdbc dbms" />
<link rel="shortcut icon" href="favicon.ico" />
<link rel="stylesheet" type="text/css" href="styles.css" />
</head>
<body left-margin="0" top-margin="0">
<div align="left">
<table style="text-align: left; position: absolute; left: 0pt; top: 0pt;" border="0"
cellpadding="0" cellspacing="0" height="407" width="100%">
<tbody>
<tr>
<td colspan="2" class="bannerbackground" height="33" width="100%">
<table border="0" cellpadding="4" cellspacing="0" width="100%">
<tbody>
<tr>
<td><a href="https://github.com/Wisser/Jailer"><img src="logo.png" hspace="10" /></td> <td class="slogan" width="100%"></a>
<td class="slogan" width="100%"></td>
<td style="text-align: right; width: 100%;">
<table border="0" cellpadding="0" cellspacing="0">
<tbody>
<tr>
<td><a href="https://github.com/Wisser/Jailer"><img src="GitHub-Mark-64px.png" title="GitHub" /></a> </td></tr><tr style="height: 100%;"><td>&nbsp;</td>
</tr>
</tbody>
</table>
</td>
</tr>
</tbody>
</table>
</td>
</tr>
<tr>
<td colspan="2" class="nav1background" width="100%">&nbsp;
<b><font color="#FFFFFF"><a href="home.htm" target="_self" class=
"tlink">&nbsp;Home&nbsp;</a> <a href="quicktour.htm" target="_self"
class="tlinkA">&nbsp;Quick Tour&nbsp;</a> <a href="exporting-data.htm"
target="_self" class="tlink">&nbsp;Tutorial&nbsp;</a> <a href=
"data-browsing.html" target="_self" class="tlink">&nbsp;Data Browser&nbsp;</a> <a class="tlink" href="videos.html" target="_self">&nbsp;Videos&nbsp;</a>
<a href="faq.html" target="_self" class="tlink">&nbsp;FAQ&nbsp;</a>
<a href="api.html" target="_self" class="tlink">&nbsp;API&nbsp;</a>
<a href="design.htm" target="_self" class=
"tlink">&nbsp;Documentation&nbsp;</a> <a href=
"http://sourceforge.net/forum/?group_id=197260" target="_self" class=
"tlink">&nbsp;Forum&nbsp;</a> <a href=
"http://sourceforge.net/project/showfiles.php?group_id=197260" target="_self"
class="tlink">&nbsp;Download&nbsp;</a> &nbsp;&nbsp;&nbsp;
&nbsp;&nbsp;&nbsp;</font></b></td>
</tr>
<tr>
<td colspan="2" class="spacer" width="100%"></td> </tr><tr><td class="lmenucontainer">&nbsp;</td>
</tr>
<tr>
<td class="lmenucontainer" height="100%" valign="top" width="14%">
<div align="center">
<center>
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tbody>
<tr>
<td height="6px" width="100%"> </td>
</tr>
</tbody>
</table>
</center>
</div>
<ul>
<li><a href="quicktour.htm" target="_self" class="mlinkA">Quick
Tour</a> </li>
</ul>
<table border="0" cellpadding="5" cellspacing="0" width="100%">
<tbody>
<tr>
<td class="content2background"><img style="width: 160px; height: 1px;"
alt="" src="architecture-Dateien/vgradp.gif" /></td>
</tr>
</tbody>
</table>
<p>&nbsp;</p>
</td>
<td class="contentbackground" height="418" valign="top" width="86%">
<div align="right">
<table border="0" cellpadding="0" cellspacing="0" height="542" width="98%">
<tbody>
<tr>
<td class="contentbackground" height="21" width="100%">&nbsp;</td>
</tr>
<tr>
<td class="content" height="520" valign="top" width="100%">
<h3>A quick tour through Jailer.</h3>
<br />
Extraction Model Editor<br/> <br/> <img alt="" src="qt1.png" /><br />
<br />
<ol>
<li><span style="font-style: italic;">Subject table.</span></li>
<li><span style="font-style: italic;">Subject condition.</span>
The export process starts with rows of subject table where this
condition holds.</li>
<li><span style="font-style: italic;">Export format.</span></li>
<li><span style="font-style: italic;">Starts export.</span></li>
<li><span style="font-style: italic;">Focused
table.</span></li>
<li><span style="font-style: italic;">Outline of focused
table.</span></li>
<li><span style="font-style: italic;">Restrictions editor.</span>
Edit restriction on currently selected association
here.</li>
<li>
<span style="font-style: italic;">Model-graph panel.</span>
<ul>
<li><span style="font-style: italic;">Panning</span>. Drag
with left mouse-button.</li>
<li><span style="font-style: italic;">Zooming</span>. Drag
with right mouse-button on empty space.</li>
<li><span style="font-style: italic;">Zoom in/out.</span>
Mouse-wheel&nbsp;down/up.</li>
<li><span style="font-style: italic;">Zoom to fit.
C</span>lick with right mouse-button on empty space.</li>
<li><span style="font-style: italic;">Context menu</span>.
Click with right mouse-button on table.</li>
<li><span style="font-style: italic;">Select association.
C</span>lick with left mouse-button on association.</li>
<li><span style="font-style: italic;">Expand table</span>.
Double-click with right mouse-button on collapsed table.</li>
<li><span style="font-style: italic;">Collapse table</span>.
Double-click with right mouse-button on expanded table.</li>
<li><span style="font-style: italic;">Move table</span>. Drag
with left mouse-button on table.</li>
</ul>
</li>
<li><span style="font-style: italic;">Currently selected
association.</span></li>
<li><span style="font-style: italic;">Collapsed table.</span> Table with hidden neighbors.</li>
<li><span style="font-style: italic;">Subject table.</span></li>
</ol><br/>
Data Model Editor<br/> <br/> <img
alt="" src="qt3.png" /><br />
<br />
<ol style="font-style: italic;">
<li>List of all tables.</li>
<li>List of all associations.</li>
</ol><br />
Table Editor
<p><img alt="" src=
"qt4.png" /><br />
<br /></p>
<ol>
<li style="font-style: italic;">Table name.</li>
<li style="font-style: italic;">Columns.</li>
<li><span style="font-style: italic;">Insert/Upsert
selection.</span> Use Upserts if exported rows may already exist
in the database in which you want to import them.</li>
<li><span style="font-style: italic;">Exclude from
deletion.</span> If switched-on, no delete-statements will be
generated for the rows of this table.</li>
</ol><br />
Association Editor<br/> <br/>
<img alt="" src=
"qt5.png" /><br />
<br />
<ol>
<li style="font-style: italic;">Source table.</li>
<li><span style="font-style: italic;">Type.</span> "associates",
"depends on" and "has dependent".</li>
<li style="font-style: italic;">Destination table.</li>
<li><span style="font-style: italic;">Join Condition.</span>
Condition which is fulfilled by a pair of rows if and only if the
two rows are associated with each other.</li>
<li><span style="font-style: italic;">Cardinality.</span> If
you're not very sure what the cardinality of the association is,
it is better to leave this field blank!</li>
<li><span style="font-style: italic;">Name.</span> Unique name of
association.</li>
</ol><br />
Data Export Dialog<br/><br/><img alt="" src="qt6.png" /><br />
<br />
<ol>
<li><span style="font-style: italic;">Export into.</span> Name of
SQL-script containing INSERT-statements for exported rows. If the
name ends with '.zip', then a zip-compressed file will be
generated.</li>
<li><span style="font-style: italic;">Generate
delete-script.</span> Name of SQL-script containing
DELETE-statements for rows to be deleted. If the name ends with
'.zip', then a zip-compressed file will be generated.</li>
<li><span style="font-style: italic;">Parallel threads.</span> Number of
thread/concurrent connections to be used for export-process. Set
this number to 1 if you encounter problems with concurrent
connections.</li>
<li><span style="font-style: italic;">Rows per statement.</span>
Maximum number of rows to be inserted with singe INSERT-statement
(if your DBMS supports multi-row inserts).<br /></li>
</ol><br />
<br />
Menu<br/>
<ul>
<li style="font-style: italic;">File</li>
<ul>
<li><span style="font-style: italic;">New Model.</span>
Creates new empty extraction model.<br /></li>
<li><span style="font-style: italic;">Load.</span> Load
extraction model.<br /></li>
<li><span style="font-style: italic;">Save.</span> Saves.
extraction model.</li>
<li><span style="font-style: italic;">Save as...</span> Asks
for file name and saves extraction model.</li>
<li><span style="font-style: italic;">Connect
database.</span> Connect or Re-connect to a
database.<br /></li>
<li><span style="font-style: italic;">Disconnect.</span>
Disconnect from database.<br /></li>
<li><span style="font-style: italic;">Exit.</span><br /></li>
</ul>
<li style="font-style: italic;">Restriction</li>
<ul>
<li><span style="font-style: italic;">Disable all
associations.</span> Creates a "disabled"-restriction for
each association. Use this if you want to explicitly tell
Jailer what you <span style="font-weight: bold;">want</span>
to export, instead of telling him what you <span style=
"font-weight: bold;">don't want</span>.<br /></li>
<li><span style="font-style: italic;">Remove all
restrictions.</span> Removes all previously defined
restrictions from model.<br /></li>
</ul>
<li style="font-style: italic;">View</li>
<ul>
<li><span style="font-style: italic;">Collapse all.</span>
Collapses all tables in model-graph panel.<br /></li>
<li><span style="font-style: italic;">Expand all.</span>
Expands all tables in model-graph panel.</li>
<li><span style="font-style: italic;">Fix all.</span> Fix the
positions of all tables in model-graph panel.</li>
<li><span style="font-style: italic;">Unfix all.</span> Unfix
the positions of all tables in model-graph panel.</li>
<li><span style="font-style: italic;">Reset.</span> Resets
model-graph panel so that only subject table is
visible.<br /></li>
<li><span style="font-style: italic;">Zoom to fix.</span>
Sets zoom scale of model-graph panel so that all tables fits
into display<span style=
"font-style: italic;">.</span><br style=
"font-style: italic;" /></li>
<li><span style="font-style: italic;">Show table
details</span>. Show/Hide column definitions.</li>
<li><span style="font-style: italic;">Show disabled
associations.</span> If enabled, don't show disabled
association and dont expand over disables associations. You
may use <span style="font-style: italic;">Reset</span> +
<span style="font-style: italic;">Expand all</span> then to
see the closure of the subject.<br /></li>
<li><span style="font-style: italic;">Look&amp;Feel.</span>
Changes the GUI Look&amp;Feel.<br /></li>
</ul>
<li style="font-style: italic;">Tools</li>
<ul>
<li><span style="font-style: italic;">Export Data.</span>
Opens Export Data Dialog.<br /></li>
<li><span style="font-style: italic;">Import Data.</span>
Imports data into database.<br /></li>
<li><span style="font-style: italic;">Analyze Database</span>
Analyzes the database and opens data model editor.<br /></li>
<li><span style="font-style: italic;">Data Model
Editor.</span> Opens data model editor.</li>
<li><span style="font-style: italic;">Print Data
Model.</span> Prints out data model as plain text.<br /></li>
<li><span style="font-style: italic;">HTML Rendering.</span>
Generates HTML pages for all tables showing restrictions and
associations.<br /></li>
</ul>
<li style="font-style: italic;">Help</li>
<ul>
<li><span style="font-style: italic;">Content.</span> Opens
web site in browser.<br /></li>
<li><span style="font-style: italic;">Tutorial.</span> Opens
tutorial page in browser.<br /></li>
<li><span style="font-style: italic;">Software Update.</span>
Looks for software update at
jailer.sourceforge.net.<br /></li>
<li><span style=
"font-style: italic;">About.</span><br /></li>
</ul>
</ul><br />
</td>
</tr>
</tbody>
</table>
</div>
<p><br /></p>
</td>
</tr>
<tr>
<td height="12" valign="top" width="14%"><br /></td>
<td><br /></td>
</tr>
</tbody>
</table>
</div>
</body>
</html>