org.apache.gravitino.model

Interface ModelCatalog

@Evolving
public interface ModelCatalog

The ModelCatalog interface defines the public API for managing model objects in a schema. If the catalog implementation supports model objects, it should implement this interface.

Method Summary

Modifier and Type	Method and Description
boolean	deleteModel(NameIdentifier ident) Delete the model from the catalog.
boolean	deleteModelVersion(NameIdentifier ident, int version) Delete the model version by the NameIdentifier and version number.
boolean	deleteModelVersion(NameIdentifier ident, java.lang.String alias) Delete the model version by the NameIdentifier and version alias.
Model	getModel(NameIdentifier ident) Get a model metadata by NameIdentifier from the catalog.
ModelVersion	getModelVersion(NameIdentifier ident, int version) Get a model version by the NameIdentifier and version number from the catalog.
ModelVersion	getModelVersion(NameIdentifier ident, java.lang.String alias) Get a model version by the NameIdentifier and version alias from the catalog.
void	linkModelVersion(NameIdentifier ident, java.lang.String uri, java.lang.String[] aliases, java.lang.String comment, java.util.Map<java.lang.String,java.lang.String> properties) Link a new model version to the registered model object.
NameIdentifier[]	listModels(Namespace namespace) List the models in a schema namespace from the catalog.
int[]	listModelVersions(NameIdentifier ident) List all the versions of the register model by NameIdentifier in the catalog.
default boolean	modelExists(NameIdentifier ident) Check if a model exists using an NameIdentifier from the catalog.
default boolean	modelVersionExists(NameIdentifier ident, int version) Check if the model version exists by the NameIdentifier and version number.
default boolean	modelVersionExists(NameIdentifier ident, java.lang.String alias) Check if the model version exists by the NameIdentifier and version alias.
Model	registerModel(NameIdentifier ident, java.lang.String comment, java.util.Map<java.lang.String,java.lang.String> properties) Register a model in the catalog if the model is not existed, otherwise the ModelAlreadyExistsException will be thrown.
default Model	registerModel(NameIdentifier ident, java.lang.String uri, java.lang.String[] aliases, java.lang.String comment, java.util.Map<java.lang.String,java.lang.String> properties) Register a model in the catalog if the model is not existed, otherwise the ModelAlreadyExistsException will be thrown.

Method Detail

listModels

NameIdentifier[] listModels(Namespace namespace)
                     throws NoSuchSchemaException

List the models in a schema namespace from the catalog.

Parameters:

namespace - A schema namespace.

Returns:

An array of model identifiers in the namespace.

Throws:

NoSuchSchemaException - If the schema does not exist.

getModel

Model getModel(NameIdentifier ident)
        throws NoSuchModelException

Get a model metadata by NameIdentifier from the catalog.

Parameters:

ident - A model identifier.

Returns:

The model metadata.

Throws:

NoSuchModelException - If the model does not exist.

modelExists

default boolean modelExists(NameIdentifier ident)

Check if a model exists using an NameIdentifier from the catalog.

Parameters:

ident - A model identifier.

Returns:

true If the model exists, false if the model does not exist.

registerModel

Model registerModel(NameIdentifier ident,
                    java.lang.String comment,
                    java.util.Map<java.lang.String,java.lang.String> properties)
             throws NoSuchSchemaException,
                    ModelAlreadyExistsException

Register a model in the catalog if the model is not existed, otherwise the ModelAlreadyExistsException will be thrown. The Model object will be created when the model is registered, users can call linkModelVersion(NameIdentifier, String, String[], String, Map) to link the model version to the registered Model.

Parameters:

ident - The name identifier of the model.

comment - The comment of the model. The comment is optional and can be null.

properties - The properties of the model. The properties are optional and can be null or empty.

Returns:

The registered model object.

Throws:

NoSuchSchemaException - If the schema does not exist.

ModelAlreadyExistsException - If the model already registered.

registerModel

default Model registerModel(NameIdentifier ident,
                            java.lang.String uri,
                            java.lang.String[] aliases,
                            java.lang.String comment,
                            java.util.Map<java.lang.String,java.lang.String> properties)
                     throws NoSuchSchemaException,
                            ModelAlreadyExistsException,
                            ModelVersionAliasesAlreadyExistException

Register a model in the catalog if the model is not existed, otherwise the ModelAlreadyExistsException will be thrown. The Model object will be created when the model is registered, in the meantime, the model version (version 0) will also be created and linked to the registered model.

Parameters:

ident - The name identifier of the model.

uri - The model artifact URI.

aliases - The aliases of the model version. The aliases should be unique in this model, otherwise the ModelVersionAliasesAlreadyExistException will be thrown. The aliases are optional and can be empty. Also, be aware that the alias cannot be a number or a number string.

comment - The comment of the model. The comment is optional and can be null.

properties - The properties of the model. The properties are optional and can be null or empty.

Returns:

The registered model object.

Throws:

NoSuchSchemaException - If the schema does not exist when register a model.

ModelAlreadyExistsException - If the model already registered.

ModelVersionAliasesAlreadyExistException - If the aliases already exist in the model.

deleteModel

boolean deleteModel(NameIdentifier ident)

Delete the model from the catalog. If the model does not exist, return false. Otherwise, return true. The deletion of the model will also delete all the model versions linked to this model.

Parameters:

ident - The name identifier of the model.

Returns:

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

listModelVersions

int[] listModelVersions(NameIdentifier ident)
                 throws NoSuchModelException

List all the versions of the register model by NameIdentifier in the catalog.

Parameters:

ident - The name identifier of the model.

Returns:

An array of version numbers of the model.

Throws:

NoSuchModelException - If the model does not exist.

getModelVersion

ModelVersion getModelVersion(NameIdentifier ident,
                             int version)
                      throws NoSuchModelVersionException

Get a model version by the NameIdentifier and version number from the catalog.

Parameters:

ident - The name identifier of the model.

version - The version number of the model.

Returns:

The model version object.

Throws:

NoSuchModelVersionException - If the model version does not exist.

getModelVersion

ModelVersion getModelVersion(NameIdentifier ident,
                             java.lang.String alias)
                      throws NoSuchModelVersionException

Get a model version by the NameIdentifier and version alias from the catalog.

Parameters:

ident - The name identifier of the model.

alias - The version alias of the model.

Returns:

The model version object.

Throws:

NoSuchModelVersionException - If the model version does not exist.

modelVersionExists

default boolean modelVersionExists(NameIdentifier ident,
                                   int version)

Check if the model version exists by the NameIdentifier and version number. If the model version exists, return true, otherwise return false.

Parameters:

ident - The name identifier of the model.

version - The version number of the model.

Returns:

True if the model version exists, false if the model version does not exist.

modelVersionExists

default boolean modelVersionExists(NameIdentifier ident,
                                   java.lang.String alias)

Check if the model version exists by the NameIdentifier and version alias. If the model version exists, return true, otherwise return false.

Parameters:

ident - The name identifier of the model.

alias - The version alias of the model.

Returns:

True if the model version exists, false if the model version does not exist.

linkModelVersion

void linkModelVersion(NameIdentifier ident,
                      java.lang.String uri,
                      java.lang.String[] aliases,
                      java.lang.String comment,
                      java.util.Map<java.lang.String,java.lang.String> properties)
               throws NoSuchModelException,
                      ModelVersionAliasesAlreadyExistException

Link a new model version to the registered model object. The new model version will be added to the model object. If the model object does not exist, it will throw an exception. If the version alias already exists in the model, it will throw an exception.

Parameters:

ident - The name identifier of the model.

uri - The URI of the model version artifact.

aliases - The aliases of the model version. The aliases should be unique in this model, otherwise the ModelVersionAliasesAlreadyExistException will be thrown. The aliases are optional and can be empty. Also, be aware that the alias cannot be a number or a number string.

comment - The comment of the model version. The comment is optional and can be null.

properties - The properties of the model version. The properties are optional and can be null or empty.

Throws:

NoSuchModelException - If the model does not exist.

ModelVersionAliasesAlreadyExistException - If the aliases already exist in the model.

deleteModelVersion

boolean deleteModelVersion(NameIdentifier ident,
                           int version)

Delete the model version by the NameIdentifier and version number. If the model version does not exist, return false. If the model version is deleted, return true.

Parameters:

ident - The name identifier of the model.

version - The version number of the model.

Returns:

True if the model version is deleted, false if the model version does not exist.

deleteModelVersion

boolean deleteModelVersion(NameIdentifier ident,
                           java.lang.String alias)

Delete the model version by the NameIdentifier and version alias. If the model version does not exist, return false. If the model version is deleted, return true.

Parameters:

ident - The name identifier of the model.

alias - The version alias of the model.

Returns:

True if the model version is deleted, false if the model version does not exist.