-
Notifications
You must be signed in to change notification settings - Fork 382
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Browse files
Browse the repository at this point in the history
) ### What changes were proposed in this pull request? Add register and link commands to CLI for model - register a model：`model create` - link a model：`model update <—uri uri> [--alias aliaA aliaB]` meantime, add two options - `—uri` ：The URI of the model version artifact. - `—alias` ：The aliases of the model version. The documentation will be updated after #6047 merge and I will create a new issue. ### Why are the changes needed? Fix: #5960 ### Does this PR introduce _any_ user-facing change? NO ### How was this patch tested? #### register test ```bash # register a model gcli model create -m demo_metalake --name Hive_catalog.default.model # register a model with comment gcli model create -m demo_metalake --name Hive_catalog.default.model --comment comment # register a model with properties gcli model create -m demo_metalake --name Hive_catalog.default.model --properties key1=val1 key2=val2 # register a model with properties and comment gcli model create -m demo_metalake --name Hive_catalog.default.model --properties key1=val1 klinkey2=val2 --comment comment ``` #### link test ```bash # link a model gcli model update -m demo_metalake --name Hive_catalog.default.model --uri file:///tmp/file # link a model with alias gcli model update -m demo_metalake --name Hive_catalog.default.model --uri file:///tmp/file --alias aliasA aliasB # link a model with all component gcli model update -m demo_metalake --name Hive_catalog.default.model --uri file:///tmp/file --alias aliasA aliasB --comment comment --properties key1=val1 key2=val2 # link a model without uri gcli model update -m demo_metalake --name Hive_catalog.default.model ```
- Loading branch information
1 parent
e98498e
commit bfb8568
Showing
7 changed files
with
564 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
106 changes: 106 additions & 0 deletions
106
clients/cli/src/main/java/org/apache/gravitino/cli/commands/LinkModel.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,106 @@ | ||
| /* | ||
| * Licensed to the Apache Software Foundation (ASF) under one | ||
| * or more contributor license agreements. See the NOTICE file | ||
| * distributed with this work for additional information | ||
| * regarding copyright ownership. The ASF licenses this file | ||
| * to you under the Apache License, Version 2.0 (the | ||
| * "License"); you may not use this file except in compliance | ||
| * with the License. You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, | ||
| * software distributed under the License is distributed on an | ||
| * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | ||
| * KIND, either express or implied. See the License for the | ||
| * specific language governing permissions and limitations | ||
| * under the License. | ||
| */ | ||
| package org.apache.gravitino.cli.commands; | ||
|
|
||
| /** Link a new model version to the registered model. */ | ||
| import java.util.Arrays; | ||
| import java.util.Map; | ||
| import org.apache.gravitino.NameIdentifier; | ||
| import org.apache.gravitino.cli.ErrorMessages; | ||
| import org.apache.gravitino.client.GravitinoClient; | ||
| import org.apache.gravitino.exceptions.ModelVersionAliasesAlreadyExistException; | ||
| import org.apache.gravitino.exceptions.NoSuchCatalogException; | ||
| import org.apache.gravitino.exceptions.NoSuchMetalakeException; | ||
| import org.apache.gravitino.exceptions.NoSuchModelException; | ||
| import org.apache.gravitino.exceptions.NoSuchSchemaException; | ||
| import org.apache.gravitino.model.ModelCatalog; | ||
|
|
||
| public class LinkModel extends Command { | ||
| protected final String metalake; | ||
| protected final String catalog; | ||
| protected final String schema; | ||
| protected final String model; | ||
| protected final String uri; | ||
| protected final String[] alias; | ||
| protected final String comment; | ||
| protected final Map<String, String> properties; | ||
|
|
||
| /** | ||
| * Link a new model version to the registered model. | ||
| * | ||
| * @param url The URL of the Gravitino server. | ||
| * @param ignoreVersions If true don't check the client/server versions match. | ||
| * @param metalake The name of the metalake. | ||
| * @param catalog The name of the catalog. | ||
| * @param schema The name of schema. | ||
| * @param model The name of model. | ||
| * @param uri The URI of the model version artifact. | ||
| * @param alias The aliases of the model version. | ||
| * @param comment The comment of the model version. | ||
| * @param properties The properties of the model version. | ||
| */ | ||
| public LinkModel( | ||
| String url, | ||
| boolean ignoreVersions, | ||
| String metalake, | ||
| String catalog, | ||
| String schema, | ||
| String model, | ||
| String uri, | ||
| String[] alias, | ||
| String comment, | ||
| Map<String, String> properties) { | ||
| super(url, ignoreVersions); | ||
| this.metalake = metalake; | ||
| this.catalog = catalog; | ||
| this.schema = schema; | ||
| this.model = model; | ||
| this.uri = uri; | ||
| this.alias = alias; | ||
| this.comment = comment; | ||
| this.properties = properties; | ||
| } | ||
|
|
||
| /** Link a new model version to the registered model. */ | ||
| @Override | ||
| public void handle() { | ||
| NameIdentifier name = NameIdentifier.of(schema, model); | ||
|
|
||
| try { | ||
| GravitinoClient client = buildClient(metalake); | ||
| ModelCatalog modelCatalog = client.loadCatalog(catalog).asModelCatalog(); | ||
| modelCatalog.linkModelVersion(name, uri, alias, comment, properties); | ||
| } catch (NoSuchMetalakeException err) { | ||
| exitWithError(ErrorMessages.UNKNOWN_METALAKE); | ||
| } catch (NoSuchCatalogException err) { | ||
| exitWithError(ErrorMessages.UNKNOWN_CATALOG); | ||
| } catch (NoSuchSchemaException err) { | ||
| exitWithError(ErrorMessages.UNKNOWN_SCHEMA); | ||
| } catch (NoSuchModelException err) { | ||
| exitWithError(ErrorMessages.UNKNOWN_MODEL); | ||
| } catch (ModelVersionAliasesAlreadyExistException err) { | ||
| exitWithError(Arrays.toString(alias) + " already exist."); | ||
| } catch (Exception err) { | ||
| exitWithError(err.getMessage()); | ||
| } | ||
|
|
||
| System.out.println( | ||
| "Linked model " + model + " to " + uri + " with aliases " + Arrays.toString(alias)); | ||
| } | ||
| } |
103 changes: 103 additions & 0 deletions
103
clients/cli/src/main/java/org/apache/gravitino/cli/commands/RegisterModel.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,103 @@ | ||
| /* | ||
| * Licensed to the Apache Software Foundation (ASF) under one | ||
| * or more contributor license agreements. See the NOTICE file | ||
| * distributed with this work for additional information | ||
| * regarding copyright ownership. The ASF licenses this file | ||
| * to you under the Apache License, Version 2.0 (the | ||
| * "License"); you may not use this file except in compliance | ||
| * with the License. You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, | ||
| * software distributed under the License is distributed on an | ||
| * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | ||
| * KIND, either express or implied. See the License for the | ||
| * specific language governing permissions and limitations | ||
| * under the License. | ||
| */ | ||
|
|
||
| package org.apache.gravitino.cli.commands; | ||
|
|
||
| import java.util.Map; | ||
| import org.apache.gravitino.NameIdentifier; | ||
| import org.apache.gravitino.cli.ErrorMessages; | ||
| import org.apache.gravitino.cli.Main; | ||
| import org.apache.gravitino.client.GravitinoClient; | ||
| import org.apache.gravitino.exceptions.ModelAlreadyExistsException; | ||
| import org.apache.gravitino.exceptions.NoSuchCatalogException; | ||
| import org.apache.gravitino.exceptions.NoSuchMetalakeException; | ||
| import org.apache.gravitino.exceptions.NoSuchSchemaException; | ||
| import org.apache.gravitino.model.Model; | ||
| import org.apache.gravitino.model.ModelCatalog; | ||
|
|
||
| /** Register a model in the catalog */ | ||
| public class RegisterModel extends Command { | ||
|
|
||
| protected final String metalake; | ||
| protected final String catalog; | ||
| protected final String schema; | ||
| protected final String model; | ||
| protected final String comment; | ||
| protected final Map<String, String> properties; | ||
|
|
||
| /** | ||
| * Register a model in the catalog | ||
| * | ||
| * @param url The URL of the Gravitino server. | ||
| * @param ignoreVersions If true don't check the client/server versions match. | ||
| * @param metalake The name of the metalake. | ||
| * @param catalog The name of the catalog. | ||
| * @param schema The name of schema. | ||
| * @param model The name of model. | ||
| * @param comment The comment of the model version. | ||
| * @param properties The properties of the model version. | ||
| */ | ||
| public RegisterModel( | ||
| String url, | ||
| boolean ignoreVersions, | ||
| String metalake, | ||
| String catalog, | ||
| String schema, | ||
| String model, | ||
| String comment, | ||
| Map<String, String> properties) { | ||
| super(url, ignoreVersions); | ||
| this.metalake = metalake; | ||
| this.catalog = catalog; | ||
| this.schema = schema; | ||
| this.model = model; | ||
| this.comment = comment; | ||
| this.properties = properties; | ||
| } | ||
|
|
||
| /** Register a model in the catalog */ | ||
| @Override | ||
| public void handle() { | ||
| NameIdentifier name = NameIdentifier.of(schema, model); | ||
| Model registeredModel = null; | ||
|
|
||
| try { | ||
| GravitinoClient client = buildClient(metalake); | ||
| ModelCatalog modelCatalog = client.loadCatalog(catalog).asModelCatalog(); | ||
| registeredModel = modelCatalog.registerModel(name, comment, properties); | ||
| } catch (NoSuchMetalakeException err) { | ||
| exitWithError(ErrorMessages.UNKNOWN_METALAKE); | ||
| } catch (NoSuchCatalogException err) { | ||
| exitWithError(ErrorMessages.UNKNOWN_CATALOG); | ||
| } catch (NoSuchSchemaException err) { | ||
| exitWithError(ErrorMessages.UNKNOWN_SCHEMA); | ||
| } catch (ModelAlreadyExistsException err) { | ||
| exitWithError(ErrorMessages.MODEL_EXISTS); | ||
| } catch (Exception err) { | ||
| exitWithError(err.getMessage()); | ||
| } | ||
|
|
||
| if (registeredModel != null) { | ||
| System.out.println("Successful register " + registeredModel.name() + "."); | ||
| } else { | ||
| System.err.println("Failed to register model: " + model + "."); | ||
| Main.exit(-1); | ||
| } | ||
| } | ||
| } |
Oops, something went wrong.