org.apache.gravitino

Interface CatalogChange

All Known Implementing Classes:

CatalogChange.RemoveProperty, CatalogChange.RenameCatalog, CatalogChange.SetProperty, CatalogChange.UpdateCatalogComment

@Evolving
public interface CatalogChange

A catalog change is a change to a catalog. It can be used to rename a catalog, update the comment of a catalog, set a property and value pair for a catalog, or remove a property from a catalog.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CatalogChange.RemoveProperty A catalog change to remove a property from the catalog.
static class	CatalogChange.RenameCatalog A catalog change to rename the catalog.
static class	CatalogChange.SetProperty A catalog change to set the property and value for the catalog.
static class	CatalogChange.UpdateCatalogComment A catalog change to update the catalog comment.

Method Summary

Modifier and Type	Method and Description
static CatalogChange	removeProperty(java.lang.String property) Creates a new catalog change to remove a property from the catalog.
static CatalogChange	rename(java.lang.String newName) Creates a new catalog change to rename the catalog.
static CatalogChange	setProperty(java.lang.String property, java.lang.String value) Creates a new catalog change to set the property and value for the catalog.
static CatalogChange	updateComment(java.lang.String newComment) Creates a new catalog change to update the catalog comment.

Method Detail

rename

static CatalogChange rename(java.lang.String newName)

Creates a new catalog change to rename the catalog.

Parameters:

newName - The new name of the catalog.

Returns:

The catalog change.

updateComment

static CatalogChange updateComment(java.lang.String newComment)

Creates a new catalog change to update the catalog comment.

Parameters:

newComment - The new comment for the catalog.

Returns:

The catalog change.

setProperty

static CatalogChange setProperty(java.lang.String property,
                                 java.lang.String value)

Creates a new catalog change to set the property and value for the catalog.

Parameters:

property - The property name to set.

value - The value to set the property to.

Returns:

The catalog change.

removeProperty

static CatalogChange removeProperty(java.lang.String property)

Creates a new catalog change to remove a property from the catalog.

Parameters:

property - The property name to remove.

Returns:

The catalog change.