microsoft
diff --git a/‎docs/changes/newsfragments/4969.improved‎
Lines changed: 2 additions & 0 deletions b/‎docs/changes/newsfragments/4969.improved‎
Lines changed: 2 additions & 0 deletions
diff --git a/‎qcodes/dataset/sqlite/db_upgrades/__init__.py‎
Lines changed: 61 additions & 24 deletions b/‎qcodes/dataset/sqlite/db_upgrades/__init__.py‎
Lines changed: 61 additions & 24 deletions
@@ -0,0 +1,2 @@
+The Dataset no longer prints upgrade progressbars when upgrading an empty database. This means that
+the progressbar will no longer be shown when creating a new database.
@@ -12,10 +12,12 @@
 principle, the upgrade functions should not have dependecies from
 :mod:`.queries` module.
 """
+from __future__ import annotations
+
 import logging
 import sys
 from functools import wraps
-from typing import Any, Callable, Dict
+from typing import Callable
 
 import numpy as np
 from tqdm import tqdm
@@ -36,20 +38,27 @@
 # INFRASTRUCTURE FOR UPGRADE FUNCTIONS
 
 
-TUpgraderFunction = Callable[[ConnectionPlus], None]
+TUpgraderFunction = Callable[[ConnectionPlus, bool], None]
 
 # Functions decorated as 'upgrader' are inserted into this dict
 # The newest database version is thus determined by the number of upgrades
 # in this module
 # The key is the TARGET VERSION of the upgrade, i.e. the first key is 1
-_UPGRADE_ACTIONS: Dict[int, Callable[..., Any]] = {}
+_UPGRADE_ACTIONS: dict[int, TUpgraderFunction] = {}
 
 
 def _latest_available_version() -> int:
     """Return latest available database schema version"""
     return len(_UPGRADE_ACTIONS)
 
 
+def _get_no_of_runs(conn: ConnectionPlus) -> int:
+    no_of_runs_query = "SELECT max(run_id) FROM runs"
+    no_of_runs = one(atomic_transaction(conn, no_of_runs_query), "max(run_id)")
+    no_of_runs = no_of_runs or 0
+    return no_of_runs
+
+
 def upgrader(func: TUpgraderFunction) -> TUpgraderFunction:
     """
     Decorator for database version upgrade functions. An upgrade function
@@ -81,7 +90,7 @@ def upgrader(func: TUpgraderFunction) -> TUpgraderFunction:
                          ' to version N+1')
 
     @wraps(func)
-    def do_upgrade(conn: ConnectionPlus) -> None:
+    def do_upgrade(conn: ConnectionPlus, show_progress_bar: bool = True) -> None:
 
         log.info(f'Starting database upgrade version {from_version} '
                  f'to {to_version}')
@@ -93,7 +102,7 @@ def do_upgrade(conn: ConnectionPlus) -> None:
             return
 
         # This function either raises or returns
-        func(conn)
+        func(conn, show_progress_bar)
 
         set_user_version(conn, to_version)
         log.info(f'Succesfully performed upgrade {from_version} '
@@ -119,17 +128,22 @@ def perform_db_upgrade(conn: ConnectionPlus, version: int = -1) -> None:
     version = _latest_available_version() if version == -1 else version
 
     current_version = get_user_version(conn)
+
+    show_progress_bar = not (_get_no_of_runs(conn) == 0)
+
     if current_version < version:
         log.info("Commencing database upgrade")
         for target_version in sorted(_UPGRADE_ACTIONS)[:version]:
-            _UPGRADE_ACTIONS[target_version](conn)
+            _UPGRADE_ACTIONS[target_version](conn, show_progress_bar)
 
 
 # DATABASE UPGRADE FUNCTIONS
 
 
 @upgrader
-def perform_db_upgrade_0_to_1(conn: ConnectionPlus) -> None:
+def perform_db_upgrade_0_to_1(
+    conn: ConnectionPlus, show_progress_bar: bool = True
+) -> None:
     """
     Perform the upgrade from version 0 to version 1
 
@@ -148,7 +162,11 @@ def perform_db_upgrade_0_to_1(conn: ConnectionPlus) -> None:
             cur = transaction(conn, 'SELECT run_id FROM runs')
             run_ids = [r[0] for r in many_many(cur, 'run_id')]
 
-            pbar = tqdm(range(1, len(run_ids) + 1), file=sys.stdout)
+            pbar = tqdm(
+                range(1, len(run_ids) + 1),
+                file=sys.stdout,
+                disable=not show_progress_bar,
+            )
             pbar.set_description("Upgrading database; v0 -> v1")
 
             for run_id in pbar:
@@ -173,7 +191,9 @@ def perform_db_upgrade_0_to_1(conn: ConnectionPlus) -> None:
 
 
 @upgrader
-def perform_db_upgrade_1_to_2(conn: ConnectionPlus) -> None:
+def perform_db_upgrade_1_to_2(
+    conn: ConnectionPlus, show_progress_bar: bool = True
+) -> None:
     """
     Perform the upgrade from version 1 to version 2
 
@@ -184,7 +204,7 @@ def perform_db_upgrade_1_to_2(conn: ConnectionPlus) -> None:
     cur = atomic_transaction(conn, sql)
     n_run_tables = len(cur.fetchall())
 
-    pbar = tqdm(range(1), file=sys.stdout)
+    pbar = tqdm(range(1), file=sys.stdout, disable=not show_progress_bar)
     pbar.set_description("Upgrading database; v1 -> v2")
 
     if n_run_tables == 1:
@@ -209,7 +229,9 @@ def perform_db_upgrade_1_to_2(conn: ConnectionPlus) -> None:
 
 
 @upgrader
-def perform_db_upgrade_2_to_3(conn: ConnectionPlus) -> None:
+def perform_db_upgrade_2_to_3(
+    conn: ConnectionPlus, show_progress_bar: bool = True
+) -> None:
     """
     Perform the upgrade from version 2 to version 3
 
@@ -219,11 +241,14 @@ def perform_db_upgrade_2_to_3(conn: ConnectionPlus) -> None:
     object
     """
     from qcodes.dataset.sqlite.db_upgrades.upgrade_2_to_3 import upgrade_2_to_3
-    upgrade_2_to_3(conn)
+
+    upgrade_2_to_3(conn, show_progress_bar)
 
 
 @upgrader
-def perform_db_upgrade_3_to_4(conn: ConnectionPlus) -> None:
+def perform_db_upgrade_3_to_4(
+    conn: ConnectionPlus, show_progress_bar: bool = True
+) -> None:
     """
     Perform the upgrade from version 3 to version 4. This really
     repeats the version 3 upgrade as it originally had two bugs in
@@ -234,11 +259,14 @@ def perform_db_upgrade_3_to_4(conn: ConnectionPlus) -> None:
     other parameters. Both have since been fixed so rerun the upgrade.
     """
     from qcodes.dataset.sqlite.db_upgrades.upgrade_3_to_4 import upgrade_3_to_4
-    upgrade_3_to_4(conn)
+
+    upgrade_3_to_4(conn, show_progress_bar)
 
 
 @upgrader
-def perform_db_upgrade_4_to_5(conn: ConnectionPlus) -> None:
+def perform_db_upgrade_4_to_5(
+    conn: ConnectionPlus, show_progress_bar: bool = True
+) -> None:
     """
     Perform the upgrade from version 4 to version 5.
 
@@ -248,7 +276,7 @@ def perform_db_upgrade_4_to_5(conn: ConnectionPlus) -> None:
     with snapshot information.
     """
     with atomic(conn) as conn:
-        pbar = tqdm(range(1), file=sys.stdout)
+        pbar = tqdm(range(1), file=sys.stdout, disable=not show_progress_bar)
         pbar.set_description("Upgrading database; v4 -> v5")
         # iterate through the pbar for the sake of the side effect; it
         # prints that the database is being upgraded
@@ -257,7 +285,9 @@ def perform_db_upgrade_4_to_5(conn: ConnectionPlus) -> None:
 
 
 @upgrader
-def perform_db_upgrade_5_to_6(conn: ConnectionPlus) -> None:
+def perform_db_upgrade_5_to_6(
+    conn: ConnectionPlus, show_progress_bar: bool = True
+) -> None:
     """
     Perform the upgrade from version 5 to version 6.
 
@@ -266,11 +296,14 @@ def perform_db_upgrade_5_to_6(conn: ConnectionPlus) -> None:
     not be tracked as schema upgrades.
     """
     from qcodes.dataset.sqlite.db_upgrades.upgrade_5_to_6 import upgrade_5_to_6
-    upgrade_5_to_6(conn)
+
+    upgrade_5_to_6(conn, show_progress_bar)
 
 
 @upgrader
-def perform_db_upgrade_6_to_7(conn: ConnectionPlus) -> None:
+def perform_db_upgrade_6_to_7(
+    conn: ConnectionPlus, show_progress_bar: bool = True
+) -> None:
     """
     Perform the upgrade from version 6 to version 7
 
@@ -284,7 +317,7 @@ def perform_db_upgrade_6_to_7(conn: ConnectionPlus) -> None:
 
     if n_run_tables == 1:
 
-        pbar = tqdm(range(1), file=sys.stdout)
+        pbar = tqdm(range(1), file=sys.stdout, disable=not show_progress_bar)
         pbar.set_description("Upgrading database; v6 -> v7")
         # iterate through the pbar for the sake of the side effect; it
         # prints that the database is being upgraded
@@ -306,14 +339,16 @@ def perform_db_upgrade_6_to_7(conn: ConnectionPlus) -> None:
 
 
 @upgrader
-def perform_db_upgrade_7_to_8(conn: ConnectionPlus) -> None:
+def perform_db_upgrade_7_to_8(
+    conn: ConnectionPlus, show_progress_bar: bool = True
+) -> None:
     """
     Perform the upgrade from version 7 to version 8.
 
     Add a new column to store the dataset's parents to the runs table.
     """
     with atomic(conn) as conn:
-        pbar = tqdm(range(1), file=sys.stdout)
+        pbar = tqdm(range(1), file=sys.stdout, disable=not show_progress_bar)
         pbar.set_description("Upgrading database; v7 -> v8")
         # iterate through the pbar for the sake of the side effect; it
         # prints that the database is being upgraded
@@ -322,7 +357,9 @@ def perform_db_upgrade_7_to_8(conn: ConnectionPlus) -> None:
 
 
 @upgrader
-def perform_db_upgrade_8_to_9(conn: ConnectionPlus) -> None:
+def perform_db_upgrade_8_to_9(
+    conn: ConnectionPlus, show_progress_bar: bool = True
+) -> None:
     """
     Perform the upgrade from version 8 to version 9.
 
@@ -333,7 +370,7 @@ def perform_db_upgrade_8_to_9(conn: ConnectionPlus) -> None:
     cur = atomic_transaction(conn, sql)
     n_run_tables = len(cur.fetchall())
 
-    pbar = tqdm(range(1), file=sys.stdout)
+    pbar = tqdm(range(1), file=sys.stdout, disable=not show_progress_bar)
     pbar.set_description("Upgrading database; v8 -> v9")
 
     if n_run_tables == 1:
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+The Dataset no longer prints upgrade progressbars when upgrading an empty database. This means that`
	`2`	`+the progressbar will no longer be shown when creating a new database.`