more commands

Author: clun

astra-shell/README.MD

@@ -1,81 +1,212 @@
-# Astra Shell
+# Getting Started with Astra CLI
 
 [![License Apache2](https://img.shields.io/hexpm/l/plug.svg)](http://www.apache.org/licenses/LICENSE-2.0)
 
-_This component is in heavy development that can lead to breaking changes._
+Astra Shell is a standalone command line interface proposing functions to operate the Datastax Astra platform.
 
+## A. Installation
 
-## Installation
+### Prequisites
 
-Installing ASTRA-CLI on UNIX-like platforms is as easy as ever. ASTRA-CLI installs smoothly on macOS, Linux, WSL, Cygwin, Solaris and FreeBSD. We also support Bash and ZSH shells.
+On your machine you will need :
+- A bash shell
+- Commands: `unzip`, `curl`
+- A Java JRE or JDK 8+ (temporary)
 
-- Open a new terminal and enter:
+You will also need to:
+- [Create an Astra account](https://astra.datastax.com)
+- [Create an authentication token](https://dtsx.io/create-astra-token)
 
+### Installation
+
+```
+curl -Ls "https://dtsx.io/get-astra-cli" | bash
+```
+
+### Setup
+
+- 1/3 - Execute the following
+```
+astra setup
+```
+
+- 2/3 When asked provides a token of your choice:
+
+```
+• Enter your token (AstraCS...) : 
+AstraCS:.......
 ```
-curl -Ls curl -s "https://dtsx.io/get-astra-cli" | bash
+ - 3/3 Open a new TAB to finalize install
+
+```
+astra --version
+astra help
 ```
 
-- Follow the instructions on-screen to complete installation. 
+## B. Working with configurations
 
-- To get autocompletion open a new terminal :
+- **List Configurations**
 
 ```
-source "$HOME/.astra/install/astra-init.sh"
+astra config list
 ```
 
-- Lastly, run the following code snippet to ensure that installation succeeded:
+- **Create new configuration** 
+
+If you have multiple organizations it could be useful to switch from one to another. To create another config, the latest created org will become the default.
 
 ```
-astra -v
+astra config create dev -t <token_of_org_2>
 ```
 
-If all went well, the version should be displayed. Something like:
+```
+astra config list
+```
+
+When you issue any command the config is now loaded for you:
 
 ```
-0.3.2-SNAPSHOT
+astra user list
 ```
 
-## Setup
+- **Change default configuration**: 
 
-- Run the following command and provide your token when needed
+You can change the default org at any time with the following command:
 
 ```
-astra setup
+astra config default dev && astra config list
 ```
 
-- You should be good to go
+- Test again, user list should be different
 
 ```
+astra user list
+```
+
+- Back to original org (change with your email)
+
+```
+astra config default [email protected] && astra config list
+```
+
+- You can use any organization without switching default configuration with `--config` or `-t`
+
+```
+astra user list --config dev
+```
+
+- **Delete configuration**
+
+You can delete any organization. I see you.. if you delete the default one you are on your own and you would need to define a new one.
+
+```
+astra config delete dev
 astra config list
 ```
 
+## C. Working with Databases
+
+- **List Databases**:
+
 ```
-+-----------------------------------------+
-| configuration                           |
-+-----------------------------------------+
-| default ([email protected])   |
-| DatastaxDevs                            |
-| [email protected]             |
-+-----------------------------------------+
+astra db list
 ```
 
-- And access Astra
+- **Create a new database:** 
+
+If not provided the region will be the default free region and the keyspace will be the database name but you can change then with `-r` and `-k` respectivitely.
 
 ```
+astra db create demo
 astra db list
 ```
 
+- **Get information on your database**
+
+Notice how you never provide any the technical ids.
+
+```
+astra db get demo
 ```
-+---------------------+--------------------------------------+---------------------+----------------+
-| name                | id                                   | default-region      | status         |
-+---------------------+--------------------------------------+---------------------+----------------+
-| mtg                 | dde308f5-a8b0-474d-afd6-81e5689e3e25 | eu-central-1        | ACTIVE         |
-| workshops           | 3ed83de7-d97f-4fb6-bf9f-82e9f7eafa23 | eu-west-1           | ACTIVE         |
-| sdk_tests           | 06a9675a-ca62-4cd0-9b94-aefaf395922b | us-east-1           | ACTIVE         |
-| api_days_dubai_2022 | 53f07b2a-8856-4741-b595-72b03be56bc6 | us-east1            | ACTIVE         |
-| free_db             | 8642763c-8ba7-4ede-a031-82355c7c34a7 | us-east1            | ACTIVE         |
-+---------------------+--------------------------------------+---------------------+----------------+
+
+- **Change output format**
+
+This CLI wil be used by CI/CD and script, sometimes the output must be parsed. There are 3 outputs: *human,json,csv"
+
 ```
+astra db list -o json
+```
+
+```
+astra db list -o csv
+```
+
+The return type is also important to check the errors. O mean everything is OK
+
+```
+echo $?
+```
+
+```
+astra db get i_do_not_exist && echo $?
+```
+
+Error codes tables
+
+| Error             | Code      |
+|-------------------|-----------|
+| SUCCESS           | 0         |
+| PARSE_ERROR       | 1         |
+| INVALID_PARAMETER | 10        |
+| NOT_FOUND         | 20        |
+| CONFLICT          | 21        |
+| ALREADY_EXIST     | 22        |
+| CANNOT_CONNECT    | 30        |
+| INTERNAL_ERROR    | 40        |
+
+
+- The cli implemented `If not Exist` for both keyspace and database (convenient for workshops and training)
+
+```
+astra help db create
+astra db create demo --if-not-exist
+```
+
+- All commands can also be in versbose mode anytime with `-v`
+
+```
+astra db create demo --if-not-exist -v
+```
+
+Make sure the database is now Active or you will get some expected errors.
+
+- **Create a new keyspace**
+
+```
+astra db create-keyspace demo -k ks2
+```
+
+Need helps ?
+```
+astra help db create-keyspace
+```
+
+- Now let's blow your mind 🥁
+
+```
+astra db cqlsh demo
+```
+
+
+## D. Interactive mode
+
+
+## E. Working with Users
+
+
+## F. Working with Roles
+
+
 
 
 

astra-shell/src/main/java/com/datastax/astra/shell/AstraShell.java

@@ -3,6 +3,8 @@
 import com.datastax.astra.shell.cmd.ExitCommand;
 import com.datastax.astra.shell.cmd.HelpCommand;
 import com.datastax.astra.shell.cmd.QuitCommand;
+import com.datastax.astra.shell.cmd.db.DbCqlShellShell;
+import com.datastax.astra.shell.cmd.db.DbCreateKeyspaceShell;
 import com.datastax.astra.shell.cmd.db.DbCreateShell;
 import com.datastax.astra.shell.cmd.db.DbDeleteShell;
 import com.datastax.astra.shell.cmd.db.DbGetShell;
@@ -38,21 +40,30 @@
     EmptyCommand.class,
     HelpCommand.class,
     ExitCommand.class,
-    QuitCommand.class
+    
+    // With selected db
+    DbCreateKeyspaceShell.class,
+    DbGetShell.class,
+    DbCqlShellShell.class,
+    QuitCommand.class,
 },
   groups = {
           @Group(name = OperationsDb.DB, description = "Commands acting of database", commands = {
                   DbCreateShell.class,
                   DbDeleteShell.class,
                   DbListShell.class,
                   DbGetShell.class,
-                  DbUseShell.class
+                  
+                  DbUseShell.class,
+          }),
+          @Group(name = OperationsDb.CMD_KEYSPACE, description = "Manage keyspaces (db must be selected)", commands = {
+                  DbCreateKeyspaceShell.class,
           }),
-          @Group(name= OperationIam.COMMAND_ROLE, description = "Manage the roles (RBAC)", commands = {
+          @Group(name= OperationIam.COMMAND_ROLE, description = "Manage roles (RBAC)", commands = {
                   RoleListShell.class,
                   RoleGetCli.class
           }),
-          @Group(name= OperationIam.COMMAND_USER, description = "Manage the users permission", commands = {
+          @Group(name= OperationIam.COMMAND_USER, description = "Manage users permission", commands = {
                   UserListShell.class,
                   UserGetShell.class,
                   UserInviteShell.class,

astra-shell/src/main/java/com/datastax/astra/shell/cmd/BaseShellCommand.java

@@ -43,5 +43,19 @@ public void run() {
     protected ShellContext ctx() {
         return ShellContext.getInstance();
     }
+    
+    /**
+     * Db Selected.
+     * @return
+     *      if a db is selected or not
+     */
+    protected boolean dbSelected() {
+        boolean selected = (null != ctx().getDatabase()) ;
+        if (!selected) {
+            LoggerShell.error("You must select a DB first with 'db use <dbname>'");
+        }
+        return selected;
+    }
+    
 
 }

astra-shell/src/main/java/com/datastax/astra/shell/cmd/QuitCommand.java

@@ -1,7 +1,6 @@
 package com.datastax.astra.shell.cmd;
 
 import com.datastax.astra.shell.ExitCode;
-import com.datastax.astra.shell.out.LoggerShell;
 import com.github.rvesse.airline.annotations.Command;
 
 /**
@@ -15,12 +14,11 @@ public class QuitCommand extends BaseShellCommand {
     /** {@inheritDoc} */
     @Override
     public ExitCode execute() {
-        if (null != ctx().getDatabase()) {
-            ctx().exitDatabase();
-            return ExitCode.SUCCESS;
+        if (!dbSelected()) {
+            return ExitCode.CONFLICT;
         }
-        LoggerShell.warning("You have no base selected.");
-        return ExitCode.NOT_FOUND;
+        ctx().exitDatabase();
+        return ExitCode.SUCCESS;
     }
 
 }