Re: [PR] [doc] Revise the CLI documentation [gravitino]
tengqm commented on PR #5840: URL: https://github.com/apache/gravitino/pull/5840#issuecomment-2865096914 superceded by #7111 -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
Re: [PR] [doc] Revise the CLI documentation [gravitino]
tengqm closed pull request #5840: [doc] Revise the CLI documentation URL: https://github.com/apache/gravitino/pull/5840 -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
Re: [PR] [doc] Revise the CLI documentation [gravitino]
justinmclean commented on code in PR #5840: URL: https://github.com/apache/gravitino/pull/5840#discussion_r1881973909 ## docs/cli.md: ## @@ -152,710 +163,464 @@ keytabFile=file.keytab ### Potentially unsafe operations -For operations that delete data or rename a metalake the user with be prompted to make sure they wish to run this command. The `--force` option can be specified to override this behaviour. +For operations that delete data or rename a metalake, the users will be prompted to +make sure they wish to run this command. +The `--force` option can be specified to override this behaviour. ### Manage metadata All the commands are performed by using the [Java API](api/java-api) internally. -### Display help +### Show help -To display help on command usage: +To view the help on command usage: ```bash gcli --help ``` -### Display client version +### Show version -To display the client version: +`gcli --version` +: Show the client version. -```bash -gcli --version -``` +`gcli --server` +: Show the server version. -### Display server version +:::note +**Client/server version mismatch** -To display the server version: +If the client and server are running different versions of the Gravitino software, +you may need to ignore the client/server version check for the command to be run. +This can be done in several ways: -```bash -gcli --server -``` - -### Client/server version mismatch - -If the client and server are running different versions of the Gravitino software then you may need to ignore the client/server version check for the command to run. This can be done in several ways: - -1. Passed in on the command line via the `--ignore` parameter. -2. Set via the `GRAVITINO_IGNORE` environment variable. -3. Stored in the Gravitino CLI configuration file. +1. Specify the `--ignore` argument in the command line. +1. Set the `GRAVITINO_IGNORE` environment variable. +1. Save it in the Gravitino CLI configuration file. +::: ### Multiple properties For commands that accept multiple properties they can be specified in a couple of different ways: -1. gcli --properties n1=v1,n2=v2,n3=v3 - -2. gcli --properties n1=v1 n2=v2 n3=v3 - -3. gcli --properties n1=v1 --properties n2=v2 --properties n3=v3 +1. `gcli --properties n1=v1,n2=v2,n3=v3` +2. `gcli --properties n1=v1 n2=v2 n3=v3` +3. `gcli --properties n1=v1 --properties n2=v2 --properties n3=v3` ### Setting properties and tags - Different options are needed to add a tag and set a property of a tag with `gcli tag set`. To add a - tag, specify the tag (via --tag) and the entity to tag (via --name). To set the property of a tag - (via --tag) you need to specify the property (via --property) and value (via --value) you want to - set. +Different options are needed to add a tag or to set a property for a tag using `gcli tag set`. +To add a tag, specify the tag (via `--tag`) and the entity to tag (via `--name`). +To set the property of a tag (via `--tag`) you need to specify the property (via `--property`) +and value (via `--value`) you want to set. - To delete a tag, again, you need to specify the tag and entity, to remove a tag's property you need - to select the tag and property. +To delete a tag, again, you need to specify the tag and the entity; to remove a tag's property, +you need to select the tag and property. -### CLI commands +## Command examples -Please set the metalake in the Gravitino configuration file or the environment variable before running any of these commands. +Please set the metalake in the Gravitino configuration file or the environment variable before +running any of these commands. ### Metalake commands - Show all metalakes +`gcli metalake create --metalake --comment ` +: Create a metalake. -```bash -gcli metalake list -``` +`gcli metalake properties` +: Show the properties for a metalake. - Show a metalake details +`gcli metalake delete` +: Delete a metalake. -```bash -gcli metalake details -``` +`gcli metalake list` +: List all metalakes - Show a metalake audit information +`gcli metalake details` +: Check the details of a specific a metalake. -```bash -gcli metalake details --audit -``` - - Create a metalake - -```bash -gcli metalake create --metalake my_metalake --comment "This is my metalake" -``` - - Delete a metalake - -```bash -gcli metalake delete -``` +`gcli metalake details --audit` +: Show the audit information for a metalake - Rename a metalake +`gcli metalake update --rename ` +: Rename a metalake -```bash -gcli metalake update --rename demo -``` +`gcli metalake update --comment ""` +: Update the comment for a metalake - Update a metalake's comment +`gcli metalake set --property --value ` +: Set the property for a metalake. -```bash -gcli metalake update --comment "new comment" -``` - - Display a metalake's properties - -```bash -gcli metalake properties -``` - - Set a metalake's property
Re: [PR] [doc] Revise the CLI documentation [gravitino]
tengqm commented on code in PR #5840: URL: https://github.com/apache/gravitino/pull/5840#discussion_r1881742453 ## docs/cli.md: ## @@ -152,710 +163,464 @@ keytabFile=file.keytab ### Potentially unsafe operations -For operations that delete data or rename a metalake the user with be prompted to make sure they wish to run this command. The `--force` option can be specified to override this behaviour. +For operations that delete data or rename a metalake, the users will be prompted to +make sure they wish to run this command. +The `--force` option can be specified to override this behaviour. ### Manage metadata All the commands are performed by using the [Java API](api/java-api) internally. -### Display help +### Show help -To display help on command usage: +To view the help on command usage: ```bash gcli --help ``` -### Display client version +### Show version -To display the client version: +`gcli --version` +: Show the client version. -```bash -gcli --version -``` +`gcli --server` +: Show the server version. -### Display server version +:::note +**Client/server version mismatch** -To display the server version: +If the client and server are running different versions of the Gravitino software, +you may need to ignore the client/server version check for the command to be run. +This can be done in several ways: -```bash -gcli --server -``` - -### Client/server version mismatch - -If the client and server are running different versions of the Gravitino software then you may need to ignore the client/server version check for the command to run. This can be done in several ways: - -1. Passed in on the command line via the `--ignore` parameter. -2. Set via the `GRAVITINO_IGNORE` environment variable. -3. Stored in the Gravitino CLI configuration file. +1. Specify the `--ignore` argument in the command line. +1. Set the `GRAVITINO_IGNORE` environment variable. +1. Save it in the Gravitino CLI configuration file. +::: ### Multiple properties For commands that accept multiple properties they can be specified in a couple of different ways: -1. gcli --properties n1=v1,n2=v2,n3=v3 - -2. gcli --properties n1=v1 n2=v2 n3=v3 - -3. gcli --properties n1=v1 --properties n2=v2 --properties n3=v3 +1. `gcli --properties n1=v1,n2=v2,n3=v3` +2. `gcli --properties n1=v1 n2=v2 n3=v3` +3. `gcli --properties n1=v1 --properties n2=v2 --properties n3=v3` ### Setting properties and tags - Different options are needed to add a tag and set a property of a tag with `gcli tag set`. To add a - tag, specify the tag (via --tag) and the entity to tag (via --name). To set the property of a tag - (via --tag) you need to specify the property (via --property) and value (via --value) you want to - set. +Different options are needed to add a tag or to set a property for a tag using `gcli tag set`. +To add a tag, specify the tag (via `--tag`) and the entity to tag (via `--name`). +To set the property of a tag (via `--tag`) you need to specify the property (via `--property`) +and value (via `--value`) you want to set. - To delete a tag, again, you need to specify the tag and entity, to remove a tag's property you need - to select the tag and property. +To delete a tag, again, you need to specify the tag and the entity; to remove a tag's property, +you need to select the tag and property. -### CLI commands +## Command examples -Please set the metalake in the Gravitino configuration file or the environment variable before running any of these commands. +Please set the metalake in the Gravitino configuration file or the environment variable before +running any of these commands. ### Metalake commands - Show all metalakes +`gcli metalake create --metalake --comment ` +: Create a metalake. -```bash -gcli metalake list -``` +`gcli metalake properties` +: Show the properties for a metalake. - Show a metalake details +`gcli metalake delete` +: Delete a metalake. -```bash -gcli metalake details -``` +`gcli metalake list` +: List all metalakes - Show a metalake audit information +`gcli metalake details` +: Check the details of a specific a metalake. -```bash -gcli metalake details --audit -``` - - Create a metalake - -```bash -gcli metalake create --metalake my_metalake --comment "This is my metalake" -``` - - Delete a metalake - -```bash -gcli metalake delete -``` +`gcli metalake details --audit` +: Show the audit information for a metalake - Rename a metalake +`gcli metalake update --rename ` +: Rename a metalake -```bash -gcli metalake update --rename demo -``` +`gcli metalake update --comment ""` +: Update the comment for a metalake - Update a metalake's comment +`gcli metalake set --property --value ` +: Set the property for a metalake. -```bash -gcli metalake update --comment "new comment" -``` - - Display a metalake's properties - -```bash -gcli metalake properties -``` - - Set a metalake's property - -```
Re: [PR] [doc] Revise the CLI documentation [gravitino]
justinmclean commented on code in PR #5840: URL: https://github.com/apache/gravitino/pull/5840#discussion_r1881468117 ## docs/cli.md: ## @@ -152,710 +163,464 @@ keytabFile=file.keytab ### Potentially unsafe operations -For operations that delete data or rename a metalake the user with be prompted to make sure they wish to run this command. The `--force` option can be specified to override this behaviour. +For operations that delete data or rename a metalake, the users will be prompted to +make sure they wish to run this command. +The `--force` option can be specified to override this behaviour. ### Manage metadata All the commands are performed by using the [Java API](api/java-api) internally. -### Display help +### Show help -To display help on command usage: +To view the help on command usage: ```bash gcli --help ``` -### Display client version +### Show version -To display the client version: +`gcli --version` +: Show the client version. -```bash -gcli --version -``` +`gcli --server` +: Show the server version. -### Display server version +:::note +**Client/server version mismatch** -To display the server version: +If the client and server are running different versions of the Gravitino software, +you may need to ignore the client/server version check for the command to be run. +This can be done in several ways: -```bash -gcli --server -``` - -### Client/server version mismatch - -If the client and server are running different versions of the Gravitino software then you may need to ignore the client/server version check for the command to run. This can be done in several ways: - -1. Passed in on the command line via the `--ignore` parameter. -2. Set via the `GRAVITINO_IGNORE` environment variable. -3. Stored in the Gravitino CLI configuration file. +1. Specify the `--ignore` argument in the command line. +1. Set the `GRAVITINO_IGNORE` environment variable. +1. Save it in the Gravitino CLI configuration file. +::: ### Multiple properties For commands that accept multiple properties they can be specified in a couple of different ways: -1. gcli --properties n1=v1,n2=v2,n3=v3 - -2. gcli --properties n1=v1 n2=v2 n3=v3 - -3. gcli --properties n1=v1 --properties n2=v2 --properties n3=v3 +1. `gcli --properties n1=v1,n2=v2,n3=v3` +2. `gcli --properties n1=v1 n2=v2 n3=v3` +3. `gcli --properties n1=v1 --properties n2=v2 --properties n3=v3` ### Setting properties and tags - Different options are needed to add a tag and set a property of a tag with `gcli tag set`. To add a - tag, specify the tag (via --tag) and the entity to tag (via --name). To set the property of a tag - (via --tag) you need to specify the property (via --property) and value (via --value) you want to - set. +Different options are needed to add a tag or to set a property for a tag using `gcli tag set`. +To add a tag, specify the tag (via `--tag`) and the entity to tag (via `--name`). +To set the property of a tag (via `--tag`) you need to specify the property (via `--property`) +and value (via `--value`) you want to set. - To delete a tag, again, you need to specify the tag and entity, to remove a tag's property you need - to select the tag and property. +To delete a tag, again, you need to specify the tag and the entity; to remove a tag's property, +you need to select the tag and property. -### CLI commands +## Command examples -Please set the metalake in the Gravitino configuration file or the environment variable before running any of these commands. +Please set the metalake in the Gravitino configuration file or the environment variable before +running any of these commands. ### Metalake commands - Show all metalakes +`gcli metalake create --metalake --comment ` +: Create a metalake. -```bash -gcli metalake list -``` +`gcli metalake properties` +: Show the properties for a metalake. - Show a metalake details +`gcli metalake delete` +: Delete a metalake. -```bash -gcli metalake details -``` +`gcli metalake list` +: List all metalakes - Show a metalake audit information +`gcli metalake details` +: Check the details of a specific a metalake. -```bash -gcli metalake details --audit -``` - - Create a metalake - -```bash -gcli metalake create --metalake my_metalake --comment "This is my metalake" -``` - - Delete a metalake - -```bash -gcli metalake delete -``` +`gcli metalake details --audit` +: Show the audit information for a metalake - Rename a metalake +`gcli metalake update --rename ` +: Rename a metalake -```bash -gcli metalake update --rename demo -``` +`gcli metalake update --comment ""` +: Update the comment for a metalake - Update a metalake's comment +`gcli metalake set --property --value ` +: Set the property for a metalake. -```bash -gcli metalake update --comment "new comment" -``` - - Display a metalake's properties - -```bash -gcli metalake properties -``` - - Set a metalake's property
Re: [PR] [doc] Revise the CLI documentation [gravitino]
tengqm commented on code in PR #5840: URL: https://github.com/apache/gravitino/pull/5840#discussion_r1881413531 ## docs/cli.md: ## @@ -152,710 +163,464 @@ keytabFile=file.keytab ### Potentially unsafe operations -For operations that delete data or rename a metalake the user with be prompted to make sure they wish to run this command. The `--force` option can be specified to override this behaviour. +For operations that delete data or rename a metalake, the users will be prompted to +make sure they wish to run this command. +The `--force` option can be specified to override this behaviour. ### Manage metadata All the commands are performed by using the [Java API](api/java-api) internally. -### Display help +### Show help -To display help on command usage: +To view the help on command usage: ```bash gcli --help ``` -### Display client version +### Show version -To display the client version: +`gcli --version` +: Show the client version. -```bash -gcli --version -``` +`gcli --server` +: Show the server version. -### Display server version +:::note +**Client/server version mismatch** -To display the server version: +If the client and server are running different versions of the Gravitino software, +you may need to ignore the client/server version check for the command to be run. +This can be done in several ways: -```bash -gcli --server -``` - -### Client/server version mismatch - -If the client and server are running different versions of the Gravitino software then you may need to ignore the client/server version check for the command to run. This can be done in several ways: - -1. Passed in on the command line via the `--ignore` parameter. -2. Set via the `GRAVITINO_IGNORE` environment variable. -3. Stored in the Gravitino CLI configuration file. +1. Specify the `--ignore` argument in the command line. +1. Set the `GRAVITINO_IGNORE` environment variable. +1. Save it in the Gravitino CLI configuration file. +::: ### Multiple properties For commands that accept multiple properties they can be specified in a couple of different ways: -1. gcli --properties n1=v1,n2=v2,n3=v3 - -2. gcli --properties n1=v1 n2=v2 n3=v3 - -3. gcli --properties n1=v1 --properties n2=v2 --properties n3=v3 +1. `gcli --properties n1=v1,n2=v2,n3=v3` +2. `gcli --properties n1=v1 n2=v2 n3=v3` +3. `gcli --properties n1=v1 --properties n2=v2 --properties n3=v3` ### Setting properties and tags - Different options are needed to add a tag and set a property of a tag with `gcli tag set`. To add a - tag, specify the tag (via --tag) and the entity to tag (via --name). To set the property of a tag - (via --tag) you need to specify the property (via --property) and value (via --value) you want to - set. +Different options are needed to add a tag or to set a property for a tag using `gcli tag set`. +To add a tag, specify the tag (via `--tag`) and the entity to tag (via `--name`). +To set the property of a tag (via `--tag`) you need to specify the property (via `--property`) +and value (via `--value`) you want to set. - To delete a tag, again, you need to specify the tag and entity, to remove a tag's property you need - to select the tag and property. +To delete a tag, again, you need to specify the tag and the entity; to remove a tag's property, +you need to select the tag and property. -### CLI commands +## Command examples -Please set the metalake in the Gravitino configuration file or the environment variable before running any of these commands. +Please set the metalake in the Gravitino configuration file or the environment variable before +running any of these commands. ### Metalake commands - Show all metalakes +`gcli metalake create --metalake --comment ` +: Create a metalake. -```bash -gcli metalake list -``` +`gcli metalake properties` +: Show the properties for a metalake. - Show a metalake details +`gcli metalake delete` +: Delete a metalake. -```bash -gcli metalake details -``` +`gcli metalake list` +: List all metalakes - Show a metalake audit information +`gcli metalake details` +: Check the details of a specific a metalake. -```bash -gcli metalake details --audit -``` - - Create a metalake - -```bash -gcli metalake create --metalake my_metalake --comment "This is my metalake" -``` - - Delete a metalake - -```bash -gcli metalake delete -``` +`gcli metalake details --audit` +: Show the audit information for a metalake - Rename a metalake +`gcli metalake update --rename ` +: Rename a metalake -```bash -gcli metalake update --rename demo -``` +`gcli metalake update --comment ""` +: Update the comment for a metalake - Update a metalake's comment +`gcli metalake set --property --value ` +: Set the property for a metalake. -```bash -gcli metalake update --comment "new comment" -``` - - Display a metalake's properties - -```bash -gcli metalake properties -``` - - Set a metalake's property - -```
Re: [PR] [doc] Revise the CLI documentation [gravitino]
justinmclean commented on code in PR #5840: URL: https://github.com/apache/gravitino/pull/5840#discussion_r1881308176 ## docs/cli.md: ## @@ -152,710 +163,464 @@ keytabFile=file.keytab ### Potentially unsafe operations -For operations that delete data or rename a metalake the user with be prompted to make sure they wish to run this command. The `--force` option can be specified to override this behaviour. +For operations that delete data or rename a metalake, the users will be prompted to +make sure they wish to run this command. +The `--force` option can be specified to override this behaviour. ### Manage metadata All the commands are performed by using the [Java API](api/java-api) internally. -### Display help +### Show help -To display help on command usage: +To view the help on command usage: ```bash gcli --help ``` -### Display client version +### Show version -To display the client version: +`gcli --version` +: Show the client version. -```bash -gcli --version -``` +`gcli --server` +: Show the server version. -### Display server version +:::note +**Client/server version mismatch** -To display the server version: +If the client and server are running different versions of the Gravitino software, +you may need to ignore the client/server version check for the command to be run. +This can be done in several ways: -```bash -gcli --server -``` - -### Client/server version mismatch - -If the client and server are running different versions of the Gravitino software then you may need to ignore the client/server version check for the command to run. This can be done in several ways: - -1. Passed in on the command line via the `--ignore` parameter. -2. Set via the `GRAVITINO_IGNORE` environment variable. -3. Stored in the Gravitino CLI configuration file. +1. Specify the `--ignore` argument in the command line. +1. Set the `GRAVITINO_IGNORE` environment variable. +1. Save it in the Gravitino CLI configuration file. +::: ### Multiple properties For commands that accept multiple properties they can be specified in a couple of different ways: -1. gcli --properties n1=v1,n2=v2,n3=v3 - -2. gcli --properties n1=v1 n2=v2 n3=v3 - -3. gcli --properties n1=v1 --properties n2=v2 --properties n3=v3 +1. `gcli --properties n1=v1,n2=v2,n3=v3` +2. `gcli --properties n1=v1 n2=v2 n3=v3` +3. `gcli --properties n1=v1 --properties n2=v2 --properties n3=v3` ### Setting properties and tags - Different options are needed to add a tag and set a property of a tag with `gcli tag set`. To add a - tag, specify the tag (via --tag) and the entity to tag (via --name). To set the property of a tag - (via --tag) you need to specify the property (via --property) and value (via --value) you want to - set. +Different options are needed to add a tag or to set a property for a tag using `gcli tag set`. +To add a tag, specify the tag (via `--tag`) and the entity to tag (via `--name`). +To set the property of a tag (via `--tag`) you need to specify the property (via `--property`) +and value (via `--value`) you want to set. - To delete a tag, again, you need to specify the tag and entity, to remove a tag's property you need - to select the tag and property. +To delete a tag, again, you need to specify the tag and the entity; to remove a tag's property, +you need to select the tag and property. -### CLI commands +## Command examples -Please set the metalake in the Gravitino configuration file or the environment variable before running any of these commands. +Please set the metalake in the Gravitino configuration file or the environment variable before +running any of these commands. ### Metalake commands - Show all metalakes +`gcli metalake create --metalake --comment ` +: Create a metalake. -```bash -gcli metalake list -``` +`gcli metalake properties` +: Show the properties for a metalake. - Show a metalake details +`gcli metalake delete` +: Delete a metalake. -```bash -gcli metalake details -``` +`gcli metalake list` +: List all metalakes - Show a metalake audit information +`gcli metalake details` +: Check the details of a specific a metalake. -```bash -gcli metalake details --audit -``` - - Create a metalake - -```bash -gcli metalake create --metalake my_metalake --comment "This is my metalake" -``` - - Delete a metalake - -```bash -gcli metalake delete -``` +`gcli metalake details --audit` +: Show the audit information for a metalake - Rename a metalake +`gcli metalake update --rename ` +: Rename a metalake -```bash -gcli metalake update --rename demo -``` +`gcli metalake update --comment ""` +: Update the comment for a metalake - Update a metalake's comment +`gcli metalake set --property --value ` +: Set the property for a metalake. -```bash -gcli metalake update --comment "new comment" -``` - - Display a metalake's properties - -```bash -gcli metalake properties -``` - - Set a metalake's property
Re: [PR] [doc] Revise the CLI documentation [gravitino]
justinmclean commented on code in PR #5840: URL: https://github.com/apache/gravitino/pull/5840#discussion_r1881308176 ## docs/cli.md: ## @@ -152,710 +163,464 @@ keytabFile=file.keytab ### Potentially unsafe operations -For operations that delete data or rename a metalake the user with be prompted to make sure they wish to run this command. The `--force` option can be specified to override this behaviour. +For operations that delete data or rename a metalake, the users will be prompted to +make sure they wish to run this command. +The `--force` option can be specified to override this behaviour. ### Manage metadata All the commands are performed by using the [Java API](api/java-api) internally. -### Display help +### Show help -To display help on command usage: +To view the help on command usage: ```bash gcli --help ``` -### Display client version +### Show version -To display the client version: +`gcli --version` +: Show the client version. -```bash -gcli --version -``` +`gcli --server` +: Show the server version. -### Display server version +:::note +**Client/server version mismatch** -To display the server version: +If the client and server are running different versions of the Gravitino software, +you may need to ignore the client/server version check for the command to be run. +This can be done in several ways: -```bash -gcli --server -``` - -### Client/server version mismatch - -If the client and server are running different versions of the Gravitino software then you may need to ignore the client/server version check for the command to run. This can be done in several ways: - -1. Passed in on the command line via the `--ignore` parameter. -2. Set via the `GRAVITINO_IGNORE` environment variable. -3. Stored in the Gravitino CLI configuration file. +1. Specify the `--ignore` argument in the command line. +1. Set the `GRAVITINO_IGNORE` environment variable. +1. Save it in the Gravitino CLI configuration file. +::: ### Multiple properties For commands that accept multiple properties they can be specified in a couple of different ways: -1. gcli --properties n1=v1,n2=v2,n3=v3 - -2. gcli --properties n1=v1 n2=v2 n3=v3 - -3. gcli --properties n1=v1 --properties n2=v2 --properties n3=v3 +1. `gcli --properties n1=v1,n2=v2,n3=v3` +2. `gcli --properties n1=v1 n2=v2 n3=v3` +3. `gcli --properties n1=v1 --properties n2=v2 --properties n3=v3` ### Setting properties and tags - Different options are needed to add a tag and set a property of a tag with `gcli tag set`. To add a - tag, specify the tag (via --tag) and the entity to tag (via --name). To set the property of a tag - (via --tag) you need to specify the property (via --property) and value (via --value) you want to - set. +Different options are needed to add a tag or to set a property for a tag using `gcli tag set`. +To add a tag, specify the tag (via `--tag`) and the entity to tag (via `--name`). +To set the property of a tag (via `--tag`) you need to specify the property (via `--property`) +and value (via `--value`) you want to set. - To delete a tag, again, you need to specify the tag and entity, to remove a tag's property you need - to select the tag and property. +To delete a tag, again, you need to specify the tag and the entity; to remove a tag's property, +you need to select the tag and property. -### CLI commands +## Command examples -Please set the metalake in the Gravitino configuration file or the environment variable before running any of these commands. +Please set the metalake in the Gravitino configuration file or the environment variable before +running any of these commands. ### Metalake commands - Show all metalakes +`gcli metalake create --metalake --comment ` +: Create a metalake. -```bash -gcli metalake list -``` +`gcli metalake properties` +: Show the properties for a metalake. - Show a metalake details +`gcli metalake delete` +: Delete a metalake. -```bash -gcli metalake details -``` +`gcli metalake list` +: List all metalakes - Show a metalake audit information +`gcli metalake details` +: Check the details of a specific a metalake. -```bash -gcli metalake details --audit -``` - - Create a metalake - -```bash -gcli metalake create --metalake my_metalake --comment "This is my metalake" -``` - - Delete a metalake - -```bash -gcli metalake delete -``` +`gcli metalake details --audit` +: Show the audit information for a metalake - Rename a metalake +`gcli metalake update --rename ` +: Rename a metalake -```bash -gcli metalake update --rename demo -``` +`gcli metalake update --comment ""` +: Update the comment for a metalake - Update a metalake's comment +`gcli metalake set --property --value ` +: Set the property for a metalake. -```bash -gcli metalake update --comment "new comment" -``` - - Display a metalake's properties - -```bash -gcli metalake properties -``` - - Set a metalake's property
Re: [PR] [doc] Revise the CLI documentation [gravitino]
justinmclean commented on code in PR #5840: URL: https://github.com/apache/gravitino/pull/5840#discussion_r1881305207 ## docs/cli.md: ## @@ -152,710 +163,464 @@ keytabFile=file.keytab ### Potentially unsafe operations -For operations that delete data or rename a metalake the user with be prompted to make sure they wish to run this command. The `--force` option can be specified to override this behaviour. +For operations that delete data or rename a metalake, the users will be prompted to +make sure they wish to run this command. +The `--force` option can be specified to override this behaviour. ### Manage metadata All the commands are performed by using the [Java API](api/java-api) internally. -### Display help +### Show help -To display help on command usage: +To view the help on command usage: ```bash gcli --help ``` -### Display client version +### Show version -To display the client version: +`gcli --version` +: Show the client version. -```bash -gcli --version -``` +`gcli --server` +: Show the server version. -### Display server version +:::note +**Client/server version mismatch** -To display the server version: +If the client and server are running different versions of the Gravitino software, +you may need to ignore the client/server version check for the command to be run. +This can be done in several ways: -```bash -gcli --server -``` - -### Client/server version mismatch - -If the client and server are running different versions of the Gravitino software then you may need to ignore the client/server version check for the command to run. This can be done in several ways: - -1. Passed in on the command line via the `--ignore` parameter. -2. Set via the `GRAVITINO_IGNORE` environment variable. -3. Stored in the Gravitino CLI configuration file. +1. Specify the `--ignore` argument in the command line. +1. Set the `GRAVITINO_IGNORE` environment variable. +1. Save it in the Gravitino CLI configuration file. +::: ### Multiple properties For commands that accept multiple properties they can be specified in a couple of different ways: -1. gcli --properties n1=v1,n2=v2,n3=v3 - -2. gcli --properties n1=v1 n2=v2 n3=v3 - -3. gcli --properties n1=v1 --properties n2=v2 --properties n3=v3 +1. `gcli --properties n1=v1,n2=v2,n3=v3` +2. `gcli --properties n1=v1 n2=v2 n3=v3` +3. `gcli --properties n1=v1 --properties n2=v2 --properties n3=v3` ### Setting properties and tags - Different options are needed to add a tag and set a property of a tag with `gcli tag set`. To add a - tag, specify the tag (via --tag) and the entity to tag (via --name). To set the property of a tag - (via --tag) you need to specify the property (via --property) and value (via --value) you want to - set. +Different options are needed to add a tag or to set a property for a tag using `gcli tag set`. +To add a tag, specify the tag (via `--tag`) and the entity to tag (via `--name`). +To set the property of a tag (via `--tag`) you need to specify the property (via `--property`) +and value (via `--value`) you want to set. - To delete a tag, again, you need to specify the tag and entity, to remove a tag's property you need - to select the tag and property. +To delete a tag, again, you need to specify the tag and the entity; to remove a tag's property, +you need to select the tag and property. -### CLI commands +## Command examples -Please set the metalake in the Gravitino configuration file or the environment variable before running any of these commands. +Please set the metalake in the Gravitino configuration file or the environment variable before +running any of these commands. ### Metalake commands - Show all metalakes +`gcli metalake create --metalake --comment ` +: Create a metalake. -```bash -gcli metalake list -``` +`gcli metalake properties` +: Show the properties for a metalake. - Show a metalake details +`gcli metalake delete` +: Delete a metalake. -```bash -gcli metalake details -``` +`gcli metalake list` +: List all metalakes - Show a metalake audit information +`gcli metalake details` +: Check the details of a specific a metalake. -```bash -gcli metalake details --audit -``` - - Create a metalake - -```bash -gcli metalake create --metalake my_metalake --comment "This is my metalake" -``` - - Delete a metalake - -```bash -gcli metalake delete -``` +`gcli metalake details --audit` +: Show the audit information for a metalake - Rename a metalake +`gcli metalake update --rename ` +: Rename a metalake -```bash -gcli metalake update --rename demo -``` +`gcli metalake update --comment ""` +: Update the comment for a metalake - Update a metalake's comment +`gcli metalake set --property --value ` +: Set the property for a metalake. -```bash -gcli metalake update --comment "new comment" -``` - - Display a metalake's properties - -```bash -gcli metalake properties -``` - - Set a metalake's property
Re: [PR] [doc] Revise the CLI documentation [gravitino]
justinmclean commented on code in PR #5840: URL: https://github.com/apache/gravitino/pull/5840#discussion_r1881305207 ## docs/cli.md: ## @@ -152,710 +163,464 @@ keytabFile=file.keytab ### Potentially unsafe operations -For operations that delete data or rename a metalake the user with be prompted to make sure they wish to run this command. The `--force` option can be specified to override this behaviour. +For operations that delete data or rename a metalake, the users will be prompted to +make sure they wish to run this command. +The `--force` option can be specified to override this behaviour. ### Manage metadata All the commands are performed by using the [Java API](api/java-api) internally. -### Display help +### Show help -To display help on command usage: +To view the help on command usage: ```bash gcli --help ``` -### Display client version +### Show version -To display the client version: +`gcli --version` +: Show the client version. -```bash -gcli --version -``` +`gcli --server` +: Show the server version. -### Display server version +:::note +**Client/server version mismatch** -To display the server version: +If the client and server are running different versions of the Gravitino software, +you may need to ignore the client/server version check for the command to be run. +This can be done in several ways: -```bash -gcli --server -``` - -### Client/server version mismatch - -If the client and server are running different versions of the Gravitino software then you may need to ignore the client/server version check for the command to run. This can be done in several ways: - -1. Passed in on the command line via the `--ignore` parameter. -2. Set via the `GRAVITINO_IGNORE` environment variable. -3. Stored in the Gravitino CLI configuration file. +1. Specify the `--ignore` argument in the command line. +1. Set the `GRAVITINO_IGNORE` environment variable. +1. Save it in the Gravitino CLI configuration file. +::: ### Multiple properties For commands that accept multiple properties they can be specified in a couple of different ways: -1. gcli --properties n1=v1,n2=v2,n3=v3 - -2. gcli --properties n1=v1 n2=v2 n3=v3 - -3. gcli --properties n1=v1 --properties n2=v2 --properties n3=v3 +1. `gcli --properties n1=v1,n2=v2,n3=v3` +2. `gcli --properties n1=v1 n2=v2 n3=v3` +3. `gcli --properties n1=v1 --properties n2=v2 --properties n3=v3` ### Setting properties and tags - Different options are needed to add a tag and set a property of a tag with `gcli tag set`. To add a - tag, specify the tag (via --tag) and the entity to tag (via --name). To set the property of a tag - (via --tag) you need to specify the property (via --property) and value (via --value) you want to - set. +Different options are needed to add a tag or to set a property for a tag using `gcli tag set`. +To add a tag, specify the tag (via `--tag`) and the entity to tag (via `--name`). +To set the property of a tag (via `--tag`) you need to specify the property (via `--property`) +and value (via `--value`) you want to set. - To delete a tag, again, you need to specify the tag and entity, to remove a tag's property you need - to select the tag and property. +To delete a tag, again, you need to specify the tag and the entity; to remove a tag's property, +you need to select the tag and property. -### CLI commands +## Command examples -Please set the metalake in the Gravitino configuration file or the environment variable before running any of these commands. +Please set the metalake in the Gravitino configuration file or the environment variable before +running any of these commands. ### Metalake commands - Show all metalakes +`gcli metalake create --metalake --comment ` +: Create a metalake. -```bash -gcli metalake list -``` +`gcli metalake properties` +: Show the properties for a metalake. - Show a metalake details +`gcli metalake delete` +: Delete a metalake. -```bash -gcli metalake details -``` +`gcli metalake list` +: List all metalakes - Show a metalake audit information +`gcli metalake details` +: Check the details of a specific a metalake. -```bash -gcli metalake details --audit -``` - - Create a metalake - -```bash -gcli metalake create --metalake my_metalake --comment "This is my metalake" -``` - - Delete a metalake - -```bash -gcli metalake delete -``` +`gcli metalake details --audit` +: Show the audit information for a metalake - Rename a metalake +`gcli metalake update --rename ` +: Rename a metalake -```bash -gcli metalake update --rename demo -``` +`gcli metalake update --comment ""` +: Update the comment for a metalake - Update a metalake's comment +`gcli metalake set --property --value ` +: Set the property for a metalake. -```bash -gcli metalake update --comment "new comment" -``` - - Display a metalake's properties - -```bash -gcli metalake properties -``` - - Set a metalake's property
Re: [PR] [doc] Revise the CLI documentation [gravitino]
justinmclean commented on code in PR #5840: URL: https://github.com/apache/gravitino/pull/5840#discussion_r1881305802 ## docs/cli.md: ## @@ -152,710 +163,464 @@ keytabFile=file.keytab ### Potentially unsafe operations -For operations that delete data or rename a metalake the user with be prompted to make sure they wish to run this command. The `--force` option can be specified to override this behaviour. +For operations that delete data or rename a metalake, the users will be prompted to +make sure they wish to run this command. +The `--force` option can be specified to override this behaviour. ### Manage metadata All the commands are performed by using the [Java API](api/java-api) internally. -### Display help +### Show help -To display help on command usage: +To view the help on command usage: ```bash gcli --help ``` -### Display client version +### Show version -To display the client version: +`gcli --version` +: Show the client version. -```bash -gcli --version -``` +`gcli --server` +: Show the server version. -### Display server version +:::note +**Client/server version mismatch** -To display the server version: +If the client and server are running different versions of the Gravitino software, +you may need to ignore the client/server version check for the command to be run. +This can be done in several ways: -```bash -gcli --server -``` - -### Client/server version mismatch - -If the client and server are running different versions of the Gravitino software then you may need to ignore the client/server version check for the command to run. This can be done in several ways: - -1. Passed in on the command line via the `--ignore` parameter. -2. Set via the `GRAVITINO_IGNORE` environment variable. -3. Stored in the Gravitino CLI configuration file. +1. Specify the `--ignore` argument in the command line. +1. Set the `GRAVITINO_IGNORE` environment variable. +1. Save it in the Gravitino CLI configuration file. +::: ### Multiple properties For commands that accept multiple properties they can be specified in a couple of different ways: -1. gcli --properties n1=v1,n2=v2,n3=v3 - -2. gcli --properties n1=v1 n2=v2 n3=v3 - -3. gcli --properties n1=v1 --properties n2=v2 --properties n3=v3 +1. `gcli --properties n1=v1,n2=v2,n3=v3` +2. `gcli --properties n1=v1 n2=v2 n3=v3` +3. `gcli --properties n1=v1 --properties n2=v2 --properties n3=v3` ### Setting properties and tags - Different options are needed to add a tag and set a property of a tag with `gcli tag set`. To add a - tag, specify the tag (via --tag) and the entity to tag (via --name). To set the property of a tag - (via --tag) you need to specify the property (via --property) and value (via --value) you want to - set. +Different options are needed to add a tag or to set a property for a tag using `gcli tag set`. +To add a tag, specify the tag (via `--tag`) and the entity to tag (via `--name`). +To set the property of a tag (via `--tag`) you need to specify the property (via `--property`) +and value (via `--value`) you want to set. - To delete a tag, again, you need to specify the tag and entity, to remove a tag's property you need - to select the tag and property. +To delete a tag, again, you need to specify the tag and the entity; to remove a tag's property, +you need to select the tag and property. -### CLI commands +## Command examples -Please set the metalake in the Gravitino configuration file or the environment variable before running any of these commands. +Please set the metalake in the Gravitino configuration file or the environment variable before +running any of these commands. ### Metalake commands - Show all metalakes +`gcli metalake create --metalake --comment ` +: Create a metalake. -```bash -gcli metalake list -``` +`gcli metalake properties` +: Show the properties for a metalake. - Show a metalake details +`gcli metalake delete` +: Delete a metalake. -```bash -gcli metalake details -``` +`gcli metalake list` +: List all metalakes - Show a metalake audit information +`gcli metalake details` +: Check the details of a specific a metalake. -```bash -gcli metalake details --audit -``` - - Create a metalake - -```bash -gcli metalake create --metalake my_metalake --comment "This is my metalake" -``` - - Delete a metalake - -```bash -gcli metalake delete -``` +`gcli metalake details --audit` +: Show the audit information for a metalake - Rename a metalake +`gcli metalake update --rename ` +: Rename a metalake -```bash -gcli metalake update --rename demo -``` +`gcli metalake update --comment ""` +: Update the comment for a metalake - Update a metalake's comment +`gcli metalake set --property --value ` +: Set the property for a metalake. -```bash -gcli metalake update --comment "new comment" -``` - - Display a metalake's properties - -```bash -gcli metalake properties -``` - - Set a metalake's property
Re: [PR] [doc] Revise the CLI documentation [gravitino]
justinmclean commented on code in PR #5840: URL: https://github.com/apache/gravitino/pull/5840#discussion_r1881305207 ## docs/cli.md: ## @@ -152,710 +163,464 @@ keytabFile=file.keytab ### Potentially unsafe operations -For operations that delete data or rename a metalake the user with be prompted to make sure they wish to run this command. The `--force` option can be specified to override this behaviour. +For operations that delete data or rename a metalake, the users will be prompted to +make sure they wish to run this command. +The `--force` option can be specified to override this behaviour. ### Manage metadata All the commands are performed by using the [Java API](api/java-api) internally. -### Display help +### Show help -To display help on command usage: +To view the help on command usage: ```bash gcli --help ``` -### Display client version +### Show version -To display the client version: +`gcli --version` +: Show the client version. -```bash -gcli --version -``` +`gcli --server` +: Show the server version. -### Display server version +:::note +**Client/server version mismatch** -To display the server version: +If the client and server are running different versions of the Gravitino software, +you may need to ignore the client/server version check for the command to be run. +This can be done in several ways: -```bash -gcli --server -``` - -### Client/server version mismatch - -If the client and server are running different versions of the Gravitino software then you may need to ignore the client/server version check for the command to run. This can be done in several ways: - -1. Passed in on the command line via the `--ignore` parameter. -2. Set via the `GRAVITINO_IGNORE` environment variable. -3. Stored in the Gravitino CLI configuration file. +1. Specify the `--ignore` argument in the command line. +1. Set the `GRAVITINO_IGNORE` environment variable. +1. Save it in the Gravitino CLI configuration file. +::: ### Multiple properties For commands that accept multiple properties they can be specified in a couple of different ways: -1. gcli --properties n1=v1,n2=v2,n3=v3 - -2. gcli --properties n1=v1 n2=v2 n3=v3 - -3. gcli --properties n1=v1 --properties n2=v2 --properties n3=v3 +1. `gcli --properties n1=v1,n2=v2,n3=v3` +2. `gcli --properties n1=v1 n2=v2 n3=v3` +3. `gcli --properties n1=v1 --properties n2=v2 --properties n3=v3` ### Setting properties and tags - Different options are needed to add a tag and set a property of a tag with `gcli tag set`. To add a - tag, specify the tag (via --tag) and the entity to tag (via --name). To set the property of a tag - (via --tag) you need to specify the property (via --property) and value (via --value) you want to - set. +Different options are needed to add a tag or to set a property for a tag using `gcli tag set`. +To add a tag, specify the tag (via `--tag`) and the entity to tag (via `--name`). +To set the property of a tag (via `--tag`) you need to specify the property (via `--property`) +and value (via `--value`) you want to set. - To delete a tag, again, you need to specify the tag and entity, to remove a tag's property you need - to select the tag and property. +To delete a tag, again, you need to specify the tag and the entity; to remove a tag's property, +you need to select the tag and property. -### CLI commands +## Command examples -Please set the metalake in the Gravitino configuration file or the environment variable before running any of these commands. +Please set the metalake in the Gravitino configuration file or the environment variable before +running any of these commands. ### Metalake commands - Show all metalakes +`gcli metalake create --metalake --comment ` +: Create a metalake. -```bash -gcli metalake list -``` +`gcli metalake properties` +: Show the properties for a metalake. - Show a metalake details +`gcli metalake delete` +: Delete a metalake. -```bash -gcli metalake details -``` +`gcli metalake list` +: List all metalakes - Show a metalake audit information +`gcli metalake details` +: Check the details of a specific a metalake. -```bash -gcli metalake details --audit -``` - - Create a metalake - -```bash -gcli metalake create --metalake my_metalake --comment "This is my metalake" -``` - - Delete a metalake - -```bash -gcli metalake delete -``` +`gcli metalake details --audit` +: Show the audit information for a metalake - Rename a metalake +`gcli metalake update --rename ` +: Rename a metalake -```bash -gcli metalake update --rename demo -``` +`gcli metalake update --comment ""` +: Update the comment for a metalake - Update a metalake's comment +`gcli metalake set --property --value ` +: Set the property for a metalake. -```bash -gcli metalake update --comment "new comment" -``` - - Display a metalake's properties - -```bash -gcli metalake properties -``` - - Set a metalake's property
Re: [PR] [doc] Revise the CLI documentation [gravitino]
justinmclean commented on code in PR #5840: URL: https://github.com/apache/gravitino/pull/5840#discussion_r1881259740 ## docs/cli.md: ## @@ -152,710 +163,464 @@ keytabFile=file.keytab ### Potentially unsafe operations -For operations that delete data or rename a metalake the user with be prompted to make sure they wish to run this command. The `--force` option can be specified to override this behaviour. +For operations that delete data or rename a metalake, the users will be prompted to +make sure they wish to run this command. +The `--force` option can be specified to override this behaviour. ### Manage metadata All the commands are performed by using the [Java API](api/java-api) internally. -### Display help +### Show help -To display help on command usage: +To view the help on command usage: ```bash gcli --help ``` -### Display client version +### Show version -To display the client version: +`gcli --version` +: Show the client version. -```bash -gcli --version -``` +`gcli --server` +: Show the server version. -### Display server version +:::note +**Client/server version mismatch** -To display the server version: +If the client and server are running different versions of the Gravitino software, +you may need to ignore the client/server version check for the command to be run. +This can be done in several ways: -```bash -gcli --server -``` - -### Client/server version mismatch - -If the client and server are running different versions of the Gravitino software then you may need to ignore the client/server version check for the command to run. This can be done in several ways: - -1. Passed in on the command line via the `--ignore` parameter. -2. Set via the `GRAVITINO_IGNORE` environment variable. -3. Stored in the Gravitino CLI configuration file. +1. Specify the `--ignore` argument in the command line. +1. Set the `GRAVITINO_IGNORE` environment variable. +1. Save it in the Gravitino CLI configuration file. +::: ### Multiple properties For commands that accept multiple properties they can be specified in a couple of different ways: -1. gcli --properties n1=v1,n2=v2,n3=v3 - -2. gcli --properties n1=v1 n2=v2 n3=v3 - -3. gcli --properties n1=v1 --properties n2=v2 --properties n3=v3 +1. `gcli --properties n1=v1,n2=v2,n3=v3` +2. `gcli --properties n1=v1 n2=v2 n3=v3` +3. `gcli --properties n1=v1 --properties n2=v2 --properties n3=v3` ### Setting properties and tags - Different options are needed to add a tag and set a property of a tag with `gcli tag set`. To add a - tag, specify the tag (via --tag) and the entity to tag (via --name). To set the property of a tag - (via --tag) you need to specify the property (via --property) and value (via --value) you want to - set. +Different options are needed to add a tag or to set a property for a tag using `gcli tag set`. +To add a tag, specify the tag (via `--tag`) and the entity to tag (via `--name`). +To set the property of a tag (via `--tag`) you need to specify the property (via `--property`) +and value (via `--value`) you want to set. - To delete a tag, again, you need to specify the tag and entity, to remove a tag's property you need - to select the tag and property. +To delete a tag, again, you need to specify the tag and the entity; to remove a tag's property, +you need to select the tag and property. -### CLI commands +## Command examples -Please set the metalake in the Gravitino configuration file or the environment variable before running any of these commands. +Please set the metalake in the Gravitino configuration file or the environment variable before +running any of these commands. ### Metalake commands - Show all metalakes +`gcli metalake create --metalake --comment ` +: Create a metalake. -```bash -gcli metalake list -``` +`gcli metalake properties` +: Show the properties for a metalake. - Show a metalake details +`gcli metalake delete` +: Delete a metalake. -```bash -gcli metalake details -``` +`gcli metalake list` +: List all metalakes - Show a metalake audit information +`gcli metalake details` +: Check the details of a specific a metalake. -```bash -gcli metalake details --audit -``` - - Create a metalake - -```bash -gcli metalake create --metalake my_metalake --comment "This is my metalake" -``` - - Delete a metalake - -```bash -gcli metalake delete -``` +`gcli metalake details --audit` +: Show the audit information for a metalake - Rename a metalake +`gcli metalake update --rename ` +: Rename a metalake -```bash -gcli metalake update --rename demo -``` +`gcli metalake update --comment ""` +: Update the comment for a metalake - Update a metalake's comment +`gcli metalake set --property --value ` +: Set the property for a metalake. -```bash -gcli metalake update --comment "new comment" -``` - - Display a metalake's properties - -```bash -gcli metalake properties -``` - - Set a metalake's property
Re: [PR] [doc] Revise the CLI documentation [gravitino]
tengqm commented on code in PR #5840: URL: https://github.com/apache/gravitino/pull/5840#discussion_r1881264758 ## docs/cli.md: ## @@ -152,710 +163,464 @@ keytabFile=file.keytab ### Potentially unsafe operations -For operations that delete data or rename a metalake the user with be prompted to make sure they wish to run this command. The `--force` option can be specified to override this behaviour. +For operations that delete data or rename a metalake, the users will be prompted to +make sure they wish to run this command. +The `--force` option can be specified to override this behaviour. ### Manage metadata All the commands are performed by using the [Java API](api/java-api) internally. -### Display help +### Show help -To display help on command usage: +To view the help on command usage: ```bash gcli --help ``` -### Display client version +### Show version -To display the client version: +`gcli --version` +: Show the client version. -```bash -gcli --version -``` +`gcli --server` +: Show the server version. -### Display server version +:::note +**Client/server version mismatch** -To display the server version: +If the client and server are running different versions of the Gravitino software, +you may need to ignore the client/server version check for the command to be run. +This can be done in several ways: -```bash -gcli --server -``` - -### Client/server version mismatch - -If the client and server are running different versions of the Gravitino software then you may need to ignore the client/server version check for the command to run. This can be done in several ways: - -1. Passed in on the command line via the `--ignore` parameter. -2. Set via the `GRAVITINO_IGNORE` environment variable. -3. Stored in the Gravitino CLI configuration file. +1. Specify the `--ignore` argument in the command line. +1. Set the `GRAVITINO_IGNORE` environment variable. +1. Save it in the Gravitino CLI configuration file. +::: ### Multiple properties For commands that accept multiple properties they can be specified in a couple of different ways: -1. gcli --properties n1=v1,n2=v2,n3=v3 - -2. gcli --properties n1=v1 n2=v2 n3=v3 - -3. gcli --properties n1=v1 --properties n2=v2 --properties n3=v3 +1. `gcli --properties n1=v1,n2=v2,n3=v3` +2. `gcli --properties n1=v1 n2=v2 n3=v3` +3. `gcli --properties n1=v1 --properties n2=v2 --properties n3=v3` ### Setting properties and tags - Different options are needed to add a tag and set a property of a tag with `gcli tag set`. To add a - tag, specify the tag (via --tag) and the entity to tag (via --name). To set the property of a tag - (via --tag) you need to specify the property (via --property) and value (via --value) you want to - set. +Different options are needed to add a tag or to set a property for a tag using `gcli tag set`. +To add a tag, specify the tag (via `--tag`) and the entity to tag (via `--name`). +To set the property of a tag (via `--tag`) you need to specify the property (via `--property`) +and value (via `--value`) you want to set. - To delete a tag, again, you need to specify the tag and entity, to remove a tag's property you need - to select the tag and property. +To delete a tag, again, you need to specify the tag and the entity; to remove a tag's property, +you need to select the tag and property. -### CLI commands +## Command examples -Please set the metalake in the Gravitino configuration file or the environment variable before running any of these commands. +Please set the metalake in the Gravitino configuration file or the environment variable before +running any of these commands. ### Metalake commands - Show all metalakes +`gcli metalake create --metalake --comment ` +: Create a metalake. -```bash -gcli metalake list -``` +`gcli metalake properties` +: Show the properties for a metalake. - Show a metalake details +`gcli metalake delete` +: Delete a metalake. -```bash -gcli metalake details -``` +`gcli metalake list` +: List all metalakes - Show a metalake audit information +`gcli metalake details` +: Check the details of a specific a metalake. -```bash -gcli metalake details --audit -``` - - Create a metalake - -```bash -gcli metalake create --metalake my_metalake --comment "This is my metalake" -``` - - Delete a metalake - -```bash -gcli metalake delete -``` +`gcli metalake details --audit` +: Show the audit information for a metalake - Rename a metalake +`gcli metalake update --rename ` +: Rename a metalake -```bash -gcli metalake update --rename demo -``` +`gcli metalake update --comment ""` +: Update the comment for a metalake - Update a metalake's comment +`gcli metalake set --property --value ` +: Set the property for a metalake. -```bash -gcli metalake update --comment "new comment" -``` - - Display a metalake's properties - -```bash -gcli metalake properties -``` - - Set a metalake's property - -```
Re: [PR] [doc] Revise the CLI documentation [gravitino]
justinmclean commented on code in PR #5840: URL: https://github.com/apache/gravitino/pull/5840#discussion_r1881015564 ## docs/cli.md: ## @@ -152,710 +163,464 @@ keytabFile=file.keytab ### Potentially unsafe operations -For operations that delete data or rename a metalake the user with be prompted to make sure they wish to run this command. The `--force` option can be specified to override this behaviour. +For operations that delete data or rename a metalake, the users will be prompted to +make sure they wish to run this command. +The `--force` option can be specified to override this behaviour. ### Manage metadata All the commands are performed by using the [Java API](api/java-api) internally. -### Display help +### Show help -To display help on command usage: +To view the help on command usage: ```bash gcli --help ``` -### Display client version +### Show version -To display the client version: +`gcli --version` +: Show the client version. -```bash -gcli --version -``` +`gcli --server` +: Show the server version. -### Display server version +:::note +**Client/server version mismatch** -To display the server version: +If the client and server are running different versions of the Gravitino software, +you may need to ignore the client/server version check for the command to be run. +This can be done in several ways: -```bash -gcli --server -``` - -### Client/server version mismatch - -If the client and server are running different versions of the Gravitino software then you may need to ignore the client/server version check for the command to run. This can be done in several ways: - -1. Passed in on the command line via the `--ignore` parameter. -2. Set via the `GRAVITINO_IGNORE` environment variable. -3. Stored in the Gravitino CLI configuration file. +1. Specify the `--ignore` argument in the command line. +1. Set the `GRAVITINO_IGNORE` environment variable. +1. Save it in the Gravitino CLI configuration file. +::: ### Multiple properties For commands that accept multiple properties they can be specified in a couple of different ways: -1. gcli --properties n1=v1,n2=v2,n3=v3 - -2. gcli --properties n1=v1 n2=v2 n3=v3 - -3. gcli --properties n1=v1 --properties n2=v2 --properties n3=v3 +1. `gcli --properties n1=v1,n2=v2,n3=v3` +2. `gcli --properties n1=v1 n2=v2 n3=v3` +3. `gcli --properties n1=v1 --properties n2=v2 --properties n3=v3` ### Setting properties and tags - Different options are needed to add a tag and set a property of a tag with `gcli tag set`. To add a - tag, specify the tag (via --tag) and the entity to tag (via --name). To set the property of a tag - (via --tag) you need to specify the property (via --property) and value (via --value) you want to - set. +Different options are needed to add a tag or to set a property for a tag using `gcli tag set`. +To add a tag, specify the tag (via `--tag`) and the entity to tag (via `--name`). +To set the property of a tag (via `--tag`) you need to specify the property (via `--property`) +and value (via `--value`) you want to set. - To delete a tag, again, you need to specify the tag and entity, to remove a tag's property you need - to select the tag and property. +To delete a tag, again, you need to specify the tag and the entity; to remove a tag's property, +you need to select the tag and property. -### CLI commands +## Command examples -Please set the metalake in the Gravitino configuration file or the environment variable before running any of these commands. +Please set the metalake in the Gravitino configuration file or the environment variable before +running any of these commands. ### Metalake commands - Show all metalakes +`gcli metalake create --metalake --comment ` +: Create a metalake. -```bash -gcli metalake list -``` +`gcli metalake properties` +: Show the properties for a metalake. - Show a metalake details +`gcli metalake delete` +: Delete a metalake. -```bash -gcli metalake details -``` +`gcli metalake list` +: List all metalakes - Show a metalake audit information +`gcli metalake details` +: Check the details of a specific a metalake. -```bash -gcli metalake details --audit -``` - - Create a metalake - -```bash -gcli metalake create --metalake my_metalake --comment "This is my metalake" -``` - - Delete a metalake - -```bash -gcli metalake delete -``` +`gcli metalake details --audit` +: Show the audit information for a metalake - Rename a metalake +`gcli metalake update --rename ` +: Rename a metalake -```bash -gcli metalake update --rename demo -``` +`gcli metalake update --comment ""` +: Update the comment for a metalake - Update a metalake's comment +`gcli metalake set --property --value ` +: Set the property for a metalake. -```bash -gcli metalake update --comment "new comment" -``` - - Display a metalake's properties - -```bash -gcli metalake properties -``` - - Set a metalake's property
Re: [PR] [doc] Revise the CLI documentation [gravitino]
tengqm commented on code in PR #5840: URL: https://github.com/apache/gravitino/pull/5840#discussion_r1881231586 ## docs/cli.md: ## @@ -152,710 +163,464 @@ keytabFile=file.keytab ### Potentially unsafe operations -For operations that delete data or rename a metalake the user with be prompted to make sure they wish to run this command. The `--force` option can be specified to override this behaviour. +For operations that delete data or rename a metalake, the users will be prompted to +make sure they wish to run this command. +The `--force` option can be specified to override this behaviour. ### Manage metadata All the commands are performed by using the [Java API](api/java-api) internally. -### Display help +### Show help -To display help on command usage: +To view the help on command usage: ```bash gcli --help ``` -### Display client version +### Show version -To display the client version: +`gcli --version` +: Show the client version. -```bash -gcli --version -``` +`gcli --server` +: Show the server version. -### Display server version +:::note +**Client/server version mismatch** -To display the server version: +If the client and server are running different versions of the Gravitino software, +you may need to ignore the client/server version check for the command to be run. +This can be done in several ways: -```bash -gcli --server -``` - -### Client/server version mismatch - -If the client and server are running different versions of the Gravitino software then you may need to ignore the client/server version check for the command to run. This can be done in several ways: - -1. Passed in on the command line via the `--ignore` parameter. -2. Set via the `GRAVITINO_IGNORE` environment variable. -3. Stored in the Gravitino CLI configuration file. +1. Specify the `--ignore` argument in the command line. +1. Set the `GRAVITINO_IGNORE` environment variable. +1. Save it in the Gravitino CLI configuration file. +::: ### Multiple properties For commands that accept multiple properties they can be specified in a couple of different ways: -1. gcli --properties n1=v1,n2=v2,n3=v3 - -2. gcli --properties n1=v1 n2=v2 n3=v3 - -3. gcli --properties n1=v1 --properties n2=v2 --properties n3=v3 +1. `gcli --properties n1=v1,n2=v2,n3=v3` +2. `gcli --properties n1=v1 n2=v2 n3=v3` +3. `gcli --properties n1=v1 --properties n2=v2 --properties n3=v3` ### Setting properties and tags - Different options are needed to add a tag and set a property of a tag with `gcli tag set`. To add a - tag, specify the tag (via --tag) and the entity to tag (via --name). To set the property of a tag - (via --tag) you need to specify the property (via --property) and value (via --value) you want to - set. +Different options are needed to add a tag or to set a property for a tag using `gcli tag set`. +To add a tag, specify the tag (via `--tag`) and the entity to tag (via `--name`). +To set the property of a tag (via `--tag`) you need to specify the property (via `--property`) +and value (via `--value`) you want to set. - To delete a tag, again, you need to specify the tag and entity, to remove a tag's property you need - to select the tag and property. +To delete a tag, again, you need to specify the tag and the entity; to remove a tag's property, +you need to select the tag and property. -### CLI commands +## Command examples -Please set the metalake in the Gravitino configuration file or the environment variable before running any of these commands. +Please set the metalake in the Gravitino configuration file or the environment variable before +running any of these commands. ### Metalake commands - Show all metalakes +`gcli metalake create --metalake --comment ` +: Create a metalake. -```bash -gcli metalake list -``` +`gcli metalake properties` +: Show the properties for a metalake. - Show a metalake details +`gcli metalake delete` +: Delete a metalake. -```bash -gcli metalake details -``` +`gcli metalake list` +: List all metalakes - Show a metalake audit information +`gcli metalake details` +: Check the details of a specific a metalake. -```bash -gcli metalake details --audit -``` - - Create a metalake - -```bash -gcli metalake create --metalake my_metalake --comment "This is my metalake" -``` - - Delete a metalake - -```bash -gcli metalake delete -``` +`gcli metalake details --audit` +: Show the audit information for a metalake - Rename a metalake +`gcli metalake update --rename ` +: Rename a metalake -```bash -gcli metalake update --rename demo -``` +`gcli metalake update --comment ""` +: Update the comment for a metalake - Update a metalake's comment +`gcli metalake set --property --value ` +: Set the property for a metalake. -```bash -gcli metalake update --comment "new comment" -``` - - Display a metalake's properties - -```bash -gcli metalake properties -``` - - Set a metalake's property - -```
Re: [PR] [doc] Revise the CLI documentation [gravitino]
justinmclean commented on code in PR #5840: URL: https://github.com/apache/gravitino/pull/5840#discussion_r1881221837 ## docs/cli.md: ## @@ -152,710 +163,464 @@ keytabFile=file.keytab ### Potentially unsafe operations -For operations that delete data or rename a metalake the user with be prompted to make sure they wish to run this command. The `--force` option can be specified to override this behaviour. +For operations that delete data or rename a metalake, the users will be prompted to +make sure they wish to run this command. +The `--force` option can be specified to override this behaviour. ### Manage metadata All the commands are performed by using the [Java API](api/java-api) internally. -### Display help +### Show help -To display help on command usage: +To view the help on command usage: ```bash gcli --help ``` -### Display client version +### Show version -To display the client version: +`gcli --version` +: Show the client version. -```bash -gcli --version -``` +`gcli --server` +: Show the server version. -### Display server version +:::note +**Client/server version mismatch** -To display the server version: +If the client and server are running different versions of the Gravitino software, +you may need to ignore the client/server version check for the command to be run. +This can be done in several ways: -```bash -gcli --server -``` - -### Client/server version mismatch - -If the client and server are running different versions of the Gravitino software then you may need to ignore the client/server version check for the command to run. This can be done in several ways: - -1. Passed in on the command line via the `--ignore` parameter. -2. Set via the `GRAVITINO_IGNORE` environment variable. -3. Stored in the Gravitino CLI configuration file. +1. Specify the `--ignore` argument in the command line. +1. Set the `GRAVITINO_IGNORE` environment variable. +1. Save it in the Gravitino CLI configuration file. +::: ### Multiple properties For commands that accept multiple properties they can be specified in a couple of different ways: -1. gcli --properties n1=v1,n2=v2,n3=v3 - -2. gcli --properties n1=v1 n2=v2 n3=v3 - -3. gcli --properties n1=v1 --properties n2=v2 --properties n3=v3 +1. `gcli --properties n1=v1,n2=v2,n3=v3` +2. `gcli --properties n1=v1 n2=v2 n3=v3` +3. `gcli --properties n1=v1 --properties n2=v2 --properties n3=v3` ### Setting properties and tags - Different options are needed to add a tag and set a property of a tag with `gcli tag set`. To add a - tag, specify the tag (via --tag) and the entity to tag (via --name). To set the property of a tag - (via --tag) you need to specify the property (via --property) and value (via --value) you want to - set. +Different options are needed to add a tag or to set a property for a tag using `gcli tag set`. +To add a tag, specify the tag (via `--tag`) and the entity to tag (via `--name`). +To set the property of a tag (via `--tag`) you need to specify the property (via `--property`) +and value (via `--value`) you want to set. - To delete a tag, again, you need to specify the tag and entity, to remove a tag's property you need - to select the tag and property. +To delete a tag, again, you need to specify the tag and the entity; to remove a tag's property, +you need to select the tag and property. -### CLI commands +## Command examples -Please set the metalake in the Gravitino configuration file or the environment variable before running any of these commands. +Please set the metalake in the Gravitino configuration file or the environment variable before +running any of these commands. ### Metalake commands - Show all metalakes +`gcli metalake create --metalake --comment ` +: Create a metalake. -```bash -gcli metalake list -``` +`gcli metalake properties` +: Show the properties for a metalake. - Show a metalake details +`gcli metalake delete` +: Delete a metalake. -```bash -gcli metalake details -``` +`gcli metalake list` +: List all metalakes - Show a metalake audit information +`gcli metalake details` +: Check the details of a specific a metalake. -```bash -gcli metalake details --audit -``` - - Create a metalake - -```bash -gcli metalake create --metalake my_metalake --comment "This is my metalake" -``` - - Delete a metalake - -```bash -gcli metalake delete -``` +`gcli metalake details --audit` +: Show the audit information for a metalake - Rename a metalake +`gcli metalake update --rename ` +: Rename a metalake -```bash -gcli metalake update --rename demo -``` +`gcli metalake update --comment ""` +: Update the comment for a metalake - Update a metalake's comment +`gcli metalake set --property --value ` +: Set the property for a metalake. -```bash -gcli metalake update --comment "new comment" -``` - - Display a metalake's properties - -```bash -gcli metalake properties -``` - - Set a metalake's property
Re: [PR] [doc] Revise the CLI documentation [gravitino]
justinmclean commented on code in PR #5840: URL: https://github.com/apache/gravitino/pull/5840#discussion_r1881187011 ## docs/cli.md: ## @@ -64,54 +68,60 @@ The general structure for running commands with the Gravitino CLI is `gcli entit -x,--index display index information -z,--provider provider one of hadoop, hive, mysql, postgres, iceberg, kafka - ``` +``` -## Commands +## Commands Types The following commands are used for entity management: -- list: List available entities -- details: Show detailed information about an entity -- create: Create a new entity -- delete: Delete an existing entity -- update: Update an existing entity -- set: Set a property on an entity -- remove: Remove a property from an entity -- properties: Display an entities properties +- `create`: Create a new entity +- `delete`: Delete an existing entity +- `details`: Show detailed information about an entity +- `list`: List available entities +- `properties`: Display an entity's properties +- `remove`: Remove a property from an entity +- `set`: Set a property on an entity +- `update`: Update an existing entity Review Comment: While there may be other logical ways to order them, that doesn't mean we should do it alphabetically. `list` is first as it is most likely the first command a user will want to use, followed by `details` the next most likely command a user would use and `list` and `details` are commonly used together. `delete` pairs with `create` so that is why it comes before `update`. If the commands were slightly different, I'd would have gone with a more CRUD style ordering. As a native English speaker, I would not expect this to be in alphabetical order. Alphabetical order is used when you have a long list. If there were, say 20 options, I would sort them alphabetically or break them up into groups. Note the `--help` command is sorted alphabetically, but I had considered following this advice from https://clig.dev/#help "Display the most common flags and commands at the start of the help text. It’s fine to have lots of flags, but if you’ve got some really common ones, display them first. For example, the Git command displays the commands for getting started and the most commonly used subcommands first:" There is also actual usability research on this: https://www.nngroup.com/articles/alphabetical-sorting-must-mostly-die/ Basically, when users don't know the name of the thing they want, it makes A–Z listings useless and A–Z listings are directly harmful because they hide logical ordering. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
Re: [PR] [doc] Revise the CLI documentation [gravitino]
justinmclean commented on code in PR #5840: URL: https://github.com/apache/gravitino/pull/5840#discussion_r1881218920 ## docs/cli.md: ## @@ -8,25 +8,29 @@ last_update: license: 'This software is licensed under the Apache License version 2.' --- -This document provides guidance on managing metadata within Apache Gravitino using the Command Line Interface (CLI). The CLI offers a terminal based alternative to using code or the REST interface for metadata management. +This document provides a guidance on managing metadata within Apache Gravitino using +the Command Line Interface (CLI). The CLI offers a terminal based alternative to +using code or the REST API for metadata management. -Currently, the CLI allows users to view metadata information for metalakes, catalogs, schemas, tables, users, roles, groups, tags, topics and filesets. Future updates will expand on these capabilities. +Currently, the CLI allows users to view metadata information for metalakes, catalogs, +schemas, tables, users, roles, groups, tags, topics and filesets. +Future updates will expand on these capabilities. ## Running the CLI -You can configure an alias for the CLI for ease of use, with the following command: +You can configure an alias for the CLI for ease of use. For example: Review Comment: Neither am I -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
Re: [PR] [doc] Revise the CLI documentation [gravitino]
tengqm commented on code in PR #5840: URL: https://github.com/apache/gravitino/pull/5840#discussion_r1881209963 ## docs/cli.md: ## @@ -8,25 +8,29 @@ last_update: license: 'This software is licensed under the Apache License version 2.' --- -This document provides guidance on managing metadata within Apache Gravitino using the Command Line Interface (CLI). The CLI offers a terminal based alternative to using code or the REST interface for metadata management. +This document provides a guidance on managing metadata within Apache Gravitino using +the Command Line Interface (CLI). The CLI offers a terminal based alternative to +using code or the REST API for metadata management. -Currently, the CLI allows users to view metadata information for metalakes, catalogs, schemas, tables, users, roles, groups, tags, topics and filesets. Future updates will expand on these capabilities. +Currently, the CLI allows users to view metadata information for metalakes, catalogs, +schemas, tables, users, roles, groups, tags, topics and filesets. +Future updates will expand on these capabilities. ## Running the CLI -You can configure an alias for the CLI for ease of use, with the following command: +You can configure an alias for the CLI for ease of use. For example: Review Comment: Okay. I'm not strongly opinionated at this. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
Re: [PR] [doc] Revise the CLI documentation [gravitino]
tengqm commented on code in PR #5840: URL: https://github.com/apache/gravitino/pull/5840#discussion_r1881209046 ## docs/cli.md: ## @@ -64,54 +68,60 @@ The general structure for running commands with the Gravitino CLI is `gcli entit -x,--index display index information -z,--provider provider one of hadoop, hive, mysql, postgres, iceberg, kafka - ``` +``` -## Commands +## Commands Types The following commands are used for entity management: -- list: List available entities -- details: Show detailed information about an entity -- create: Create a new entity -- delete: Delete an existing entity -- update: Update an existing entity -- set: Set a property on an entity -- remove: Remove a property from an entity -- properties: Display an entities properties +- `create`: Create a new entity +- `delete`: Delete an existing entity +- `details`: Show detailed information about an entity +- `list`: List available entities +- `properties`: Display an entity's properties +- `remove`: Remove a property from an entity +- `set`: Set a property on an entity +- `update`: Update an existing entity Review Comment: @justinmclean That is persuasive. I was most of the time treating this docs as reference rather than a tutorial. In a tutorial or guideline, we leave the least frequently used (aka, "advanced") commands at the bottom of the list. In this case, maybe, as you said, we can keep the short list as is. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
Re: [PR] [doc] Revise the CLI documentation [gravitino]
justinmclean commented on code in PR #5840: URL: https://github.com/apache/gravitino/pull/5840#discussion_r1881194308 ## docs/cli.md: ## @@ -8,25 +8,29 @@ last_update: license: 'This software is licensed under the Apache License version 2.' --- -This document provides guidance on managing metadata within Apache Gravitino using the Command Line Interface (CLI). The CLI offers a terminal based alternative to using code or the REST interface for metadata management. +This document provides a guidance on managing metadata within Apache Gravitino using +the Command Line Interface (CLI). The CLI offers a terminal based alternative to +using code or the REST API for metadata management. Review Comment: Here, you can see two words have been changed, and I know no other changes have been made. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
Re: [PR] [doc] Revise the CLI documentation [gravitino]
justinmclean commented on code in PR #5840: URL: https://github.com/apache/gravitino/pull/5840#discussion_r1881196503 ## docs/cli.md: ## @@ -8,25 +8,29 @@ last_update: license: 'This software is licensed under the Apache License version 2.' --- -This document provides guidance on managing metadata within Apache Gravitino using the Command Line Interface (CLI). The CLI offers a terminal based alternative to using code or the REST interface for metadata management. +This document provides a guidance on managing metadata within Apache Gravitino using +the Command Line Interface (CLI). The CLI offers a terminal based alternative to +using code or the REST API for metadata management. -Currently, the CLI allows users to view metadata information for metalakes, catalogs, schemas, tables, users, roles, groups, tags, topics and filesets. Future updates will expand on these capabilities. +Currently, the CLI allows users to view metadata information for metalakes, catalogs, +schemas, tables, users, roles, groups, tags, topics and filesets. +Future updates will expand on these capabilities. ## Running the CLI -You can configure an alias for the CLI for ease of use, with the following command: +You can configure an alias for the CLI for ease of use. For example: Review Comment: Because if you compile it, that is what you always get, but it's a minor thing. This change probably doesn't matter in teh scheme of things. ## docs/cli.md: ## @@ -8,25 +8,29 @@ last_update: license: 'This software is licensed under the Apache License version 2.' --- -This document provides guidance on managing metadata within Apache Gravitino using the Command Line Interface (CLI). The CLI offers a terminal based alternative to using code or the REST interface for metadata management. +This document provides a guidance on managing metadata within Apache Gravitino using +the Command Line Interface (CLI). The CLI offers a terminal based alternative to +using code or the REST API for metadata management. -Currently, the CLI allows users to view metadata information for metalakes, catalogs, schemas, tables, users, roles, groups, tags, topics and filesets. Future updates will expand on these capabilities. +Currently, the CLI allows users to view metadata information for metalakes, catalogs, +schemas, tables, users, roles, groups, tags, topics and filesets. +Future updates will expand on these capabilities. ## Running the CLI -You can configure an alias for the CLI for ease of use, with the following command: +You can configure an alias for the CLI for ease of use. For example: Review Comment: Because if you compile it, that is what you always get, but it's a minor thing. This change probably doesn't matter in the scheme of things. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
Re: [PR] [doc] Revise the CLI documentation [gravitino]
justinmclean commented on code in PR #5840: URL: https://github.com/apache/gravitino/pull/5840#discussion_r1881193889 ## docs/cli.md: ## @@ -8,25 +8,29 @@ last_update: license: 'This software is licensed under the Apache License version 2.' --- -This document provides guidance on managing metadata within Apache Gravitino using the Command Line Interface (CLI). The CLI offers a terminal based alternative to using code or the REST interface for metadata management. +This document provides a guidance on managing metadata within Apache Gravitino using +the Command Line Interface (CLI). The CLI offers a terminal based alternative to +using code or the REST API for metadata management. Review Comment: That shows no changes other than the newlines or lines moved. This is a better example: https://github.com/user-attachments/assets/71f4ff63-674d-4c04-82b2-49ad5308cb19"; /> -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
Re: [PR] [doc] Revise the CLI documentation [gravitino]
justinmclean commented on code in PR #5840: URL: https://github.com/apache/gravitino/pull/5840#discussion_r1881194308 ## docs/cli.md: ## @@ -8,25 +8,29 @@ last_update: license: 'This software is licensed under the Apache License version 2.' --- -This document provides guidance on managing metadata within Apache Gravitino using the Command Line Interface (CLI). The CLI offers a terminal based alternative to using code or the REST interface for metadata management. +This document provides a guidance on managing metadata within Apache Gravitino using +the Command Line Interface (CLI). The CLI offers a terminal based alternative to +using code or the REST API for metadata management. Review Comment: Here you can see two words have been changed -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
Re: [PR] [doc] Revise the CLI documentation [gravitino]
justinmclean commented on code in PR #5840: URL: https://github.com/apache/gravitino/pull/5840#discussion_r1881187011 ## docs/cli.md: ## @@ -64,54 +68,60 @@ The general structure for running commands with the Gravitino CLI is `gcli entit -x,--index display index information -z,--provider provider one of hadoop, hive, mysql, postgres, iceberg, kafka - ``` +``` -## Commands +## Commands Types The following commands are used for entity management: -- list: List available entities -- details: Show detailed information about an entity -- create: Create a new entity -- delete: Delete an existing entity -- update: Update an existing entity -- set: Set a property on an entity -- remove: Remove a property from an entity -- properties: Display an entities properties +- `create`: Create a new entity +- `delete`: Delete an existing entity +- `details`: Show detailed information about an entity +- `list`: List available entities +- `properties`: Display an entity's properties +- `remove`: Remove a property from an entity +- `set`: Set a property on an entity +- `update`: Update an existing entity Review Comment: While there may be other logical ways to order them, that doesn't mean we should do it alphabetically. `list` is first as it is most likely the first command a user will want to use, followed by `details` the next most likely command a user would use and `list` and `details` are commonly used together. `delete` pairs with `create` so that is why it comes before `update`. If the commands were slightly different, I'd would have gone with a more CRUD style ordering. As a native English speaker, I would not expect this to be in alphabetical order. Alphabetical order is used when you have a long list. If there were, say 20 options, I would sort them alphabetically or break them up into groups. Not in the `--help` command is sorted alphabetically, but I had considered following this advice from https://clig.dev/#help "Display the most common flags and commands at the start of the help text. It’s fine to have lots of flags, but if you’ve got some really common ones, display them first. For example, the Git command displays the commands for getting started and the most commonly used subcommands first:" There is also actual usability research on this: https://www.nngroup.com/articles/alphabetical-sorting-must-mostly-die/ Basically, when users don't know the name of the thing they want, it makes A–Z listings useless and A–Z listings are directly harmful because they hide logical ordering. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
Re: [PR] [doc] Revise the CLI documentation [gravitino]
tengqm commented on code in PR #5840: URL: https://github.com/apache/gravitino/pull/5840#discussion_r1881158655 ## docs/cli.md: ## @@ -8,25 +8,29 @@ last_update: license: 'This software is licensed under the Apache License version 2.' --- -This document provides guidance on managing metadata within Apache Gravitino using the Command Line Interface (CLI). The CLI offers a terminal based alternative to using code or the REST interface for metadata management. +This document provides a guidance on managing metadata within Apache Gravitino using +the Command Line Interface (CLI). The CLI offers a terminal based alternative to +using code or the REST API for metadata management. Review Comment: Em... Let me try articulate the reasons behind this kind of changes. - We'd better treat docs as code. That means we write them and then track whatever changes in the future. - The GIT tool compare changes on a line by line basis. When we have a long line of text, GIT can only tell you that this "line" has changed. We as human reviewers have to identify the actual change(s) manually. That means a painful experience like finding a needle fallen on the ground. - The GitHub web UI works the same way. I have myself been tortured by this for many years. - When we break long lines manually, appropriately, this line breaks are not impacting the rendered output (mainly HTML here). - With manual line breaks, we ensure that every developer sees the same thing on his or her environment. Think about the tab size problem here. - I am not quite sure how an IDE helps improve the documentation. Even if there is an IDE (say IDEA) can do a great job for something, we are not writing code/docs for that IDE. Human is not supposed to be hijacked by tools, right? - I'm open to learn the draw backs of manually wrapped long lines. In some other communities, manually wrapping long lines is strongly encouraged. - This does NOT mean we want to encourage people to break the long lines at a fix boundary. The recommended way is to break them WHEN APPROPRIATE. For example, we encourage breaking long lines when a statement ends, when there is a punctuation character, so on and so forth. We discourage breaking links, however, because it doesn't make a lot of senses. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
Re: [PR] [doc] Revise the CLI documentation [gravitino]
tengqm commented on code in PR #5840: URL: https://github.com/apache/gravitino/pull/5840#discussion_r1881173861 ## docs/cli.md: ## @@ -8,25 +8,29 @@ last_update: license: 'This software is licensed under the Apache License version 2.' --- -This document provides guidance on managing metadata within Apache Gravitino using the Command Line Interface (CLI). The CLI offers a terminal based alternative to using code or the REST interface for metadata management. +This document provides a guidance on managing metadata within Apache Gravitino using +the Command Line Interface (CLI). The CLI offers a terminal based alternative to +using code or the REST API for metadata management. Review Comment:  Let's use the change I made as an example. GitHub failed to identify that this change is only about inserting several line breaks. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
Re: [PR] [doc] Revise the CLI documentation [gravitino]
tengqm commented on code in PR #5840: URL: https://github.com/apache/gravitino/pull/5840#discussion_r1881166402 ## docs/cli.md: ## @@ -64,54 +68,60 @@ The general structure for running commands with the Gravitino CLI is `gcli entit -x,--index display index information -z,--provider provider one of hadoop, hive, mysql, postgres, iceberg, kafka - ``` +``` -## Commands +## Commands Types The following commands are used for entity management: -- list: List available entities -- details: Show detailed information about an entity -- create: Create a new entity -- delete: Delete an existing entity -- update: Update an existing entity -- set: Set a property on an entity -- remove: Remove a property from an entity -- properties: Display an entities properties +- `create`: Create a new entity +- `delete`: Delete an existing entity +- `details`: Show detailed information about an entity +- `list`: List available entities +- `properties`: Display an entity's properties +- `remove`: Remove a property from an entity +- `set`: Set a property on an entity +- `update`: Update an existing entity ### Setting the Metalake name -As dealing with one Metalake is a typical scenario, you can set the Metalake name in several ways so it doesn't need to be passed on the command line. +Considering that managing a metalake is a typical scenario, you can set the metalake +name in several ways so it doesn't need to be passed on the command line. -1. Passed in on the command line via the `--metalake` parameter. -2. Set via the `GRAVITINO_METALAKE` environment variable. -3. Stored in the Gravitino CLI configuration file. +1. Specify the `--metalake` argument on the command line. +1. Set the `GRAVITINO_METALAKE` environment variable. +1. Save it in the Gravitino [CLI configuration file](#config-file). Review Comment: Yup. Good suggestion. ## docs/cli.md: ## @@ -8,25 +8,29 @@ last_update: license: 'This software is licensed under the Apache License version 2.' --- -This document provides guidance on managing metadata within Apache Gravitino using the Command Line Interface (CLI). The CLI offers a terminal based alternative to using code or the REST interface for metadata management. +This document provides a guidance on managing metadata within Apache Gravitino using +the Command Line Interface (CLI). The CLI offers a terminal based alternative to +using code or the REST API for metadata management. -Currently, the CLI allows users to view metadata information for metalakes, catalogs, schemas, tables, users, roles, groups, tags, topics and filesets. Future updates will expand on these capabilities. +Currently, the CLI allows users to view metadata information for metalakes, catalogs, +schemas, tables, users, roles, groups, tags, topics and filesets. +Future updates will expand on these capabilities. ## Running the CLI -You can configure an alias for the CLI for ease of use, with the following command: +You can configure an alias for the CLI for ease of use. For example: Review Comment: Well .. it is. It is using a "incubating", "SNAPSHOT" jar. If the syntax is changed to `alias gcli='java -jar `, I would not call it an example. ## docs/cli.md: ## @@ -8,25 +8,29 @@ last_update: license: 'This software is licensed under the Apache License version 2.' --- -This document provides guidance on managing metadata within Apache Gravitino using the Command Line Interface (CLI). The CLI offers a terminal based alternative to using code or the REST interface for metadata management. +This document provides a guidance on managing metadata within Apache Gravitino using Review Comment: OK. ## docs/cli.md: ## @@ -152,710 +163,464 @@ keytabFile=file.keytab ### Potentially unsafe operations -For operations that delete data or rename a metalake the user with be prompted to make sure they wish to run this command. The `--force` option can be specified to override this behaviour. +For operations that delete data or rename a metalake, the users will be prompted to +make sure they wish to run this command. +The `--force` option can be specified to override this behaviour. ### Manage metadata All the commands are performed by using the [Java API](api/java-api) internally. -### Display help +### Show help -To display help on command usage: +To view the help on command usage: ```bash gcli --help ``` -### Display client version +### Show version -To display the client version: +`gcli --version` +: Show the client version. -```bash -gcli --version -``` +`gcli --server` +: Show the server version. -### Display server version +:::note +**Client/server version mismatch** -To display the server version: +If the client and server are running different versions of the Gravitino software, +you may need to ignore the client/server version check for the command t
Re: [PR] [doc] Revise the CLI documentation [gravitino]
justinmclean commented on code in PR #5840: URL: https://github.com/apache/gravitino/pull/5840#discussion_r1881164753 ## docs/cli.md: ## @@ -8,25 +8,29 @@ last_update: license: 'This software is licensed under the Apache License version 2.' --- -This document provides guidance on managing metadata within Apache Gravitino using the Command Line Interface (CLI). The CLI offers a terminal based alternative to using code or the REST interface for metadata management. +This document provides a guidance on managing metadata within Apache Gravitino using +the Command Line Interface (CLI). The CLI offers a terminal based alternative to +using code or the REST API for metadata management. Review Comment: The GitHub web UI doesn't work the same way it highlights word changes within a line. We are writing docs in an IDE, and IDE plugins such as grammar checkers help do that. They don't always work if you break sentences over lines. In this project, I noticed that in the documentation that breaks up sentences, errors are easily introduced in changes (as they are here). ## docs/cli.md: ## @@ -8,25 +8,29 @@ last_update: license: 'This software is licensed under the Apache License version 2.' --- -This document provides guidance on managing metadata within Apache Gravitino using the Command Line Interface (CLI). The CLI offers a terminal based alternative to using code or the REST interface for metadata management. +This document provides a guidance on managing metadata within Apache Gravitino using +the Command Line Interface (CLI). The CLI offers a terminal based alternative to +using code or the REST API for metadata management. Review Comment: The GitHub web UI doesn't work the same way it highlights word changes within a line. We are writing docs in an IDE, and IDE plugins such as grammar checkers help do that. They don't always work if you break sentences over lines. In this project, I noticed that in the documentation that breaks up sentences, errors are easily introduced in changes (as they have been here). -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
Re: [PR] [doc] Revise the CLI documentation [gravitino]
tengqm commented on code in PR #5840: URL: https://github.com/apache/gravitino/pull/5840#discussion_r1881164099 ## docs/cli.md: ## @@ -64,54 +68,60 @@ The general structure for running commands with the Gravitino CLI is `gcli entit -x,--index display index information -z,--provider provider one of hadoop, hive, mysql, postgres, iceberg, kafka - ``` +``` -## Commands +## Commands Types The following commands are used for entity management: -- list: List available entities -- details: Show detailed information about an entity -- create: Create a new entity -- delete: Delete an existing entity -- update: Update an existing entity -- set: Set a property on an entity -- remove: Remove a property from an entity -- properties: Display an entities properties +- `create`: Create a new entity +- `delete`: Delete an existing entity +- `details`: Show detailed information about an entity +- `list`: List available entities +- `properties`: Display an entity's properties +- `remove`: Remove a property from an entity +- `set`: Set a property on an entity +- `update`: Update an existing entity Review Comment: As I have responded in another review comment. When we don't have a consensus on the ordering of things, the best way to do it is to sort them in alphabetic order. Why? Every people may have a different opinion on the definition of "logical grouping". For example, why the first entry should be `list`? What am I doing this if I haven't created something? Why `delete` comes before `update`? The main problem of this "logical grouping" is about predictability. There will never be a consensus on the correct/golden ordering. With that, I'm strongly against it. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
Re: [PR] [doc] Revise the CLI documentation [gravitino]
justinmclean commented on code in PR #5840: URL: https://github.com/apache/gravitino/pull/5840#discussion_r1881024434 ## docs/cli.md: ## @@ -152,710 +163,464 @@ keytabFile=file.keytab ### Potentially unsafe operations -For operations that delete data or rename a metalake the user with be prompted to make sure they wish to run this command. The `--force` option can be specified to override this behaviour. +For operations that delete data or rename a metalake, the users will be prompted to +make sure they wish to run this command. +The `--force` option can be specified to override this behaviour. ### Manage metadata All the commands are performed by using the [Java API](api/java-api) internally. -### Display help +### Show help -To display help on command usage: +To view the help on command usage: ```bash gcli --help ``` -### Display client version +### Show version -To display the client version: +`gcli --version` +: Show the client version. -```bash -gcli --version -``` +`gcli --server` +: Show the server version. -### Display server version +:::note +**Client/server version mismatch** -To display the server version: +If the client and server are running different versions of the Gravitino software, +you may need to ignore the client/server version check for the command to be run. +This can be done in several ways: -```bash -gcli --server -``` - -### Client/server version mismatch - -If the client and server are running different versions of the Gravitino software then you may need to ignore the client/server version check for the command to run. This can be done in several ways: - -1. Passed in on the command line via the `--ignore` parameter. -2. Set via the `GRAVITINO_IGNORE` environment variable. -3. Stored in the Gravitino CLI configuration file. +1. Specify the `--ignore` argument in the command line. +1. Set the `GRAVITINO_IGNORE` environment variable. +1. Save it in the Gravitino CLI configuration file. +::: ### Multiple properties For commands that accept multiple properties they can be specified in a couple of different ways: -1. gcli --properties n1=v1,n2=v2,n3=v3 - -2. gcli --properties n1=v1 n2=v2 n3=v3 - -3. gcli --properties n1=v1 --properties n2=v2 --properties n3=v3 +1. `gcli --properties n1=v1,n2=v2,n3=v3` +2. `gcli --properties n1=v1 n2=v2 n3=v3` +3. `gcli --properties n1=v1 --properties n2=v2 --properties n3=v3` ### Setting properties and tags - Different options are needed to add a tag and set a property of a tag with `gcli tag set`. To add a - tag, specify the tag (via --tag) and the entity to tag (via --name). To set the property of a tag - (via --tag) you need to specify the property (via --property) and value (via --value) you want to - set. +Different options are needed to add a tag or to set a property for a tag using `gcli tag set`. +To add a tag, specify the tag (via `--tag`) and the entity to tag (via `--name`). +To set the property of a tag (via `--tag`) you need to specify the property (via `--property`) +and value (via `--value`) you want to set. - To delete a tag, again, you need to specify the tag and entity, to remove a tag's property you need - to select the tag and property. +To delete a tag, again, you need to specify the tag and the entity; to remove a tag's property, +you need to select the tag and property. -### CLI commands +## Command examples -Please set the metalake in the Gravitino configuration file or the environment variable before running any of these commands. +Please set the metalake in the Gravitino configuration file or the environment variable before +running any of these commands. ### Metalake commands - Show all metalakes +`gcli metalake create --metalake --comment ` +: Create a metalake. -```bash -gcli metalake list -``` +`gcli metalake properties` +: Show the properties for a metalake. - Show a metalake details +`gcli metalake delete` +: Delete a metalake. -```bash -gcli metalake details -``` +`gcli metalake list` +: List all metalakes - Show a metalake audit information +`gcli metalake details` +: Check the details of a specific a metalake. -```bash -gcli metalake details --audit -``` - - Create a metalake - -```bash -gcli metalake create --metalake my_metalake --comment "This is my metalake" -``` - - Delete a metalake - -```bash -gcli metalake delete -``` +`gcli metalake details --audit` +: Show the audit information for a metalake - Rename a metalake +`gcli metalake update --rename ` +: Rename a metalake -```bash -gcli metalake update --rename demo -``` +`gcli metalake update --comment ""` +: Update the comment for a metalake - Update a metalake's comment +`gcli metalake set --property --value ` +: Set the property for a metalake. -```bash -gcli metalake update --comment "new comment" -``` - - Display a metalake's properties - -```bash -gcli metalake properties -``` - - Set a metalake's property
Re: [PR] [doc] Revise the CLI documentation [gravitino]
justinmclean commented on code in PR #5840: URL: https://github.com/apache/gravitino/pull/5840#discussion_r1881014243 ## docs/cli.md: ## @@ -152,710 +163,464 @@ keytabFile=file.keytab ### Potentially unsafe operations -For operations that delete data or rename a metalake the user with be prompted to make sure they wish to run this command. The `--force` option can be specified to override this behaviour. +For operations that delete data or rename a metalake, the users will be prompted to +make sure they wish to run this command. +The `--force` option can be specified to override this behaviour. ### Manage metadata All the commands are performed by using the [Java API](api/java-api) internally. -### Display help +### Show help -To display help on command usage: +To view the help on command usage: ```bash gcli --help ``` -### Display client version +### Show version -To display the client version: +`gcli --version` +: Show the client version. -```bash -gcli --version -``` +`gcli --server` +: Show the server version. -### Display server version +:::note +**Client/server version mismatch** -To display the server version: +If the client and server are running different versions of the Gravitino software, +you may need to ignore the client/server version check for the command to be run. +This can be done in several ways: -```bash -gcli --server -``` - -### Client/server version mismatch - -If the client and server are running different versions of the Gravitino software then you may need to ignore the client/server version check for the command to run. This can be done in several ways: - -1. Passed in on the command line via the `--ignore` parameter. -2. Set via the `GRAVITINO_IGNORE` environment variable. -3. Stored in the Gravitino CLI configuration file. +1. Specify the `--ignore` argument in the command line. +1. Set the `GRAVITINO_IGNORE` environment variable. +1. Save it in the Gravitino CLI configuration file. +::: ### Multiple properties For commands that accept multiple properties they can be specified in a couple of different ways: -1. gcli --properties n1=v1,n2=v2,n3=v3 - -2. gcli --properties n1=v1 n2=v2 n3=v3 - -3. gcli --properties n1=v1 --properties n2=v2 --properties n3=v3 +1. `gcli --properties n1=v1,n2=v2,n3=v3` +2. `gcli --properties n1=v1 n2=v2 n3=v3` +3. `gcli --properties n1=v1 --properties n2=v2 --properties n3=v3` ### Setting properties and tags - Different options are needed to add a tag and set a property of a tag with `gcli tag set`. To add a - tag, specify the tag (via --tag) and the entity to tag (via --name). To set the property of a tag - (via --tag) you need to specify the property (via --property) and value (via --value) you want to - set. +Different options are needed to add a tag or to set a property for a tag using `gcli tag set`. +To add a tag, specify the tag (via `--tag`) and the entity to tag (via `--name`). +To set the property of a tag (via `--tag`) you need to specify the property (via `--property`) +and value (via `--value`) you want to set. - To delete a tag, again, you need to specify the tag and entity, to remove a tag's property you need - to select the tag and property. +To delete a tag, again, you need to specify the tag and the entity; to remove a tag's property, +you need to select the tag and property. -### CLI commands +## Command examples -Please set the metalake in the Gravitino configuration file or the environment variable before running any of these commands. +Please set the metalake in the Gravitino configuration file or the environment variable before +running any of these commands. ### Metalake commands - Show all metalakes +`gcli metalake create --metalake --comment ` +: Create a metalake. -```bash -gcli metalake list -``` +`gcli metalake properties` +: Show the properties for a metalake. - Show a metalake details +`gcli metalake delete` +: Delete a metalake. -```bash -gcli metalake details -``` +`gcli metalake list` +: List all metalakes - Show a metalake audit information +`gcli metalake details` +: Check the details of a specific a metalake. -```bash -gcli metalake details --audit -``` - - Create a metalake - -```bash -gcli metalake create --metalake my_metalake --comment "This is my metalake" -``` - - Delete a metalake - -```bash -gcli metalake delete -``` +`gcli metalake details --audit` +: Show the audit information for a metalake - Rename a metalake +`gcli metalake update --rename ` +: Rename a metalake -```bash -gcli metalake update --rename demo -``` +`gcli metalake update --comment ""` +: Update the comment for a metalake - Update a metalake's comment +`gcli metalake set --property --value ` +: Set the property for a metalake. -```bash -gcli metalake update --comment "new comment" -``` - - Display a metalake's properties - -```bash -gcli metalake properties -``` - - Set a metalake's property
Re: [PR] [doc] Revise the CLI documentation [gravitino]
justinmclean commented on code in PR #5840: URL: https://github.com/apache/gravitino/pull/5840#discussion_r1881020162 ## docs/cli.md: ## @@ -152,710 +163,464 @@ keytabFile=file.keytab ### Potentially unsafe operations -For operations that delete data or rename a metalake the user with be prompted to make sure they wish to run this command. The `--force` option can be specified to override this behaviour. +For operations that delete data or rename a metalake, the users will be prompted to +make sure they wish to run this command. +The `--force` option can be specified to override this behaviour. ### Manage metadata All the commands are performed by using the [Java API](api/java-api) internally. -### Display help +### Show help -To display help on command usage: +To view the help on command usage: ```bash gcli --help ``` -### Display client version +### Show version -To display the client version: +`gcli --version` +: Show the client version. -```bash -gcli --version -``` +`gcli --server` +: Show the server version. -### Display server version +:::note +**Client/server version mismatch** -To display the server version: +If the client and server are running different versions of the Gravitino software, +you may need to ignore the client/server version check for the command to be run. +This can be done in several ways: -```bash -gcli --server -``` - -### Client/server version mismatch - -If the client and server are running different versions of the Gravitino software then you may need to ignore the client/server version check for the command to run. This can be done in several ways: - -1. Passed in on the command line via the `--ignore` parameter. -2. Set via the `GRAVITINO_IGNORE` environment variable. -3. Stored in the Gravitino CLI configuration file. +1. Specify the `--ignore` argument in the command line. +1. Set the `GRAVITINO_IGNORE` environment variable. +1. Save it in the Gravitino CLI configuration file. +::: ### Multiple properties For commands that accept multiple properties they can be specified in a couple of different ways: -1. gcli --properties n1=v1,n2=v2,n3=v3 - -2. gcli --properties n1=v1 n2=v2 n3=v3 - -3. gcli --properties n1=v1 --properties n2=v2 --properties n3=v3 +1. `gcli --properties n1=v1,n2=v2,n3=v3` +2. `gcli --properties n1=v1 n2=v2 n3=v3` +3. `gcli --properties n1=v1 --properties n2=v2 --properties n3=v3` ### Setting properties and tags - Different options are needed to add a tag and set a property of a tag with `gcli tag set`. To add a - tag, specify the tag (via --tag) and the entity to tag (via --name). To set the property of a tag - (via --tag) you need to specify the property (via --property) and value (via --value) you want to - set. +Different options are needed to add a tag or to set a property for a tag using `gcli tag set`. +To add a tag, specify the tag (via `--tag`) and the entity to tag (via `--name`). +To set the property of a tag (via `--tag`) you need to specify the property (via `--property`) +and value (via `--value`) you want to set. - To delete a tag, again, you need to specify the tag and entity, to remove a tag's property you need - to select the tag and property. +To delete a tag, again, you need to specify the tag and the entity; to remove a tag's property, +you need to select the tag and property. -### CLI commands +## Command examples -Please set the metalake in the Gravitino configuration file or the environment variable before running any of these commands. +Please set the metalake in the Gravitino configuration file or the environment variable before +running any of these commands. ### Metalake commands - Show all metalakes +`gcli metalake create --metalake --comment ` +: Create a metalake. -```bash -gcli metalake list -``` +`gcli metalake properties` +: Show the properties for a metalake. - Show a metalake details +`gcli metalake delete` +: Delete a metalake. -```bash -gcli metalake details -``` +`gcli metalake list` +: List all metalakes - Show a metalake audit information +`gcli metalake details` +: Check the details of a specific a metalake. -```bash -gcli metalake details --audit -``` - - Create a metalake - -```bash -gcli metalake create --metalake my_metalake --comment "This is my metalake" -``` - - Delete a metalake - -```bash -gcli metalake delete -``` +`gcli metalake details --audit` +: Show the audit information for a metalake - Rename a metalake +`gcli metalake update --rename ` +: Rename a metalake -```bash -gcli metalake update --rename demo -``` +`gcli metalake update --comment ""` +: Update the comment for a metalake - Update a metalake's comment +`gcli metalake set --property --value ` +: Set the property for a metalake. -```bash -gcli metalake update --comment "new comment" -``` - - Display a metalake's properties - -```bash -gcli metalake properties -``` - - Set a metalake's property
Re: [PR] [doc] Revise the CLI documentation [gravitino]
justinmclean commented on code in PR #5840: URL: https://github.com/apache/gravitino/pull/5840#discussion_r1881019130 ## docs/cli.md: ## @@ -152,710 +163,464 @@ keytabFile=file.keytab ### Potentially unsafe operations -For operations that delete data or rename a metalake the user with be prompted to make sure they wish to run this command. The `--force` option can be specified to override this behaviour. +For operations that delete data or rename a metalake, the users will be prompted to +make sure they wish to run this command. +The `--force` option can be specified to override this behaviour. ### Manage metadata All the commands are performed by using the [Java API](api/java-api) internally. -### Display help +### Show help -To display help on command usage: +To view the help on command usage: ```bash gcli --help ``` -### Display client version +### Show version -To display the client version: +`gcli --version` +: Show the client version. -```bash -gcli --version -``` +`gcli --server` +: Show the server version. -### Display server version +:::note +**Client/server version mismatch** -To display the server version: +If the client and server are running different versions of the Gravitino software, +you may need to ignore the client/server version check for the command to be run. +This can be done in several ways: -```bash -gcli --server -``` - -### Client/server version mismatch - -If the client and server are running different versions of the Gravitino software then you may need to ignore the client/server version check for the command to run. This can be done in several ways: - -1. Passed in on the command line via the `--ignore` parameter. -2. Set via the `GRAVITINO_IGNORE` environment variable. -3. Stored in the Gravitino CLI configuration file. +1. Specify the `--ignore` argument in the command line. +1. Set the `GRAVITINO_IGNORE` environment variable. +1. Save it in the Gravitino CLI configuration file. +::: ### Multiple properties For commands that accept multiple properties they can be specified in a couple of different ways: -1. gcli --properties n1=v1,n2=v2,n3=v3 - -2. gcli --properties n1=v1 n2=v2 n3=v3 - -3. gcli --properties n1=v1 --properties n2=v2 --properties n3=v3 +1. `gcli --properties n1=v1,n2=v2,n3=v3` +2. `gcli --properties n1=v1 n2=v2 n3=v3` +3. `gcli --properties n1=v1 --properties n2=v2 --properties n3=v3` ### Setting properties and tags - Different options are needed to add a tag and set a property of a tag with `gcli tag set`. To add a - tag, specify the tag (via --tag) and the entity to tag (via --name). To set the property of a tag - (via --tag) you need to specify the property (via --property) and value (via --value) you want to - set. +Different options are needed to add a tag or to set a property for a tag using `gcli tag set`. +To add a tag, specify the tag (via `--tag`) and the entity to tag (via `--name`). +To set the property of a tag (via `--tag`) you need to specify the property (via `--property`) +and value (via `--value`) you want to set. - To delete a tag, again, you need to specify the tag and entity, to remove a tag's property you need - to select the tag and property. +To delete a tag, again, you need to specify the tag and the entity; to remove a tag's property, +you need to select the tag and property. -### CLI commands +## Command examples -Please set the metalake in the Gravitino configuration file or the environment variable before running any of these commands. +Please set the metalake in the Gravitino configuration file or the environment variable before +running any of these commands. ### Metalake commands - Show all metalakes +`gcli metalake create --metalake --comment ` +: Create a metalake. -```bash -gcli metalake list -``` +`gcli metalake properties` +: Show the properties for a metalake. - Show a metalake details +`gcli metalake delete` +: Delete a metalake. -```bash -gcli metalake details -``` +`gcli metalake list` +: List all metalakes - Show a metalake audit information +`gcli metalake details` +: Check the details of a specific a metalake. -```bash -gcli metalake details --audit -``` - - Create a metalake - -```bash -gcli metalake create --metalake my_metalake --comment "This is my metalake" -``` - - Delete a metalake - -```bash -gcli metalake delete -``` +`gcli metalake details --audit` +: Show the audit information for a metalake - Rename a metalake +`gcli metalake update --rename ` +: Rename a metalake -```bash -gcli metalake update --rename demo -``` +`gcli metalake update --comment ""` +: Update the comment for a metalake - Update a metalake's comment +`gcli metalake set --property --value ` +: Set the property for a metalake. -```bash -gcli metalake update --comment "new comment" -``` - - Display a metalake's properties - -```bash -gcli metalake properties -``` - - Set a metalake's property
Re: [PR] [doc] Revise the CLI documentation [gravitino]
justinmclean commented on code in PR #5840: URL: https://github.com/apache/gravitino/pull/5840#discussion_r1881018415 ## docs/cli.md: ## @@ -152,710 +163,464 @@ keytabFile=file.keytab ### Potentially unsafe operations -For operations that delete data or rename a metalake the user with be prompted to make sure they wish to run this command. The `--force` option can be specified to override this behaviour. +For operations that delete data or rename a metalake, the users will be prompted to +make sure they wish to run this command. +The `--force` option can be specified to override this behaviour. ### Manage metadata All the commands are performed by using the [Java API](api/java-api) internally. -### Display help +### Show help -To display help on command usage: +To view the help on command usage: ```bash gcli --help ``` -### Display client version +### Show version -To display the client version: +`gcli --version` +: Show the client version. -```bash -gcli --version -``` +`gcli --server` +: Show the server version. -### Display server version +:::note +**Client/server version mismatch** -To display the server version: +If the client and server are running different versions of the Gravitino software, +you may need to ignore the client/server version check for the command to be run. +This can be done in several ways: -```bash -gcli --server -``` - -### Client/server version mismatch - -If the client and server are running different versions of the Gravitino software then you may need to ignore the client/server version check for the command to run. This can be done in several ways: - -1. Passed in on the command line via the `--ignore` parameter. -2. Set via the `GRAVITINO_IGNORE` environment variable. -3. Stored in the Gravitino CLI configuration file. +1. Specify the `--ignore` argument in the command line. +1. Set the `GRAVITINO_IGNORE` environment variable. +1. Save it in the Gravitino CLI configuration file. +::: ### Multiple properties For commands that accept multiple properties they can be specified in a couple of different ways: -1. gcli --properties n1=v1,n2=v2,n3=v3 - -2. gcli --properties n1=v1 n2=v2 n3=v3 - -3. gcli --properties n1=v1 --properties n2=v2 --properties n3=v3 +1. `gcli --properties n1=v1,n2=v2,n3=v3` +2. `gcli --properties n1=v1 n2=v2 n3=v3` +3. `gcli --properties n1=v1 --properties n2=v2 --properties n3=v3` ### Setting properties and tags - Different options are needed to add a tag and set a property of a tag with `gcli tag set`. To add a - tag, specify the tag (via --tag) and the entity to tag (via --name). To set the property of a tag - (via --tag) you need to specify the property (via --property) and value (via --value) you want to - set. +Different options are needed to add a tag or to set a property for a tag using `gcli tag set`. +To add a tag, specify the tag (via `--tag`) and the entity to tag (via `--name`). +To set the property of a tag (via `--tag`) you need to specify the property (via `--property`) +and value (via `--value`) you want to set. - To delete a tag, again, you need to specify the tag and entity, to remove a tag's property you need - to select the tag and property. +To delete a tag, again, you need to specify the tag and the entity; to remove a tag's property, +you need to select the tag and property. -### CLI commands +## Command examples -Please set the metalake in the Gravitino configuration file or the environment variable before running any of these commands. +Please set the metalake in the Gravitino configuration file or the environment variable before +running any of these commands. ### Metalake commands - Show all metalakes +`gcli metalake create --metalake --comment ` +: Create a metalake. -```bash -gcli metalake list -``` +`gcli metalake properties` +: Show the properties for a metalake. - Show a metalake details +`gcli metalake delete` +: Delete a metalake. -```bash -gcli metalake details -``` +`gcli metalake list` +: List all metalakes - Show a metalake audit information +`gcli metalake details` +: Check the details of a specific a metalake. -```bash -gcli metalake details --audit -``` - - Create a metalake - -```bash -gcli metalake create --metalake my_metalake --comment "This is my metalake" -``` - - Delete a metalake - -```bash -gcli metalake delete -``` +`gcli metalake details --audit` +: Show the audit information for a metalake - Rename a metalake +`gcli metalake update --rename ` +: Rename a metalake -```bash -gcli metalake update --rename demo -``` +`gcli metalake update --comment ""` +: Update the comment for a metalake - Update a metalake's comment +`gcli metalake set --property --value ` +: Set the property for a metalake. -```bash -gcli metalake update --comment "new comment" -``` - - Display a metalake's properties - -```bash -gcli metalake properties -``` - - Set a metalake's property
Re: [PR] [doc] Revise the CLI documentation [gravitino]
justinmclean commented on code in PR #5840: URL: https://github.com/apache/gravitino/pull/5840#discussion_r1881015564 ## docs/cli.md: ## @@ -152,710 +163,464 @@ keytabFile=file.keytab ### Potentially unsafe operations -For operations that delete data or rename a metalake the user with be prompted to make sure they wish to run this command. The `--force` option can be specified to override this behaviour. +For operations that delete data or rename a metalake, the users will be prompted to +make sure they wish to run this command. +The `--force` option can be specified to override this behaviour. ### Manage metadata All the commands are performed by using the [Java API](api/java-api) internally. -### Display help +### Show help -To display help on command usage: +To view the help on command usage: ```bash gcli --help ``` -### Display client version +### Show version -To display the client version: +`gcli --version` +: Show the client version. -```bash -gcli --version -``` +`gcli --server` +: Show the server version. -### Display server version +:::note +**Client/server version mismatch** -To display the server version: +If the client and server are running different versions of the Gravitino software, +you may need to ignore the client/server version check for the command to be run. +This can be done in several ways: -```bash -gcli --server -``` - -### Client/server version mismatch - -If the client and server are running different versions of the Gravitino software then you may need to ignore the client/server version check for the command to run. This can be done in several ways: - -1. Passed in on the command line via the `--ignore` parameter. -2. Set via the `GRAVITINO_IGNORE` environment variable. -3. Stored in the Gravitino CLI configuration file. +1. Specify the `--ignore` argument in the command line. +1. Set the `GRAVITINO_IGNORE` environment variable. +1. Save it in the Gravitino CLI configuration file. +::: ### Multiple properties For commands that accept multiple properties they can be specified in a couple of different ways: -1. gcli --properties n1=v1,n2=v2,n3=v3 - -2. gcli --properties n1=v1 n2=v2 n3=v3 - -3. gcli --properties n1=v1 --properties n2=v2 --properties n3=v3 +1. `gcli --properties n1=v1,n2=v2,n3=v3` +2. `gcli --properties n1=v1 n2=v2 n3=v3` +3. `gcli --properties n1=v1 --properties n2=v2 --properties n3=v3` ### Setting properties and tags - Different options are needed to add a tag and set a property of a tag with `gcli tag set`. To add a - tag, specify the tag (via --tag) and the entity to tag (via --name). To set the property of a tag - (via --tag) you need to specify the property (via --property) and value (via --value) you want to - set. +Different options are needed to add a tag or to set a property for a tag using `gcli tag set`. +To add a tag, specify the tag (via `--tag`) and the entity to tag (via `--name`). +To set the property of a tag (via `--tag`) you need to specify the property (via `--property`) +and value (via `--value`) you want to set. - To delete a tag, again, you need to specify the tag and entity, to remove a tag's property you need - to select the tag and property. +To delete a tag, again, you need to specify the tag and the entity; to remove a tag's property, +you need to select the tag and property. -### CLI commands +## Command examples -Please set the metalake in the Gravitino configuration file or the environment variable before running any of these commands. +Please set the metalake in the Gravitino configuration file or the environment variable before +running any of these commands. ### Metalake commands - Show all metalakes +`gcli metalake create --metalake --comment ` +: Create a metalake. -```bash -gcli metalake list -``` +`gcli metalake properties` +: Show the properties for a metalake. - Show a metalake details +`gcli metalake delete` +: Delete a metalake. -```bash -gcli metalake details -``` +`gcli metalake list` +: List all metalakes - Show a metalake audit information +`gcli metalake details` +: Check the details of a specific a metalake. -```bash -gcli metalake details --audit -``` - - Create a metalake - -```bash -gcli metalake create --metalake my_metalake --comment "This is my metalake" -``` - - Delete a metalake - -```bash -gcli metalake delete -``` +`gcli metalake details --audit` +: Show the audit information for a metalake - Rename a metalake +`gcli metalake update --rename ` +: Rename a metalake -```bash -gcli metalake update --rename demo -``` +`gcli metalake update --comment ""` +: Update the comment for a metalake - Update a metalake's comment +`gcli metalake set --property --value ` +: Set the property for a metalake. -```bash -gcli metalake update --comment "new comment" -``` - - Display a metalake's properties - -```bash -gcli metalake properties -``` - - Set a metalake's property
Re: [PR] [doc] Revise the CLI documentation [gravitino]
justinmclean commented on code in PR #5840: URL: https://github.com/apache/gravitino/pull/5840#discussion_r1881010176 ## docs/cli.md: ## @@ -152,710 +163,464 @@ keytabFile=file.keytab ### Potentially unsafe operations -For operations that delete data or rename a metalake the user with be prompted to make sure they wish to run this command. The `--force` option can be specified to override this behaviour. +For operations that delete data or rename a metalake, the users will be prompted to +make sure they wish to run this command. +The `--force` option can be specified to override this behaviour. ### Manage metadata All the commands are performed by using the [Java API](api/java-api) internally. -### Display help +### Show help -To display help on command usage: +To view the help on command usage: ```bash gcli --help ``` -### Display client version +### Show version -To display the client version: +`gcli --version` +: Show the client version. -```bash -gcli --version -``` +`gcli --server` +: Show the server version. -### Display server version +:::note +**Client/server version mismatch** -To display the server version: +If the client and server are running different versions of the Gravitino software, +you may need to ignore the client/server version check for the command to be run. +This can be done in several ways: -```bash -gcli --server -``` - -### Client/server version mismatch - -If the client and server are running different versions of the Gravitino software then you may need to ignore the client/server version check for the command to run. This can be done in several ways: - -1. Passed in on the command line via the `--ignore` parameter. -2. Set via the `GRAVITINO_IGNORE` environment variable. -3. Stored in the Gravitino CLI configuration file. +1. Specify the `--ignore` argument in the command line. +1. Set the `GRAVITINO_IGNORE` environment variable. +1. Save it in the Gravitino CLI configuration file. +::: ### Multiple properties For commands that accept multiple properties they can be specified in a couple of different ways: -1. gcli --properties n1=v1,n2=v2,n3=v3 - -2. gcli --properties n1=v1 n2=v2 n3=v3 - -3. gcli --properties n1=v1 --properties n2=v2 --properties n3=v3 +1. `gcli --properties n1=v1,n2=v2,n3=v3` +2. `gcli --properties n1=v1 n2=v2 n3=v3` +3. `gcli --properties n1=v1 --properties n2=v2 --properties n3=v3` ### Setting properties and tags - Different options are needed to add a tag and set a property of a tag with `gcli tag set`. To add a - tag, specify the tag (via --tag) and the entity to tag (via --name). To set the property of a tag - (via --tag) you need to specify the property (via --property) and value (via --value) you want to - set. +Different options are needed to add a tag or to set a property for a tag using `gcli tag set`. +To add a tag, specify the tag (via `--tag`) and the entity to tag (via `--name`). +To set the property of a tag (via `--tag`) you need to specify the property (via `--property`) +and value (via `--value`) you want to set. - To delete a tag, again, you need to specify the tag and entity, to remove a tag's property you need - to select the tag and property. +To delete a tag, again, you need to specify the tag and the entity; to remove a tag's property, +you need to select the tag and property. -### CLI commands +## Command examples -Please set the metalake in the Gravitino configuration file or the environment variable before running any of these commands. +Please set the metalake in the Gravitino configuration file or the environment variable before +running any of these commands. ### Metalake commands - Show all metalakes +`gcli metalake create --metalake --comment ` +: Create a metalake. -```bash -gcli metalake list -``` +`gcli metalake properties` +: Show the properties for a metalake. - Show a metalake details +`gcli metalake delete` +: Delete a metalake. -```bash -gcli metalake details -``` +`gcli metalake list` +: List all metalakes - Show a metalake audit information +`gcli metalake details` +: Check the details of a specific a metalake. -```bash -gcli metalake details --audit -``` - - Create a metalake - -```bash -gcli metalake create --metalake my_metalake --comment "This is my metalake" -``` - - Delete a metalake - -```bash -gcli metalake delete -``` +`gcli metalake details --audit` +: Show the audit information for a metalake - Rename a metalake +`gcli metalake update --rename ` +: Rename a metalake -```bash -gcli metalake update --rename demo -``` +`gcli metalake update --comment ""` +: Update the comment for a metalake - Update a metalake's comment +`gcli metalake set --property --value ` +: Set the property for a metalake. -```bash -gcli metalake update --comment "new comment" -``` - - Display a metalake's properties - -```bash -gcli metalake properties -``` - - Set a metalake's property
Re: [PR] [doc] Revise the CLI documentation [gravitino]
justinmclean commented on code in PR #5840: URL: https://github.com/apache/gravitino/pull/5840#discussion_r1880968336 ## docs/cli.md: ## @@ -64,54 +68,60 @@ The general structure for running commands with the Gravitino CLI is `gcli entit -x,--index display index information -z,--provider provider one of hadoop, hive, mysql, postgres, iceberg, kafka - ``` +``` -## Commands +## Commands Types The following commands are used for entity management: -- list: List available entities -- details: Show detailed information about an entity -- create: Create a new entity -- delete: Delete an existing entity -- update: Update an existing entity -- set: Set a property on an entity -- remove: Remove a property from an entity -- properties: Display an entities properties +- `create`: Create a new entity +- `delete`: Delete an existing entity +- `details`: Show detailed information about an entity +- `list`: List available entities +- `properties`: Display an entity's properties +- `remove`: Remove a property from an entity +- `set`: Set a property on an entity +- `update`: Update an existing entity ### Setting the Metalake name -As dealing with one Metalake is a typical scenario, you can set the Metalake name in several ways so it doesn't need to be passed on the command line. +Considering that managing a metalake is a typical scenario, you can set the metalake +name in several ways so it doesn't need to be passed on the command line. -1. Passed in on the command line via the `--metalake` parameter. -2. Set via the `GRAVITINO_METALAKE` environment variable. -3. Stored in the Gravitino CLI configuration file. +1. Specify the `--metalake` argument on the command line. +1. Set the `GRAVITINO_METALAKE` environment variable. +1. Save it in the Gravitino [CLI configuration file](#config-file). Review Comment: This change (Save it) doesn't work well. Perhaps "Place it"? -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
Re: [PR] [doc] Revise the CLI documentation [gravitino]
justinmclean commented on code in PR #5840: URL: https://github.com/apache/gravitino/pull/5840#discussion_r1880994523 ## docs/cli.md: ## @@ -64,54 +68,60 @@ The general structure for running commands with the Gravitino CLI is `gcli entit -x,--index display index information -z,--provider provider one of hadoop, hive, mysql, postgres, iceberg, kafka - ``` +``` -## Commands +## Commands Types The following commands are used for entity management: -- list: List available entities -- details: Show detailed information about an entity -- create: Create a new entity -- delete: Delete an existing entity -- update: Update an existing entity -- set: Set a property on an entity -- remove: Remove a property from an entity -- properties: Display an entities properties +- `create`: Create a new entity +- `delete`: Delete an existing entity +- `details`: Show detailed information about an entity +- `list`: List available entities +- `properties`: Display an entity's properties +- `remove`: Remove a property from an entity +- `set`: Set a property on an entity +- `update`: Update an existing entity ### Setting the Metalake name -As dealing with one Metalake is a typical scenario, you can set the Metalake name in several ways so it doesn't need to be passed on the command line. +Considering that managing a metalake is a typical scenario, you can set the metalake +name in several ways so it doesn't need to be passed on the command line. -1. Passed in on the command line via the `--metalake` parameter. -2. Set via the `GRAVITINO_METALAKE` environment variable. -3. Stored in the Gravitino CLI configuration file. +1. Specify the `--metalake` argument on the command line. +1. Set the `GRAVITINO_METALAKE` environment variable. +1. Save it in the Gravitino [CLI configuration file](#config-file). -The command line option overrides the environment variable and the environment variable overrides the configuration file. +The command line option overrides the environment variable and the environment variable +takes precedence over the configuration file. ### Setting the Gravitino URL -As you need to set the Gravitino URL for every command, you can set the URL in several ways. +To avoid specifying the Gravitino URL using `--url` argument for every command, +you can persist the the URL setting. Review Comment: "the the URL setting." -> " the URL setting." -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
Re: [PR] [doc] Revise the CLI documentation [gravitino]
justinmclean commented on code in PR #5840: URL: https://github.com/apache/gravitino/pull/5840#discussion_r1880988002 ## docs/cli.md: ## @@ -8,25 +8,29 @@ last_update: license: 'This software is licensed under the Apache License version 2.' --- -This document provides guidance on managing metadata within Apache Gravitino using the Command Line Interface (CLI). The CLI offers a terminal based alternative to using code or the REST interface for metadata management. +This document provides a guidance on managing metadata within Apache Gravitino using Review Comment: "a guidance" -> "guidance" as the guidance in the document is not singular -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
Re: [PR] [doc] Revise the CLI documentation [gravitino]
justinmclean commented on code in PR #5840: URL: https://github.com/apache/gravitino/pull/5840#discussion_r1880974267 ## docs/cli.md: ## @@ -64,54 +68,60 @@ The general structure for running commands with the Gravitino CLI is `gcli entit -x,--index display index information -z,--provider provider one of hadoop, hive, mysql, postgres, iceberg, kafka - ``` +``` -## Commands +## Commands Types Review Comment: I would not use "Types" to describe commands. Perhaps "Command Actions"? -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
Re: [PR] [doc] Revise the CLI documentation [gravitino]
justinmclean commented on code in PR #5840: URL: https://github.com/apache/gravitino/pull/5840#discussion_r1880968336 ## docs/cli.md: ## @@ -64,54 +68,60 @@ The general structure for running commands with the Gravitino CLI is `gcli entit -x,--index display index information -z,--provider provider one of hadoop, hive, mysql, postgres, iceberg, kafka - ``` +``` -## Commands +## Commands Types The following commands are used for entity management: -- list: List available entities -- details: Show detailed information about an entity -- create: Create a new entity -- delete: Delete an existing entity -- update: Update an existing entity -- set: Set a property on an entity -- remove: Remove a property from an entity -- properties: Display an entities properties +- `create`: Create a new entity +- `delete`: Delete an existing entity +- `details`: Show detailed information about an entity +- `list`: List available entities +- `properties`: Display an entity's properties +- `remove`: Remove a property from an entity +- `set`: Set a property on an entity +- `update`: Update an existing entity ### Setting the Metalake name -As dealing with one Metalake is a typical scenario, you can set the Metalake name in several ways so it doesn't need to be passed on the command line. +Considering that managing a metalake is a typical scenario, you can set the metalake +name in several ways so it doesn't need to be passed on the command line. -1. Passed in on the command line via the `--metalake` parameter. -2. Set via the `GRAVITINO_METALAKE` environment variable. -3. Stored in the Gravitino CLI configuration file. +1. Specify the `--metalake` argument on the command line. +1. Set the `GRAVITINO_METALAKE` environment variable. +1. Save it in the Gravitino [CLI configuration file](#config-file). Review Comment: This change (Save it) doesn't work well. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
Re: [PR] [doc] Revise the CLI documentation [gravitino]
justinmclean commented on code in PR #5840: URL: https://github.com/apache/gravitino/pull/5840#discussion_r1880965809 ## docs/cli.md: ## @@ -64,54 +68,60 @@ The general structure for running commands with the Gravitino CLI is `gcli entit -x,--index display index information -z,--provider provider one of hadoop, hive, mysql, postgres, iceberg, kafka - ``` +``` -## Commands +## Commands Types The following commands are used for entity management: -- list: List available entities -- details: Show detailed information about an entity -- create: Create a new entity -- delete: Delete an existing entity -- update: Update an existing entity -- set: Set a property on an entity -- remove: Remove a property from an entity -- properties: Display an entities properties +- `create`: Create a new entity +- `delete`: Delete an existing entity +- `details`: Show detailed information about an entity +- `list`: List available entities +- `properties`: Display an entity's properties +- `remove`: Remove a property from an entity +- `set`: Set a property on an entity +- `update`: Update an existing entity Review Comment: Please leave the order as it, it ordered according to use of command / logical grouping. The list and details commands belong together, so do create/delete/update and set/remove. Alphabetical order is not helpful here. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
Re: [PR] [doc] Revise the CLI documentation [gravitino]
justinmclean commented on code in PR #5840: URL: https://github.com/apache/gravitino/pull/5840#discussion_r1880961126 ## docs/cli.md: ## @@ -8,25 +8,29 @@ last_update: license: 'This software is licensed under the Apache License version 2.' --- -This document provides guidance on managing metadata within Apache Gravitino using the Command Line Interface (CLI). The CLI offers a terminal based alternative to using code or the REST interface for metadata management. +This document provides a guidance on managing metadata within Apache Gravitino using +the Command Line Interface (CLI). The CLI offers a terminal based alternative to +using code or the REST API for metadata management. Review Comment: Please don't break up sentences, this stops some IDE tools like grammar checkers from working and makes it easier for errors to slip into the text. ## docs/cli.md: ## @@ -8,25 +8,29 @@ last_update: license: 'This software is licensed under the Apache License version 2.' --- -This document provides guidance on managing metadata within Apache Gravitino using the Command Line Interface (CLI). The CLI offers a terminal based alternative to using code or the REST interface for metadata management. +This document provides a guidance on managing metadata within Apache Gravitino using +the Command Line Interface (CLI). The CLI offers a terminal based alternative to +using code or the REST API for metadata management. -Currently, the CLI allows users to view metadata information for metalakes, catalogs, schemas, tables, users, roles, groups, tags, topics and filesets. Future updates will expand on these capabilities. +Currently, the CLI allows users to view metadata information for metalakes, catalogs, +schemas, tables, users, roles, groups, tags, topics and filesets. +Future updates will expand on these capabilities. ## Running the CLI -You can configure an alias for the CLI for ease of use, with the following command: +You can configure an alias for the CLI for ease of use. For example: Review Comment: This is not an example. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
Re: [PR] [doc] Revise the CLI documentation [gravitino]
tengqm commented on PR #5840: URL: https://github.com/apache/gravitino/pull/5840#issuecomment-2536106012 To reviewers: checking the git diff is not an efficient way to review for this PR (drastical change). Maybe a direct checking of the rendered output can help save some energy. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
