org.apache.gravitino.tag

Interface TagOperations

All Known Implementing Classes:

GravitinoClient, GravitinoMetalake

@Evolving
public interface TagOperations

Interface for supporting global tag operations. This interface will provide tag listing, getting, creating, and other tag operations under a metalake. This interface will be mixed with GravitinoMetalake or GravitinoClient to provide tag operations.

Method Summary

Modifier and Type	Method and Description
Tag	alterTag(java.lang.String name, TagChange... changes) Alter a tag under a metalake.
Tag	createTag(java.lang.String name, java.lang.String comment, java.util.Map<java.lang.String,java.lang.String> properties) Create a tag under a metalake.
boolean	deleteTag(java.lang.String name) Delete a tag under a metalake.
Tag	getTag(java.lang.String name) Get a tag by its name under a metalake.
java.lang.String[]	listTags() List all the tag names under a metalake.
Tag[]	listTagsInfo() List all the tags with detailed information under a metalake.

Method Detail

listTags

java.lang.String[] listTags()
                     throws NoSuchMetalakeException

List all the tag names under a metalake.

Returns:

The list of tag names.

Throws:

NoSuchMetalakeException - If the metalake does not exist.

listTagsInfo

Tag[] listTagsInfo()
            throws NoSuchMetalakeException

List all the tags with detailed information under a metalake.

Returns:

The list of tags.

Throws:

NoSuchMetalakeException - If the metalake does not exist.

getTag

Tag getTag(java.lang.String name)
    throws NoSuchTagException

Get a tag by its name under a metalake.

Parameters:

name - The name of the tag.

Returns:

The tag.

Throws:

NoSuchTagException - If the tag does not exist.

createTag

Tag createTag(java.lang.String name,
              java.lang.String comment,
              java.util.Map<java.lang.String,java.lang.String> properties)
       throws TagAlreadyExistsException

Create a tag under a metalake.

Parameters:

name - The name of the tag.

comment - The comment of the tag.

properties - The properties of the tag.

Returns:

The created tag.

Throws:

TagAlreadyExistsException - If the tag already exists.

alterTag

Tag alterTag(java.lang.String name,
             TagChange... changes)
      throws NoSuchTagException,
             java.lang.IllegalArgumentException

Alter a tag under a metalake.

Parameters:

name - The name of the tag.

changes - The changes to apply to the tag.

Returns:

The altered tag.

Throws:

NoSuchTagException - If the tag does not exist.

java.lang.IllegalArgumentException - If the changes cannot be applied to the tag.

deleteTag

boolean deleteTag(java.lang.String name)

Delete a tag under a metalake.

Parameters:

name - The name of the tag.

Returns:

True if the tag is deleted, false if the tag does not exist.