| 1 |
LMDB_File version 0.13 |
| 2 |
====================== |
| 3 |
|
| 4 |
LMDB_File is a Perl wrapper around the OpenLDAP's LMDB (Lightning |
| 5 |
Memory-Mapped Database) C library. |
| 6 |
|
| 7 |
LMDB is an ultra-fast, ultra-compact key-value data store developed |
| 8 |
by Symas for the OpenLDAP Project. See http://symas.com/mdb/ for details. |
| 9 |
|
| 10 |
LMDB_File provides full access to the complete C API, a thin Perl wrapper |
| 11 |
with an Object-Oriented interface and a simple Perl's tie interface |
| 12 |
compatible with others DBMs. |
| 13 |
|
| 14 |
PREREQUISITES |
| 15 |
|
| 16 |
Right now LMDB needs a 64bits platform. |
| 17 |
|
| 18 |
Before you can build LMDB_File you need to have the following installed |
| 19 |
on your system: |
| 20 |
|
| 21 |
* Perl 5.10.0 up to 5.38 linked with pthreads. |
| 22 |
See https://rt.perl.org/Public/Bug/Display.html?id=122906 |
| 23 |
|
| 24 |
* A working C compiler. |
| 25 |
|
| 26 |
* LMDB Version 0.9.17 or greater |
| 27 |
(previous versions may work but will miss some features) |
| 28 |
|
| 29 |
Some Linux distributions are now including it: |
| 30 |
|
| 31 |
* Fedora 20+ |
| 32 |
|
| 33 |
`yum install lmdb-devel` |
| 34 |
|
| 35 |
* Ubuntu |
| 36 |
|
| 37 |
`apt-get install liblmdb-dev` |
| 38 |
|
| 39 |
If the library and its header file isn't found installed in |
| 40 |
your system, Makefile.PL will try to use Doug Hoyte's Alien::LMDB module |
| 41 |
if available. |
| 42 |
|
| 43 |
Otherwise, if you getting this from GitHub, a submodule is included |
| 44 |
in 'liblmdb' that you can use, please check git documentation to |
| 45 |
populate the directory. |
| 46 |
|
| 47 |
* To run the test harness for this module: |
| 48 |
- You must make sure that the directory where you have untarred this |
| 49 |
module is NOT a network drive, e.g. NFS or AFS. |
| 50 |
- You need the Test::Exception module installed. |
| 51 |
|
| 52 |
INSTALLATION |
| 53 |
|
| 54 |
To install this module type the following: |
| 55 |
|
| 56 |
perl Makefile.PL |
| 57 |
make |
| 58 |
make test |
| 59 |
make install |
| 60 |
|
| 61 |
*** WARNING *** |
| 62 |
This is an early release to allow the interested people the testing and |
| 63 |
discussion of the module: there is some missing features and you should |
| 64 |
be aware that the API isn't in stone yet. See TODO |
| 65 |
|
| 66 |
|
| 67 |
COPYRIGHT AND LICENCE |
| 68 |
|
| 69 |
Copyright (C) 2013-2023 by Salvador Ortiz Garcia |
| 70 |
|
| 71 |
This library is free software; you can redistribute it and/or modify |
| 72 |
it under the terms of the Artistic License version 2.0. |
| 73 |
|