lakefs.tag module

Module containing lakeFS tag implementation

class lakefs.tag.Tag(repository_id, tag_id, client=None)

Bases: Reference

Class representing a tag in lakeFS.

create(source_ref, exist_ok=False, **kwargs)

Create a tag from the given source_ref

Parameters:

• source_ref (Union[str, Reference, Commit]) – The reference to create the tag on (either ID or Reference object)

• exist_ok (Optional[bool]) – If True returns the existing Tag reference otherwise raises exception

• kwargs – Additional Keyword Arguments to send to the server

Return type:

Tag

Returns:

A lakeFS SDK Tag object

Raises:

• NotAuthorizedException – if user is not authorized to perform this operation

• NotFoundException – if source_ref_id doesn’t exist on the lakeFS server

• ServerException – for any other errors.

delete(**kwargs)

Delete the tag from the lakeFS server

Parameters:

kwargs – Additional Keyword Arguments to send to the server

Raises:

• NotAuthorizedException – if user is not authorized to perform this operation

• NotFoundException – if source_ref_id doesn’t exist on the lakeFS server

• ServerException – for any other errors

Return type:

None