gravitino.api.catalog_change.CatalogChange¶
- class gravitino.api.catalog_change.CatalogChange¶
Bases:
ABC
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.
- __init__()¶
Methods
__init__
()remove_property
(catalog_property)Creates a new catalog change to remove a property from the catalog.
rename
(new_name)Creates a new catalog change to rename the catalog.
set_property
(catalog_property, value)Creates a new catalog change to set the property and value for the catalog.
update_comment
(new_comment)Creates a new catalog change to update the catalog comment.
- class RemoveProperty(catalog_property)¶
Bases:
object
A catalog change to remove a property from the catalog.
- get_property()¶
Retrieves the name of the property to be removed from the catalog.
- Returns:
The name of the property for removal.
- class RenameCatalog(new_name)¶
Bases:
object
A catalog change to rename the catalog.
- new_name()¶
Retrieves the new name set for the catalog.
- Returns:
The new name of the catalog.
- class SetProperty(catalog_property, value)¶
Bases:
object
A catalog change to set the property and value for the catalog.
- property()¶
Retrieves the name of the property being set in the catalog.
- Returns:
The name of the property.
- value()¶
Retrieves the value assigned to the property in the catalog.
- Returns:
The value of the property.
- class UpdateCatalogComment(new_comment)¶
Bases:
object
A catalog change to update the catalog comment.
- new_comment()¶
Retrieves the new comment intended for the catalog.
- Returns:
The new comment that has been set for the catalog.
- static remove_property(catalog_property)¶
Creates a new catalog change to remove a property from the catalog.
- Args:
catalog_property: The property name to remove.
- Returns:
The catalog change.
- static rename(new_name)¶
Creates a new catalog change to rename the catalog.
- Args:
new_name: The new name of the catalog.
- Returns:
The catalog change.
- static set_property(catalog_property, value)¶
Creates a new catalog change to set the property and value for the catalog.
- Args:
catalog_property: The property name to set. value: The value to set the property to.
- Returns:
The catalog change.
- static update_comment(new_comment)¶
Creates a new catalog change to update the catalog comment.
- Args:
new_comment: The new comment for the catalog.
- Returns:
The catalog change.