cmathiesen commented on a change in pull request #678: Add Java code examples and update site docs URL: https://github.com/apache/incubator-iceberg/pull/678#discussion_r404807393
########## File path: site/docs/getting-started.md ########## @@ -15,4 +15,65 @@ - limitations under the License. --> -## Getting Started +# Getting Started + +## Including Iceberg + +### Downloads + +The latest version of Iceberg is [0.7.0-incubating](https://github.com/apache/incubator-iceberg/releases/tag/apache-iceberg-0.7.0-incubating). + +* [0.7.0-incubating source tar.gz](https://www.apache.org/dyn/closer.cgi/incubator/iceberg/apache-iceberg-0.7.0-incubating/apache-iceberg-0.7.0-incubating.tar.gz) -- [signature](https://dist.apache.org/repos/dist/release/incubator/iceberg/apache-iceberg-0.7.0-incubating/apache-iceberg-0.7.0-incubating.tar.gz.asc) -- [sha512](https://dist.apache.org/repos/dist/release/incubator/iceberg/apache-iceberg-0.7.0-incubating/apache-iceberg-0.7.0-incubating.tar.gz.sha512) +* [0.7.0-incubating Spark 2.4 runtime Jar](https://search.maven.org/remotecontent?filepath=org/apache/iceberg/iceberg-spark-runtime/0.7.0-incubating/iceberg-spark-runtime-0.7.0-incubating.jar) + +One way to use Iceberg in Spark 2.4 is to download the runtime Jar and add it to the jars folder of your Spark install. + +Spark 2.4 is limited to reading and writing existing Iceberg tables. Use the [Iceberg API](../api) to create Iceberg tables. + +The recommended way is to include Iceberg's latest release using the `--packages` option: +```sh +spark-shell --packages org.apache.iceberg:iceberg-spark-runtime:0.7.0-incubating +``` + +You can also build Iceberg locally, and add the jar to Spark's classpath. This can be helpful to test unreleased features or while developing something new: + +```sh +./gradlew assemble + +spark-shell --jars spark-runtime/build/libs/iceberg-spark-runtime-93990904.jar +``` + +Where you have to replace `93990904` with the git hash that you're using. + +### Gradle +To add a dependency on Iceberg in Gradle, add the following to `build.gradle`: +``` +dependencies { + compile 'org.apache.iceberg:iceberg-core:0.7.0-incubating' +} +``` + +### Maven +If you'd like to try out Iceberg in a Maven project using the Spark Iceberg API, you can add the `iceberg-spark-runtime` dependency to your `pom.xml` file: +```xml + <dependency> + <groupId>org.apache.iceberg</groupId> + <artifactId>iceberg-spark-runtime</artifactId> + <version>${iceberg.version}</version> + </dependency> +``` + +You'll also need `spark-sql` to read tables: +```xml + <dependency> + <groupId>org.apache.spark</groupId> + <artifactId>spark-sql_2.12</artifactId> Review comment: Ah, good spot! Fixed that now ---------------------------------------------------------------- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: [email protected] With regards, Apache Git Services --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
