View on GitHub

lakeFS

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

lakefs_client.OtfDiffApi

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

Method	HTTP request	Description
get_otf_diffs	GET /otf/diffs	get the available Open Table Format diffs
otf_diff	GET /repositories/{repository}/otf/refs/{left_ref}/diff/{right_ref}	perform otf diff

get_otf_diffs

OTFDiffs get_otf_diffs()

get the available Open Table Format diffs

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 otf_diff_api
from lakefs_client.model.error import Error
from lakefs_client.model.otf_diffs import OTFDiffs
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 = otf_diff_api.OtfDiffApi(api_client)

    # example, this endpoint has no required or optional parameters
    try:
        # get the available Open Table Format diffs
        api_response = api_instance.get_otf_diffs()
        pprint(api_response)
    except lakefs_client.ApiException as e:
        print("Exception when calling OtfDiffApi->get_otf_diffs: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

OTFDiffs

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	available Open Table Format diffs	-
401	Unauthorized	-
0	Internal Server Error	-

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

otf_diff

OtfDiffList otf_diff(repository, left_ref, right_ref, table_path, type)

perform otf diff

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 otf_diff_api
from lakefs_client.model.otf_diff_list import OtfDiffList
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 = otf_diff_api.OtfDiffApi(api_client)
    repository = "repository_example" # str | 
    left_ref = "left_ref_example" # str | 
    right_ref = "right_ref_example" # str | 
    table_path = "table_path_example" # str | a path to the table location under the specified ref.
    type = "type_example" # str | the type of otf

    # example passing only required values which don't have defaults set
    try:
        # perform otf diff
        api_response = api_instance.otf_diff(repository, left_ref, right_ref, table_path, type)
        pprint(api_response)
    except lakefs_client.ApiException as e:
        print("Exception when calling OtfDiffApi->otf_diff: %s\n" % e)

Parameters

Name	Type	Description
repository	str
left_ref	str
right_ref	str
table_path	str	a path to the table location under the specified ref.
type	str	the type of otf

Return type

OtfDiffList

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	diff list	-
401	Unauthorized	-
404	Resource Not Found	-
412	Precondition Failed	-
0	Internal Server Error	-

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