Skip to content

Commit

Permalink
release 1.18.1
Browse files Browse the repository at this point in the history
  • Loading branch information
@halibobo1205
halibobo1205 committed Sep 13, 2022
1 parent a3066ac commit 6812202
Show file tree
Hide file tree
Showing 45 changed files with 245 additions and 4,281 deletions.
374 changes: 33 additions & 341 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -1,355 +1,47 @@
# LevelDB JNI
#NOTE
this repo is fork from [leveldbjni](https://github.com/fusesource/leveldbjni)

## Description
#Build
```shell
wget https://src.fedoraproject.org/lookaside/pkgs/snappy/snappy-1.0.5.tar.gz/4c0af044e654f5983f4acbf00d1ac236/snappy-1.0.5.tar.gz

LevelDB JNI gives you a Java interface to the
[LevelDB](https://github.com/google/leveldb) C++ library
which is a fast key-value storage library written at Google
that provides an ordered mapping from string keys to string values.
tar -zxvf snappy-1.0.5.tar.gz

git clone git@github.com:chirino/leveldb.git
git clone git@github.com:fusesource/leveldbjni.git

## Declaration

This LevelDB JNI is based on [leveldb-1.23](https://github.com/halibobor/leveldb/tree/leveldbjni/v1.23) and [snappy-1.1.9](https://github.com/halibobor/snappy/tree/leveldbjni/v1.1.9) .
export SNAPPY_HOME=`cd snappy-1.0.5; pwd`
export LEVELDB_HOME=`cd leveldb; pwd`
export LEVELDBJNI_HOME=`cd leveldbjni; pwd`

Maybe you need this [LevelDB JNI](https://github.com/fusesource/leveldbjni) ?
cd ${SNAPPY_HOME}
./configure --disable-shared --with-pic
make

### Strong Attention

> NOTE: If you are using [org.fusesource.leveldbjni/leveldbjni-all/1.8](https://mvnrepository.com/artifact/org.fusesource.leveldbjni/leveldbjni-all/1.8)
> Here's what you need to know this jni:
> * ``suspendCompactions`` and ``resumeCompactions`` are no longer supported.
> * 1.23.1 +, iterator.prev() changed, see [change](https://github.com/halibobor/leveldbjni-all/commit/ca2b1b2575ce11b0c98c66a74520da56ad7a1eb1)
## Getting the JAR

Just add the following jar to your java project:
[leveldbjni-all-1.23.1.jar](https://repo1.maven.org/maven2/com/halibobor/leveldbjni-all/1.23.1/leveldbjni-all-1.23.1.jar)

## Using the Dependency

### gradle

```gradle
dependencies {
implementation 'com.halibobor:leveldbjni-all:1.23.1'
}
```

### maven

```maven
<dependency>
<groupId>com.halibobor</groupId>
<artifactId>leveldbjni-all</artifactId>
<version>1.23.1</version>
</dependency>
```


## API Usage:

Recommended Package imports:

```java
import org.iq80.leveldb.*;
import static org.fusesource.leveldbjni.JniDBFactory.*;
import java.io.*;
```

Opening and closing the database.

```java
Options options = new Options();
options.createIfMissing(true);
DB db = factory.open(new File("example"), options);
try {
// Use the db in here....
} finally {
// Make sure you close the db to shutdown the
// database and avoid resource leaks.
db.close();
}
```
Putting, Getting, and Deleting key/values.

```java
db.put(bytes("Tampa"), bytes("rocks"));
String value = asString(db.get(bytes("Tampa")));
db.delete(bytes("Tampa"));
```

Performing Batch/Bulk/Atomic Updates.

```java
WriteBatch batch = db.createWriteBatch();
try {
batch.delete(bytes("Denver"));
batch.put(bytes("Tampa"), bytes("green"));
batch.put(bytes("London"), bytes("red"));

db.write(batch);
} finally {
// Make sure you close the batch to avoid resource leaks.
batch.close();
}
```

Iterating key/values.

```java
DBIterator iterator = db.iterator();
try {
for(iterator.seekToFirst(); iterator.Valid(); iterator.next()) {
String key = asString(iterator.key());
String value = asString(iterator.value());
System.out.println(key+" = "+value);
}
} finally {
// Make sure you close the iterator to avoid resource leaks.
iterator.close();
}
try {
for(iterator.seekToLast(); iterator.Valid(); iterator.prev()) {
String key = asString(iterator.key());
String value = asString(iterator.value());
System.out.println(key+" = "+value);
}
} finally {
// Make sure you close the iterator to avoid resource leaks.
iterator.close();
}
```

Working against a Snapshot view of the Database.

```java
ReadOptions ro = new ReadOptions();
ro.snapshot(db.getSnapshot());
try {

// All read operations will now use the same
// consistent view of the data.
... = db.iterator(ro);
... = db.get(bytes("Tampa"), ro);

} finally {
// Make sure you close the snapshot to avoid resource leaks.
ro.snapshot().close();
}
```

Using a custom Comparator.

```java
DBComparator comparator = new DBComparator(){
public int compare(byte[] key1, byte[] key2) {
return new String(key1).compareTo(new String(key2));
}
public String name() {
return "simple";
}
public byte[] findShortestSeparator(byte[] start, byte[] limit) {
return start;
}
public byte[] findShortSuccessor(byte[] key) {
return key;
}
};
Options options = new Options();
options.comparator(comparator);
DB db = factory.open(new File("example"), options);
```
Disabling Compression.

```java
Options options = new Options();
options.compressionType(CompressionType.NONE);
DB db = factory.open(new File("example"), options);
```

Configuring the Cache.

```java
Options options = new Options();
options.cacheSize(100 * 1048576); // 100MB cache
DB db = factory.open(new File("example"), options);
```

Configuring the BloomFilter.

```java
Options options = new Options();
options.bitsPerKey(10);
DB db = factory.open(new File("example"), options);
cd ${LEVELDB_HOME}
export LIBRARY_PATH=${SNAPPY_HOME}
export C_INCLUDE_PATH=${LIBRARY_PATH}
export CPLUS_INCLUDE_PATH=${LIBRARY_PATH}
git apply ../leveldbjni/leveldb.patch
make libleveldb.a
```

Getting approximate sizes.

```java
long[] sizes = db.getApproximateSizes(new Range(bytes("a"), bytes("k")), new Range(bytes("k"), bytes("z")));
System.out.println("Size: "+sizes[0]+", "+sizes[1]);
```
Getting database status.

```java
String stats = db.getProperty("leveldb.stats");
System.out.println(stats);
```

Getting database approximate-memory-usage.

```java
String approximate = db.getProperty("leveldb.approximate-memory-usage");
System.out.println(approximate);
```


Getting informational log messages.

```java
Logger logger = new Logger() {
public void log(String message) {
System.out.println(message);
}
};
Options options = new Options();
options.logger(logger);
DB db = factory.open(new File("example"), options);
```

Destroying a database.

```java
Options options = new Options();
factory.destroy(new File("example"), options);
```

Repairing a database.

```java
Options options = new Options();
factory.repair(new File("example"), options);
```

Using a memory pool to make native memory allocations more efficient:

```java
JniDBFactory.pushMemoryPool(1024 * 512);
try {
// .. work with the DB in here,
} finally {
JniDBFactory.popMemoryPool();
}
```

## Building
> The following Steps work on mac, linux well, other platforms are not verified yet.
>
> Welcome to contribute to other platforms.
### Supported Platforms

The following worked for me on:

* OS X Mojave with X Code 11 (x86_64)
* OS X Monterey with X Code 13 (aarch64)
* CentOS (x86_64 | i386 | aarch64)

### Prerequisites
* GNU compiler toolchain,gcc-c++
* openssl, openssl-devel(cmake required)
* JAVA(1.8+)，make sure the current session $JAVA_HOME is set.
* [cmake3.1+](https://cmake.org/download/)
* git
* maven3
* automake
* [autoconf](https://github.com/asdf-vm/asdf-erlang/issues/195#issuecomment-815999279)
* pkg-configls,build-essential,libtool (linux maybe required)


### Build Procedure
Then download the snappy, leveldb, leveldbjni,leveldbjni-all project source code.
```shell script
git clone https://github.com/halibobor/leveldbjni-all.git
cd leveldbjni-all
git submodule update --init --recursive
cd third_party
```

#### 1. snappy
#Special for M1
```shell script
cd snappy
mkdir build && cd build
cmake -DCMAKE_BUILD_TYPE=Release ../
make && make DESTDIR=/tmp install
cd ../../
brew install maven
set $JAVA_HOME
update pom.xml
1. 1.5 -> 1.8
2. add java_home, remove with-universal
<arg>--with-jni-jdk=${env.JAVA_HOME}</arg>
<arg>--with-leveldb=${env.LEVELDB_HOME}</arg>
<arg>--with-snappy=${env.SNAPPY_HOME}</arg>
<!--<arg>--with-universal</arg>-->
```

#### 2. leveldb
```shell script
cd leveldb
export LIBRARY_PATH=/tmp/usr/local/lib
# export LIBRARY_PATH=/tmp/usr/local/lib64
export CPLUS_INCLUDE_PATH=/tmp/usr/local/include
mkdir build && cd build
cmake -DCMAKE_BUILD_TYPE=Release .. && cmake --build .
./db_test
./db_bench
make DESTDIR=/tmp install
cd ../../
```

#### 3. leveldbjni
```shell script
cd leveldbjni
export SNAPPY_HOME=/tmp/usr/local
export LEVELDB_HOME=/tmp/usr/local
mvn clean package -P ${platform}
```
Replace ${platform} with one of the following platform identifiers (depending on the platform your building on):

* osx
* linux32
* linux64
* linux64-aarch64
* linux64-ppc64le
* linux64-sunos64-amd64
* linux64-sunos64-sparcv9
* win32
* win64
* freebsd64

##### Build Results

* `leveldbjni-${platform}/target/native-build/target/lib/leveldbjni-${version}.[jnilib|so|dll]` : native library using your currently platform.
* `leveldbjni/target/leveldbjni-${version}-native-src.zip` : A GNU style source project which you can use to build the native library on other systems.
* `leveldbjni-${platform}/target/leveldbjni-${platform}-${version}.jar` : A jar file containing the built native library using your currently platform.


#### 4. leveldbjni-all
```shell script
git clone https://github.com/halibobor/leveldbjni-all.git
cd leveldbjni-all
cd src/main/resources/META-INF/
# mkdir for native library
mkdir -p ${os}${bit-model}/${arch}
# cp native library to ${os}${bit-model}/${arch}
cp ${native_library_path}/leveldbjni-1.23.jnilib ${os}${bit-model}/${arch}
# update pom.xml
# add new config to Bundle-NativeCode
# such as META-INF/native/osx64/aarch64/libleveldbjni.jnilib;osname=macosx;processor=aarch64
mvn clean install
#Build jni
```shell
mvn clean install -P download -P osx
```

> ${os},${bit-model},${arch} values, such as osx,64,x86_64.
>
> ${platform}=${os}${bit-model},such as osx64.
>
> Please refer to [Library.java](https://github.com/fusesource/hawtjni/blob/master/hawtjni-runtime/src/main/java/org/fusesource/hawtjni/runtime/Library.java) to get more.

### Build Results

* `leveldbjni/target/leveldbjni-all-${version}.jar` : The java class file to the library.
Loading

0 comments on commit 6812202

Please sign in to comment.