View on GitHub

lakeFS

lakeFS - Data version control for your data lake | Git for data

lakefs_client.StagingApi

All URIs are relative to http://localhost/api/v1

Method	HTTP request	Description
get_physical_address	GET /repositories/{repository}/branches/{branch}/staging/backing	get a physical address and a return token to write object to underlying storage
link_physical_address	PUT /repositories/{repository}/branches/{branch}/staging/backing	associate staging on this physical address with a path

get_physical_address

StagingLocation get_physical_address(repository, branch, path)

get a physical address and a return token to write object to underlying storage

Example

Basic Authentication (basic_auth):
Api Key Authentication (cookie_auth):
Bearer (JWT) Authentication (jwt_token):
Api Key Authentication (oidc_auth):
Api Key Authentication (saml_auth):

import time
import lakefs_client
from lakefs_client.api import staging_api
from lakefs_client.model.staging_location import StagingLocation
from lakefs_client.model.error import Error
from pprint import pprint
# Defining the host is optional and defaults to http://localhost/api/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = lakefs_client.Configuration(
    host = "http://localhost/api/v1"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure HTTP basic authorization: basic_auth
configuration = lakefs_client.Configuration(
    username = 'YOUR_USERNAME',
    password = 'YOUR_PASSWORD'
)

# Configure API key authorization: cookie_auth
configuration.api_key['cookie_auth'] = 'YOUR_API_KEY'

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['cookie_auth'] = 'Bearer'

# Configure Bearer authorization (JWT): jwt_token
configuration = lakefs_client.Configuration(
    access_token = 'YOUR_BEARER_TOKEN'
)

# Configure API key authorization: oidc_auth
configuration.api_key['oidc_auth'] = 'YOUR_API_KEY'

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['oidc_auth'] = 'Bearer'

# Configure API key authorization: saml_auth
configuration.api_key['saml_auth'] = 'YOUR_API_KEY'

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['saml_auth'] = 'Bearer'

# Enter a context with an instance of the API client
with lakefs_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = staging_api.StagingApi(api_client)
    repository = "repository_example" # str | 
    branch = "branch_example" # str | 
    path = "path_example" # str | relative to the branch
    presign = True # bool |  (optional)

    # example passing only required values which don't have defaults set
    try:
        # get a physical address and a return token to write object to underlying storage
        api_response = api_instance.get_physical_address(repository, branch, path)
        pprint(api_response)
    except lakefs_client.ApiException as e:
        print("Exception when calling StagingApi->get_physical_address: %s\n" % e)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # get a physical address and a return token to write object to underlying storage
        api_response = api_instance.get_physical_address(repository, branch, path, presign=presign)
        pprint(api_response)
    except lakefs_client.ApiException as e:
        print("Exception when calling StagingApi->get_physical_address: %s\n" % e)

Parameters

Name	Type	Description	Notes
repository	str
branch	str
path	str	relative to the branch
presign	bool		[optional]

Return type

StagingLocation

Authorization

basic_auth, cookie_auth, jwt_token, oidc_auth, saml_auth

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	physical address for staging area	-
401	Unauthorized	-
404	Resource Not Found	-
0	Internal Server Error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

link_physical_address

ObjectStats link_physical_address(repository, branch, path, staging_metadata)

associate staging on this physical address with a path

If the supplied token matches the current staging token, associate the object as the physical address with the supplied path. Otherwise, if staging has been committed and the token has expired, return a conflict and hint where to place the object to try again. Caller should copy the object to the new physical address and PUT again with the new staging token. (No need to back off, this is due to losing the race against a concurrent commit operation.)