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

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

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

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

@@ -1,6 +1,6 @@
 [metadata]
 name = vortex_cli
-version = 4.14.0
+version = 4.15.0
 long_description = file: README.md
 long_description_content_type = text/markdown
 url = https://github.com/jordanamos/vortex-cli

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

@@ -111,11 +111,14 @@ def validate_args(
 
     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'")
-    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'")
+    elif args.command == "db" and args.sql is not None:
+        try:
+            args.database = int(args.database)
+        except ValueError:
+            db_parser.error(
+                "Positional argument 'database' must be a database connection "
+                "ID (int) when using the '--sql' option"
+            )
 
 
 def add_code_parser(
@@ -523,9 +526,25 @@ def add_delete_parser(command_parser: _SubParsersAction[ArgumentParser]) -> None
 
 def add_db_parser(command_parser: _SubParsersAction[ArgumentParser]) -> ArgumentParser:
     db_parser = command_parser.add_parser("db", help="Interact with Databases")
-
+    db_parser.add_argument(
+        "database",
+        help=(
+            "The database name to connect to or the "
+            "database connection ID if using --sql"
+        ),
+    )
     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(
+        "--sql",
+        type=str,
+        nargs="?",
+        const="",
+        help=(
+            "The SQL query to execute. "
+            "Requires <database> to be a database connection id (int). "
+            "Interactively prompts for the sql if the value is empty (Non Windows)."
+        ),
+    )
     db_mutex.add_argument(
         "--schema",
         metavar="TABLE_NAME",
@@ -537,38 +556,17 @@ def add_db_parser(command_parser: _SubParsersAction[ArgumentParser]) -> Argument
         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",
-        action="store_true",
-        help="Set this flag when running querys for altering/updating the database",
-    )
     sql_group.add_argument(
         "--all-cols",
+        "-a",
         action="store_false",
-        help="Show all columns in the output. Default is max 8 columns",
+        help="Show all columns in the output. Default is max 6 columns",
         dest="truncate_cols",
     )
     sql_group.add_argument(
         "--limit",
+        "-n",
         metavar="INT",
         type=_check_int_in_range,
         help=(
@@ -577,7 +575,13 @@ def add_db_parser(command_parser: _SubParsersAction[ArgumentParser]) -> Argument
             "This flag adds the 'LIMIT' clause of the given SQL query "
             "and so that clause should never be used when executing a query."
         ),
-        default=5,
+        default=10,
+    )
+    sql_group.add_argument(
+        "--update",
+        "-u",
+        action="store_true",
+        help="Set this flag when running querys for altering/updating the database",
     )
     return db_parser
 

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

@@ -1,6 +1,10 @@
 from __future__ import annotations
 
 import logging
+import os
+import subprocess
+import sys
+import tempfile
 from typing import Any
 
 import tabulate
@@ -9,13 +13,59 @@ from vortex.models import DatabaseConnection
 from vortex.models import PuakmaServer
 from vortex.workspace import Workspace
 
-
 logger = logging.getLogger("vortex")
 
+GET_SCHEMA_SQL = """\
+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 'Yes'
+        ELSE 'No'
+    END AS "Allow Null"
+FROM attribute a
+INNER JOIN pmatable t
+ON t.tableid = a.tableid
+INNER JOIN dbconnection db
+ON db.dbconnectionid = t.dbconnectionid
+LEFT JOIN pmatable ref
+ON ref.tableid::VARCHAR = a.reftable
+WHERE LOWER(db.dbname) = '%s'
+    AND LOWER(t.tablename) = '%s'
+ORDER BY attributename
+"""
+
+LIST_TABLES_SQL = """\
+SELECT DISTINCT tablename
+    , description
+FROM dbconnection db
+INNER JOIN pmatable t
+ON db.dbconnectionid = t.dbconnectionid
+WHERE LOWER(db.dbname)='%s'
+"""
+
 
 def _truncate_cols(result: tuple[dict[str, Any], ...]) -> tuple[dict[str, Any], ...]:
     number_of_cols = len(result[0])
-    max_cols = 8
+    max_cols = 6
     if number_of_cols <= max_cols:
         return result
 
@@ -40,12 +90,18 @@ def _output_result(
     truncate_cols: bool = False,
     db_name: str | None = None,
     schema_table: str | None = None,
+    list_tables: bool = False,
 ) -> int:
     with server:
+        logger.debug("Executing query")
+        logger.debug(sql)
         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 list_tables and not result:
+            logger.error(f"No tables found in database '{db_name}'.")
+            return 1
         if result:
             if truncate_cols:
                 result = _truncate_cols(result)
@@ -72,11 +128,25 @@ def _is_connection_cloned(workspace: Workspace, conn_id: int) -> bool:
     return any(conn.id == conn_id for conn in conns)
 
 
+def _read_from_editor() -> str:
+    fd, tmp_sql_file = tempfile.mkstemp(suffix=".sql")
+    os.close(fd)
+    try:
+        subprocess.call(["nano", tmp_sql_file])
+        with open(tmp_sql_file) as f:
+            sql_query = f.read().strip()
+    except Exception:
+        os.remove(tmp_sql_file)
+        raise
+    else:
+        os.remove(tmp_sql_file)
+        return sql_query
+
+
 def db(
     workspace: Workspace,
     server: PuakmaServer,
-    conn_id: int | None,
-    db_name: str | None,
+    database: int | str,
     sql: str | None,
     update: bool = False,
     limit_n_results: int = 5,
@@ -84,74 +154,35 @@ def db(
     list_tables: bool = False,
     truncate_cols: bool = False,
 ) -> int:
-    do_schema = schema_table is not None
-    db_name = db_name or ""
-    conn_id = conn_id or -1
-    if do_schema:
-        sql = f"""\
-            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 'Yes'
-                    ELSE 'No'
-                END AS "Allow Null"
-            FROM attribute a
-            INNER JOIN pmatable t
-            ON t.tableid = a.tableid
-            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
-        truncate_cols = False
-        conn_id = server.puakma_db_conn_id
-    elif list_tables:
-        sql = f"""\
-            SELECT DISTINCT tablename
-                , description
-            FROM dbconnection db
-            INNER JOIN pmatable t
-            ON db.dbconnectionid = t.dbconnectionid
-            WHERE LOWER(db.dbname)='{db_name.lower()}'
-        """
-        update = False
-        truncate_cols = False
-        conn_id = server.puakma_db_conn_id
-    elif sql is not None:
+    if sql is not None:
+        if sql.strip() == "":
+            if sys.platform == "win32":
+                sql = None
+            else:
+                sql = _read_from_editor()
+        db_name = None
+        conn_id = int(database)
         # If we're modifying a database, lets check that its locally
         # cloned to ensure intent
-        if not _is_connection_cloned(workspace, conn_id):
+        if update and not _is_connection_cloned(workspace, conn_id):
             logger.error(f"No cloned applications with DB Connection ID '{conn_id}'")
             return 1
-        if not update:
+        if sql and not update:
             sql = sql + f" LIMIT {limit_n_results}"
+    else:
+        db_name = str(database).lower()
+        update = False
+        truncate_cols = False
+        conn_id = server.puakma_db_conn_id
+        if schema_table is not None:
+            sql = GET_SCHEMA_SQL % (db_name, schema_table)
+        elif list_tables:
+            sql = LIST_TABLES_SQL % db_name
 
-    if sql is None:
-        raise ValueError("No Query to execute.")
+    if not sql:
+        logger.error("No Query to execute.")
+        return 1
 
     return _output_result(
-        server, conn_id, sql, update, truncate_cols, db_name, schema_table
+        server, conn_id, sql, update, truncate_cols, db_name, schema_table, list_tables
     )

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

@@ -230,8 +230,7 @@ def main(argv: Sequence[str] | None = None) -> int:
             return db(
                 workspace,
                 server,
-                args.conn_id,
-                args.db_name,
+                args.database,
                 args.sql,
                 update=args.update,
                 limit_n_results=args.limit,

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

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