lakeFS Documentation

File: README.md Copy Chapter

lakeFS is Data Version Control (Git for Data) Copy Chapter

lakeFS is an open-source tool that transforms your object storage into a Git-like repository. It enables you to manage your data lake the way you manage your code.

With lakeFS you can build repeatable, atomic, and versioned data lake operations - from complex ETL jobs to data science and analytics.

lakeFS supports AWS S3, Azure Blob Storage, and Google Cloud Storage as its underlying storage service. It is API compatible with S3 and works seamlessly with all modern data frameworks such as Spark, Hive, AWS Athena, DuckDB, and Presto.

For more information, see the documentation.

Getting Started Copy Chapter

You can spin up a standalone sandbox instance of lakeFS:

pip install lakefs
python -m lakefs.quickstart

Once you've got lakeFS running, open http://127.0.0.1:8000/ in your web browser.

Getting Started with Docker Copy Section

Alternatively, you can run lakeFS a server using Docker:

docker run --pull always \
		   --name lakefs \
		   -p 8000:8000 \
		   treeverse/lakefs:latest \
		   run --quickstart

Quickstart Copy Section

👉🏻 For a hands-on walk through of the core functionality in lakeFS head over to the quickstart to jump right in!

Make sure to also have a look at the lakeFS samples. These are a rich resource of examples of end-to-end applications that you can build with lakeFS.

Why Do I Need lakeFS? Copy Chapter

ETL Testing with Isolated Dev/Test Environment Copy Section

When working with a data lake, it’s useful to have replicas of your production environment. These replicas allow you to test these ETLs and understand changes to your data without impacting downstream data consumers.

Running ETL and transformation jobs directly in production without proper ETL Testing is a guaranteed way to have data issues flow into dashboards, ML models, and other consumers sooner or later. The most common approach to avoid making changes directly in production is to create and maintain multiple data environments and perform ETL testing on them. Dev environment to develop the data pipelines and test environment where pipeline changes are tested before pushing it to production. With lakeFS you can create branches, and get a copy of the full production data, without copying anything. This enables a faster and easier process of ETL testing.

Reproducibility Copy Section

Data changes frequently. This makes the task of keeping track of its exact state over time difficult. Oftentimes, people maintain only one state of their data––its current state.

This has a negative impact on the work, as it becomes hard to:

• Debug a data issue.
• Validate machine learning training accuracy (re-running a model over different data gives different results).
  Comply with data audits.

In comparison, lakeFS exposes a Git-like interface to data that allows keeping track of more than just the current state of data. This makes reproducing its state at any point in time straightforward.

Write-Audit-Publish Copy Section

Data pipelines feed processed data from data lakes to downstream consumers like business dashboards and machine learning models. As more and more organizations rely on data to enable business critical decisions, data reliability and trust are of paramount concern. Thus, it’s important to ensure that production data adheres to the data governance policies of businesses. These data governance requirements can be as simple as a file format validation, schema check, or an exhaustive PII(Personally Identifiable Information) data removal from all of organization’s data.

Thus, to ensure the quality and reliability at each stage of the data lifecycle, data quality gates need to be implemented. That is, we need to run quality and correctness tests on the data, and only if data governance requirements are met can the data can be published to production for business use.

Everytime there is an update to production data, the best practice would be to run tests and then publish (deploy) the data to production. With lakeFS you can create hooks that make sure that only data that passed these tests will become part of production.

Rollback Copy Section

A rollback operation is used to to fix critical data errors immediately.

What is a critical data error? Think of a situation where erroneous or misformatted data causes a signficant issue with an important service or function. In such situations, the first thing to do is stop the bleeding.

Rolling back returns data to a state in the past, before the error was present. You might not be showing all the latest data after a rollback, but at least you aren’t showing incorrect data or raising errors. Since lakeFS provides versions of the data without making copies of the data, you can time travel between versions and roll back to the version of the data before the error was presented.

Community Copy Chapter

Stay up to date and get lakeFS support via:

• Share your lakeFS experience and get support on our Slack.
• Follow us and join the conversation on Twitter.
• Learn from video tutorials on our YouTube channel.
• Read more on data versioning and other data lake best practices in our blog.
• Feel free to contact us about anything else.

More information Copy Chapter

• Read the documentation.
• See the contributing guide.
• Take a look at our roadmap to peek into the future of lakeFS.

Licensing Copy Chapter

lakeFS is completely free and open-source and licensed under the Apache 2.0 License.

Treeverse considers that any sharing of source code with an AI agent, and any output an AI agent generates based on our source code, without the appropriate notices or attribution requirements, violates the terms of the Apache 2.0 license to which this source code is subject.
We also do not consider AI provider guardrails as sufficient to prevent copyright infringement. Treeverse reserves all of its rights to pursue legal action against any party that inputs LakeFS code into an AI agent.

Who Uses lakeFS? Copy Chapter

lakeFS is used by numerous companies, including those below. If you use lakeFS and would like to be included here please open a PR.

• AirAsia
• APEX Global
• AppsFlyer
• Auburn University
• BAE Systems
• Bureau of Labor Statistics
• Cambridge Consultants
• Connor, Clark & Lunn Financial Group
• Context Labs Bv
• Daimler Truck
• Enigma
• EPCOR
• Ford Motor Company
• Generali
• Giesecke+Devrient
• greehill
• Karius
• Luxonis
• Mixpeek
• Netflix
• Paige
• PETRONAS
• Pollinate
• Proton Technologies AG
• ProtonMail
• Renaissance Computing Institute
• RHEA Group
• RMS
• Sensum
• Similarweb
• State Street Global Advisors
• Terramera
• Tredence
• Volvo Cars
• Webiks
• Windward
• Woven by Toyota

File: clients/hadoopfs/README.md Copy Chapter

lakeFS Hadoop FileSystem

An implementation of org.apache.hadoop.fs.FileSystem, the lakeFS Hadoop Filesystem allows to run Spark jobs on lakeFS with data operations performed directly on the underlying storage.
It uses the lakeFS server for metadata operations only.

Publishing Copy Chapter

Follow the HadoopFS release checklist

Building and Testing Copy Chapter

The project uses Maven.
Prerequisite: Java 8 must be installed for building and testing.

File: clients/java/docs/AbortPresignMultipartUpload.md Copy Chapter

AbortPresignMultipartUpload

Properties Copy Chapter

File: clients/java/docs/AccessKeyCredentials.md Copy Chapter

AccessKeyCredentials

Properties Copy Chapter

File: clients/java/docs/ACL.md Copy Chapter

ACL

Properties Copy Chapter

File: clients/java/docs/ActionRunList.md Copy Chapter

ActionRunList

Properties Copy Chapter

File: clients/java/docs/ActionsApi.md Copy Chapter

ActionsApi

All URIs are relative to /api/v1

**getRun**

ActionRun getRun(repository, runId).execute();

get a run

Example Copy Section

/* Detailed source-code truncated for AI context efficiency. */

Parameters Copy Section

Return type Copy Section

ActionRun

Authorization Copy Section

basic_auth, cookie_auth, oidc_auth, saml_auth, jwt_token

HTTP request headers Copy Section

• Content-Type: Not defined
• Accept: application/json

HTTP response details Copy Section

**getRunHookOutput**

File getRunHookOutput(repository, runId, hookRunId).execute();

get run hook output

Example Copy Section

/* Detailed source-code truncated for AI context efficiency. */

Parameters Copy Section

Return type Copy Section

File

Authorization Copy Section

basic_auth, cookie_auth, oidc_auth, saml_auth, jwt_token

HTTP request headers Copy Section

• Content-Type: Not defined
• Accept: application/octet-stream, application/json

HTTP response details Copy Section

**listRepositoryRuns**

ActionRunList listRepositoryRuns(repository).after(after).amount(amount).branch(branch).commit(commit).execute();

list runs

Example Copy Section

/* Detailed source-code truncated for AI context efficiency. */

Parameters Copy Section

Return type Copy Section

ActionRunList

Authorization Copy Section

basic_auth, cookie_auth, oidc_auth, saml_auth, jwt_token

HTTP request headers Copy Section

• Content-Type: Not defined
• Accept: application/json

HTTP response details Copy Section

**listRunHooks**

HookRunList listRunHooks(repository, runId).after(after).amount(amount).execute();

list run hooks

Example Copy Section

/* Detailed source-code truncated for AI context efficiency. */

Parameters Copy Section

Return type Copy Section

HookRunList

Authorization Copy Section

basic_auth, cookie_auth, oidc_auth, saml_auth, jwt_token

HTTP request headers Copy Section

• Content-Type: Not defined
• Accept: application/json

HTTP response details Copy Section