solentware-base 5.2.3__tar.gz → 5.3__tar.gz

{solentware_base-5.2.3/solentware_base.egg-info → solentware_base-5.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: solentware-base
-Version: 5.2.3
+Version: 5.3
 Summary: Bitmapped record number databases.
 Author-email: Roger Marsh <roger.marsh@solentware.co.uk>
 License-Expression: BSD-3-Clause

{solentware_base-5.2.3 → solentware_base-5.3}/pyproject.toml

@@ -10,7 +10,7 @@ line-length = 79
 
 [project]
 name = "solentware-base"
-version = "5.2.3"
+version = "5.3"
 authors = [
   { name="Roger Marsh", email="roger.marsh@solentware.co.uk" },
 ]

{solentware_base-5.2.3 → solentware_base-5.3}/solentware_base/core/_databasedu.py

@@ -270,3 +270,15 @@ class Database(_database.Database):
         merger = merge.Merge(index_directory)
         for item in merger.sorter():
             yield item
+
+    def get_merge_import_sort_area(self):
+        """Return database directory.
+
+        The directory containing database is used for sorting by default,
+        subclasses should override as required.
+
+        There is little point in doing so unless the sort area is then on
+        a different drive or mount point.
+
+        """
+        return self.home_directory

{solentware_base-5.2.3 → solentware_base-5.3}/solentware_base/core/_db.py

@@ -34,6 +34,7 @@ from .constants import (
     CONTROL_FILE,
     DEFAULT_SEGMENT_SIZE_BYTES,
     SPECIFICATION_KEY,
+    APPLICATION_CONTROL_KEY,
     SEGMENT_SIZE_BYTES_KEY,
     SEGMENT_HEADER_LENGTH,
     FIELDS,
@@ -496,6 +497,9 @@ class Database(_database.Database):
                 repr(self.segment_size_bytes).encode(),
                 txn=self.dbtxn,
             )
+            self.table[CONTROL_FILE].put(
+                APPLICATION_CONTROL_KEY, repr({}).encode(), txn=self.dbtxn
+            )
         self.commit()
         self._dbe = dbe
 
@@ -1763,6 +1767,25 @@ class Database(_database.Database):
             return super()._generate_database_file_name(name)
         return os.path.join(self.home_directory, name)
 
+    def get_application_control(self):
+        """Return dict of application control items."""
+        value = self.table[CONTROL_FILE].get(
+            APPLICATION_CONTROL_KEY,
+            txn=self.dbtxn,
+        )
+        if value is not None:
+            return literal_eval(value.decode())
+        return {}
+
+    def set_application_control(self, appcontrol):
+        """Set dict of application control items."""
+        self.table[CONTROL_FILE].delete(
+            APPLICATION_CONTROL_KEY, txn=self.dbtxn
+        )
+        self.table[CONTROL_FILE].put(
+            APPLICATION_CONTROL_KEY, repr(appcontrol).encode(), txn=self.dbtxn
+        )
+
 
 class Cursor(_cursor.Cursor):
     """Define a cursor on the underlying database engine dbset.

{solentware_base-5.2.3 → solentware_base-5.3}/solentware_base/core/_db_tkinter.py

@@ -33,6 +33,7 @@ from .constants import (
     CONTROL_FILE,
     DEFAULT_SEGMENT_SIZE_BYTES,
     SPECIFICATION_KEY,
+    APPLICATION_CONTROL_KEY,
     SEGMENT_SIZE_BYTES_KEY,
     SEGMENT_HEADER_LENGTH,
     FIELDS,
@@ -638,6 +639,11 @@ class Database(_database.Database):
                 ]
             )
             tcl_tk_call(tuple(command))
+            command = [self.table[CONTROL_FILE], "put"]
+            if self.dbtxn:
+                command.extend(["-txn", self.dbtxn])
+            command.extend([APPLICATION_CONTROL_KEY, repr({}).encode()])
+            tcl_tk_call(tuple(command))
         self.commit()
 
     def _run_db_archive(self):
@@ -2197,6 +2203,34 @@ class Database(_database.Database):
             return super()._generate_database_file_name(name)
         return os.path.join(self.home_directory, name)
 
+    def get_application_control(self):
+        """Return dict of application control items."""
+        command = [self.table[CONTROL_FILE], "get"]
+        if self.dbtxn:
+            command.extend(["-txn", self.dbtxn])
+        command.extend(
+            [
+                APPLICATION_CONTROL_KEY,
+            ]
+        )
+        value = tcl_tk_call(tuple(command))
+        if value is not None:
+            return literal_eval(value.decode())
+        return {}
+
+    def set_application_control(self, appcontrol):
+        """Set dict of application control items."""
+        command = [self.table[CONTROL_FILE], "delete"]
+        if self.dbtxn:
+            command.extend(["-txn", self.dbtxn])
+        command.extend([APPLICATION_CONTROL_KEY])
+        tcl_tk_call(tuple(command))
+        command = [self.table[CONTROL_FILE], "put"]
+        if self.dbtxn:
+            command.extend(["-txn", self.dbtxn])
+        command.extend([APPLICATION_CONTROL_KEY, repr(appcontrol).encode()])
+        tcl_tk_call(tuple(command))
+
 
 class Cursor(_cursor.Cursor):
     """Define a cursor on the underlying database engine dbset.

{solentware_base-5.2.3 → solentware_base-5.3}/solentware_base/core/_lmdb.py

@@ -18,6 +18,7 @@ from .constants import (
     DESIGN_FILE,
     DEFAULT_SEGMENT_SIZE_BYTES,
     SPECIFICATION_KEY,
+    APPLICATION_CONTROL_KEY,
     SEGMENT_SIZE_BYTES_KEY,
     SEGMENT_HEADER_LENGTH,
     DEFAULT_MAP_SIZE,
@@ -343,6 +344,7 @@ class Database(_database.Database):
                 SEGMENT_SIZE_BYTES_KEY,
                 repr(self.segment_size_bytes).encode(),
             )
+            cursor.put(APPLICATION_CONTROL_KEY, repr({}).encode())
             cursor.close()
             self.table[DESIGN_FILE].close_datastore()
             self.open_database_contexts()
@@ -387,6 +389,8 @@ class Database(_database.Database):
             self._real_segment_size_bytes = False
         if segment_size != self.segment_size_bytes:
             self._real_segment_size_bytes = segment_size
+            self.dbenv.close()
+            self.dbenv = None
             raise self.SegmentSizeError(
                 " ".join(
                     (
@@ -1847,6 +1851,24 @@ class Database(_database.Database):
         ) // DEFAULT_MAP_PAGES
         self.dbenv.set_mapsize(self.map_blocks * DEFAULT_MAP_SIZE)
 
+    def get_application_control(self):
+        """Return dict of application control items."""
+        value = self.dbtxn.transaction.get(
+            APPLICATION_CONTROL_KEY,
+            db=self.table[DESIGN_FILE].datastore,
+        )
+        if value is not None:
+            return literal_eval(value.decode())
+        return {}
+
+    def set_application_control(self, appcontrol):
+        """Set dict of application control items."""
+        self.dbtxn.transaction.put(
+            APPLICATION_CONTROL_KEY,
+            repr(appcontrol).encode(),
+            db=self.table[DESIGN_FILE].datastore,
+        )
+
 
 class _DBtxn:
     """Provide a Symas LMMD read-only or read-write transaction instance.

{solentware_base-5.2.3 → solentware_base-5.3}/solentware_base/core/_sqlite.py

@@ -21,6 +21,7 @@ from .constants import (
     CONTROL_FILE,
     DEFAULT_SEGMENT_SIZE_BYTES,
     SPECIFICATION_KEY,
+    APPLICATION_CONTROL_KEY,
     SEGMENT_SIZE_BYTES_KEY,
     SQLITE_VALUE_COLUMN,
     SQLITE_SEGMENT_COLUMN,
@@ -124,7 +125,7 @@ class Database(_database.Database):
                 cursor.close()
 
     def backout(self):
-        """Backout tranaction."""
+        """Backout transaction."""
         if self.dbenv:
             cursor = self.dbenv.cursor()
             try:
@@ -133,7 +134,7 @@ class Database(_database.Database):
                 cursor.close()
 
     def commit(self):
-        """Commit tranaction."""
+        """Commit transaction."""
         if self.dbenv:
             cursor = self.dbenv.cursor()
             try:
@@ -349,6 +350,7 @@ class Database(_database.Database):
                     statement,
                     (SEGMENT_SIZE_BYTES_KEY, repr(self.segment_size_bytes)),
                 )
+                cursor.execute(statement, (APPLICATION_CONTROL_KEY, repr({})))
         self.commit()
 
     def _raise_if_no_object(self, type_, name):
@@ -2089,6 +2091,54 @@ class Database(_database.Database):
         finally:
             db.close_database()
 
+    def get_application_control(self):
+        """Return dict of application control items."""
+        cursor = self.dbenv.cursor()
+        statement = " ".join(
+            (
+                "select",
+                SQLITE_VALUE_COLUMN,
+                "from",
+                CONTROL_FILE,
+                "where",
+                CONTROL_FILE,
+                "== ?",
+            )
+        )
+        cursor.execute(statement, (APPLICATION_CONTROL_KEY,))
+        rsk = cursor.fetchall()
+        if rsk:
+            return literal_eval(rsk[0][0])
+        return {}
+
+    def set_application_control(self, appcontrol):
+        """Set dict of application control items."""
+        # Why is 'insert or replace into' on it's own not sufficient.
+        cursor = self.dbenv.cursor()
+        statement = " ".join(
+            (
+                "delete from",
+                CONTROL_FILE,
+                "where",
+                CONTROL_FILE,
+                "== ?",
+            )
+        )
+        cursor.execute(statement, (APPLICATION_CONTROL_KEY,))
+        statement = " ".join(
+            (
+                "insert into",
+                CONTROL_FILE,
+                "(",
+                CONTROL_FILE,
+                ",",
+                SQLITE_VALUE_COLUMN,
+                ")",
+                "values ( ? , ? )",
+            )
+        )
+        cursor.execute(statement, (APPLICATION_CONTROL_KEY, repr(appcontrol)))
+
 
 class Cursor(_cursor.Cursor):
     """Define a cursor on the underlying database engine dbset.

{solentware_base-5.2.3 → solentware_base-5.3}/solentware_base/core/constants.py

@@ -194,6 +194,7 @@ SPECIFICATION_KEY = b"_specification"
 SEGMENT_SIZE_BYTES_KEY = b"_segment_size_bytes"
 TABLE_REGISTER_KEY = b"_table_register"
 FIELD_REGISTER_KEY = b"_field_register"
+APPLICATION_CONTROL_KEY = b"_application_control"
 
 # Constants defined for UnQLite and Vedis databases.  dbm.gnu and dbm.ndbm are
 # added to this list later.

{solentware_base-5.2.3 → solentware_base-5.3}/solentware_base/core/merge.py

@@ -125,7 +125,7 @@ class SortIndiciesToSequentialFiles:
         encode_number = database.encode_number_for_sequential_file_dump
         encode_segment = database.encode_segment_for_sequential_file_dump
         dump_directory = os.path.join(
-            database.home_directory,
+            database.get_merge_import_sort_area(),
             "_".join((os.path.basename(database.database_file), self.file)),
             index,
         )
@@ -156,7 +156,7 @@ class SortIndiciesToSequentialFiles:
             self.write_segment_to_sequential_file(index, reference)
             reference.clear()
         guard_file = os.path.join(
-            self.database.home_directory,
+            self.database.get_merge_import_sort_area(),
             "_".join(
                 (os.path.basename(self.database.database_file), self.file)
             ),

{solentware_base-5.2.3 → solentware_base-5.3/solentware_base.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: solentware-base
-Version: 5.2.3
+Version: 5.3
 Summary: Bitmapped record number databases.
 Author-email: Roger Marsh <roger.marsh@solentware.co.uk>
 License-Expression: BSD-3-Clause