| <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
| <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en" dir="ltr"> |
| <head> |
| <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> |
| <meta name="keywords" content="SMILA/Documentation/JDBC Crawler,SMILA/Documentation/Crawler" /> |
| <link rel="shortcut icon" href="http://wiki.eclipse.org/SMILA/Documentation/favicon.ico" /> |
| <link rel="search" type="application/opensearchdescription+xml" href="http://wiki.eclipse.org/opensearch_desc.php" title="Eclipsepedia (English)" /> |
| <link rel="alternate" type="application/rss+xml" title="Eclipsepedia RSS Feed" href="http://wiki.eclipse.org/index.php?title=Special:Recentchanges&feed=rss" /> |
| <link rel="alternate" type="application/atom+xml" title="Eclipsepedia Atom Feed" href="http://wiki.eclipse.org/index.php?title=Special:Recentchanges&feed=atom" /> |
| |
| |
| <title>SMILA/Documentation/JDBC Crawler - Eclipsepedia</title> |
| |
| <style type="text/css" media="screen,projection">/*<![CDATA[*/ @import "http://wiki.eclipse.org/skins/eclipsenova/novaWide.css?116"; /*]]>*/</style> |
| <link rel="stylesheet" type="text/css" media="print" href="http://wiki.eclipse.org/skins/eclipsenova/eclipsenovaPrint.css?116" /> |
| <link rel="stylesheet" type="text/css" media="handheld" href="http://wiki.eclipse.org/skins/eclipsenova/handheld.css?116" /> |
| <link rel="stylesheet" type="text/css" href="http://wiki.eclipse.org/skins/eclipsenova/Nova/css/header.css" media="screen" /> |
| <link rel="stylesheet" type="text/css" href="http://wiki.eclipse.org/skins/eclipsenova/tabs.css" media="screen" /> |
| <link rel="stylesheet" type="text/css" href="http://wiki.eclipse.org/skins/eclipsenova/Nova/css/visual.css" media="screen" /> |
| <link rel="stylesheet" type="text/css" href="http://wiki.eclipse.org/skins/eclipsenova/Nova/css/layout.css" media="screen" /> |
| <link rel="stylesheet" type="text/css" href="http://wiki.eclipse.org/skins/eclipsenova/Nova/css/footer.css" media="screen" /> |
| <!--[if IE]><link rel="stylesheet" type="text/css" href="/skins/eclipsenova/IEpngfix.css" media="screen" /><![endif]--> |
| <!--[if lt IE 5.5000]><style type="text/css">@import "/skins/eclipsenova/IE50Fixes.css?116";</style> <![endif]--> |
| <!--[if IE 5.5000]><style type="text/css">@import "/skins/eclipsenova/IE55Fixes.css?116";</style><![endif]--> |
| <!--[if IE 6]><style type="text/css">@import "/skins/eclipsenova/IE60Fixes.css?116";</style><![endif]--> |
| <!--[if IE 7]><style type="text/css">@import "/skins/eclipsenova/IE70Fixes.css?116";</style><![endif]--> |
| <!--[if lt IE 7]><script type="text/javascript" src="/skins/common/IEFixes.js?116"></script> |
| <meta http-equiv="imagetoolbar" content="no" /><![endif]--> |
| <script type= "text/javascript">/*<![CDATA[*/ |
| var skin = "eclipsenova"; |
| var stylepath = "/skins"; |
| var wgArticlePath = "/$1"; |
| var wgScriptPath = ""; |
| var wgScript = "/index.php"; |
| var wgServer = "http://wiki.eclipse.org"; |
| var wgCanonicalNamespace = ""; |
| var wgCanonicalSpecialPageName = false; |
| var wgNamespaceNumber = 0; |
| var wgPageName = "SMILA/Documentation/JDBC_Crawler"; |
| var wgTitle = "SMILA/Documentation/JDBC Crawler"; |
| var wgAction = "view"; |
| var wgRestrictionEdit = []; |
| var wgRestrictionMove = []; |
| var wgArticleId = "16918"; |
| var wgIsArticle = true; |
| var wgUserName = null; |
| var wgUserGroups = null; |
| var wgUserLanguage = "en"; |
| var wgContentLanguage = "en"; |
| var wgBreakFrames = false; |
| var wgCurRevisionId = "285988"; |
| var wgVersion = "1.12.0"; |
| var wgEnableAPI = true; |
| var wgEnableWriteAPI = false; |
| /*]]>*/</script> |
| |
| <script type="text/javascript" src="http://wiki.eclipse.org/skins/common/wikibits.js?116"><!-- wikibits js --></script> |
| |
| <!-- Performance mods similar to those for bug 166401 --> |
| <script type="text/javascript" src="http://wiki.eclipse.org/index.php?title=-&action=raw&gen=js&useskin=eclipsenova"><!-- site js --></script> |
| |
| <!-- Head Scripts --> |
| <script type="text/javascript" src="http://wiki.eclipse.org/skins/common/ajax.js?116"></script> |
| <style type="text/css">/*<![CDATA[*/ |
| .source-xml {line-height: normal; font-size: medium;} |
| .source-xml li {line-height: normal;} |
| /** |
| * GeSHi Dynamically Generated Stylesheet |
| * -------------------------------------- |
| * Dynamically generated stylesheet for xml |
| * CSS class: source-xml, CSS id: |
| * GeSHi (C) 2004 - 2007 Nigel McNie (http://qbnz.com/highlighter) |
| */ |
| .source-xml .de1, .source-xml .de2 {font-family: 'Courier New', Courier, monospace; font-weight: normal;} |
| .source-xml {} |
| .source-xml .head {} |
| .source-xml .foot {} |
| .source-xml .imp {font-weight: bold; color: red;} |
| .source-xml .ln-xtra {color: #cc0; background-color: #ffc;} |
| .source-xml li {font-family: 'Courier New', Courier, monospace; color: black; font-weight: normal; font-style: normal;} |
| .source-xml li.li2 {font-weight: bold;} |
| .source-xml .coMULTI {color: #808080; font-style: italic;} |
| .source-xml .es0 {color: #000099; font-weight: bold;} |
| .source-xml .br0 {color: #66cc66;} |
| .source-xml .st0 {color: #ff0000;} |
| .source-xml .nu0 {color: #cc66cc;} |
| .source-xml .sc0 {color: #00bbdd;} |
| .source-xml .sc1 {color: #ddbb00;} |
| .source-xml .sc2 {color: #339933;} |
| .source-xml .sc3 {color: #009900;} |
| .source-xml .re0 {color: #000066;} |
| .source-xml .re1 {font-weight: bold; color: black;} |
| .source-xml .re2 {font-weight: bold; color: black;} |
| |
| /*]]>*/ |
| </style> |
| <style type="text/css">/*<![CDATA[*/ |
| @import "http://wiki.eclipse.org/index.php?title=MediaWiki:Geshi.css&usemsgcache=yes&action=raw&ctype=text/css&smaxage=18000"; |
| /*]]>*/ |
| </style><style type="text/css">/*<![CDATA[*/ |
| .source-sql {line-height: normal; font-size: medium;} |
| .source-sql li {line-height: normal;} |
| /** |
| * GeSHi Dynamically Generated Stylesheet |
| * -------------------------------------- |
| * Dynamically generated stylesheet for sql |
| * CSS class: source-sql, CSS id: |
| * GeSHi (C) 2004 - 2007 Nigel McNie (http://qbnz.com/highlighter) |
| */ |
| .source-sql .de1, .source-sql .de2 {font-family: 'Courier New', Courier, monospace; font-weight: normal;} |
| .source-sql {} |
| .source-sql .head {} |
| .source-sql .foot {} |
| .source-sql .imp {font-weight: bold; color: red;} |
| .source-sql .ln-xtra {color: #cc0; background-color: #ffc;} |
| .source-sql li {font-family: 'Courier New', Courier, monospace; color: black; font-weight: normal; font-style: normal;} |
| .source-sql li.li2 {font-weight: bold;} |
| .source-sql .kw1 {color: #993333; font-weight: bold;} |
| .source-sql .co1 {color: #808080; font-style: italic;} |
| .source-sql .co2 {color: #808080; font-style: italic;} |
| .source-sql .coMULTI {color: #808080; font-style: italic;} |
| .source-sql .es0 {color: #000099; font-weight: bold;} |
| .source-sql .br0 {color: #66cc66;} |
| .source-sql .st0 {color: #ff0000;} |
| .source-sql .nu0 {color: #cc66cc;} |
| |
| /*]]>*/ |
| </style> |
| <style type="text/css">/*<![CDATA[*/ |
| @import "http://wiki.eclipse.org/index.php?title=MediaWiki:Geshi.css&usemsgcache=yes&action=raw&ctype=text/css&smaxage=18000"; |
| /*]]>*/ |
| </style><style type="text/css">/*<![CDATA[*/ |
| .source-java {line-height: normal; font-size: medium;} |
| .source-java li {line-height: normal;} |
| /** |
| * GeSHi Dynamically Generated Stylesheet |
| * -------------------------------------- |
| * Dynamically generated stylesheet for java |
| * CSS class: source-java, CSS id: |
| * GeSHi (C) 2004 - 2007 Nigel McNie (http://qbnz.com/highlighter) |
| */ |
| .source-java .de1, .source-java .de2 {font-family: 'Courier New', Courier, monospace; font-weight: normal;} |
| .source-java {} |
| .source-java .head {} |
| .source-java .foot {} |
| .source-java .imp {font-weight: bold; color: red;} |
| .source-java .ln-xtra {color: #cc0; background-color: #ffc;} |
| .source-java li {font-family: 'Courier New', Courier, monospace; color: black; font-weight: normal; font-style: normal;} |
| .source-java li.li2 {font-weight: bold;} |
| .source-java .kw1 {color: #7F0055; font-weight: bold;} |
| .source-java .kw2 {color: #7F0055; font-weight: bold;} |
| .source-java .kw3 {color: #000000; font-weight: normal} |
| .source-java .kw4 {color: #7F0055; font-weight: bold;} |
| .source-java .co1 {color: #3F7F5F; font-style: italic;} |
| .source-java .co2 {color: #3F7F5F;} |
| .source-java .co3 {color: #3F7F5F; font-style: italic; font-weight: bold;} |
| .source-java .coMULTI {color: #3F5FBF; font-style: italic;} |
| .source-java .es0 {color: #000000;} |
| .source-java .br0 {color: #000000;} |
| .source-java .st0 {color: #2A00ff;} |
| .source-java .nu0 {color: #000000;} |
| .source-java .me1 {color: #000000;} |
| .source-java .me2 {color: #000000;} |
| |
| /*]]>*/ |
| </style> |
| <style type="text/css">/*<![CDATA[*/ |
| @import "http://wiki.eclipse.org/index.php?title=MediaWiki:Geshi.css&usemsgcache=yes&action=raw&ctype=text/css&smaxage=18000"; |
| /*]]>*/ |
| </style><link rel="stylesheet" type="text/css" href="JDBC_Crawler.html" /> </head> |
| <body class="mediawiki ns-0 ltr page-SMILA_Documentation_JDBC_Crawler"> |
| <div id="globalWrapper"> |
| |
| |
| <div id="column-one"> |
| <!-- Eclipse Additions for the Top Nav start here M. Ward--> |
| |
| <div id="header"> |
| <div id="header-graphic"> |
| <img src="http://wiki.eclipse.org/skins/eclipsenova/eclipse.png" alt="Eclipse Wiki"> |
| </div> |
| <!-- Pulled 101409 Mward --> |
| |
| <div class="portlet" id="p-personal"> |
| <div class="pBody"> |
| <ul> |
| <li id="pt-login"><a href="http://wiki.eclipse.org/index.php?title=Special:Userlogin&returnto=SMILA/Documentation/JDBC_Crawler">Log in</a></li> |
| </ul> |
| </div> |
| </div> |
| |
| <div id="header-icons"> |
| <div id="sites"> |
| <ul id="sitesUL"> |
| <li><a href="http://www.eclipse.org"><img src="http://dev.eclipse.org/custom_icons/eclipseIcon.png" width="28" height="28" alt="Eclipse Foundation" title="Eclipse Foundation" /><div>Eclipse Foundation</div></a></li> |
| <li><a href="http://marketplace.eclipse.org"><img src="http://dev.eclipse.org/custom_icons/marketplace.png" width="28" height="28" alt="Eclipse Marketplace" title="Eclipse Marketplace" /><div>Eclipse Marketplace</div></a></li> |
| <li><a href="https://bugs.eclipse.org/bugs"><img src="http://dev.eclipse.org/custom_icons/system-search-bw.png" width="28" height="28" alt="Bugzilla" title="Bugzilla" /><div>Bugzilla</div></a></li> |
| <li><a href="http://live.eclipse.org"><img src="http://dev.eclipse.org/custom_icons/audio-input-microphone-bw.png" width="28" height="28" alt="Live" title="Live" /><div>Eclipse Live</div></a></li> |
| <li><a href="http://planeteclipse.org"><img src="http://dev.eclipse.org/large_icons/devices/audio-card.png" width="28" height="28" alt="PlanetEclipse" title="Planet" /><div>Planet Eclipse</div></a></li> |
| <li><a href="http://portal.eclipse.org"><img src="http://dev.eclipse.org/custom_icons/preferences-system-network-proxy-bw.png" width="28" height="28" alt="Portal" title="Portal" /><div>My Foundation Portal</div></a></li> |
| </ul> |
| </div> |
| </div> |
| </div> |
| <!-- NEW HEADER STUFF HERE --> |
| <div id="header-menu"> |
| <div id="header-nav"> |
| <ul> <li><a class="first_one" href="http://wiki.eclipse.org/" target="_self">Home</a></li> <li><a href="http://www.eclipse.org/downloads/" target="_self">Downloads</a></li> |
| <li><a href="http://www.eclipse.org/users/" target="_self">Users</a></li> |
| <li><a href="http://www.eclipse.org/membership/" target="_self">Members</a></li> |
| <li><a href="http://wiki.eclipse.org/index.php/Development_Resources" target="_self">Committers</a></li> |
| <li><a href="http://www.eclipse.org/resources/" target="_self">Resources</a></li> |
| <li><a href="http://www.eclipse.org/projects/" target="_self">Projects</a></li> |
| <li><a href="http://www.eclipse.org/org/" target="_self">About Us</a></li> |
| </ul> |
| </div> |
| <div id="header-utils"> |
| <!-- moved the search window here --> |
| <form action="http://wiki.eclipse.org/Special:Search" > |
| <input class="input" name="search" type="text" accesskey="f" value="" /> |
| <input type='submit' onclick="this.submit();" name="go" id="searchGoButton" class="button" title="Go to a page with this exact name if one exists" value="Go" /> |
| <input type='submit' onclick="this.submit();" name="fulltext" class="button" id="mw-searchButton" title="Search Eclipsepedia for this text" value="Search" /> |
| </form> |
| </div> |
| </div> |
| |
| |
| <!-- Eclipse Additions for the Header stop here --> |
| <!-- Additions and mods for leftside nav Start here --> |
| |
| <!--Started nav rip here--> |
| <!-- these are the nav controls main page, changes etc --> |
| <div id="novaContent" class="faux"> |
| <div id="leftcol"> |
| <ul id="leftnav"> |
| <!-- these are the page controls, edit history etc --> |
| <li class="separator"><a class="separator">Navigation   </li> |
| <li id="n-mainpage"><a href="http://wiki.eclipse.org/Main_Page">Main Page</a></li> |
| <li id="n-portal"><a href="http://wiki.eclipse.org/Eclipsepedia:Community_Portal">Community portal</a></li> |
| <li id="n-currentevents"><a href="http://wiki.eclipse.org/Eclipsepedia:Current_events">Current events</a></li> |
| <li id="n-recentchanges"><a href="http://wiki.eclipse.org/Special:Recentchanges">Recent changes</a></li> |
| <li id="n-randompage"><a href="http://wiki.eclipse.org/Special:Random">Random page</a></li> |
| <li id="n-help"><a href="http://wiki.eclipse.org/Help:Contents">Help</a></li> |
| <li class="separator"><a class="separator">Toolbox   </a></li> |
| |
| <li id="t-whatlinkshere"><a href="http://wiki.eclipse.org/Special:Whatlinkshere/SMILA/Documentation/JDBC_Crawler">What links here</a></li> |
| <li id="t-recentchangeslinked"><a href="http://wiki.eclipse.org/Special:Recentchangeslinked/SMILA/Documentation/JDBC_Crawler">Related changes</a></li> |
| <!-- This is the toolbox section --> |
| <li id="t-upload"><a href="http://wiki.eclipse.org/Special:Upload">Upload file</a></li> |
| <li id="t-specialpages"><a href="http://wiki.eclipse.org/Special:Specialpages">Special pages</a></li> |
| <li id="t-print"><a href="http://wiki.eclipse.org/index.php?title=SMILA/Documentation/JDBC_Crawler&printable=yes">Printable version</a></li> <li id="t-permalink"><a href="http://wiki.eclipse.org/index.php?title=SMILA/Documentation/JDBC_Crawler&oldid=285988">Permanent link</a></li> </ul> |
| </div> |
| |
| |
| <!-- Additions and mods for leftside nav End here --> |
| |
| |
| <div id="column-content"> |
| <div id="content"> |
| <a name="top" id="top"></a> |
| |
| <div id="tabs"> |
| <ul class="primary"> |
| <li class="active"><a href="JDBC_Crawler.html"><span class="tab">Page</span></a></li> |
| <li><a href="http://wiki.eclipse.org/index.php?title=Talk:SMILA/Documentation/JDBC_Crawler&action=edit"><span class="tab">Discussion</span></a></li> |
| <li><a href="http://wiki.eclipse.org/index.php?title=SMILA/Documentation/JDBC_Crawler&action=edit"><span class="tab">View source</span></a></li> |
| <li><a href="http://wiki.eclipse.org/index.php?title=SMILA/Documentation/JDBC_Crawler&action=history"><span class="tab">History</span></a></li> |
| <li><a href="http://wiki.eclipse.org/index.php?title=Special:Userlogin&returnto=SMILA/Documentation/JDBC Crawler"><span class="tab">Edit</span></a></li> |
| </ul> |
| </div> |
| |
| |
| <script type="text/javascript"> if (window.isMSIE55) fixalpha(); </script> |
| <h1 class="firstHeading">SMILA/Documentation/JDBC Crawler</h1> |
| <div id="bodyContent"> |
| <h3 id="siteSub">From Eclipsepedia</h3> |
| <div id="contentSub"><span class="subpages">< <a href="../../SMILA.html" title="SMILA">SMILA</a> | <a href="../Documentation.1.html" title="SMILA/Documentation">Documentation</a></span></div> |
| <div id="jump-to-nav">Jump to: <a href="JDBC_Crawler.html#column-one">navigation</a>, <a href="JDBC_Crawler.html#searchInput">search</a></div> <!-- start content --> |
| <div class="messagebox" style="background-color: #def3fe; border: 1px solid #c5d7e0; color: black; padding: 5px; margin: 1ex 0; min-height: 35px; padding-left: 45px;"> |
| <div style="float: left; margin-left: -40px;"><a href="http://wiki.eclipse.org/Image:Note.png" class="image" title="Note.png"><img alt="" src="http://wiki.eclipse.org/images/c/cc/Note.png" width="35" height="35" border="0" /></a></div> |
| <div><b>This is deprecated for SMILA 1.0, the connectivity framework is still functional but will aimed to be replaced by scalable import based on SMILAs job management.</b><br /></div> |
| </div> |
| <p><br /> |
| </p> |
| <table id="toc" class="toc" summary="Contents"><tr><td><div id="toctitle"><h2>Contents</h2></div> |
| <ul> |
| <li class="toclevel-1"><a href="JDBC_Crawler.html#Overview"><span class="tocnumber">1</span> <span class="toctext">Overview</span></a></li> |
| <li class="toclevel-1"><a href="JDBC_Crawler.html#Crawling_configuration"><span class="tocnumber">2</span> <span class="toctext">Crawling configuration</span></a></li> |
| <li class="toclevel-1"><a href="JDBC_Crawler.html#Crawling_configuration_explanation"><span class="tocnumber">3</span> <span class="toctext">Crawling configuration explanation</span></a></li> |
| <li class="toclevel-1"><a href="JDBC_Crawler.html#Crawling_configuration_example"><span class="tocnumber">4</span> <span class="toctext">Crawling configuration example</span></a></li> |
| <li class="toclevel-1"><a href="JDBC_Crawler.html#Output_example"><span class="tocnumber">5</span> <span class="toctext">Output example</span></a></li> |
| <li class="toclevel-1"><a href="JDBC_Crawler.html#Using_the_Grouping_element"><span class="tocnumber">6</span> <span class="toctext">Using the Grouping element</span></a></li> |
| </ul> |
| </td></tr></table><script type="text/javascript"> if (window.showTocToggle) { var tocShowText = "show"; var tocHideText = "hide"; showTocToggle(); } </script> |
| <a name="Overview"></a><h2> <span class="mw-headline"> Overview </span></h2> |
| <p>The JDBC crawler collects data from a JDBC-accessible databases based on a SELECT statement given in <tt>DataSourceConnectionConfig</tt>. |
| Any of the columns of the database record returned by the SELECT statement may be mapped to an attribute of the SMILA record in the <tt>Attributes</tt> section of the <tt>DataSourceConnectionConfig</tt>. |
| </p><p>To overcome certain shortcomings of some JDBCd drivers concerning the handling of really large data sets, the crawler features an optional grouping mechanism enabling it to retrieve data in well defined frames from the database and thus avoid OutOfMemoryExceptions. |
| </p><p>To use the JDBC crawler with your custom JDBC driver, the JDBC crawler bundle's ClassLoader has to have access to the driver class, i.e. you have to have a bundle that exports the driver class. |
| </p> |
| <a name="Crawling_configuration"></a><h2> <span class="mw-headline"> Crawling configuration </span></h2> |
| <p>The configuration file has to be located at <tt>configuration/org.eclipse.smila.connectivity.framework</tt>. |
| </p><p>Defining Schema: <tt>org.eclipse.smila.connectivitiy.framework.crawler.jdbc/schemas/JdbcDataSourceConnectionConfigSchema.xsd</tt> |
| </p> |
| <a name="Crawling_configuration_explanation"></a><h2> <span class="mw-headline"> Crawling configuration explanation </span></h2> |
| <p>See <a href="Crawler.html#Configuration" title="SMILA/Documentation/Crawler">SMILA/Documentation/Crawler#Configuration</a> for the generic parts of the configuration file. |
| </p><p>The root element of the crawling configuration is <tt>DataSourceConnectionConfig</tt> and contains the following sub elements: |
| </p> |
| <ul><li> <tt>DataSourceID</tt> – the identification of a data source. |
| </li><li> <tt>SchemaID</tt> – specify the schema for a crawler job. |
| </li><li> <tt>DataConnectionID</tt> – describes which agent crawler should be used. |
| <ul><li> <tt>Crawler</tt> – implementation class of a crawler. |
| </li></ul> |
| </li><li> <tt>DeltaIndexing</tt> – specifies deltaindexing mode. |
| </li><li> <tt>Attributes</tt> – list all attributes you would like to use from a database row |
| <ul><li> <tt>Attribute</tt> |
| <ul><li> <tt>Type</tt> (required) – the data type to use in the SMILA record. |
| </li><li> <tt>Name</tt> (required) – the name of the attribute to create in the SMILA record. |
| </li><li> <tt>HashAttribute</tt> (required) – specify if a hash should be created (true or false). |
| </li><li> <tt>KeyAttribute</tt> (required) – creates a key for this object, for example for record id (true or false). |
| </li><li> <tt>Attachment</tt> (required) – specify if the attribute's data should be stored as an attachment e.g. for blob or clob fields (true or false) |
| </li><li> <tt>ColumnName</tt> (required) - the name of the column in the database row to use for this attribute |
| </li><li> <tt>SqlType</tt> (required)- specify the SQL Type of the column in the database row (one of: "string", "long", "date", "double", "blob", "clob", "boolean", "byte[]", "timestamp") |
| </li></ul> |
| </li></ul> |
| </li></ul> |
| <ul><li> <tt>Process</tt> |
| <ul><li> <tt>Selections</tt> - Which data is to be selected (and how) |
| <ul><li> <tt>Grouping</tt> (optional) - adds support for "chunk"-wise retrieving of data from the database in order to preserve memory resources. See "Using the Grouping Element" below. |
| <ul><li> <tt>Stepping</tt> - how many rows should be retrieved at a time (integer) |
| </li><li> <tt>SQL</tt> - specify an SQL statement that returns an ordered list of database keys which can be used to create the retrieval partitions |
| </li></ul> |
| </li><li> <tt>SQL</tt> - the SQL statement that selects the actual data to be retrieved. |
| </li></ul> |
| </li><li> <tt>Database</tt> - JDBC Connection information |
| <ul><li> <tt>Connection</tt> - The JDBC connection URL to use for connecting to the database |
| </li><li> <tt>User</tt> - The username to use when connecting to the database (can be left blank if anonymous access is possible) |
| </li><li> <tt>Password</tt> - The password to use when connecting to the database (can be left blank if anonymous access is possible) |
| </li><li> <tt>FetchSize</tt> - The FetchSize to set when creating the JDBC-Connection. This is mapped to the JDBC-property and must not be confused with the Stepping functionality of the crawler. |
| </li><li> <tt>JdbcDriver</tt> - Specify the fully qualified class name of the Jdbc-Driver to use (must be accessible to the bundle's class loader) |
| </li></ul> |
| </li></ul> |
| </li></ul> |
| <a name="Crawling_configuration_example"></a><h2> <span class="mw-headline"> Crawling configuration example </span></h2> |
| <p>A typical configuration for the JDBC crawler looks like this: |
| </p> |
| <div dir="ltr" style="text-align: left;"><pre class="source-xml"><span class="sc3"><span class="re1"><?xml</span> <span class="re0">version</span>=<span class="st0">"1.0"</span> <span class="re0">encoding</span>=<span class="st0">"UTF-8"</span><span class="re2">?></span></span> |
| <span class="sc3"><span class="re1"><DataSourceConnectionConfig</span> |
| <span class="re0">xmlns:xsi</span>=<span class="st0">"http://www.w3.org/2001/XMLSchema-instance"</span> |
| <span class="re0">xsi:noNamespaceSchemaLocation</span>=<span class="st0">"../org.eclipse.smila.connectivity.framework.crawler.jdbc/schemas/JdbcDataSourceConnectionConfigSchema.xsd"</span><span class="re2">></span></span> |
| <span class="sc3"><span class="re1"><DataSourceID<span class="re2">></span></span></span>jdbc<span class="sc3"><span class="re1"></DataSourceID<span class="re2">></span></span></span> |
| <span class="sc3"><span class="re1"><SchemaID<span class="re2">></span></span></span>org.eclipse.smila.connectivity.framework.crawler.jdbc<span class="sc3"><span class="re1"></SchemaID<span class="re2">></span></span></span> |
| <span class="sc3"><span class="re1"><DataConnectionID<span class="re2">></span></span></span> |
| <span class="sc3"><span class="re1"><Crawler<span class="re2">></span></span></span>JdbcCrawler<span class="sc3"><span class="re1"></Crawler<span class="re2">></span></span></span> |
| <span class="sc3"><span class="re1"></DataConnectionID<span class="re2">></span></span></span> |
| <span class="sc3"><span class="re1"><DeltaIndexing<span class="re2">></span></span></span>full<span class="sc3"><span class="re1"></DeltaIndexing<span class="re2">></span></span></span> |
| <span class="sc3"><span class="re1"><Attributes<span class="re2">></span></span></span> |
| <span class="sc3"><span class="re1"><Attribute</span> <span class="re0">Name</span>=<span class="st0">"Person_ID"</span> <span class="re0">HashAttribute</span>=<span class="st0">"true"</span> |
| <span class="re0">KeyAttribute</span>=<span class="st0">"true"</span> <span class="re0">Type</span>=<span class="st0">"Long"</span><span class="re2">></span></span> |
| <span class="sc3"><span class="re1"><ColumnName<span class="re2">></span></span></span>id<span class="sc3"><span class="re1"></ColumnName<span class="re2">></span></span></span> |
| <span class="sc3"><span class="re1"><SqlType<span class="re2">></span></span></span>long<span class="sc3"><span class="re1"></SqlType<span class="re2">></span></span></span> |
| <span class="sc3"><span class="re1"></Attribute<span class="re2">></span></span></span> |
| <span class="sc3"><span class="re1"><Attribute</span> <span class="re0">Name</span>=<span class="st0">"BMI"</span> <span class="re0">HashAttribute</span>=<span class="st0">"true"</span> <span class="re0">KeyAttribute</span>=<span class="st0">"false"</span> |
| <span class="re0">Type</span>=<span class="st0">"double"</span><span class="re2">></span></span> |
| <span class="sc3"><span class="re1"><ColumnName<span class="re2">></span></span></span>body_mass_index<span class="sc3"><span class="re1"></ColumnName<span class="re2">></span></span></span> |
| <span class="sc3"><span class="re1"><SqlType<span class="re2">></span></span></span>double<span class="sc3"><span class="re1"></SqlType<span class="re2">></span></span></span> |
| <span class="sc3"><span class="re1"></Attribute<span class="re2">></span></span></span> |
| <span class="sc3"><span class="re1"><Attribute</span> <span class="re0">Name</span>=<span class="st0">"VacationDays"</span> <span class="re0">HashAttribute</span>=<span class="st0">"false"</span> |
| <span class="re0">KeyAttribute</span>=<span class="st0">"false"</span> <span class="re0">Type</span>=<span class="st0">"Long"</span><span class="re2">></span></span> |
| <span class="sc3"><span class="re1"><ColumnName<span class="re2">></span></span></span>vacationdays<span class="sc3"><span class="re1"></ColumnName<span class="re2">></span></span></span> |
| <span class="sc3"><span class="re1"><SqlType<span class="re2">></span></span></span>long<span class="sc3"><span class="re1"></SqlType<span class="re2">></span></span></span> |
| <span class="sc3"><span class="re1"></Attribute<span class="re2">></span></span></span> |
| <span class="sc3"><span class="re1"><Attribute</span> <span class="re0">Name</span>=<span class="st0">"BirthDay"</span> <span class="re0">HashAttribute</span>=<span class="st0">"true"</span> |
| <span class="re0">KeyAttribute</span>=<span class="st0">"true"</span> <span class="re0">Type</span>=<span class="st0">"date"</span><span class="re2">></span></span> |
| <span class="sc3"><span class="re1"><ColumnName<span class="re2">></span></span></span>birthday<span class="sc3"><span class="re1"></ColumnName<span class="re2">></span></span></span> |
| <span class="sc3"><span class="re1"><SqlType<span class="re2">></span></span></span>date<span class="sc3"><span class="re1"></SqlType<span class="re2">></span></span></span> |
| <span class="sc3"><span class="re1"></Attribute<span class="re2">></span></span></span> |
| <span class="sc3"><span class="re1"><Attribute</span> <span class="re0">Name</span>=<span class="st0">"DownSizeCandidate"</span> <span class="re0">HashAttribute</span>=<span class="st0">"false"</span> |
| <span class="re0">KeyAttribute</span>=<span class="st0">"false"</span> <span class="re0">Type</span>=<span class="st0">"Boolean"</span><span class="re2">></span></span> |
| <span class="sc3"><span class="re1"><ColumnName<span class="re2">></span></span></span>scheduled_for_downsizing<span class="sc3"><span class="re1"></ColumnName<span class="re2">></span></span></span> |
| <span class="sc3"><span class="re1"><SqlType<span class="re2">></span></span></span>boolean<span class="sc3"><span class="re1"></SqlType<span class="re2">></span></span></span> |
| <span class="sc3"><span class="re1"></Attribute<span class="re2">></span></span></span> |
| <span class="sc3"><span class="re1"><Attribute</span> <span class="re0">Name</span>=<span class="st0">"DownSizedOn"</span> <span class="re0">HashAttribute</span>=<span class="st0">"false"</span> |
| <span class="re0">KeyAttribute</span>=<span class="st0">"false"</span> <span class="re0">Type</span>=<span class="st0">"Timestamp"</span><span class="re2">></span></span> |
| <span class="sc3"><span class="re1"><ColumnName<span class="re2">></span></span></span>downsized<span class="sc3"><span class="re1"></ColumnName<span class="re2">></span></span></span> |
| <span class="sc3"><span class="re1"><SqlType<span class="re2">></span></span></span>timestamp<span class="sc3"><span class="re1"></SqlType<span class="re2">></span></span></span> |
| <span class="sc3"><span class="re1"></Attribute<span class="re2">></span></span></span> |
| <span class="sc3"><span class="re1"><Attribute</span> <span class="re0">Name</span>=<span class="st0">"Photo"</span> <span class="re0">HashAttribute</span>=<span class="st0">"false"</span> <span class="re0">Attachment</span>=<span class="st0">"true"</span> |
| <span class="re0">KeyAttribute</span>=<span class="st0">"false"</span> <span class="re0">Type</span>=<span class="st0">"Blob"</span><span class="re2">></span></span> |
| <span class="sc3"><span class="re1"><ColumnName<span class="re2">></span></span></span>photo<span class="sc3"><span class="re1"></ColumnName<span class="re2">></span></span></span> |
| <span class="sc3"><span class="re1"><SqlType<span class="re2">></span></span></span>blob<span class="sc3"><span class="re1"></SqlType<span class="re2">></span></span></span> |
| <span class="sc3"><span class="re1"></Attribute<span class="re2">></span></span></span> |
| <span class="sc3"><span class="re1"><Attribute</span> <span class="re0">Name</span>=<span class="st0">"Resume"</span> <span class="re0">HashAttribute</span>=<span class="st0">"false"</span> |
| <span class="re0">KeyAttribute</span>=<span class="st0">"false"</span> <span class="re0">Attachment</span>=<span class="st0">"true"</span> <span class="re0">Type</span>=<span class="st0">"Clob"</span><span class="re2">></span></span> |
| <span class="sc3"><span class="re1"><ColumnName<span class="re2">></span></span></span>cv<span class="sc3"><span class="re1"></ColumnName<span class="re2">></span></span></span> |
| <span class="sc3"><span class="re1"><SqlType<span class="re2">></span></span></span>clob<span class="sc3"><span class="re1"></SqlType<span class="re2">></span></span></span> |
| <span class="sc3"><span class="re1"></Attribute<span class="re2">></span></span></span> |
| <span class="sc3"><span class="re1"></Attributes<span class="re2">></span></span></span> |
| <span class="sc3"><span class="re1"><Process<span class="re2">></span></span></span> |
| <span class="sc3"><span class="re1"><Selections<span class="re2">></span></span></span> |
| <span class="sc3"><span class="re1"><Grouping<span class="re2">></span></span></span> |
| <span class="sc3"><span class="re1"><Stepping<span class="re2">></span></span></span>13<span class="sc3"><span class="re1"></Stepping<span class="re2">></span></span></span> |
| <span class="sc3"><span class="re1"><SQL<span class="re2">></span></span></span>SELECT id FROM person ORDER BY id ASC<span class="sc3"><span class="re1"></SQL<span class="re2">></span></span></span> |
| <span class="sc3"><span class="re1"></Grouping<span class="re2">></span></span></span> |
| <span class="sc3"><span class="re1"><SQL<span class="re2">></span></span></span> |
| SELECT id, vorname, name, body_mass_index, vacationdays, |
| birthday, scheduled_for_downsizing, downsized, photo, cv |
| FROM person where id BETWEEN %01min AND %01max |
| <span class="sc3"><span class="re1"></SQL<span class="re2">></span></span></span> |
| <span class="sc3"><span class="re1"></Selections<span class="re2">></span></span></span> |
| <span class="sc3"><span class="re1"><Database</span> <span class="re0">Connection</span>=<span class="st0">"jdbc:derby:crawlerTestDerbyDB"</span> <span class="re0">User</span>=<span class="st0">""</span> |
| <span class="re0">Password</span>=<span class="st0">""</span> <span class="re0">FetchSize</span>=<span class="st0">"100000"</span> |
| <span class="re0">JdbcDriver</span>=<span class="st0">"org.apache.derby.jdbc.EmbeddedDriver"</span> <span class="re2">/></span></span> |
| <span class="sc3"><span class="re1"></Process<span class="re2">></span></span></span> |
| <span class="sc3"><span class="re1"></DataSourceConnectionConfig<span class="re2">></span></span></span></pre></div> |
| <a name="Output_example"></a><h2> <span class="mw-headline"> Output example </span></h2> |
| <div dir="ltr" style="text-align: left;"><pre class="source-xml"><span class="sc3"><span class="re1"><Record</span> <span class="re0">xmlns</span>=<span class="st0">"http://www.eclipse.org/smila/record"</span> <span class="re0">version</span>=<span class="st0">"2.0"</span><span class="re2">></span></span> |
| <span class="sc3"><span class="re1"><Val</span> <span class="re0">key</span>=<span class="st0">"_recordid"</span><span class="re2">></span></span>jdbc:<span class="sc1">&lt;</span>Birthday=2009-04-02T00:00:00+0100;Person_ID=1<span class="sc1">&gt;</span><span class="sc3"><span class="re1"></Val<span class="re2">></span></span></span> |
| <span class="sc3"><span class="re1"><Val</span> <span class="re0">key</span>=<span class="st0">"_source"</span><span class="re2">></span></span>jdbc<span class="sc3"><span class="re1"></Val<span class="re2">></span></span></span> |
| <span class="sc3"><span class="re1"><Val</span> <span class="re0">key</span>=<span class="st0">"Person_ID"</span> <span class="re0">type</span>=<span class="st0">"long"</span><span class="re2">></span></span>1<span class="sc3"><span class="re1"></Val<span class="re2">></span></span></span> |
| <span class="sc3"><span class="re1"><Val</span> <span class="re0">key</span>=<span class="st0">"BMI"</span> <span class="re0">type</span>=<span class="st0">"long"</span><span class="re2">></span></span>0.5497346110141528<span class="sc3"><span class="re1"></Val<span class="re2">></span></span></span> |
| <span class="sc3"><span class="re1"><Val</span> <span class="re0">key</span>=<span class="st0">"VacationDays"</span> <span class="re0">type</span>=<span class="st0">"long"</span><span class="re2">></span></span>23<span class="sc3"><span class="re1"></Val<span class="re2">></span></span></span> |
| <span class="sc3"><span class="re1"><Val</span> <span class="re0">key</span>=<span class="st0">"BirthDay"</span> <span class="re0">type</span>=<span class="st0">"datetime"</span><span class="re2">></span></span>2009-04-02T00:00:00+0100<span class="sc3"><span class="re1"></Val<span class="re2">></span></span></span> |
| <span class="sc3"><span class="re1"><Val</span> <span class="re0">key</span>=<span class="st0">"DownSizeCandidate"</span> <span class="re0">type</span>=<span class="st0">"long"</span><span class="re2">></span></span>0<span class="sc3"><span class="re1"></Val<span class="re2">></span></span></span> |
| <span class="sc3"><span class="re1"><Val</span> <span class="re0">key</span>=<span class="st0">"DownSizedOn"</span> <span class="re0">type</span>=<span class="st0">"datetime"</span><span class="re2">></span></span>2009-04-02 00:00:00+0100<span class="sc3"><span class="re1"></Val<span class="re2">></span></span></span> |
| <span class="sc3"><span class="re1"><Val</span> <span class="re0">key</span>=<span class="st0">"_HASH_TOKEN"</span><span class="re2">></span></span>69d132fab2fd88cf9ccc17e57f68394ac3fed97ec8bab1c89bf764a6fa662<span class="sc3"><span class="re1"></Val<span class="re2">></span></span></span> |
| <span class="sc3"><span class="re1"><Attachment<span class="re2">></span></span></span>Photo<span class="sc3"><span class="re1"></Attachment<span class="re2">></span></span></span> |
| <span class="sc3"><span class="re1"><Attachment<span class="re2">></span></span></span>Resume<span class="sc3"><span class="re1"></Attachment<span class="re2">></span></span></span> |
| <span class="sc3"><span class="re1"></Record<span class="re2">></span></span></span></pre></div> |
| <a name="Using_the_Grouping_element"></a><h2> <span class="mw-headline"> Using the Grouping element </span></h2> |
| <p>If used, the <b>Grouping</b> element must contain its own <b>SQL</b> element with a SELECT statement and an additional <b>Stepping</b> element containing a non-negative integer value. |
| </p> |
| Use of the <b>Grouping</b> element is best explained by means of an example. Imagine running the retrieval statement <div dir="ltr" style="text-align: left;"><pre class="source-sql"><span class="kw1">SELECT</span> * <span class="kw1">FROM</span> CUSTOMER</pre></div> on your CUSTOMER table and further imagine that you have a very healthy customer base, so your CUSTOMER table contains 750.000 rows. You would invariably come down with OutOfMemoryExceptions during the crawling run, as the JDBC-Resultset does not release the resources for retrieved data rows. After calling <div dir="ltr" style="text-align: left;"><pre class="source-java">resultSet.<span class="me1">next</span><span class="br0">(</span><span class="br0">)</span></pre></div> a few hundred thousand times an OutOfMemoryException is more or less inevitable. |
| <p>Grouping to the rescue! The grouping element enables you to break down your query results into blocks of custom size (specified by the <b>Stepping</b> value) which can be retrieved sequentially while releasing the resultset's resources after each block. You have to be sure to provide a SELECT statement in the <b>SQL</b> element of <b>Grouping</b> which returns a <i><b>sorted</b></i> list of key values by which the results can be grouped. This could be the primary key of the table for instance or any other suitable discriminator. The stepping value is used by the crawler in turn to form groups of the specified size from the keys. |
| </p> |
| If the statement <div dir="ltr" style="text-align: left;"><pre class="source-sql"><span class="kw1">SELECT</span> primaryKey <span class="kw1">FROM</span> CUSTOMER <span class="kw1">ORDER</span> <span class="kw1">BY</span> primaryKey <span class="kw1">ASC</span></pre></div> returned for example the following values: |
| <dl><dd><dl><dd><b>{1, 2, 4, 5, 6, 8, 12, 13, 21, 34, 56, 67}</b> |
| </dd></dl> |
| </dd></dl> |
| <p>a stepping value of <b>5</b> would result in the creation of the following groups: |
| </p> |
| <dl><dd><dl><dd><b>{1, 2, 4, 5, 6}</b> |
| </dd><dd><b>{8, 12, 13, 21, 34}</b> and |
| </dd><dd><b>{56, 67}</b> |
| </dd></dl> |
| </dd></dl> |
| <p>whereas with a stepping value of <b>9</b> the following groups would have been formed: |
| </p> |
| <dl><dd><dl><dd><b>{1, 2, 4, 5, 6, 8, 12, 13, 21}</b> and |
| </dd><dd><b>{34, 56, 67}</b> |
| </dd></dl> |
| </dd></dl> |
| <p>You also have to apply a slight modification to your original retrieval SQL statement (the one directly descending the <b>Selections</b> element) in order for the grouping feature to do its magic: |
| </p> |
| <div dir="ltr" style="text-align: left;"><pre class="source-sql"><span class="kw1">SELECT</span> * <span class="kw1">FROM</span> CUSTOMER <span class="kw1">WHERE</span> primaryKey <span class="kw1">BETWEEN</span> %min01 <span class="kw1">AND</span> %max01</pre></div> |
| <p>The crawler will replace the <b>%min01</b> and <b>%max01</b> tokens with the respective minimum and maximum values of each of the formed groups thus creating the following three SQL statements for data retrieval (assuming a stepping value of <b>5</b> was used: |
| </p> |
| <div dir="ltr" style="text-align: left;"><pre class="source-sql"><span class="kw1">SELECT</span> * <span class="kw1">FROM</span> CUSTOMER <span class="kw1">WHERE</span> primaryKey <span class="kw1">BETWEEN</span> <span class="nu0">1</span> <span class="kw1">AND</span> <span class="nu0">6</span></pre></div> |
| <div dir="ltr" style="text-align: left;"><pre class="source-sql"><span class="kw1">SELECT</span> * <span class="kw1">FROM</span> CUSTOMER <span class="kw1">WHERE</span> primaryKey <span class="kw1">BETWEEN</span> <span class="nu0">8</span> <span class="kw1">AND</span> <span class="nu0">34</span></pre></div> |
| <div dir="ltr" style="text-align: left;"><pre class="source-sql"><span class="kw1">SELECT</span> * <span class="kw1">FROM</span> CUSTOMER <span class="kw1">WHERE</span> primaryKey <span class="kw1">BETWEEN</span> <span class="nu0">56</span> <span class="kw1">AND</span> <span class="nu0">67</span></pre></div> |
| <p>which will subsequently be submitted sequentially to the database. |
| </p> |
| <!-- |
| NewPP limit report |
| Preprocessor node count: 102/1000000 |
| Post-expand include size: 1047/2097152 bytes |
| Template argument size: 515/2097152 bytes |
| #ifexist count: 0/100 |
| --> |
| |
| <!-- Saved in parser cache with key wikidb:pcache:idhash:16918-0!1!0!!en!2!edit=0 and timestamp 20130416061010 --> |
| <div class="printfooter"> |
| Retrieved from "<a href="JDBC_Crawler.html">http://wiki.eclipse.org/SMILA/Documentation/JDBC_Crawler</a>"</div> |
| <!-- end content --> |
| <div class="visualClear"></div> |
| </div> |
| </div> |
| |
| |
| </div> |
| |
| |
| <!-- Yoink of toolbox for phoenix moved up --> |
| |
| |
| </div> |
| </div> |
| <div id="clearFooter"/> |
| <div id="footer" > |
| <ul id="footernav"> |
| <li class="first"><a href="http://www.eclipse.org/">Home</a></li> |
| <li><a href="http://www.eclipse.org/legal/privacy.php">Privacy Policy</a></li> |
| <li><a href="http://www.eclipse.org/legal/termsofuse.php">Terms of Use</a></li> |
| <li><a href="http://www.eclipse.org/legal/copyright.php">Copyright Agent</a></li> |
| <li><a href="http://www.eclipse.org/org/foundation/contact.php">Contact</a></li> |
| <li><a href="http://wiki.eclipse.org/Eclipsepedia:About" title="Eclipsepedia:About">About Eclipsepedia</a></li> |
| </ul> |
| <span id="copyright">Copyright © 2013 The Eclipse Foundation. All Rights Reserved</span> |
| <p id="footercredit">This page was last modified 09:41, 24 January 2012 by <a href="http://wiki.eclipse.org/index.php?title=User:Juergen.schumacher.attensity.com&action=edit" class="new" title="User:Juergen.schumacher.attensity.com">Juergen Schumacher</a>. Based on work by <a href="http://wiki.eclipse.org/User:Drazen.cindric.attensity.com" title="User:Drazen.cindric.attensity.com">Drazen Cindric</a>, <a href="http://wiki.eclipse.org/User:Andreas.Weber.empolis.com" title="User:Andreas.Weber.empolis.com">Andreas Weber</a> and <a href="http://wiki.eclipse.org/User:Igor.novakovic.empolis.com" title="User:Igor.novakovic.empolis.com">Igor Novakovic</a> and <a href="http://wiki.eclipse.org/index.php?title=SMILA/Documentation/JDBC_Crawler&action=credits" title="SMILA/Documentation/JDBC Crawler">others</a>.</p> |
| <p id="footerviews">This page has been accessed 7,560 times.</p> |
| </div> |
| |
| <script type="text/javascript"> |
| var gaJsHost = (("https:" == document.location.protocol) ? "https://ssl." : "http://www."); |
| document.write(unescape("%3Cscript src='" + gaJsHost + "google-analytics.com/ga.js' type='text/javascript'%3E%3C/script%3E")); |
| </script> |
| <script type="text/javascript"> |
| var pageTracker = _gat._getTracker("UA-910670-4"); |
| pageTracker._trackPageview(); |
| </script> |
| |
| |
| |
| |
| |
| |
| |
| <!-- <div class="visualClear"></div> --> |
| |
| <script type="text/javascript">if (window.runOnloadHook) runOnloadHook();</script> |
| </div> |
| |
| <!-- Served in 0.051 secs. --></body></html> |
