Skip to content

Commit

Permalink
net-sf-ucanaccess-fork: Migrate documentation to Maven site
Browse files Browse the repository at this point in the history
  • Loading branch information
@spannm
spannm committed Jan 24, 2024
1 parent 4453dd3 commit e4c71ef
Show file tree
Hide file tree
Showing 472 changed files with 95,733 additions and 2,083 deletions.
250 changes: 250 additions & 0 deletions docs/10-index.html
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,250 @@
<!DOCTYPE html>


<!--
| Generated by Apache Maven Doxia Site Renderer 2.0.0-M16 from src/site/xhtml/10-index.xhtml at 2024-01-24
| Rendered using Apache Maven Fluido Skin 2.0.0-M8
-->
<html xmlns="http://www.w3.org/1999/xhtml" lang="en">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1" />
<meta name="generator" content="Apache Maven Doxia Site Renderer 2.0.0-M16" />
<title>UCanAccess – UCanAccess</title>
<link rel="stylesheet" href="./css/apache-maven-fluido-2.0.0-M8.min.css" />
<link rel="stylesheet" href="./css/site.css" />
<link rel="stylesheet" href="./css/print.css" media="print" />
<script src="./js/apache-maven-fluido-2.0.0-M8.min.js"></script>
<meta http-equiv="Content-Type" content="text/html; charset=UTF8" /><meta name="keywords" content="Access, jdbc, driver, Java, mdb, accdb, ms, linux, Unix, mac, pure" /> </head>
<body>
<div class="container-fluid container-fluid-top">
<header>
<div id="banner">
<div class="pull-left"><div id="bannerLeft"><h1>UCanAccess</h1></div></div>
<div class="pull-right"></div>
<div class="clear"><hr/></div>
</div>

<div id="breadcrumbs">
<ul class="breadcrumb">
<li id="publishDate">Last Published: 2024-01-24</li>
<li id="projectVersion" class="pull-right">Version: 5.1.1-SNAPSHOT</li>
<li class="pull-right"><span class="divider">|</span>
<a href="https://ucanaccess.sourceforge.net/" class="externalLink">SourceForge</a></li>
<li class="pull-right"><span class="divider">|</span>
<a href="https://central.sonatype.com/artifact/io.github.spannm/ucanaccess" class="externalLink">Maven Central</a></li>
<li class="pull-right"><span class="divider">|</span>
<a href="wiki">GitHub Wiki</a></li>
<li class="pull-right"><a href="./">GitHub Repository</a></li>
</ul>
</div>
</header>
<div class="row-fluid">
<header id="leftColumn" class="span2">
<nav class="well sidebar-nav">
<ul class="nav nav-list">
<li class="nav-header">Overview</li>
<li class="active"><a>UCanAccess</a></li>
<li><a href="20-getting-started.html">Getting Started</a></li>
<li><a href="30-jdbc-client-tools.html">JDBC Client Tools</a></li>
<li><a href="40-change-log.html">Change Log</a></li>
<li><a href="50-links-licensing.html">Links/Licensing</a></li>
<li><a href="60-about.html">About</a></li>
<li class="nav-header">Project Documentation</li>
<li><a href="project-info.html"><span class="icon-chevron-right"></span>Project Information</a></li>
<li><a href="project-reports.html"><span class="icon-chevron-right"></span>Project Reports</a></li>
</ul>
</nav>
<div class="well sidebar-nav">
<div id="poweredBy">
<div class="clear"></div>
<div class="clear"></div>
<div class="clear"></div>
<a href="https://maven.apache.org/" class="builtBy" target="_blank"><img class="builtBy" alt="Built by Maven" src="./images/logos/maven-feather.png" /></a>
</div>
</div>
</header>
<main id="bodyColumn" class="span10">



<section><section><section>
<h3>UCanAccess</h3>


<p>This is the home page of UCanAccess, an open-source Java JDBC driver implementation that allows Java
developers and JDBC client programs (e.g., DBeaver, NetBeans, SQLeo, OpenOffice Base, LibreOffice Base,
Squirrel SQL) to read/write Microsoft Access databases.
</p>

<p>
Because it is a pure Java implementation it runs on both Windows and non-Windows operating systems (e.g.,
Linux/Unix). <b>No ODBC needed</b>. UCanAccess uses:
</p>

<ul>

<li>Jackcess as MS Access input/output library (Web site: <a href="http://jackcess.sourceforge.net/" class="externalLink">http://jackcess.sourceforge.net/</a>)</li>

<li>HSQLDB (aka HyperSQL) as synchronized DBMS (Web site: <a href="http://hsqldb.org/" class="externalLink">http://hsqldb.org/</a>)</li>
</ul>
</section><section>
<h3>Features</h3>

<ul>

<li>Supported Access formats: 2000, 2002/2003, 2007, 2010/2013/2016 databases. (Access 97 format supported for <b>read-only</b>)</li>

<li>SELECT, INSERT, UPDATE, DELETE statements. Transactions and savepoints.</li>

<li>Access data types: YESNO, BYTE, INTEGER, LONG, SINGLE, DOUBLE, NUMERIC, CURRENCY, COUNTER,
TEXT, OLE, MEMO, GUID, DATETIME.
</li>

<li>Concurrent access from multiple application server threads.</li>

<li>Connection pooling.</li>

<li>ANSI 92 SQL, core SQL-2008.</li>

<li>Access SQL.</li>

<li>Core built-in functions for Access SQL are supported (e.g., <code>Date()</code>,
<code>Now()</code>, <code>IIf()</code>, ...).
</li>

<li>You can execute Select queries defined and saved in Access. Since version 1.0.1, UCanAccess can
execute Crosstab queries (<code>TRANSFORM ... PIVOT ...</code>)
</li>

<li>LIKE operator accepts both standard <code>%</code> and Access-specific <code>*</code> as multi-character wildcards, both standard <code>_</code>
and Access-specific <code>?</code> as single-character wildcards, <code>#</code> for single digit and <code>[xxx][!xxx]</code> for character
intervals (Access).
</li>

<li>Both <code>&amp;</code> and <code>+</code> (Access SQL) as well
as <code>||</code> (ANSI SQL) for string concatenation.
</li>

<li>Square brackets for field names, table names and view names (saved Access queries) that include
spaces or other special characters, e.g., <code>SELECT [my column] FROM [my
table]</code>.
</li>

<li>Access date format (e.g., <code>#11/22/2003 10:42:58 PM#</code>).</li>

<li>Both double quote <code>&quot;</code> and single quote <code>'</code>
as SQL string delimiters.
</li>

<li>Read and write support to complex types (i.e., array of Version, Attachment, SingleValue).</li>

<li>Since version 2.0.1, UCanAccess supports both constants and functions as default column values in
<code>CREATE TABLE</code> statements e.g. <code>CREATE TABLE tbl (fld1 TEXT PRIMARY
KEY, fld2 LONG DEFAULT 3 NOT NULL, fld3 TEXT(255) NOT NULL, fld4 DATETIME DEFAULT Now(), fld5 TEXT
DEFAULT 'bla')</code>
</li>

<li>Command-line console (&quot;console.bat&quot; and &quot;console.sh&quot;). You can run SQL commands and display their
results. CSV export command included.
</li>
</ul>
</section><section>
<h3>Limitations</h3>

<ul>

<li>Access
<a href="https://support.office.com/en-us/article/Create-a-data-macro-b1b94bca-4f17-47ad-a66d-f296ef834200" class="externalLink">data macros</a>
are not supported. UCanAccess can update tables for which event-driven data macros are defined, but the macros
themselves are ignored.
</li>

<li>
In versions prior to UCanAccess 4.0.0, only basic DDL was supported (<code>CREATE TABLE</code>
with Primary Key, <code>DROP TABLE</code>).<br />
Since version 4.0.0 UCanAccess can now support DDL for <b>Table metadata modification</b>:

<ul>

<li>Columns, Primary Keys and other Indexes can now be added to an <b>existing</b> table.</li>

<li>UCanAccess 4.x.x has also the ability to create Foreign Keys and to rename Tables.</li>
</ul>
</li>

<li>Very limited multiprocess access support (details
<a href="http://ucanaccess.blogspot.ca/2017/07/multiuser-concurrent-write-access.html" class="externalLink">here</a>).
Nevertheless, it tries to synchronize data when a concurrent process modifies the Access database file.
</li>
</ul>
</section><section>
<h3>Requirements</h3>

<p>
<b>From version 5.1.0 UCanAccess requires Java 11 or later to run.</b><br />
From version 5.0.0 Java 8 or later is required, while older versions require at least Java 6.
</p>

<p>
When dealing with large databases and using the default &quot;memory&quot; setting (i.e., with driver property <code>memory=true</code>), it is recommended that users allocate sufficient memory to the JVM
using the <code>-Xms</code> and <code>-Xmx</code> options. <b><br />
Otherwise it will be necessary to set the driver's &quot;memory&quot; property to &quot;false&quot;:</b><br />
<br /> <code>Connection conn = DriverManager.getConnection(&quot;jdbc:ucanaccess://c:/data/myaccessdb.mdb;memory=false&quot;);</code><br />
</p>
</section><section>
<h3>Dependencies</h3>

<p>
UCanAccess depends on Jackcess and HSQLDB. If you are using
<a href="https://maven.apache.org" class="externalLink">Apache Maven</a> to manage your dependencies (recommended)
simply add the following to your pom.xml:<br />
</p>

<div class="verbatim">
<pre>
&lt;dependency&gt;
&lt;groupId&gt;io.github.spannm&lt;/groupId&gt;
&lt;artifactId&gt;ucanaccess&lt;/artifactId&gt;
&lt;version&gt;5.1.0&lt;/version&gt;
&lt;/dependency&gt;</pre></div>

<p>
Maven will add the other dependencies for you. If you are manually managing your classpath,
you will need to add the <code>ucanaccess-5.1.0.jar</code> file along with its dependencies to your classpath.
</p>

<p>
In order to open encrypted files you must use UCanAccess 2.x.x or later with jackcess-encrypt-2.x.x and
all related dependencies. Again, if you are using Maven, simply add this extra dependency:
</p>

<div class="verbatim">
<pre>
&lt;dependency&gt;
&lt;groupId&gt;com.healthmarketscience.jackcess&lt;/groupId&gt;
&lt;artifactId&gt;jackcess-encrypt&lt;/artifactId&gt;
&lt;version&gt;4.0.2&lt;/version&gt;
&lt;/dependency&gt;</pre></div>
</section></section></section>

</main>
</div>
</div>
<hr/>
<footer>
<div class="container-fluid">
<div class="row-fluid">
<p>© 2012–2024
<a href="https://github.com/spannm/ucanaccess">UCanAccess</a>
</p>
</div>
</div>
</footer>
<script>
if(anchors) {
anchors.add();
}
</script>
</body>
</html>
Loading

0 comments on commit e4c71ef

Please sign in to comment.