Initial support for Firebird 5.0

Author: pcisar

src/firebird/driver/__init__.py

@@ -59,4 +59,4 @@
      Server, Statement)
 
 #: Current driver version, SEMVER string.
-__VERSION__ = '1.8.0'
+__VERSION__ = '1.9.0'

src/firebird/driver/config.py

@@ -150,6 +150,9 @@ def __init__(self, name: str, *, optional: bool=False, description: str=None):
         self.decfloat_traps: ListOption = \
             ListOption('decfloat_traps', DecfloatTraps,
                        "Which DECFLOAT exceptional conditions cause a trap")
+        #: Number of parallel workers
+        self.parallel_workers = \
+            IntOption('parallel_workers', "Number of parallel workers")
         # Create options
         #: Database create option. Page size to be used.
         self.page_size: IntOption = \

src/firebird/driver/core.py

@@ -411,7 +411,8 @@ def __init__(self, *, user: str=None, password: str=None, role: str=None,
                  config: str=None, auth_plugin_list: str=None, session_time_zone: str=None,
                  set_db_replica: ReplicaMode=None, set_bind: str=None,
                  decfloat_round: DecfloatRound=None,
-                 decfloat_traps: List[DecfloatTraps]=None
+                 decfloat_traps: List[DecfloatTraps]=None,
+                 parallel_workers: int=None
                  ):
         # Available options:
         # AuthClient, WireCryptPlugin, Providers, ConnectionTimeout, WireCrypt,
@@ -482,6 +483,8 @@ def __init__(self, *, user: str=None, password: str=None, role: str=None,
         self.db_sql_dialect: Optional[int] = db_sql_dialect
         #: Character set for the database [db create only]
         self.db_charset: Optional[str] = db_charset
+        #: Number of parallel workers
+        self.parallel_workers: int = parallel_workers
     def clear(self) -> None:
         """Clear all information.
         """
@@ -586,6 +589,8 @@ def parse_buffer(self, buffer: bytes) -> None:
                 elif tag == DPBItem.DECFLOAT_TRAPS:
                     self.decfloat_traps = [DecfloatTraps(v.strip())
                                            for v in dpb.get_string().split(',')]
+                elif tag == DPBItem.PARALLEL_WORKERS:
+                    self.parallel_workers = dpb.get_int()
     def get_buffer(self, *, for_create: bool = False) -> bytes:
         """Create DPB from stored information.
         """
@@ -637,6 +642,8 @@ def get_buffer(self, *, for_create: bool = False) -> bytes:
             if self.decfloat_traps is not None:
                 dpb.insert_string(DPBItem.DECFLOAT_TRAPS, ','.join(e.value for e in
                                                                    self.decfloat_traps))
+            if self.parallel_workers is not None:
+                dpb.insert_int(DPBItem.PARALLEL_WORKERS, self.parallel_workers)
             if for_create:
                 if self.page_size is not None:
                     dpb.insert_int(DPBItem.PAGE_SIZE, self.page_size)
@@ -2118,7 +2125,8 @@ def connect(database: str, *, user: str=None, password: str=None, role: str=None
               config=db_config.config.value, auth_plugin_list=auth_plugin_list,
               session_time_zone=session_time_zone, set_bind=db_config.set_bind.value,
               decfloat_round=db_config.decfloat_round.value,
-              decfloat_traps=db_config.decfloat_traps.value)
+              decfloat_traps=db_config.decfloat_traps.value,
+              parallel_workers=db_config.parallel_workers.value)
     return __make_connection(False, dsn, db_config.utf8filename.value, dpb.get_buffer(),
                              db_config.sql_dialect.value, charset, crypt_callback)
 
@@ -4222,7 +4230,7 @@ def backup(self, *, database: FILESPEC, backup: Union[FILESPEC, Sequence[FILESPE
                callback: CB_OUTPUT_LINE=None, stats: str=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:
+               crypt: str=None, parallel_workers: int=None) -> None:
         """Request logical (GBAK) database backup. **(ASYNC service)**
 
         Arguments:
@@ -4240,6 +4248,7 @@ def backup(self, *, database: FILESPEC, backup: Union[FILESPEC, Sequence[FILESPE
             keyholder: Keyholder name [Firebird 4]
             keyname: Key name [Firebird 4]
             crypt: Encryption specification [Firebird 4]
+            parallel_workers: Number of parallel workers [Firebird 5]
         """
         if isinstance(backup, (str, Path)):
             backup = [backup]
@@ -4267,6 +4276,8 @@ def backup(self, *, database: FILESPEC, backup: Union[FILESPEC, Sequence[FILESPE
                 spb.insert_string(SrvBackupOption.KEYNAME, keyname)
             if crypt is not None:
                 spb.insert_string(SrvBackupOption.CRYPT, crypt)
+            if parallel_workers is not None:
+                spb.insert_int(SrvBackupOption.PARALLEL_WORKERS, parallel_workers)
             spb.insert_int(SPBItem.OPTIONS, flags)
             if verbose:
                 spb.insert_tag(SPBItem.VERBOSE)
@@ -4287,7 +4298,7 @@ def restore(self, *, backup: Union[FILESPEC, Sequence[FILESPEC]],
                 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:
+                replica_mode: ReplicaMode=None, parallel_workers: int=None) -> None:
         """Request database restore from logical (GBAK) backup. **(ASYNC service)**
 
         Arguments:
@@ -4309,6 +4320,7 @@ def restore(self, *, backup: Union[FILESPEC, Sequence[FILESPEC]],
             keyname: Key name [Firebird 4]
             crypt: Encryption specification [Firebird 4]
             replica_mode: Replica mode for restored database [Firebird 4]
+            parallel_workers: Number of parallel workers [Firebird 5]
         """
         if isinstance(backup, (str, Path)):
             backup = [backup]
@@ -4346,6 +4358,8 @@ def restore(self, *, backup: Union[FILESPEC, Sequence[FILESPEC]],
                 spb.insert_string(SrvRestoreOption.CRYPT, crypt)
             if replica_mode is not None:
                 spb.insert_int(SrvRestoreOption.REPLICA_MODE, replica_mode.value)
+            if parallel_workers is not None:
+                spb.insert_int(SrvRestoreOption.PARALLEL_WORKERS, parallel_workers)
             spb.insert_int(SPBItem.OPTIONS, flags)
             if verbose:
                 spb.insert_tag(SPBItem.VERBOSE)
@@ -4725,24 +4739,27 @@ def bring_online(self, *, database: FILESPEC, mode: OnlineMode=OnlineMode.NORMAL
             spb.insert_bytes(SrvPropertiesOption.ONLINE_MODE, bytes([mode]))
             self._srv()._svc.start(spb.get_buffer())
         self._srv().wait()
-    def sweep(self, *, database: FILESPEC, role: str=None) -> None:
+    def sweep(self, *, database: FILESPEC, role: str=None, parallel_workers: int=None) -> None:
         """Perform database sweep operation.
 
         Arguments:
             database: Database specification or alias.
             role: SQL ROLE name passed to gfix.
+            parallel_workers: Number of parallel workers [Firebird 5]
         """
         self._srv()._reset_output()
         with a.get_api().util.get_xpb_builder(XpbKind.SPB_START) as spb:
             spb.insert_tag(ServerAction.REPAIR)
             spb.insert_string(SPBItem.DBNAME, str(database), encoding=self._srv().encoding)
             if role is not None:
                 spb.insert_string(SPBItem.SQL_ROLE_NAME, role, encoding=self._srv().encoding)
+            if parallel_workers is not None:
+                spb.insert_int(SrvRepairOption.PARALLEL_WORKERS, parallel_workers)
             spb.insert_int(SPBItem.OPTIONS, SrvRepairFlag.SWEEP_DB)
             self._srv()._svc.start(spb.get_buffer())
         self._srv().wait()
     def repair(self, *, database: FILESPEC, flags: SrvRepairFlag=SrvRepairFlag.REPAIR,
-               role: str=None) -> bytes:
+               role: str=None) -> None:
         """Perform database repair operation.  **(SYNC service)**
 
         Arguments:
@@ -4903,7 +4920,7 @@ def rollback_limbo_transaction(self, *, database: FILESPEC, transaction_id: int)
             self._srv()._svc.start(spb.get_buffer())
         self._srv()._read_all_binary_output()
 
-class ServerDbServices(ServerDbServices3):
+class ServerDbServices4(ServerDbServices3):
     """Database-related actions and services [Firebird 4+].
     """
     def nfix_database(self, *, database: FILESPEC, role: str=None,
@@ -4942,6 +4959,26 @@ def set_replica_mode(self, *, database: FILESPEC, mode: ReplicaMode, role: str=N
             self._srv()._svc.start(spb.get_buffer())
         self._srv().wait()
 
+class ServerDbServices(ServerDbServices4):
+    """Database-related actions and services [Firebird 5+].
+    """
+    def upgrade(self, *, database: FILESPEC) -> bytes:
+        """Perform database repair operation.  **(SYNC service)**
+
+        Arguments:
+            database: Database specification or alias.
+            flags: Repair flags.
+            role: SQL ROLE name passed to gfix.
+        """
+        self._srv()._reset_output()
+        with a.get_api().util.get_xpb_builder(XpbKind.SPB_START) as spb:
+            spb.insert_tag(ServerAction.REPAIR)
+            spb.insert_string(SPBItem.DBNAME, str(database), encoding=self._srv().encoding)
+            spb.insert_int(SPBItem.OPTIONS, SrvRepairFlag.UPGRADE_DB)
+            self._srv()._svc.start(spb.get_buffer())
+        self._srv().wait()
+
+
 class ServerUserServices(ServerServiceProvider):
     """User-related actions and services.
     """
@@ -5457,8 +5494,12 @@ def database(self) -> Union[ServerDbServices3, ServerDbServices]:
         """Access to various database-related actions and services.
         """
         if self.__dbsvc is None:
-            cls = ServerDbServices if self._engine_version() >= 4.0 \
-                else ServerDbServices3
+            if self._engine_version() >= 5.0:
+                cls = ServerDbServices
+            elif self._engine_version() == 4.0:
+                cls = ServerDbServices4
+            else:
+                cls = ServerDbServices3
             self.__dbsvc = cls(self)
         return self.__dbsvc
     @property

src/firebird/driver/fbapi.py

@@ -981,8 +981,14 @@ class IInt128_struct(Structure):
 IResultSet_deprecatedClose = CFUNCTYPE(None, IResultSet, IStatus)
 # procedure setDelayedOutputFormat(this: IResultSet; status: IStatus; format: IMessageMetadata)
 IResultSet_setDelayedOutputFormat = CFUNCTYPE(None, IResultSet, IStatus, IMessageMetadata)
+# IResultSet(4) : IResultSet(3)
 # procedure close(this: IResultSet; status: IStatus)
 IResultSet_close = CFUNCTYPE(None, IResultSet, IStatus)
+# >>> Firebird 5
+# IResultSet(5) : IResultSet(4)
+# procedure(this: IResultSet; status: IStatus; itemsLength: Cardinal; items: BytePtr; bufferLength: Cardinal; buffer: BytePtr); cdecl;
+IResultSet_getInfo = CFUNCTYPE(None, IResultSet, IStatus, Cardinal, BytePtr, Cardinal, BytePtr)
+
 #
 # IStatement(3) : ReferenceCounted
 # --------------------------------
@@ -1549,7 +1555,9 @@ class IInt128_struct(Structure):
     ('getMetadata', IResultSet_getMetadata),
     ('deprecatedClose', IResultSet_deprecatedClose),
     ('setDelayedOutputFormat', IResultSet_setDelayedOutputFormat),
-    ('close', IResultSet_close)] # v4: 3.0.7 => 3.0.8, 4.0.0 => 4.0.1
+    ('close', IResultSet_close), # v4: 3.0.7 => 3.0.8, 4.0.0 => 4.0.1
+    ('getInfo', IResultSet_getInfo),  # v5: 5.0.0
+    ]
 # >>> Firebird 4
 # IStatement(5) : ReferenceCounted
 IStatement_VTable._fields_ = [ # v3 - initial
@@ -1955,22 +1963,59 @@ class FirebirdAPI:
                 `ISC_LONG`
 
         isc_array_lookup_bounds():
-            Old API function isc_array_lookup_bounds()
+            Old API function.
 
         isc_array_put_slice():
-            Old API function isc_array_put_slice()
+            Old API function.
 
         isc_array_get_slice():
-            Old API function isc_array_get_slice()
+            Old API function.
 
         isc_que_events():
-            Old API function isc_que_events()
+            Old API function.
 
         isc_event_counts():
-            Old API function isc_event_counts()
+            Old API function.
 
         isc_cancel_events():
-            Old API function isc_cancel_events()
+            Old API function.
+
+        isc_compile_request()
+            Old API function.
+
+        isc_start_request()
+            Old API function.
+
+        isc_release_request()
+            Old API function.
+
+        isc_receive()
+            Old API function.
+
+        isc_start_and_send()
+            Old API function.
+
+        isc_send()
+            Old API function.
+
+        isc_open_blob2()
+            Old API function.
+
+        isc_blob_info()
+            Old API function.
+
+        isc_create_blob2()
+            Old API function.
+
+        isc_get_segment()
+            Old API function.
+
+        isc_put_segment()
+            Old API function.
+
+        isc_close_blob():
+            Old API function.
+
     """
     def __init__(self, filename: Path = None):
         decimal.getcontext().prec = 34

src/firebird/driver/interfaces.py

@@ -715,8 +715,8 @@ def set_delayed_output_format(self, fmt: iMessageMetadata) -> None:
         self.vtable.setDelayedOutputFormat(self, self.status, fmt)
         self._check()
 
-# IResultSet(3) : ReferenceCounted
-class iResultSet(iResultSet_v3):
+# IResultSet(4) : ReferenceCounted
+class iResultSet_v4(iResultSet_v3):
     "Class that wraps IResultSet interface for use from Python"
     VERSION = 4
     def close(self) -> None:
@@ -725,6 +725,15 @@ def close(self) -> None:
         self._check()
         self._refcnt -= 1
 
+# IResultSet(5) : ReferenceCounted
+class iResultSet(iResultSet_v3):
+    "Class that wraps IResultSet interface for use from Python"
+    VERSION = 5
+    def get_info(self, items: bytes, buffer: bytes) -> None:
+        "Returns information about result set."
+        self.vtable.getInfo(self, self.status, len(items), items, len(buffer), buffer)
+        self._check()
+
 # IStatement(3) : ReferenceCounted
 class iStatement_v3(iReferenceCounted):
     "Class that wraps IStatement v3 interface for use from Python"