-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
duyalei
committed
Mar 31, 2023
1 parent
6f7d13b
commit 36c0fb7
Showing
4 changed files
with
32 additions
and
71 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,84 +1,45 @@ | ||
<!-- | ||
- Licensed to the Apache Software Foundation (ASF) under one | ||
- or more contributor license agreements. See the NOTICE file | ||
- distributed with this work for additional information | ||
- regarding copyright ownership. The ASF licenses this file | ||
- to you under the Apache License, Version 2.0 (the | ||
- "License"); you may not use this file except in compliance | ||
- with the License. You may obtain a copy of the License at | ||
- | ||
- http://www.apache.org/licenses/LICENSE-2.0 | ||
- | ||
- Unless required by applicable law or agreed to in writing, | ||
- software distributed under the License is distributed on an | ||
- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | ||
- KIND, either express or implied. See the License for the | ||
- specific language governing permissions and limitations | ||
- under the License. | ||
--> | ||
# GeoLake | ||
|
||
![Iceberg](https://iceberg.apache.org/docs/latest/img/Iceberg-logo.png) | ||
**GeoLake** aims at bringing geospatial support to lakehouses. | ||
|
||
[![](https://github.com/apache/iceberg/actions/workflows/java-ci.yml/badge.svg)](https://github.com/apache/iceberg/actions/workflows/java-ci.yml) | ||
[![](https://github.com/apache/iceberg/actions/workflows/python-ci.yml/badge.svg)](https://github.com/apache/iceberg/actions/workflows/python-ci.yml) | ||
[![Slack](https://img.shields.io/badge/chat-on%20Slack-brightgreen.svg)](https://apache-iceberg.slack.com/) | ||
![geolake-overview](docs/geolake-overview.png) | ||
|
||
Iceberg is a high-performance format for huge analytic tables. Iceberg brings the reliability and simplicity of SQL tables to big data, while making it possible for engines like Spark, Trino, Flink, Presto, Hive and Impala to safely work with the same tables, at the same time. | ||
## GeoLake Architecture | ||
|
||
Background and documentation is available at <https://iceberg.apache.org> | ||
GeoLake can be used to build a lakehouse with geospatial support. It is built on top of [Apache Spark](https://spark.apache.org/) and [Apache Iceberg](https://iceberg.apache.org/). | ||
|
||
- **GeoLake Parquet**: A extension to Apache Parquet to support geospatial data types. | ||
- **Spatial Partition**: A spatial partitioning scheme for Apache Iceberg. | ||
- **Geometry Type**: A geometry type for Apache Iceberg. | ||
- **Spark & Sedona**: Integrate with Apache Spark and Apache Sedona seamlessly. | ||
|
||
## Status | ||
## Spark SQL Examples | ||
```sql | ||
-- Create table with a geometry type, as well as a spatial partition | ||
CREATE TABLE iceberg.geom_table( | ||
id int, | ||
geom geometry | ||
) USING ICEBERG PARTITIONED BY (xz2(geo, 7)); | ||
|
||
Iceberg is under active development at the Apache Software Foundation. | ||
-- insert geometry values using WKT | ||
INSERT INTO iceberg.geom_table VALUES | ||
(1, 'POINT(1 2)'), | ||
(2, 'LINESTRING(1 2, 3 4)'), | ||
(3, 'POLYGON((0 0, 0 1, 1 1, 1 0, 0 0))'); | ||
|
||
The core Java library that tracks table snapshots and metadata is complete, but still evolving. Current work is focused on adding row-level deletes and upserts, and integration work with new engines like Flink and Hive. | ||
-- query with spatial predicates | ||
SELECT * FROM iceberg.geom_table | ||
WHERE ST_Contains(geom, ST_Point(0.5, 0.5)); | ||
``` | ||
|
||
The [Iceberg format specification][iceberg-spec] is being actively updated and is open for comment. Until the specification is complete and released, it carries no compatibility guarantees. The spec is currently evolving as the Java reference implementation changes. | ||
## Quickstart | ||
|
||
[Java API javadocs][iceberg-javadocs] are available for the master. | ||
Check this repo [docker-spark-geolake](https://github.com/spatialx-project/docker-spark-geolake) for early access, there are some [notebooks](https://github.com/spatialx-project/docker-spark-geolake/tree/main/spark/notebooks) inside. | ||
|
||
[iceberg-javadocs]: https://iceberg.apache.org/javadoc/master | ||
[iceberg-spec]: https://iceberg.apache.org/spec | ||
Source code and documentation will be released soon. | ||
|
||
## PVLDB Artifact | ||
|
||
## Collaboration | ||
We are submitting a paper titled "GeoLake: Bringing Geospatial Support to Lakehouses" to VLDB (Very Large Data Bases), and we have made the experiment-related code, data, and results available at this repository. Specialy, check [parquet-benchmark](https://github.com/spatialx-project/geplake-parquet-benchmark) for Parquet-related experiments(paper's section 7.2), check [serde-benckmark](https://github.com/Kontinuation/play-with-geometry-serde) for Serde-related experiments(paper's section 7.3), check [Partition-Resolution](https://github.com/spatialx-project/docker-spark-geolake/blob/main/spark/notebooks/benchmark-portotaxi.ipynb) for Partition-related experiments(paper's section 7.4), check [end-2-end](https://github.com/spatialx-project/docker-spark-geolake/blob/main/spark/notebooks/benchmark-portotaxi.ipynb) for end-2-end experiments(paper's section 7.5). | ||
|
||
Iceberg tracks issues in GitHub and prefers to receive contributions as pull requests. | ||
|
||
Community discussions happen primarily on the [dev mailing list][dev-list] or on specific issues. | ||
|
||
[dev-list]: mailto:dev@iceberg.apache.org | ||
|
||
|
||
### Building | ||
|
||
Iceberg is built using Gradle with Java 1.8 or Java 11. | ||
|
||
* To invoke a build and run tests: `./gradlew build` | ||
* To skip tests: `./gradlew build -x test -x integrationTest` | ||
* To fix code style for default versions: `./gradlew spotlessApply` | ||
* To fix code style for all versions of Spark/Hive/Flink:`./gradlew spotlessApply -DallVersions` | ||
|
||
Iceberg table support is organized in library modules: | ||
|
||
* `iceberg-common` contains utility classes used in other modules | ||
* `iceberg-api` contains the public Iceberg API | ||
* `iceberg-core` contains implementations of the Iceberg API and support for Avro data files, **this is what processing engines should depend on** | ||
* `iceberg-parquet` is an optional module for working with tables backed by Parquet files | ||
* `iceberg-arrow` is an optional module for reading Parquet into Arrow memory | ||
* `iceberg-orc` is an optional module for working with tables backed by ORC files | ||
* `iceberg-hive-metastore` is an implementation of Iceberg tables backed by the Hive metastore Thrift client | ||
* `iceberg-data` is an optional module for working with tables directly from JVM applications | ||
|
||
Iceberg also has modules for adding Iceberg support to processing engines: | ||
|
||
* `iceberg-spark` is an implementation of Spark's Datasource V2 API for Iceberg with submodules for each spark versions (use runtime jars for a shaded version) | ||
* `iceberg-flink` contains classes for integrating with Apache Flink (use iceberg-flink-runtime for a shaded version) | ||
* `iceberg-mr` contains an InputFormat and other classes for integrating with Apache Hive | ||
* `iceberg-pig` is an implementation of Pig's LoadFunc API for Iceberg | ||
|
||
### Engine Compatibility | ||
|
||
See the [Multi-Engine Support](https://iceberg.apache.org/multi-engine-support/) page to know about Iceberg compatibility with different Spark, Flink and Hive versions. | ||
For other engines such as Presto or Trino, please visit their websites for Iceberg integration details. | ||
It is noteworthy that, for Partition-related experiments and end-2-end experiments, the corresponding repository only contains code for the Portotaxi dataset. For the TIGER2018 and MSBuildings datasets, you only need to modify the logic for reading the dataset in the code. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Empty file.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.