Skip to content

Commit 04083e4

Browse files
committed
docs: add README.md for java module
1 parent bcb040e commit 04083e4

File tree

1 file changed

+55
-0
lines changed

1 file changed

+55
-0
lines changed

java/README.md

+55
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
# Java bindings and SDK for Lance Data Format
2+
3+
> :warning: **Under heavy development**
4+
5+
<div align="center">
6+
<p align="center">
7+
8+
<img width="257" alt="Lance Logo" src="https://user-images.githubusercontent.com/917119/199353423-d3e202f7-0269-411d-8ff2-e747e419e492.png">
9+
10+
Lance is a new columnar data format for data science and machine learning
11+
</p></div>
12+
13+
Why you should use Lance
14+
1. Is order of magnitude faster than parquet for point queries and nested data structures common to DS/ML
15+
2. Comes with a fast vector index that delivers sub-millisecond nearest neighbors search performance
16+
3. Is automatically versioned and supports lineage and time-travel for full reproducibility
17+
4. Integrated with duckdb/pandas/polars already. Easily convert from/to parquet in 2 lines of code
18+
19+
## Quick start
20+
21+
Introduce the Lance SDK for Java Maven dependency(It is recommended to choose the latest version.):
22+
23+
```shell
24+
<dependency>
25+
<groupId>com.lancedb</groupId>
26+
<artifactId>lance-core</artifactId>
27+
<version>0.18.0</version>
28+
</dependency>
29+
```
30+
31+
### Basic I/Os
32+
33+
* create and write a Lance dataset
34+
* read dataset
35+
* drop dataset
36+
37+
### Random Access
38+
39+
### Indexing and Searching
40+
41+
### Schema evolution
42+
43+
* add columns
44+
45+
* alter columns
46+
47+
* drop columns
48+
49+
## Integrations
50+
51+
### Spark connector
52+
53+
## Contributing
54+
55+
### Environment(IDE) setup

0 commit comments

Comments
 (0)