-
Notifications
You must be signed in to change notification settings - Fork 305
docs: Add documentation for accelerating Iceberg Parquet scans with Comet [branch-0.8] #1696
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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
30 changes: 30 additions & 0 deletions
30
common/src/main/java/org/apache/comet/CometSchemaImporter.java
This file contains hidden or 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 |
|---|---|---|
| @@ -0,0 +1,30 @@ | ||
| /* | ||
| * 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. | ||
| */ | ||
|
|
||
| package org.apache.comet; | ||
|
|
||
| import org.apache.arrow.c.*; | ||
| import org.apache.arrow.memory.BufferAllocator; | ||
|
|
||
| /** This is a simple wrapper around SchemaImporter to make it accessible from Java Arrow. */ | ||
| public class CometSchemaImporter extends AbstractCometSchemaImporter { | ||
| public CometSchemaImporter(BufferAllocator allocator) { | ||
| super(allocator); | ||
| } | ||
| } |
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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 |
|---|---|---|
| @@ -0,0 +1,147 @@ | ||
| <!--- | ||
| 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. | ||
| --> | ||
|
|
||
| # Accelerating Apache Iceberg Parquet Scans using Comet (Experimental) | ||
|
|
||
| **Note: Iceberg integration is a work-in-progress. It is currently necessary to build Iceberg from | ||
| source rather than using available artifacts in Maven** | ||
|
|
||
| ## Build Comet | ||
|
|
||
| Run a Maven install so that we can compile Iceberg against latest Comet: | ||
|
|
||
| ```shell | ||
| mvn install -DskipTests | ||
| ``` | ||
|
|
||
| Build the release JAR to be used from Spark: | ||
|
|
||
| ```shell | ||
| make release | ||
| ``` | ||
|
|
||
| Set `COMET_JAR` env var: | ||
|
|
||
| ```shell | ||
| export COMET_JAR=`pwd`/spark/target/comet-spark-spark3.5_2.12-0.9.0-SNAPSHOT.jar | ||
| ``` | ||
|
|
||
| ## Build Iceberg | ||
|
|
||
| Clone the Iceberg repository. | ||
|
|
||
| ```shell | ||
| git clone git@github.com:apache/iceberg.git | ||
| ``` | ||
|
|
||
| It will be necessary to make some small changes to Iceberg: | ||
|
|
||
| - Update Gradle files to change Comet version to `0.9.0-SNAPSHOT`. | ||
| - Replace `import org.apache.comet.shaded.arrow.c.CometSchemaImporter;` with `import org.apache.comet.CometSchemaImporter;` | ||
| - Modify `SparkBatchQueryScan` so that it implements the `SupportsComet` interface | ||
| - Stop shading Parquet by commenting out the following lines in the iceberg-spark build: | ||
|
|
||
| ``` | ||
| // relocate 'org.apache.parquet', 'org.apache.iceberg.shaded.org.apache.parquet' | ||
| // relocate 'shaded.parquet', 'org.apache.iceberg.shaded.org.apache.parquet.shaded' | ||
| ``` | ||
|
|
||
| Perform a clean build | ||
|
|
||
| ```shell | ||
| ./gradlew clean | ||
| ./gradlew build -x test -x integrationTest | ||
| ``` | ||
|
|
||
| ## Test | ||
|
|
||
| Set `ICEBERG_JAR` environment variable. | ||
|
|
||
| ```shell | ||
| export ICEBERG_JAR=`pwd`/spark/v3.5/spark-runtime/build/libs/iceberg-spark-runtime-3.5_2.12-1.10.0-SNAPSHOT.jar | ||
| ``` | ||
|
|
||
| Launch Spark Shell: | ||
|
|
||
| ```shell | ||
| $SPARK_HOME/bin/spark-shell \ | ||
| --jars $COMET_JAR,$ICEBERG_JAR \ | ||
| --conf spark.driver.extraClassPath=$COMET_JAR,$ICEBERG_JAR \ | ||
| --conf spark.executor.extraClassPath=$COMET_JAR,$ICEBERG_JAR \ | ||
| --conf spark.sql.extensions=org.apache.iceberg.spark.extensions.IcebergSparkSessionExtensions \ | ||
| --conf spark.sql.catalog.spark_catalog=org.apache.iceberg.spark.SparkCatalog \ | ||
| --conf spark.sql.catalog.spark_catalog.type=hadoop \ | ||
| --conf spark.sql.catalog.spark_catalog.warehouse=/tmp/warehouse \ | ||
| --conf spark.plugins=org.apache.spark.CometPlugin \ | ||
| --conf spark.shuffle.manager=org.apache.spark.sql.comet.execution.shuffle.CometShuffleManager \ | ||
| --conf spark.sql.iceberg.parquet.reader-type=COMET \ | ||
| --conf spark.comet.explainFallback.enabled=true \ | ||
| --conf spark.memory.offHeap.enabled=true \ | ||
| --conf spark.memory.offHeap.size=16g | ||
| ``` | ||
|
|
||
| Create an Iceberg table. Note that Comet will not accelerate this part. | ||
|
|
||
| ``` | ||
| scala> spark.sql(s"CREATE TABLE IF NOT EXISTS t1 (c0 INT, c1 STRING) USING iceberg") | ||
| scala> spark.sql(s"INSERT INTO t1 VALUES ${(0 until 10000).map(i => (i, i)).mkString(",")}") | ||
| ``` | ||
|
|
||
| Comet should now be able to accelerate reading the table: | ||
|
|
||
| ``` | ||
| scala> spark.sql(s"SELECT * from t1").show() | ||
| ``` | ||
|
|
||
| This should produce the following output: | ||
|
|
||
| ``` | ||
| scala> spark.sql(s"SELECT * from t1").show() | ||
| 25/04/28 07:29:37 INFO core/src/lib.rs: Comet native library version 0.9.0 initialized | ||
| 25/04/28 07:29:37 WARN CometSparkSessionExtensions$CometExecRule: Comet cannot execute some parts of this plan natively (set spark.comet.explainFallback.enabled=false to disable this logging): | ||
| CollectLimit [COMET: CollectLimit is not supported] | ||
| +- Project [COMET: toprettystring is not supported] | ||
| +- CometScanWrapper | ||
|
|
||
| +---+---+ | ||
| | c0| c1| | ||
| +---+---+ | ||
| | 0| 0| | ||
| | 1| 1| | ||
| | 2| 2| | ||
| | 3| 3| | ||
| | 4| 4| | ||
| | 5| 5| | ||
| | 6| 6| | ||
| | 7| 7| | ||
| | 8| 8| | ||
| | 9| 9| | ||
| | 10| 10| | ||
| | 11| 11| | ||
| | 12| 12| | ||
| | 13| 13| | ||
| | 14| 14| | ||
| | 15| 15| | ||
| | 16| 16| | ||
| | 17| 17| | ||
| | 18| 18| | ||
| | 19| 19| | ||
| +---+---+ | ||
| only showing top 20 rows | ||
| ``` |
This file contains hidden or 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
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
(nit) Should we keep
###Local?