Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
153 changes: 89 additions & 64 deletions content/Development/quickStart.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,155 +18,181 @@ Run Apache Hive inside docker container in pseudo-distributed mode, inorder to p

##### **STEP 1: Pull the image**

- Pull the image from DockerHub: https://hub.docker.com/r/apache/hive/tags. Here are the latest images:
- 4.0.0
- 3.1.3
Pull the image from DockerHub: https://hub.docker.com/r/apache/hive/tags. Here are the latest images:

- 4.2.0
- 3.1.3
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we still need to keep version 3.1.3, since this version has long been out of maintenance?


```shell
docker pull apache/hive:4.0.0
docker pull apache/hive:4.2.0
```
` `

##### **STEP 2: Export the Hive version**

```shell
export HIVE_VERSION=4.0.0
export HIVE_VERSION=4.2.0
```
` `

##### **STEP 3: Launch the HiveServer2 with an embedded Metastore.**
This is lightweight and for a quick setup, it uses Derby as metastore db.

```shell
docker run -d -p 10000:10000 -p 10002:10002 --env SERVICE_NAME=hiveserver2 --name hive4 apache/hive:${HIVE_VERSION}
```
` `

##### **STEP 4: Connect to beeline**

```shell
docker exec -it hiveserver2 beeline -u 'jdbc:hive2://hiveserver2:10000/'
```
` `

##### Note: Launch Standalone Metastore To use standalone Metastore with Derby,

```shell
docker run -d -p 9083:9083 --env SERVICE_NAME=metastore --name metastore-standalone apache/hive:${HIVE_VERSION}
```
` `

## Detailed Setup

---
##### - Build image

Apache Hive relies on Hadoop, Tez and some others to facilitate reading, writing, and managing large datasets.
The [/packaging/src/docker/build.sh] provides ways to build the image against specified version of the dependent, as well as build from source.
The [/packaging/src/docker/build.sh](https://github.com/apache/hive/blob/master/packaging/src/docker/build.sh) provides ways to build the image against specified version of the dependent, as well as build from source.

##### - Build from source

```shell
mvn clean package -pl packaging -DskipTests -Pdocker
```
` `

##### - Build with specified version

There are some arguments to specify the component version:

```shell
-hadoop <hadoop version>
-tez <tez version>
-hive <hive version>
```

If the version is not provided, it will read the version from current `pom.xml`:
`project.version`, `hadoop.version` and `tez.version` for Hive, Hadoop and Tez respectively.
For example, the following command uses Hive 4.0.0, Hadoop `hadoop.version` and Tez `tez.version` to build the image,
For example, the following command uses Hive 4.2.0, Hadoop `hadoop.version` and Tez `tez.version` to build the image,

```shell
./build.sh -hive 4.0.0
./build.sh -hive 4.2.0
```
If the command does not specify the Hive version, it will use the local `apache-hive-${project.version}-bin.tar.gz`(will trigger a build if it doesn't exist),
together with Hadoop 3.3.6 and Tez 0.10.3 to build the image,

If the command does not specify the Hive version, it will use the local `apache-hive-${project.version}-bin.tar.gz`(will trigger a build if it doesn't exist), together with Hadoop 3.3.6 and Tez 0.10.3 to build the image,

```shell
./build.sh -hadoop 3.3.6 -tez 0.10.3
```

After building successfully, we can get a Docker image named `apache/hive` by default, the image is tagged by the provided Hive version.

### Run services
---
Before going further, we should define the environment variable `HIVE_VERSION` first.
For example, if `-hive 4.0.0` is specified to build the image,
For example, if `-hive 4.2.0` is specified to build the image,

```shell
export HIVE_VERSION=4.0.0
export HIVE_VERSION=4.2.0
```

or assuming that you're relying on current `project.version` from pom.xml,

```shell
export HIVE_VERSION=$(mvn -f pom.xml -q help:evaluate -Dexpression=project.version -DforceStdout)
```
` `

##### **- Metastore**

For a quick start, launch the Metastore with Derby,
```shell
docker run -d -p 9083:9083 --env SERVICE_NAME=metastore --name metastore-standalone apache/hive:${HIVE_VERSION}
```

```shell
docker run -d -p 9083:9083 --env SERVICE_NAME=metastore --name metastore-standalone apache/hive:${HIVE_VERSION}
```

Everything would be lost when the service is down. In order to save the Hive table's schema and data, start the container with an external Postgres and Volume to keep them,

```shell
docker run -d -p 9083:9083 --env SERVICE_NAME=metastore --env DB_DRIVER=postgres \
--env SERVICE_OPTS="-Djavax.jdo.option.ConnectionDriverName=org.postgresql.Driver -Djavax.jdo.option.ConnectionURL=jdbc:postgresql://postgres:5432/metastore_db -Djavax.jdo.option.ConnectionUserName=hive -Djavax.jdo.option.ConnectionPassword=password" \
--mount source=warehouse,target=/opt/hive/data/warehouse \
--mount type=bind,source=`mvn help:evaluate -Dexpression=settings.localRepository -q -DforceStdout`/org/postgresql/postgresql/42.5.1/postgresql-42.5.1.jar,target=/opt/hive/lib/postgres.jar \
--name metastore-standalone apache/hive:${HIVE_VERSION}
```
```shell
docker run -d -p 9083:9083 --env SERVICE_NAME=metastore --env DB_DRIVER=postgres \
--env SERVICE_OPTS="-Djavax.jdo.option.ConnectionDriverName=org.postgresql.Driver -Djavax.jdo.option.ConnectionURL=jdbc:postgresql://postgres:5432/metastore_db -Djavax.jdo.option.ConnectionUserName=hive -Djavax.jdo.option.ConnectionPassword=password" \
--mount source=warehouse,target=/opt/hive/data/warehouse \
--mount type=bind,source=`mvn help:evaluate -Dexpression=settings.localRepository -q -DforceStdout`/org/postgresql/postgresql/42.5.1/postgresql-42.5.1.jar,target=/opt/hive/lib/postgres.jar \
--name metastore-standalone apache/hive:${HIVE_VERSION}
```

If you want to use your own `hdfs-site.xml` or `yarn-site.xml` for the service, you can provide the environment variable `HIVE_CUSTOM_CONF_DIR` for the command. For instance, put the custom configuration file under the directory `/opt/hive/conf`, then,

```shell
docker run -d -p 9083:9083 --env SERVICE_NAME=metastore --env DB_DRIVER=postgres \
-v /opt/hive/conf:/hive_custom_conf --env HIVE_CUSTOM_CONF_DIR=/hive_custom_conf \
--mount type=bind,source=`mvn help:evaluate -Dexpression=settings.localRepository -q -DforceStdout`/org/postgresql/postgresql/42.5.1/postgresql-42.5.1.jar,target=/opt/hive/lib/postgres.jar \
--name metastore apache/hive:${HIVE_VERSION}
```
For Hive releases before 4.0, if you want to upgrade the existing external Metastore schema to the target version, then add `--env SCHEMA_COMMAND=upgradeSchema` to the command.
```shell
docker run -d -p 9083:9083 --env SERVICE_NAME=metastore --env DB_DRIVER=postgres \
-v /opt/hive/conf:/hive_custom_conf --env HIVE_CUSTOM_CONF_DIR=/hive_custom_conf \
--mount type=bind,source=`mvn help:evaluate -Dexpression=settings.localRepository -q -DforceStdout`/org/postgresql/postgresql/42.5.1/postgresql-42.5.1.jar,target=/opt/hive/lib/postgres.jar \
--name metastore apache/hive:${HIVE_VERSION}
```

For Hive releases before 4.2, if you want to upgrade the existing external Metastore schema to the target version, then add `--env SCHEMA_COMMAND=upgradeSchema` to the command.
To skip schematool initialisation or upgrade for metastore use `--env IS_RESUME="true"`, for verbose logging set `--env VERBOSE="true"`.

` `
##### **- HiveServer2**

Launch the HiveServer2 with an embedded Metastore,
```shell
docker run -d -p 10000:10000 -p 10002:10002 --env SERVICE_NAME=hiveserver2 --name hiveserver2-standalone apache/hive:${HIVE_VERSION}
```

```shell
docker run -d -p 10000:10000 -p 10002:10002 --env SERVICE_NAME=hiveserver2 --name hiveserver2-standalone apache/hive:${HIVE_VERSION}
```

or specify a remote Metastore if it's available,
```shell
docker run -d -p 10000:10000 -p 10002:10002 --env SERVICE_NAME=hiveserver2 \
--env SERVICE_OPTS="-Dhive.metastore.uris=thrift://metastore:9083" \
--env IS_RESUME="true" \
--name hiveserver2-standalone apache/hive:${HIVE_VERSION}
```

```shell
docker run -d -p 10000:10000 -p 10002:10002 --env SERVICE_NAME=hiveserver2 \
--env SERVICE_OPTS="-Dhive.metastore.uris=thrift://metastore:9083" \
--env IS_RESUME="true" \
--name hiveserver2-standalone apache/hive:${HIVE_VERSION}
```

To save the data between container restarts, you can start the HiveServer2 with a Volume,
```shell
docker run -d -p 10000:10000 -p 10002:10002 --env SERVICE_NAME=hiveserver2 \
--env SERVICE_OPTS="-Dhive.metastore.uris=thrift://metastore:9083" \
--mount source=warehouse,target=/opt/hive/data/warehouse \
--env IS_RESUME="true" \
--name hiveserver2 apache/hive:${HIVE_VERSION}
```
` `

```shell
docker run -d -p 10000:10000 -p 10002:10002 --env SERVICE_NAME=hiveserver2 \
--env SERVICE_OPTS="-Dhive.metastore.uris=thrift://metastore:9083" \
--mount source=warehouse,target=/opt/hive/data/warehouse \
--env IS_RESUME="true" \
--name hiveserver2 apache/hive:${HIVE_VERSION}
```

##### **- HiveServer2, Metastore**

To get a quick overview of both HiveServer2 and Metastore, there is a `docker-compose.yml` placed under `packaging/src/docker` for this purpose,
specify the `POSTGRES_LOCAL_PATH` first:
To get a quick overview of both HiveServer2 and Metastore, there is a `docker-compose.yml` placed under `packaging/src/docker` for this purpose, specify the `POSTGRES_LOCAL_PATH` first:

```shell
export POSTGRES_LOCAL_PATH=your_local_path_to_postgres_driver
```

Example:

```shell
mvn dependency:copy -Dartifact="org.postgresql:postgresql:42.5.1" && \
export POSTGRES_LOCAL_PATH=`mvn help:evaluate -Dexpression=settings.localRepository -q -DforceStdout`/org/postgresql/postgresql/42.5.1/postgresql-42.5.1.jar
```
If you don't install maven or have problem in resolving the postgres driver, you can always download this jar yourself,
change the `POSTGRES_LOCAL_PATH` to the path of the downloaded jar. Then,

If you don't install maven or have problem in resolving the postgres driver, you can always download this jar yourself, change the `POSTGRES_LOCAL_PATH` to the path of the downloaded jar. Then,

```shell
docker compose up -d
```

HiveServer2, Metastore and Postgres services will be started as a consequence. Volumes are used to persist data generated by Hive inside Postgres and HiveServer2 containers:
- hive_db
- The volume persists the metadata of Hive tables inside Postgres container.
- warehouse
- The volume stores tables' files inside HiveServer2 container.

To stop/remove them all,

```shell
docker compose down
```
Expand All @@ -176,7 +202,7 @@ docker compose down
---

- HiveServer2 web
- Accessed on browser at http://localhost:10002/
- Accessed on browser at http://localhost:10002/
- Beeline:
```shell
docker exec -it hiveserver2 beeline -u 'jdbc:hive2://hiveserver2:10000/'
Expand All @@ -198,8 +224,7 @@ docker compose down
`Hive Schema Tool` is located in the Docker Image at `/opt/hive/bin/schematool`.

By default, system schemas such as `information_schema` for HiveServer2 are not created.
To create system schemas for a HiveServer2 instance,
users need to configure the Hive Metastore Server used by HiveServer2 to use a database other than the embedded Derby.
To create system schemas for a HiveServer2 instance, users need to configure the Hive Metastore Server used by HiveServer2 to use a database other than the embedded Derby.
The following text discusses how to configure HiveServer2 when the Hive Metastore Server is in different locations.

##### HiveServer2 with embedded Hive Metastore Server
Expand All @@ -214,7 +239,7 @@ services:
environment:
POSTGRES_PASSWORD: "example"
hiveserver2-standalone:
image: apache/hive:4.0.1
image: apache/hive:4.2.0
depends_on:
- some-postgres
environment:
Expand Down Expand Up @@ -251,7 +276,7 @@ services:
environment:
POSTGRES_PASSWORD: "example"
metastore-standalone:
image: apache/hive:4.0.1
image: apache/hive:4.2.0
depends_on:
- some-postgres
environment:
Expand All @@ -265,7 +290,7 @@ services:
volumes:
- ~/.m2/repository/org/postgresql/postgresql/42.7.5/postgresql-42.7.5.jar:/opt/hive/lib/postgres.jar
hiveserver2-standalone:
image: apache/hive:4.0.1
image: apache/hive:4.2.0
depends_on:
- metastore-standalone
environment:
Expand Down
13 changes: 13 additions & 0 deletions content/community/resources/howtorelease.md
Original file line number Diff line number Diff line change
Expand Up @@ -557,6 +557,19 @@ For example, if you are working on branch-3 and have just released Hive 3.2 and
4. Verify that the build is working with changes.
5. Commit these changes with a comment "Preparing for X.Y.Z+1 development".

## Update hive-site

### Announce the release

- https://github.com/apache/hive-site/blob/main/content/general/downloads.md
- https://github.com/apache/hive-site/blob/main/themes/hive/layouts/partials/release-banner.html

### Update Hive versions

The following page should include the latest Hive version.

- https://github.com/apache/hive-site/blob/main/content/Development/quickStart.md

## See Also

* [Apache Releases FAQ](http://www.apache.org/dev/release.html)