lakeFS SDK

1.80.0 · active · verified Sat Apr 11

The `lakefs-sdk` is the low-level Python client for interacting with the lakeFS API. It provides direct access based on the OpenAPI specification, offering full control over API interactions. It is distinct from the higher-level `lakefs` SDK, which provides a more Pythonic interface for common operations. The library is actively maintained with frequent releases, currently at version 1.80.0.

Warnings

breaking The `lakefs-client` package is deprecated as of lakeFS 1.0 (last release v1.44.0) and is no longer supported for new updates or features. Users should migrate to `lakefs-sdk` (for low-level API access) or the higher-level `lakefs` package.
Fix: Replace `lakefs-client` imports and usage with `lakefs_sdk` or `lakefs`. Refer to the 'Migrating to 1.0' guide for specific code changes.
gotcha There are two main Python SDKs for lakeFS: `lakefs-sdk` (low-level, auto-generated, direct API calls) and `lakefs` (high-level, Pythonic interface for common operations like branches, commits, objects, transactions). Choosing the wrong SDK can lead to more complex code than necessary for common tasks.
Fix: For most common lakeFS operations, the `lakefs` (high-level) SDK is recommended for its simpler interface. Use `lakefs-sdk` when you need full control over API requests or features not exposed by the high-level SDK.
breaking Migrating to lakeFS 1.0 and the `lakefs-sdk` from older `lakefs-client` versions involved API changes, such as renaming the `model` module to `models` and `apis` to `api`. Also, fetching results from response objects changed from dictionary-like access (`get_property`) to direct attribute access (`prop_name`).
Fix: Update import paths (e.g., `lakefs_client.model` to `lakefs_sdk.models`, `lakefs_client.apis` to `lakefs_sdk.apis`) and adapt result parsing to use direct object attributes instead of `get_property`.
gotcha The `lakefs-sdk` requires explicit configuration of host and credentials. Unlike the higher-level `lakefs` SDK, it does not automatically infer identity from environment variables (`LAKEFS_ACCESS_KEY_ID`, `LAKEFS_SECRET_ACCESS_KEY`, `LAKEFS_SERVER_ENDPOINT_URL`) or a local `.lakectl.yaml` file without explicit handling.
Fix: Always explicitly pass `host`, `username`, and `password` to `lakefs_sdk.Configuration`. Use `os.environ.get()` to read credentials from environment variables if desired.
deprecated OpenID Connect (OIDC) support for authentication via older configuration methods is deprecated. For single sign-on (SSO) or short-lived token (STS-like) authentication, users should consider lakeFS Cloud or Enterprise features.
Fix: Refer to the latest lakeFS documentation on 'Short-Lived Tokens (STS)' and 'Authentication' for current recommended patterns for SSO and temporary credential usage.

Install

pip install lakefs-sdk Install stable version

Imports

Configuration
```
from lakefs_sdk import Configuration
```
Used to configure the API client with host and credentials.
ApiClient
```
from lakefs_sdk import ApiClient
```
Initializes the API client using the configured settings.
RepositoriesApi
```
from lakefs_sdk.apis import RepositoriesApi
```
Example for accessing repository-related API endpoints. Other API groups (e.g., `BranchesApi`, `ObjectsApi`) are accessed similarly.
ApiException
```
from lakefs_sdk.rest import ApiException
```
Common exception class for API errors.
lakefs_client
```
from lakefs_sdk import Configuration, ApiClient
```
The `lakefs-client` package is deprecated and no longer supported for new updates or features. Migrate to `lakefs-sdk` for low-level access or `lakefs` for high-level operations.

Quickstart

This quickstart demonstrates how to configure the `lakefs-sdk` client using environment variables and then list all available repositories. Ensure `LAKEFS_SERVER_ENDPOINT_URL`, `LAKEFS_ACCESS_KEY_ID`, and `LAKEFS_SECRET_ACCESS_KEY` are set in your environment.

import os
import lakefs_sdk
from lakefs_sdk.apis import RepositoriesApi
from lakefs_sdk.rest import ApiException

# Configure API client with credentials from environment variables
configuration = lakefs_sdk.Configuration(
    host=os.environ.get('LAKEFS_SERVER_ENDPOINT_URL', 'https://example.lakefs.io/api/v1'),
    username=os.environ.get('LAKEFS_ACCESS_KEY_ID', ''),
    password=os.environ.get('LAKEFS_SECRET_ACCESS_KEY', '')
)

# Create an API client instance
with lakefs_sdk.ApiClient(configuration) as api_client:
    # Create an instance of the Repositories API
    repositories_api = RepositoriesApi(api_client)

    try:
        # List repositories
        repos = repositories_api.list_repositories()
        print("Successfully connected to lakeFS!")
        print("Repositories:")
        for repo in repos.results:
            print(f"- {repo.id}")
    except ApiException as e:
        print(f"Error connecting to lakeFS or listing repositories: {e}")
        print("Ensure LAKEFS_SERVER_ENDPOINT_URL, LAKEFS_ACCESS_KEY_ID, and LAKEFS_SECRET_ACCESS_KEY are set.")

view raw JSON →