Getting Started

Lakelet's philosophy is to be simple, run on a single machine, and be easy to use.

Build Lakelet

Lakelet requires a Rust toolchain. Build the release binary from the repository root:

git clone https://github.com/Smith-Cruise/Lakelet.git
cd Lakelet
cargo build --release

The binary is written to target/release/lakelet.

Create a Configuration File

Copy the example configuration and edit it for your environment:

cp config_demo.toml config.toml

A configuration file can contain the following top-level sections:

Section	Required	Description
[server]	No	Server-wide settings.
[[catalog.hms]]	No	A Hive Metastore catalog. Repeat the block to configure multiple HMS catalogs.
[[catalog.glue]]	No	An AWS Glue catalog. Repeat the block to configure multiple Glue catalogs.

At least one HMS or Glue catalog is needed to query external tables. The built-in internal catalog is always available, even when no external catalog is configured.

The following is a minimal HMS configuration:

[[catalog.hms]]
name = "hms"
metastore-uri = "127.0.0.1:9083"

Add an s3-storage or oss-storage entry to the catalog when its tables use object storage:

[[catalog.hms]]
name = "hms"
metastore-uri = "127.0.0.1:9083"
s3-storage = { region = "us-east-1", endpoint = "http://127.0.0.1:9000", access-key = "admin", secret-key = "password", path-style-access = true }

See Server, Catalog, and Storage for the complete configuration reference.

Start Lakelet

Pass the configuration file with --config:

target/release/lakelet --config config.toml

The configuration file is required for normal execution.

You can get more help by target/release/lakelet --help.