prestodb/presto

Overview (Java)

Presto is a standard Maven project. Simply run the following command from the project root directory:

./mvnw clean install

On the first build, Maven will download all the dependencies from the internet and cache them in the local repository (~/.m2/repository), which can take a considerable amount of time. Subsequent builds will be faster.

When building multiple Presto projects locally, each project may write updates to the user's global M2 cache, which could cause build issues. You can configure your local .mvn/maven.config to support a local cache specific to that project via -Dmaven.repo.local=./.m2/repository.

Presto has a comprehensive set of unit tests that can take several minutes to run. You can disable the tests when building:

./mvnw clean install -DskipTests

After building Presto for the first time, you can load the project into your IDE and run the server. We recommend using IntelliJ IDEA. Because Presto is a standard Maven project, you can import it into your IDE using the root pom.xml file. In IntelliJ, choose Open Project from the Quick Start box or choose Open from the File menu and select the root pom.xml file.

After opening the project in IntelliJ, double check that the Java SDK is properly configured for the project:

• Open the File menu and select Project Structure
• In the SDKs section, ensure that a distribution of JDK 17 is selected (create one if none exist)
• In the Project section, ensure the Project language level is set to at least 8.0.
• When using JDK 17, an IntelliJ bug requires you to disable the Use '--release' option for cross-compilation (Java 9 and later) setting in Settings > Build, Execution, Deployment > Compiler > Java Compiler. If this option remains enabled, you may encounter errors such as: package sun.misc does not exist because IntelliJ fails to resolve certain internal JDK classes.

Presto comes with sample configuration that should work out-of-the-box for development. Use the following options to create a run configuration:

• Main Class: com.facebook.presto.server.PrestoServer
• VM Options: -ea -XX:+UseG1GC -XX:G1HeapRegionSize=32M -XX:+UseGCOverheadLimit -XX:+ExplicitGCInvokesConcurrent -Xmx2G -Dconfig=etc/config.properties -Dlog.levels-file=etc/log.properties -Djdk.attach.allowAttachSelf=true
• Working directory: $MODULE_WORKING_DIR$ or $MODULE_DIR$(Depends your version of IntelliJ)
• Use classpath of module: presto-main

The working directory should be the presto-main subdirectory. In IntelliJ, using $MODULE_DIR$ accomplishes this automatically.

Additionally, the Hive plugin must be configured with location of your Hive metastore Thrift service. Add the following to the list of VM options, replacing localhost:9083 with the correct host and port (or use the below value if you do not have a Hive metastore):

-Dhive.metastore.uri=thrift://localhost:9083

To modify the loaded plugins in IntelliJ, modify the config.properties located in presto-main/etc. You can modify plugin.bundles with the location of the plugin pom.xml

Additional configuration for Java 17

When running with Java 17, additional --add-opens flags are required to allow reflective access used by certain catalogs based on which catalogs are configured. For the default set of catalogs loaded when starting the Presto server in IntelliJ without changes, add the following flags to the VM Options:

--add-opens=java.base/java.io=ALL-UNNAMED
--add-opens=java.base/java.lang=ALL-UNNAMED
--add-opens=java.base/java.lang.ref=ALL-UNNAMED
--add-opens=java.base/java.lang.reflect=ALL-UNNAMED
--add-opens=java.base/java.net=ALL-UNNAMED
--add-opens=java.base/java.nio=ALL-UNNAMED
--add-opens=java.base/java.security=ALL-UNNAMED
--add-opens=java.base/javax.security.auth=ALL-UNNAMED
--add-opens=java.base/javax.security.auth.login=ALL-UNNAMED
--add-opens=java.base/java.text=ALL-UNNAMED
--add-opens=java.base/java.util=ALL-UNNAMED
--add-opens=java.base/java.util.concurrent=ALL-UNNAMED
--add-opens=java.base/java.util.concurrent.atomic=ALL-UNNAMED
--add-opens=java.base/java.util.regex=ALL-UNNAMED
--add-opens=java.base/jdk.internal.loader=ALL-UNNAMED
--add-opens=java.base/sun.security.action=ALL-UNNAMED
--add-opens=java.security.jgss/sun.security.krb5=ALL-UNNAMED

These flags ensure that internal JDK modules are accessible at runtime for components used by Presto’s default configuration. It is not a comprehensive list. Additional flags may need to be added, depending on the catalogs configured on the server.

Using SOCKS for Hive or HDFS

If your Hive metastore or HDFS cluster is not directly accessible to your local machine, you can use SSH port forwarding to access it. Setup a dynamic SOCKS proxy with SSH listening on local port 1080:

ssh -v -N -D 1080 server

Then add the following to the list of VM options:

-Dhive.metastore.thrift.client.socks-proxy=localhost:1080

Running the CLI

Start the CLI to connect to the server and run SQL queries:

presto-cli/target/presto-cli-*-executable.jar

Run a query to see the nodes in the cluster:

SELECT * FROM system.runtime.nodes;

In the sample configuration, the Hive connector is mounted in the hive catalog, so you can run the following queries to show the tables in the Hive database default:

SHOW TABLES FROM hive.default;

Building the Documentation

To build the Presto docs, see the docs README.

Building the Presto Console

The Presto Console is composed of several React components and is written in JSX and ES6. This source code is stored in the presto-ui/ module. The compilation process generates browser-compatible javascript which is added as JAR resources during the maven build. When the resource JAR is included on the classpath of Presto coordinator, it will be able to serve the resources.

None of the Java code relies on the Presto UI project being compiled, so it is possible to exclude this UI when building Presto. Add the property -DskipUI to the maven command to disable building the ui maven module.

./mvnw clean install -DskipUI

You must have Node.js and Yarn installed to build the UI. When using Maven to build the project, Node and yarn are installed in the presto-ui/target folder. Add the node and yarn executables to the PATH environment variable.

To update Presto Console after making changes, run:

yarn --cwd presto-ui/src install

To simplify iteration, you can also run in watch mode, which automatically re-compiles when changes to source files are detected:

yarn --cwd presto-ui/src run watch

To iterate quickly, simply re-build the project in IntelliJ after packaging is complete. Project resources will be hot-reloaded and changes are reflected on browser refresh.

Presto native and Velox

Presto native is a C++ rewrite of Presto worker. Presto native uses Velox as its primary engine to run presto workloads.

Velox is a C++ database library which provides reusable, extensible, and high-performance data processing components.

Check out building instructions to get started.

Using development containers

The PrestoDB project provides support for development containers in its own repository. Please visit the presto-dev README for details.