vortex-cli 4.13.1__tar.gz → 4.14.0__tar.gz

{vortex_cli-4.13.1 → vortex_cli-4.14.0}/PKG-INFO

@@ -1,7 +1,6 @@
 Metadata-Version: 2.1
 Name: vortex_cli
-Version: 4.13.1
-Summary: Vortex CLI
+Version: 4.14.0
 Home-page: https://github.com/jordanamos/vortex-cli
 Author: Jordan Amos
 Author-email: jordan.amos@gmail.com

{vortex_cli-4.13.1 → vortex_cli-4.14.0}/setup.cfg

@@ -1,7 +1,6 @@
 [metadata]
 name = vortex_cli
-version = 4.13.1
-description = Vortex CLI
+version = 4.14.0
 long_description = file: README.md
 long_description_content_type = text/markdown
 url = https://github.com/jordanamos/vortex-cli
@@ -18,6 +17,7 @@ classifiers =
 	Programming Language :: Python :: 3
 	Programming Language :: Python :: 3 :: Only
 keywords = vortex cli
+vdescription = Vortex CLI
 
 [options]
 packages = find:

{vortex_cli-4.13.1 → vortex_cli-4.14.0}/vortex/cli.py

@@ -71,6 +71,7 @@ def validate_args(
     args: Namespace,
     new_parser: ArgumentParser,
     clone_parser: ArgumentParser,
+    db_parser: ArgumentParser,
 ) -> None:
     if args.command == "new" and args.subcommand == "object":
         missing_required_fields = not args.update_id and not (
@@ -103,13 +104,18 @@ def validate_args(
         elif update_arg_contains_app_id:
             msg = "Can't use --app-id with --update"
         elif update_is_missing_args:
-            msg = "Please spectify an option to update"
+            msg = "Please specify an option to update"
 
         if msg:
             new_parser.error(msg)
 
     elif args.command == "clone" and not (args.app_ids or args.reclone):
-        clone_parser.error("Please specifiy the APP_ID[s] to clone or use --reclone")
+        clone_parser.error("Please specifiy the APP_ID[s] to clone or use '--reclone'")
+    elif args.command == "db":
+        if args.sql and not args.conn_id:
+            db_parser.error("The '--sql' option requires '--connection-id'")
+        if (args.schema or args.list) and not args.db_name:
+            db_parser.error("Options '--schema' and '--list' require '--db-name'")
 
 
 def add_code_parser(
@@ -198,9 +204,10 @@ def add_list_parser(command_parser: _SubParsersAction[ArgumentParser]) -> None:
         action="store_true",
     )
     list_parser.add_argument(
-        "--show-connections",
+        "--connections",
         help="List the Database Connections of locally cloned apps",
         action="store_true",
+        dest="show_connections",
     )
     _add_server_option(list_parser)
 
@@ -514,16 +521,9 @@ def add_delete_parser(command_parser: _SubParsersAction[ArgumentParser]) -> None
     _add_server_option(delete_parser)
 
 
-def add_db_parser(command_parser: _SubParsersAction[ArgumentParser]) -> None:
-    db_parser = command_parser.add_parser(
-        "db", help="Interact with Database Connections"
-    )
-    db_parser.add_argument(
-        "connection_id",
-        metavar="CONNECTION_ID",
-        type=int,
-        help="The Database Connection ID",
-    )
+def add_db_parser(command_parser: _SubParsersAction[ArgumentParser]) -> ArgumentParser:
+    db_parser = command_parser.add_parser("db", help="Interact with Databases")
+
     db_mutex = db_parser.add_mutually_exclusive_group(required=True)
     db_mutex.add_argument("--sql", help="Execute a given SQL query")
     db_mutex.add_argument(
@@ -537,7 +537,24 @@ def add_db_parser(command_parser: _SubParsersAction[ArgumentParser]) -> None:
         action="store_true",
         help="List the tables in the Database",
     )
+    list_schema_group = db_parser.add_argument_group("List/Schema Options")
+    list_schema_group.add_argument(
+        "--db-name",
+        "--name",
+        "-n",
+        metavar="DB_NAME",
+        dest="db_name",
+        help="The Database Name.",
+    )
     sql_group = db_parser.add_argument_group("SQL Options")
+    sql_group.add_argument(
+        "--connection-id",
+        "--id",
+        metavar="INT",
+        dest="conn_id",
+        type=int,
+        help="The Database Connection ID to query. (Required for SQL)",
+    )
     sql_group.add_argument(
         "--update",
         "-u",
@@ -552,7 +569,6 @@ def add_db_parser(command_parser: _SubParsersAction[ArgumentParser]) -> None:
     )
     sql_group.add_argument(
         "--limit",
-        "-n",
         metavar="INT",
         type=_check_int_in_range,
         help=(
@@ -563,6 +579,7 @@ def add_db_parser(command_parser: _SubParsersAction[ArgumentParser]) -> None:
         ),
         default=5,
     )
+    return db_parser
 
 
 def add_docs_parser(command_parser: _SubParsersAction[ArgumentParser]) -> None:

{vortex_cli-4.13.1 → vortex_cli-4.14.0}/vortex/commands/clone.py

@@ -122,8 +122,15 @@ def _parse_app_xml(
     db_connections: list[DatabaseConnection] = []
     for db_ele in app_xml.findall(".//database"):
         db_conn = DatabaseConnection(
-            int(db_ele.attrib["id"]), db_ele.attrib["name"].lower()
+            int(db_ele.attrib["id"]),
+            db_ele.attrib["name"],
+            db_ele.attrib["dbName"],
+            db_ele.attrib["driver"],
+            db_ele.attrib["url"],
+            db_ele.attrib["userName"],
+            db_ele.attrib["pwd"],
         )
+        # print(db_ele.attrib)
         db_connections.append(db_conn)
 
     java_version_ele = app_xml.find('.//sysProp[@name="java.class.version"]')

{vortex_cli-4.13.1 → vortex_cli-4.14.0}/vortex/commands/db.py

@@ -38,9 +38,14 @@ def _output_result(
     sql: str,
     update: bool,
     truncate_cols: bool = False,
-) -> None:
+    db_name: str | None = None,
+    schema_table: str | None = None,
+) -> int:
     with server:
         result = tuple(server.database_designer.execute_query(conn_id, sql, update))
+        if schema_table and not result:
+            logger.error(f"Table '{schema_table}' not found in database '{db_name}'")
+            return 1
         if result:
             if truncate_cols:
                 result = _truncate_cols(result)
@@ -55,9 +60,10 @@ def _output_result(
             )
         else:
             logger.info("Query returned nil results.")
+    return 0
 
 
-def _check_connection_is_cloned(workspace: Workspace, conn_id: int) -> bool:
+def _is_connection_cloned(workspace: Workspace, conn_id: int) -> bool:
     """Returns True if the given conn_id exists in a locally cloned Application."""
     conns: list[DatabaseConnection] = []
     for app in workspace.listapps():
@@ -69,7 +75,8 @@ def _check_connection_is_cloned(workspace: Workspace, conn_id: int) -> bool:
 def db(
     workspace: Workspace,
     server: PuakmaServer,
-    conn_id: int,
+    conn_id: int | None,
+    db_name: str | None,
     sql: str | None,
     update: bool = False,
     limit_n_results: int = 5,
@@ -77,21 +84,45 @@ def db(
     list_tables: bool = False,
     truncate_cols: bool = False,
 ) -> int:
-    if schema_table is not None:
+    do_schema = schema_table is not None
+    db_name = db_name or ""
+    conn_id = conn_id or -1
+    if do_schema:
         sql = f"""\
-            SELECT attributename AS name
-                , type
-                , typesize AS type_size
+            SELECT DISTINCT
+                CASE
+                    WHEN isprimarykey = '1'
+                    THEN 'PK'
+                    ELSE ''
+                END AS "PK"
+                , attributename AS "Attribute"
+                , CASE WHEN ref.tableid > 0
+                    THEN UPPER(ref.tablename)
+                    ELSE ''
+                END AS "References"
+                , CASE WHEN type IN ('VARCHAR', 'CHAR')
+                    THEN CONCAT(type, ' (', typesize, ')')
+                    ELSE type
+                END AS "Type"
+                , CASE
+                    WHEN isunique = '1'
+                    THEN 'Yes'
+                    ELSE 'No'
+                END AS "Unique"
                 , CASE
                     WHEN allownull = '1'
-                    THEN 'Y'
-                    ELSE 'N'
-                END AS nullable
+                    THEN 'Yes'
+                    ELSE 'No'
+                END AS "Allow Null"
             FROM attribute a
             INNER JOIN pmatable t
             ON t.tableid = a.tableid
-            WHERE dbconnectionid = {conn_id}
-                AND lower(tablename) = '{schema_table}'
+            INNER JOIN dbconnection db
+            ON db.dbconnectionid = t.dbconnectionid
+            LEFT JOIN pmatable ref
+            ON ref.tableid::VARCHAR = a.reftable
+            WHERE LOWER(db.dbname) = '{db_name.lower()}'
+                AND LOWER(t.tablename) = '{schema_table}'
             ORDER BY attributename
         """
         update = False
@@ -99,11 +130,12 @@ def db(
         conn_id = server.puakma_db_conn_id
     elif list_tables:
         sql = f"""\
-            SELECT tablename
+            SELECT DISTINCT tablename
                 , description
-            FROM pmatable a
-            WHERE dbconnectionid = {conn_id}
-            ORDER BY tablename
+            FROM dbconnection db
+            INNER JOIN pmatable t
+            ON db.dbconnectionid = t.dbconnectionid
+            WHERE LOWER(db.dbname)='{db_name.lower()}'
         """
         update = False
         truncate_cols = False
@@ -111,8 +143,8 @@ def db(
     elif sql is not None:
         # If we're modifying a database, lets check that its locally
         # cloned to ensure intent
-        if update and not _check_connection_is_cloned(workspace, conn_id):
-            logger.error(f"No cloned applications with DB Connection '{conn_id}'")
+        if not _is_connection_cloned(workspace, conn_id):
+            logger.error(f"No cloned applications with DB Connection ID '{conn_id}'")
             return 1
         if not update:
             sql = sql + f" LIMIT {limit_n_results}"
@@ -120,6 +152,6 @@ def db(
     if sql is None:
         raise ValueError("No Query to execute.")
 
-    _output_result(server, conn_id, sql, update, truncate_cols)
-
-    return 0
+    return _output_result(
+        server, conn_id, sql, update, truncate_cols, db_name, schema_table
+    )

{vortex_cli-4.13.1 → vortex_cli-4.14.0}/vortex/commands/list.py

@@ -63,12 +63,19 @@ def list_(
 
 
 def _render_db_connections(apps: list[PuakmaApplication]) -> None:
-    row_headers = ["ID", "Connection Name", "Application"]
+    row_headers = ["ID", "Name", "DB Name", "Driver", "URL", "Application"]
     row_data = []
     for app in sorted(apps, key=lambda x: (x.group.casefold(), x.name.casefold())):
         if app.db_connections:
             for conn in app.db_connections:
-                row = (conn.id, conn.name, str(app))
+                row = (
+                    conn.id,
+                    conn.name,
+                    conn.db_name,
+                    conn.driver,
+                    conn.url,
+                    str(app),
+                )
                 row_data.append(row)
     print(tabulate.tabulate(row_data, headers=row_headers))
 

{vortex_cli-4.13.1 → vortex_cli-4.14.0}/vortex/main.py

@@ -92,11 +92,11 @@ def main(argv: Sequence[str] | None = None) -> int:
     cli.add_grep_parser(command_parser)
     cli.add_log_parser(command_parser)
     cli.add_watch_parser(command_parser)
-    cli.add_db_parser(command_parser)
     cli.add_docs_parser(command_parser)
     cli.add_execute_parser(command_parser)
     clone_parser = cli.add_clone_parser(command_parser)
     code_parser = cli.add_code_parser(command_parser)
+    db_parser = cli.add_db_parser(command_parser)
     new_parser = cli.add_new_parser(command_parser)
 
     args, remaining_args = parser.parse_known_args(argv)
@@ -104,7 +104,7 @@ def main(argv: Sequence[str] | None = None) -> int:
     if args.command != "code":
         parser.parse_args(argv)
 
-    cli.validate_args(args, new_parser, clone_parser)
+    cli.validate_args(args, new_parser, clone_parser, db_parser)
 
     if args.no_colour:
         Colour.disable()
@@ -230,7 +230,8 @@ def main(argv: Sequence[str] | None = None) -> int:
             return db(
                 workspace,
                 server,
-                args.connection_id,
+                args.conn_id,
+                args.db_name,
                 args.sql,
                 update=args.update,
                 limit_n_results=args.limit,

{vortex_cli-4.13.1 → vortex_cli-4.14.0}/vortex/models.py

@@ -120,6 +120,11 @@ class LogItem(NamedTuple):
 class DatabaseConnection(NamedTuple):
     id: int
     name: str
+    db_name: str
+    driver: str
+    url: str
+    username: str
+    password: str
 
 
 class PuakmaServer:

{vortex_cli-4.13.1 → vortex_cli-4.14.0}/vortex_cli.egg-info/PKG-INFO

@@ -1,7 +1,6 @@
 Metadata-Version: 2.1
 Name: vortex_cli
-Version: 4.13.1
-Summary: Vortex CLI
+Version: 4.14.0
 Home-page: https://github.com/jordanamos/vortex-cli
 Author: Jordan Amos
 Author-email: jordan.amos@gmail.com