Skip to content

Settings

Database settings.

The settings class contains the following parameters:

  • db_root - Path to root directory of database. By default = "ScrubyDB" (in root of project).
  • db_id - Database ID.
  • hash_reduce_left - The length of the hash reduction on the left side.
    • 0 - 4294967296 branches in collection.
    • 2 - 16777216 branches in collection.
    • 4 - 65536 branches in collection.
    • 6 - 256 branches in collection (by default).
  • max_workers - The maximum number of processes that can be used By default = None.
  • plugins - For adding plugins.

ScrubySettings

Database settings.

Source code in src/scruby/settings.py 
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
@final
class ScrubySettings:
    """Database settings."""

    # Path to root directory of database
    # By default = "ScrubyDB" (in root of project).
    db_root: ClassVar[str] = "ScrubyDB"

    # Database ID
    db_id: ClassVar[str | None] = None

    # The length of the hash reduction on the left side.
    # 0 = 4294967296 branches in collection.
    # 2 = 16777216 branches in collection.
    # 4 = 65536 branches in collection.
    # 6 = 256 branches in collection (by default).
    # Number of branches is number of requests to the hard disk during quantum operations.
    # Quantum operations: find_one, find_many, count_documents, delete_many, run_custom_task.
    hash_reduce_left: ClassVar[Literal[0, 2, 4, 6]] = 6

    # The maximum number of processes that can be used to execute the given calls.
    # If None, then as many worker processes will be
    # created as the machine has processors.
    max_workers: ClassVar[int | None] = None

    # For adding plugins.
    plugins: ClassVar[list[Any]] = []

    # Information about the operating system.
    sys_platform: ClassVar[str] = sys.platform  # "linux", "win32", "cygwin", "darwin", "os2", "os2emx"

    @classmethod
    def init_params(cls) -> None:
        """Method for general initialization of parameters."""
        cls.init_db_id()

    @classmethod
    def init_db_id(cls) -> None:
        """Initialize the `db_id` parameter from `db_root/.env.meta`."""
        key = "id"
        delimiter: str = "/" if cls.sys_platform != "win32" else ""
        dotenv_path: str = f"{cls.db_root}{delimiter}.env.meta"

        db_id: str | None = get_from_env(
            key=key,
            dotenv_path=dotenv_path,
        ) or add_to_env(
            key=key,
            value=str(uuid4())[:8],
            dotenv_path=dotenv_path,
        )

        if db_id is None:
            raise ValueError("ScrubySettings.get_db_id() => Failed to get database ID.")

        cls.db_id = db_id

init_db_id() classmethod

Initialize the db_id parameter from db_root/.env.meta.

Source code in src/scruby/settings.py 
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
@classmethod
def init_db_id(cls) -> None:
    """Initialize the `db_id` parameter from `db_root/.env.meta`."""
    key = "id"
    delimiter: str = "/" if cls.sys_platform != "win32" else ""
    dotenv_path: str = f"{cls.db_root}{delimiter}.env.meta"

    db_id: str | None = get_from_env(
        key=key,
        dotenv_path=dotenv_path,
    ) or add_to_env(
        key=key,
        value=str(uuid4())[:8],
        dotenv_path=dotenv_path,
    )

    if db_id is None:
        raise ValueError("ScrubySettings.get_db_id() => Failed to get database ID.")

    cls.db_id = db_id

init_params() classmethod

Method for general initialization of parameters.

Source code in src/scruby/settings.py 
62
63
64
65
@classmethod
def init_params(cls) -> None:
    """Method for general initialization of parameters."""
    cls.init_db_id()

Hint:
Number of branches is number of requests to the hard disk during quantum operations.
Quantum operations: find_one, find_many, count_documents, delete_many, run_custom_task.

ScrubySettings.max_workers (clarification):
The maximum number of processes that can be used to execute the given calls.
If None, then as many worker processes will be
reated as the machine has processors.