|
346.1.3
by Nathan Williams
Simple readme file |
1 |
************************************
|
2 |
Akiban Persistit
|
|
3 |
************************************
|
|
4 |
||
5 |
Overview
|
|
6 |
========
|
|
7 |
We have worked hard to make Akiban Persistit™ exceptionally fast, reliable, simple and lightweight. We hope you will enjoy learning more about it and using it. |
|
8 |
||
9 |
Akiban Persistit is a key/value data storage library written in Java™. Key features include: |
|
10 |
||
11 |
- Support for highly concurrent transaction processing with multi-version concurrency control
|
|
12 |
- Optimized serialization and deserialization mechanism for Java primitives and objects
|
|
13 |
- Multi-segment (compound) keys to enable a natural logical key hierarchy
|
|
14 |
- Support for long records (megabytes)
|
|
15 |
- Implementation of a persistent SortedMap
|
|
16 |
- Extensive management capability including command-line and GUI tools
|
|
17 |
||
|
427.1.1
by Nathan Williams
Release 3.2.7 |
18 |
See http://akiban.github.com/persistit/ for more information, documentation, and support details. |
|
346.1.3
by Nathan Williams
Simple readme file |
19 |
|
20 |
Documentation
|
|
21 |
=============
|
|
|
427.1.1
by Nathan Williams
Release 3.2.7 |
22 |
Users Guide: http://akiban.github.com/persistit/docs/ |
|
346.1.3
by Nathan Williams
Simple readme file |
23 |
|
|
427.1.1
by Nathan Williams
Release 3.2.7 |
24 |
JavaDoc: http://akiban.github.com/persistit/javadoc/ |
|
346.1.3
by Nathan Williams
Simple readme file |
25 |
|
26 |
Building Akiban Persistit From Source
|
|
27 |
=====================================
|
|
28 |
Use Maven (http://maven.apache.org) to build Persistit. |
|
29 |
||
30 |
To build::
|
|
31 |
||
32 |
mvn install
|
|
33 |
||
34 |
The resulting jar files are in the ``target`` directory. To build the Javadoc:: |
|
35 |
||
36 |
mvn javadoc:javadoc
|
|
37 |
||
38 |
The resulting Javadoc HTML files are in ``target/site/apidocs``.
|
|
39 |
||
40 |
Building and Running the Examples
|
|
41 |
---------------------------------
|
|
42 |
||
|
347.1.1
by Nathan Williams
Release 3.1.4 |
43 |
Small examples are located in the ``examples`` directory. Each has a short README file describing the example, and an Ant build script (http://ant.apache.org). After building the main akiban-persistit jar file using Maven, you may run:: |
|
346.1.3
by Nathan Williams
Simple readme file |
44 |
|
45 |
ant run
|
|
46 |
||
47 |
in each of the examples subdirectories to build and run the examples. |
|
48 |
||
49 |
||
50 |
Download and Install Akiban Persistit From Binaries
|
|
51 |
---------------------------------------------------
|
|
52 |
||
|
427.1.1
by Nathan Williams
Release 3.2.7 |
53 |
Pre-built jars can be downloaded directly from http://akiban.github.com/persistit/. |
|
346.1.3
by Nathan Williams
Simple readme file |
54 |
|
55 |
Unpack the distribution kit into a convenient directory using the appropriate utility (e.g. unzip or tar). |
|
56 |
||
|
374.3.55
by Peter Beaman
Change EPL -> Apache License 2.0 |
57 |
Review the ``LICENSE.txt`` file located in the root of the installation directory. This version of Persistit is licensed under the Apache License, Version 2.0. By installing, copying or otherwise using the Software contained in the distribution kit, you agree to be bound by the terms of the license agreement. If you do not agree to these terms, remove and destroy all copies of the software in your possession immediately.
|
|
346.1.3
by Nathan Williams
Simple readme file |
58 |
|
59 |
Working With Persistit
|
|
60 |
----------------------
|
|
61 |
||
|
432.1.2
by Peter Beaman
3.3.0 -> 3.3.1 |
62 |
Add the jar file (e.g. ``akiban-persistit-3.3.1.jar``), found in the root directory of the distribution kit, to your project's classpath. For example, copy it to ``jre/lib/ext`` in your Java Runtime Environment, or add it to your classpath environment variable. |
|
346.1.3
by Nathan Williams
Simple readme file |
63 |
|
64 |
That's it. You are ready to work with Persistit. |