Release 1.5.0

Author: pcisar

docs/changelog.txt

@@ -2,6 +2,25 @@
 Changelog
 #########
 
+Version 1.5.0
+=============
+
+* Fix: `.create_database()` now use server configuration user/password if either is not
+  specified in database configuration (like `.connect()`)
+* Fix: Problem in `.Server` processing incomplete LINE responses.
+* New: `verbint` parameter for `.ServerDbServices3.backup()` and `.ServerDbServices3.restore()`
+
+  This is undocumented Firebird v3 gbak feature. See https://github.com/FirebirdSQL/firebird/issues/808
+  for details. It's mutually exclusive with `verbose`, and minimal value is 100.
+
+Potentially breaking changes
+----------------------------
+
+* Change in `.ServerDbServices3.restore()`: The `verbose` parameter default value was changed
+  to `False` to be consistent with `.ServerDbServices3.backup()`
+* Change in `.ShutdownMethod`: DENNY_ATTACHMENTS/DENNY_TRANSACTIONS renamed to
+  DENY_ATTACHMENTS/DENY_TRANSACTIONS.
+
 Version 1.4.3
 =============
 

docs/conf.py

@@ -23,10 +23,10 @@
 author = 'Pavel Císař'
 
 # The short X.Y version
-version = '1.4.3'
+version = '1.5.0'
 
 # The full version, including alpha/beta/rc tags
-release = '1.4.3'
+release = '1.5.0'
 
 
 # -- General configuration ---------------------------------------------------

firebird/driver/core.py

@@ -2180,8 +2180,12 @@ def create_database(database: str, *, user: str=None, password: str=None, role:
                 raise ValueError(f"Configuration for server '{db_config.server.value}' not found")
     if user is None:
         user = db_config.user.value
+        if user is None:
+            user = srv_config.user.value
     if password is None:
         password = db_config.password.value
+        if password is None:
+            password = srv_config.password.value
     if role is None:
         role = db_config.role.value
     if charset is None:
@@ -4239,8 +4243,9 @@ def backup(self, *, database: FILESPEC, backup: Union[FILESPEC, Sequence[FILESPE
                backup_file_sizes: Sequence[int]=(),
                flags: SrvBackupFlag=SrvBackupFlag.NONE, role: str=None,
                callback: CB_OUTPUT_LINE=None, stats: str=None,
-               verbose: bool=False, skip_data: str=None, include_data: str=None,
-               keyhoder: str=None, keyname: str=None, crypt: str=None) -> None:
+               verbose: bool=False, verbint: int=None, skip_data: str=None,
+               include_data: str=None, keyhoder: str=None, keyname: str=None,
+               crypt: str=None) -> None:
         """Request logical (GBAK) database backup. **(ASYNC service)**
 
         Arguments:
@@ -4252,6 +4257,7 @@ def backup(self, *, database: FILESPEC, backup: Union[FILESPEC, Sequence[FILESPE
             callback: Function to call back with each output line.
             stats: Backup statistic options (TDWR).
             verbose: Whether output should be verbose or not.
+            verbint: Verbose information with explicit interval (number of records)
             skip_data: String with table names whose data should be excluded from backup.
             include_data: String with table names whose data should be included into backup [Firebird 4].
             keyholder: Keyholder name [Firebird 4]
@@ -4287,6 +4293,8 @@ def backup(self, *, database: FILESPEC, backup: Union[FILESPEC, Sequence[FILESPE
             spb.insert_int(SPBItem.OPTIONS, flags)
             if verbose:
                 spb.insert_tag(SPBItem.VERBOSE)
+            if verbint is not None:
+                spb.insert_int(SPBItem.VERBINT, verbint)
             if stats:
                 spb.insert_string(SrvBackupOption.STAT, stats)
             self._srv()._svc.start(spb.get_buffer())
@@ -4298,10 +4306,11 @@ def restore(self, *, backup: Union[FILESPEC, Sequence[FILESPEC]],
                 db_file_pages: Sequence[int]=(),
                 flags: SrvRestoreFlag=SrvRestoreFlag.CREATE, role: str=None,
                 callback: CB_OUTPUT_LINE=None, stats: str=None,
-                verbose: bool=True, skip_data: str=None, page_size: int=None,
-                buffers: int=None, access_mode: DbAccessMode=DbAccessMode.READ_WRITE,
-                include_data: str=None, keyhoder: str=None, keyname: str=None,
-                crypt: str=None, replica_mode: ReplicaMode=None) -> None:
+                verbose: bool=False, verbint: int=None, skip_data: str=None,
+                page_size: int=None, buffers: int=None,
+                access_mode: DbAccessMode=DbAccessMode.READ_WRITE, include_data: str=None,
+                keyhoder: str=None, keyname: str=None, crypt: str=None,
+                replica_mode: ReplicaMode=None) -> None:
         """Request database restore from logical (GBAK) backup. **(ASYNC service)**
 
         Arguments:
@@ -4313,6 +4322,7 @@ def restore(self, *, backup: Union[FILESPEC, Sequence[FILESPEC]],
             callback: Function to call back with each output line.
             stats: Restore statistic options (TDWR).
             verbose: Whether output should be verbose or not.
+            verbint: Verbose information with explicit interval (number of records)
             skip_data: String with table names whose data should be excluded from restore.
             page_size: Page size for restored database.
             buffers: Cache size for restored database.
@@ -4362,6 +4372,8 @@ def restore(self, *, backup: Union[FILESPEC, Sequence[FILESPEC]],
             spb.insert_int(SPBItem.OPTIONS, flags)
             if verbose:
                 spb.insert_tag(SPBItem.VERBOSE)
+            if verbint is not None:
+                spb.insert_int(SPBItem.VERBINT, verbint)
             if stats:
                 spb.insert_string(SrvRestoreOption.STAT, stats)
             self._srv()._svc.start(spb.get_buffer())
@@ -5325,9 +5337,9 @@ def _read_output(self, *, init: str='', timeout: int=-1) -> None:
             self._eof = self.response.get_tag() == isc_info_end
         else: # LINE mode
             self._eof = not data
-            while self.response.get_tag() == isc_info_truncated:
+            while (tag := self.response.get_tag()) == isc_info_truncated:
                 data += self._query_output(timeout)
-            if self.response.get_tag() != isc_info_end:  # pragma: no cover
+            if tag != isc_info_end:  # pragma: no cover
                 raise InterfaceError("Malformed result buffer (missing isc_info_end item)")
         init += data
         if data and self.mode is SrvInfoCode.LINE:

firebird/driver/types.py

@@ -827,8 +827,8 @@ class ShutdownMethod(IntEnum):
     """Database shutdown method options.
     """
     FORCED = 41
-    DENNY_ATTACHMENTS = 42
-    DENNY_TRANSACTIONS = 43
+    DENY_ATTACHMENTS = 42
+    DENY_TRANSACTIONS = 43
 
 class TransactionState(IntEnum):
     """Transaction state.

setup.cfg

@@ -5,7 +5,7 @@ all-files=True
 
 [metadata]
 name = firebird-driver
-version = 1.4.3
+version = 1.5.0
 description = Firebird driver
 long_description = file: README.rst
 long_description_content_type = text/x-rst; charset=UTF-8

test/test_driver.py

@@ -1845,14 +1845,14 @@ def fetchline(line):
             self.assertIsInstance(line, str)
         # callback
         output = []
-        self.svc.database.restore(backup=self.fbk, database=self.rfdb,
+        self.svc.database.restore(backup=self.fbk, database=self.rfdb, verbose=True,
                                   flags=SrvRestoreFlag.REPLACE, callback=fetchline)
         self.assertGreater(len(output), 0)
         # Firebird 3.0 stats
         output = []
         self.svc.database.restore(backup=self.fbk, database=self.rfdb,
                                   flags=SrvRestoreFlag.REPLACE, callback=fetchline,
-                                  stats='TDRW')
+                                  stats='TDRW', verbose=True)
         self.assertGreater(len(output), 0)
         self.assertIn('gbak: time     delta  reads  writes \n', output)
         # Skip data option
@@ -1939,7 +1939,7 @@ def test_shutdown_bring_online(self):
         self.assertIn('multi-user maintenance', ''.join(self.svc.readlines()))
         # Go to full shutdown mode, disabling new attachments during 5 seconds
         self.svc.database.shutdown(database=self.rfdb, mode=ShutdownMode.FULL,
-                                   method=ShutdownMethod.DENNY_ATTACHMENTS, timeout=5)
+                                   method=ShutdownMethod.DENY_ATTACHMENTS, timeout=5)
         self.svc.database.get_statistics(database=self.rfdb, flags=SrvStatFlag.HDR_PAGES)
         self.assertIn('full shutdown', ''.join(self.svc.readlines()))
         # Enable single-user maintenance