Skip to content

XMRigDatabase

A class for handling database operations related to the XMRig miner.

Attributes:

Name Type Description
_engines dict

A dictionary to store database engines.
_table_model_map dict

A dictionary mapping table names to their corresponding ORM models.
Source code in xmrig/db.py 
 22
 23
 24
 25
 26
 27
 28
 29
 30
 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
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
class XMRigDatabase:
    """
    A class for handling database operations related to the XMRig miner.

    Attributes:
        _engines (dict): A dictionary to store database engines.
        _table_model_map (dict): A dictionary mapping table names to their corresponding ORM models.
    """

    _engines = {}
    _table_model_map = {
        "summary": Summary,
        "config": Config,
        "backends": Backends,
    }

    @classmethod
    def _init_db(cls, db_url):
        """
        Initializes the database engine, if it already exists, it returns the existing engine.

        Args:
            db_url (str): Database URL for creating the engine.

        Returns:
            Engine: SQLAlchemy engine instance.

        Raises:
            XMRigDatabaseError: If an error occurs while initializing the database.
        """
        try:
            if db_url not in cls._engines:
                engine = create_engine(db_url)
                Base.metadata.create_all(engine)
                cls._engines[db_url] = engine
            return cls._engines[db_url]
        except Exception as e:
            raise XMRigDatabaseError(e, traceback.format_exc(), f"An error occurred initializing the database:") from e

    @classmethod
    def _get_db_session(cls, db_url):
        """
        Returns a new session for the specified database URL.

        Args:
            db_url (str): Database URL for creating the session.

        Returns:
            Session: SQLAlchemy session instance.

        Raises:
            XMRigDatabaseError: If the database engine does not exist.
        """
        try:
            engine = cls._engines[db_url]
            Session = sessionmaker(bind=engine)
            return Session()
        except KeyError as e:
            raise XMRigDatabaseError(e, traceback.format_exc(), f"Database engine for '{db_url}' does not exist. Please initialize the database first.") from e

    @classmethod
    def _insert_data_to_db(cls, json_data, miner, endpoint, db_url):
        """
        Inserts JSON data into the specified database table.

        Args:
            json_data (dict | list): JSON data to insert.
            miner (str): Name of the miner.
            endpoint (str): Endpoint from which the data is retrieved.
            db_url (str): Database URL for creating the engine.

        Raises:
            XMRigDatabaseError: If an error occurs while inserting data into the database.
        """
        try:
            session = cls._get_db_session(db_url)
            cur_time = datetime.now()
            if endpoint == "summary":
                cls._insert_summary_data(session, json_data, miner, cur_time)
            elif endpoint == "config":
                cls._insert_config_data(session, json_data, miner, cur_time)
            elif endpoint == "backends":
                cls._insert_backends_data(session, json_data, miner, cur_time)
            session.commit()
        except Exception as e:
            session.rollback()
            raise XMRigDatabaseError(e, traceback.format_exc(), f"An error occurred inserting data to the database:") from e
        finally:
            session.close()

    @classmethod
    def _insert_summary_data(cls, session, json_data, miner, cur_time):
        """
        Inserts summary data into the database.

        This method extracts various pieces of information from the provided JSON data
        and creates a Summary object which is then added to the database session.

        Args:
            session (Session): The database session to add the summary data to.
            json_data (dict): The JSON data containing the summary information.
            miner (str): The name of the miner.
            cur_time (datetime): The current timestamp.
        """
        resources_data = json_data.get("resources", {})
        memory_data = resources_data.get("memory", {})
        results_data = json_data.get("results", {})
        connection_data = json_data.get("connection", {})
        cpu_data = json_data.get("cpu", {})
        hashrate_data = json_data.get("hashrate", {})
        summary = Summary(
            miner_name=miner,
            timestamp=cur_time,
            full_json=json_data,
            id=json_data.get("id"),
            worker_id=json_data.get("worker_id"),
            uptime=json_data.get("uptime"),
            restricted=json_data.get("restricted"),
            resources=resources_data,
            resources_memory=memory_data,
            resources_memory_free=memory_data.get("free"),
            resources_memory_total=memory_data.get("total"),
            resources_memory_rsm=memory_data.get("resident_set_memory"),
            resources_load_average=resources_data.get("load_average"),
            resources_hardware_concurrency=resources_data.get("hardware_concurrency"),
            features=json_data.get("features"),
            results=results_data,
            results_diff_current=results_data.get("diff_current"),
            results_shares_good=results_data.get("shares_good"),
            results_shares_total=results_data.get("shares_total"),
            results_avg_time=results_data.get("avg_time"),
            results_avg_time_ms=results_data.get("avg_time_ms"),
            results_hashes_total=results_data.get("hashes_total"),
            results_best=results_data.get("best"),
            algo=json_data.get("algo"),
            connection=connection_data,
            connection_ip=connection_data.get("ip"),
            connection_uptime=connection_data.get("uptime"),
            connection_uptime_ms=connection_data.get("uptime_ms"),
            connection_ping=connection_data.get("ping"),
            connection_failures=connection_data.get("failures"),
            connection_tls=connection_data.get("tls"),
            connection_tls_fingerprint=connection_data.get("tls-fingerprint"),
            connection_algo=connection_data.get("algo"),
            connection_diff=connection_data.get("diff"),
            connection_accepted=connection_data.get("accepted"),
            connection_rejected=connection_data.get("rejected"),
            connection_avg_time=connection_data.get("avg_time"),
            connection_avg_time_ms=connection_data.get("avg_time_ms"),
            connection_hashes_total=connection_data.get("hashes_total"),
            version=json_data.get("version"),
            kind=json_data.get("kind"),
            ua=json_data.get("ua"),
            cpu=cpu_data,
            cpu_brand=cpu_data.get("brand"),
            cpu_family=cpu_data.get("family"),
            cpu_model=cpu_data.get("model"),
            cpu_stepping=cpu_data.get("stepping"),
            cpu_proc_info=cpu_data.get("proc_info"),
            cpu_aes=cpu_data.get("aes"),
            cpu_avx2=cpu_data.get("avx2"),
            cpu_x64=cpu_data.get("x64"),
            cpu_64_bit=cpu_data.get("64_bit"),
            cpu_l2=cpu_data.get("l2"),
            cpu_l3=cpu_data.get("l3"),
            cpu_cores=cpu_data.get("cores"),
            cpu_threads=cpu_data.get("threads"),
            cpu_packages=cpu_data.get("packages"),
            cpu_nodes=cpu_data.get("nodes"),
            cpu_backend=cpu_data.get("backend"),
            cpu_msr=cpu_data.get("msr"),
            cpu_assembly=cpu_data.get("assembly"),
            cpu_arch=cpu_data.get("arch"),
            cpu_flags=cpu_data.get("flags"),
            donate_level=json_data.get("donate_level"),
            paused=json_data.get("paused"),
            algorithms=json_data.get("algorithms"),
            hashrate=hashrate_data,
            hashrate_total=hashrate_data.get("total"),
            hashrate_highest=hashrate_data.get("highest"),
            hugepages=json_data.get("hugepages"),
        )
        session.add(summary)

    @classmethod
    def _insert_config_data(cls, session, json_data, miner, cur_time):
        """
        Inserts configuration data into the database.

        This method extracts various configuration parameters from the provided JSON data
        and creates a Config object which is then added to the database session.

        Args:
            session (Session): The database session to add the Config object to.
            json_data (dict): The JSON data containing configuration parameters.
            miner (str): The name of the miner.
            cur_time (datetime): The current timestamp.
        """
        api_data = json_data.get("api", {})
        http_data = json_data.get("http", {})
        randomx_data = json_data.get("randomx", {})
        cpu_data = json_data.get("cpu", {})
        opencl_data = json_data.get("opencl", {})
        cuda_data = json_data.get("cuda", {})
        tls_data = json_data.get("tls", {})
        dns_data = json_data.get("dns", {})
        benchmark_data = json_data.get("benchmark", {})
        config = Config(
            miner_name=miner,
            timestamp=cur_time,
            full_json=json_data,
            api=api_data,
            api_id=api_data.get("id"),
            api_worker_id=api_data.get("worker-id"),
            http=http_data,
            http_enabled=http_data.get("enabled"),
            http_host=http_data.get("host"),
            http_port=http_data.get("port"),
            http_access_token=http_data.get("access-token"),
            http_restricted=http_data.get("restricted"),
            autosave=json_data.get("autosave"),
            background=json_data.get("background"),
            colors=json_data.get("colors"),
            title=json_data.get("title"),
            randomx=randomx_data,
            randomx_init=randomx_data.get("init"),
            randomx_init_avx2=randomx_data.get("init-avx2"),
            randomx_mode=randomx_data.get("mode"),
            randomx_1gb_pages=randomx_data.get("1gb-pages"),
            randomx_rdmsr=randomx_data.get("rdmsr"),
            randomx_wrmsr=randomx_data.get("wrmsr"),
            randomx_cache_qos=randomx_data.get("cache_qos"),
            randomx_numa=randomx_data.get("numa"),
            randomx_scratchpad_prefetch_mode=randomx_data.get("scratchpad_prefetch_mode"),
            cpu=cpu_data,
            cpu_enabled=cpu_data.get("enabled"),
            cpu_huge_pages=cpu_data.get("huge-pages"),
            cpu_huge_pages_jit=cpu_data.get("huge-pages-jit"),
            cpu_hw_aes=cpu_data.get("hw-aes"),
            cpu_priority=cpu_data.get("priority"),
            cpu_memory_pool=cpu_data.get("memory-pool"),
            cpu_yield=cpu_data.get("yield"),
            cpu_max_threads_hint=cpu_data.get("max-threads-hint"),
            cpu_asm=cpu_data.get("asm"),
            cpu_argon2_impl=cpu_data.get("argon2-impl"),
            opencl=opencl_data,
            opencl_enabled=opencl_data.get("enabled"),
            opencl_cache=opencl_data.get("cache"),
            opencl_loader=opencl_data.get("loader"),
            opencl_platform=opencl_data.get("platform"),
            opencl_adl=opencl_data.get("adl"),
            cuda=cuda_data,
            cuda_enabled=cuda_data.get("enabled"),
            cuda_loader=cuda_data.get("loader"),
            cuda_nvml=cuda_data.get("nvml"),
            donate_level=json_data.get("donate-level"),
            donate_over_proxy=json_data.get("donate-over-proxy"),
            log_file=json_data.get("log-file"),
            pools=json_data.get("pools"),
            print_time=json_data.get("print-time"),
            health_print_time=json_data.get("health-print-time"),
            dmi=json_data.get("dmi"),
            retries=json_data.get("retries"),
            retry_pause=json_data.get("retry-pause"),
            syslog=json_data.get("syslog"),
            tls=tls_data,
            tls_enabled=tls_data.get("enabled"),
            tls_protocols=tls_data.get("protocols"),
            tls_cert=tls_data.get("cert"),
            tls_cert_key=tls_data.get("cert_key"),
            tls_ciphers=tls_data.get("ciphers"),
            tls_ciphersuites=tls_data.get("ciphersuites"),
            tls_dhparam=tls_data.get("dhparam"),
            dns=dns_data,
            dns_ipv6=dns_data.get("ipv6"),
            dns_ttl=dns_data.get("ttl"),
            user_agent=json_data.get("user-agent"),
            verbose=json_data.get("verbose"),
            watch=json_data.get("watch"),
            rebench_algo=json_data.get("rebench-algo"),
            bench_algo_time=json_data.get("bench-algo-time"),
            pause_on_battery=json_data.get("pause-on-battery"),
            pause_on_active=json_data.get("pause-on-active"),
            benchmark=benchmark_data,
            benchmark_size=benchmark_data.get("size"),
            benchmark_algo=benchmark_data.get("algo"),
            benchmark_submit=benchmark_data.get("submit"),
            benchmark_verify=benchmark_data.get("verify"),
            benchmark_seed=benchmark_data.get("seed"),
            benchmark_hash=benchmark_data.get("hash-num"),
        )
        session.add(config)

    @classmethod
    def _insert_backends_data(cls, session, json_data, miner, cur_time):
        """
        Inserts backend data into the database.

        This method processes JSON data representing backend information and inserts it into the database.
        It handles both single backend (CPU) and multiple backends (CPU, OpenCL, CUDA).

        Args:
            session (Session): The database session to use for the insertion.
            json_data (list): A list of dictionaries containing backend data.
            miner (str): The name of the miner.
            cur_time (datetime): The current timestamp.
        """
        if len(json_data) == 1:
            cpu_backend_data = json_data[0]
            backends = Backends(
                miner_name=miner,
                timestamp=cur_time,
                full_json=json_data,
                cpu=cpu_backend_data,
                cpu_type=cpu_backend_data.get("type"),
                cpu_enabled=cpu_backend_data.get("enabled"),
                cpu_algo=cpu_backend_data.get("algo"),
                cpu_profile=cpu_backend_data.get("profile"),
                cpu_hw_aes=cpu_backend_data.get("hw-aes"),
                cpu_priority=cpu_backend_data.get("priority"),
                cpu_msr=cpu_backend_data.get("msr"),
                cpu_asm=cpu_backend_data.get("asm"),
                cpu_argon2_impl=cpu_backend_data.get("argon2-impl"),
                cpu_hugepages=cpu_backend_data.get("hugepages"),
                cpu_memory=cpu_backend_data.get("memory"),
                cpu_hashrate=cpu_backend_data.get("hashrate"),
                cpu_threads=cpu_backend_data.get("threads"),
            )
        elif len(json_data) > 1:
            cpu_backend_data = json_data[0]
            opencl_backend_data = json_data[1]
            cuda_backend_data = json_data[2]
            backends = Backends(
                miner_name=miner,
                timestamp=cur_time,
                full_json=json_data,
                cpu=cpu_backend_data,
                cpu_type=cpu_backend_data.get("type"),
                cpu_enabled=cpu_backend_data.get("enabled"),
                cpu_algo=cpu_backend_data.get("algo"),
                cpu_profile=cpu_backend_data.get("profile"),
                cpu_hw_aes=cpu_backend_data.get("hw-aes"),
                cpu_priority=cpu_backend_data.get("priority"),
                cpu_msr=cpu_backend_data.get("msr"),
                cpu_asm=cpu_backend_data.get("asm"),
                cpu_argon2_impl=cpu_backend_data.get("argon2-impl"),
                cpu_hugepages=cpu_backend_data.get("hugepages"),
                cpu_memory=cpu_backend_data.get("memory"),
                cpu_hashrate=cpu_backend_data.get("hashrate"),
                cpu_threads=cpu_backend_data.get("threads"),
                opencl=opencl_backend_data,
                opencl_type=opencl_backend_data.get("type"),
                opencl_enabled=opencl_backend_data.get("enabled"),
                opencl_algo=opencl_backend_data.get("algo"),
                opencl_profile=opencl_backend_data.get("profile"),
                opencl_platform=opencl_backend_data.get("platform"),
                opencl_platform_index=opencl_backend_data["platform"].get("index") if opencl_backend_data.get("platform") else None,
                opencl_platform_profile=opencl_backend_data["platform"].get("profile") if opencl_backend_data.get("platform") else None,
                opencl_platform_version=opencl_backend_data["platform"].get("version") if opencl_backend_data.get("platform") else None,
                opencl_platform_name=opencl_backend_data["platform"].get("name") if opencl_backend_data.get("platform") else None,
                opencl_platform_vendor=opencl_backend_data["platform"].get("vendor") if opencl_backend_data.get("platform") else None,
                opencl_platform_extensions=opencl_backend_data["platform"].get("extensions") if opencl_backend_data.get("platform") else None,
                opencl_hashrate=opencl_backend_data.get("hashrate"),
                opencl_threads=opencl_backend_data.get("threads"),
                cuda=cuda_backend_data,
                cuda_type=cuda_backend_data.get("type"),
                cuda_enabled=cuda_backend_data.get("enabled"),
                cuda_algo=cuda_backend_data.get("algo"),
                cuda_profile=cuda_backend_data.get("profile"),
                cuda_versions=cuda_backend_data.get("versions"),
                cuda_versions_cuda_runtime=cuda_backend_data["versions"].get("cuda_runtime") if cuda_backend_data.get("versions") else None,
                cuda_versions_cuda_driver=cuda_backend_data["versions"].get("cuda_driver") if cuda_backend_data.get("versions") else None,
                cuda_versions_plugin=cuda_backend_data["versions"].get("plugin") if cuda_backend_data.get("versions") else None,
                cuda_hashrate=cuda_backend_data.get("hashrate"),
                cuda_threads=cuda_backend_data.get("threads"),
            )
        session.add(backends)

    @classmethod
    def retrieve_data_from_db(cls, db_url, table_name, miner_name = None, selection = "*", start_time = None, end_time = None, limit = 1):
        """
        Retrieves data from the specified database table within the given timeframe.

        Args:
            db_url (str): Database URL for creating the engine.
            table_name (str): Name of the table to retrieve data from.
            miner_name (str): Name of the miner to filter data by.
            selection (str, optional): Column(s) to select from the table. Defaults to "*".
            start_time (datetime, optional): Start time for the data retrieval. Defaults to None.
            end_time (datetime, optional): End time for the data retrieval. Defaults to None.
            limit (int, optional): Limit the number of rows retrieved. Defaults to 1.

        Returns:
            list: List of dictionaries containing the retrieved data or "N/A" if no data is found.

        Raises:
            XMRigDatabaseError: If an error occurs while retrieving data from the database.
        """
        data = "N/A"
        try:
            session = cls._get_db_session(db_url)

            model_class = cls._table_model_map.get(table_name)
            if not model_class:
                raise ValueError(f"Table '{table_name}' does not have a corresponding ORM model class.")

            # Build the query
            query = session.query(model_class)

            # Apply selection
            if selection != "*":
                if isinstance(selection, list):
                    query = query.with_entities(*[getattr(model_class, col) for col in selection])
                else:
                    query = query.with_entities(getattr(model_class, selection))

            # Apply miner_name filter if provided
            if miner_name:
                query = query.filter(model_class.miner_name == miner_name)

            # Apply time filters
            if start_time:
                query = query.filter(model_class.timestamp >= start_time)
            if end_time:
                query = query.filter(model_class.timestamp <= end_time)

            # Apply limit
            query = query.order_by(model_class.timestamp.desc()).limit(limit)

            # Execute the query and fetch results
            results = query.all()
            if results:
                data = [result._asdict() for result in results]
            else:
                data = "N/A"
        except Exception as e:
            raise XMRigDatabaseError(e, traceback.format_exc(), f"An error occurred retrieving data from the database:") from e
        finally:
            session.close()
        return data

    @classmethod
    def _delete_all_miner_data_from_db(cls, miner_name, db_url):
        """
        Deletes all data related to a specific miner from all tables in the database.

        Args:
            miner_name: The unique name of the miner.
            db_url: Database URL for creating the engine.

        Raises:
            XMRigDatabaseError: If an error occurs while deleting the miner data from the database.
        """
        try:
            session = cls._get_db_session(db_url)

            for table_name, model_class in cls._table_model_map.items():
                session.query(model_class).filter(model_class.miner_name == miner_name).delete()

            session.commit()
            log.debug(f"All data for miner '{miner_name}' has been deleted from the database")
        except Exception as e:
            session.rollback()
            raise XMRigDatabaseError(e, traceback.format_exc(), f"An error occurred deleting miner '{miner_name}' data from the database:") from e
        finally:
            session.close()

_delete_all_miner_data_from_db(miner_name, db_url) classmethod

Deletes all data related to a specific miner from all tables in the database.

Parameters:

Name Type Description Default
miner_name

The unique name of the miner.

 required
db_url

Database URL for creating the engine.

 required

Raises:

Type Description
XMRigDatabaseError

If an error occurs while deleting the miner data from the database.
Source code in xmrig/db.py 
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
@classmethod
def _delete_all_miner_data_from_db(cls, miner_name, db_url):
    """
    Deletes all data related to a specific miner from all tables in the database.

    Args:
        miner_name: The unique name of the miner.
        db_url: Database URL for creating the engine.

    Raises:
        XMRigDatabaseError: If an error occurs while deleting the miner data from the database.
    """
    try:
        session = cls._get_db_session(db_url)

        for table_name, model_class in cls._table_model_map.items():
            session.query(model_class).filter(model_class.miner_name == miner_name).delete()

        session.commit()
        log.debug(f"All data for miner '{miner_name}' has been deleted from the database")
    except Exception as e:
        session.rollback()
        raise XMRigDatabaseError(e, traceback.format_exc(), f"An error occurred deleting miner '{miner_name}' data from the database:") from e
    finally:
        session.close()

_get_db_session(db_url) classmethod

Returns a new session for the specified database URL.

Parameters:

Name Type Description Default
db_url str

Database URL for creating the session.

 required

Returns:

Name Type Description
Session

SQLAlchemy session instance.

Raises:

Type Description
XMRigDatabaseError

If the database engine does not exist.
Source code in xmrig/db.py 
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
@classmethod
def _get_db_session(cls, db_url):
    """
    Returns a new session for the specified database URL.

    Args:
        db_url (str): Database URL for creating the session.

    Returns:
        Session: SQLAlchemy session instance.

    Raises:
        XMRigDatabaseError: If the database engine does not exist.
    """
    try:
        engine = cls._engines[db_url]
        Session = sessionmaker(bind=engine)
        return Session()
    except KeyError as e:
        raise XMRigDatabaseError(e, traceback.format_exc(), f"Database engine for '{db_url}' does not exist. Please initialize the database first.") from e

_init_db(db_url) classmethod

Initializes the database engine, if it already exists, it returns the existing engine.

Parameters:

Name Type Description Default
db_url str

Database URL for creating the engine.

 required

Returns:

Name Type Description
Engine

SQLAlchemy engine instance.

Raises:

Type Description
XMRigDatabaseError

If an error occurs while initializing the database.
Source code in xmrig/db.py 
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
@classmethod
def _init_db(cls, db_url):
    """
    Initializes the database engine, if it already exists, it returns the existing engine.

    Args:
        db_url (str): Database URL for creating the engine.

    Returns:
        Engine: SQLAlchemy engine instance.

    Raises:
        XMRigDatabaseError: If an error occurs while initializing the database.
    """
    try:
        if db_url not in cls._engines:
            engine = create_engine(db_url)
            Base.metadata.create_all(engine)
            cls._engines[db_url] = engine
        return cls._engines[db_url]
    except Exception as e:
        raise XMRigDatabaseError(e, traceback.format_exc(), f"An error occurred initializing the database:") from e

_insert_backends_data(session, json_data, miner, cur_time) classmethod

Inserts backend data into the database.

This method processes JSON data representing backend information and inserts it into the database. It handles both single backend (CPU) and multiple backends (CPU, OpenCL, CUDA).

Parameters:

Name Type Description Default
session Session

The database session to use for the insertion.

 required
json_data list

A list of dictionaries containing backend data.

 required
miner str

The name of the miner.

 required
cur_time datetime

The current timestamp.

 required
Source code in xmrig/db.py 
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
@classmethod
def _insert_backends_data(cls, session, json_data, miner, cur_time):
    """
    Inserts backend data into the database.

    This method processes JSON data representing backend information and inserts it into the database.
    It handles both single backend (CPU) and multiple backends (CPU, OpenCL, CUDA).

    Args:
        session (Session): The database session to use for the insertion.
        json_data (list): A list of dictionaries containing backend data.
        miner (str): The name of the miner.
        cur_time (datetime): The current timestamp.
    """
    if len(json_data) == 1:
        cpu_backend_data = json_data[0]
        backends = Backends(
            miner_name=miner,
            timestamp=cur_time,
            full_json=json_data,
            cpu=cpu_backend_data,
            cpu_type=cpu_backend_data.get("type"),
            cpu_enabled=cpu_backend_data.get("enabled"),
            cpu_algo=cpu_backend_data.get("algo"),
            cpu_profile=cpu_backend_data.get("profile"),
            cpu_hw_aes=cpu_backend_data.get("hw-aes"),
            cpu_priority=cpu_backend_data.get("priority"),
            cpu_msr=cpu_backend_data.get("msr"),
            cpu_asm=cpu_backend_data.get("asm"),
            cpu_argon2_impl=cpu_backend_data.get("argon2-impl"),
            cpu_hugepages=cpu_backend_data.get("hugepages"),
            cpu_memory=cpu_backend_data.get("memory"),
            cpu_hashrate=cpu_backend_data.get("hashrate"),
            cpu_threads=cpu_backend_data.get("threads"),
        )
    elif len(json_data) > 1:
        cpu_backend_data = json_data[0]
        opencl_backend_data = json_data[1]
        cuda_backend_data = json_data[2]
        backends = Backends(
            miner_name=miner,
            timestamp=cur_time,
            full_json=json_data,
            cpu=cpu_backend_data,
            cpu_type=cpu_backend_data.get("type"),
            cpu_enabled=cpu_backend_data.get("enabled"),
            cpu_algo=cpu_backend_data.get("algo"),
            cpu_profile=cpu_backend_data.get("profile"),
            cpu_hw_aes=cpu_backend_data.get("hw-aes"),
            cpu_priority=cpu_backend_data.get("priority"),
            cpu_msr=cpu_backend_data.get("msr"),
            cpu_asm=cpu_backend_data.get("asm"),
            cpu_argon2_impl=cpu_backend_data.get("argon2-impl"),
            cpu_hugepages=cpu_backend_data.get("hugepages"),
            cpu_memory=cpu_backend_data.get("memory"),
            cpu_hashrate=cpu_backend_data.get("hashrate"),
            cpu_threads=cpu_backend_data.get("threads"),
            opencl=opencl_backend_data,
            opencl_type=opencl_backend_data.get("type"),
            opencl_enabled=opencl_backend_data.get("enabled"),
            opencl_algo=opencl_backend_data.get("algo"),
            opencl_profile=opencl_backend_data.get("profile"),
            opencl_platform=opencl_backend_data.get("platform"),
            opencl_platform_index=opencl_backend_data["platform"].get("index") if opencl_backend_data.get("platform") else None,
            opencl_platform_profile=opencl_backend_data["platform"].get("profile") if opencl_backend_data.get("platform") else None,
            opencl_platform_version=opencl_backend_data["platform"].get("version") if opencl_backend_data.get("platform") else None,
            opencl_platform_name=opencl_backend_data["platform"].get("name") if opencl_backend_data.get("platform") else None,
            opencl_platform_vendor=opencl_backend_data["platform"].get("vendor") if opencl_backend_data.get("platform") else None,
            opencl_platform_extensions=opencl_backend_data["platform"].get("extensions") if opencl_backend_data.get("platform") else None,
            opencl_hashrate=opencl_backend_data.get("hashrate"),
            opencl_threads=opencl_backend_data.get("threads"),
            cuda=cuda_backend_data,
            cuda_type=cuda_backend_data.get("type"),
            cuda_enabled=cuda_backend_data.get("enabled"),
            cuda_algo=cuda_backend_data.get("algo"),
            cuda_profile=cuda_backend_data.get("profile"),
            cuda_versions=cuda_backend_data.get("versions"),
            cuda_versions_cuda_runtime=cuda_backend_data["versions"].get("cuda_runtime") if cuda_backend_data.get("versions") else None,
            cuda_versions_cuda_driver=cuda_backend_data["versions"].get("cuda_driver") if cuda_backend_data.get("versions") else None,
            cuda_versions_plugin=cuda_backend_data["versions"].get("plugin") if cuda_backend_data.get("versions") else None,
            cuda_hashrate=cuda_backend_data.get("hashrate"),
            cuda_threads=cuda_backend_data.get("threads"),
        )
    session.add(backends)

_insert_config_data(session, json_data, miner, cur_time) classmethod

Inserts configuration data into the database.

This method extracts various configuration parameters from the provided JSON data and creates a Config object which is then added to the database session.

Parameters:

Name Type Description Default
session Session

The database session to add the Config object to.

 required
json_data dict

The JSON data containing configuration parameters.

 required
miner str

The name of the miner.

 required
cur_time datetime

The current timestamp.

 required
Source code in xmrig/db.py 
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
@classmethod
def _insert_config_data(cls, session, json_data, miner, cur_time):
    """
    Inserts configuration data into the database.

    This method extracts various configuration parameters from the provided JSON data
    and creates a Config object which is then added to the database session.

    Args:
        session (Session): The database session to add the Config object to.
        json_data (dict): The JSON data containing configuration parameters.
        miner (str): The name of the miner.
        cur_time (datetime): The current timestamp.
    """
    api_data = json_data.get("api", {})
    http_data = json_data.get("http", {})
    randomx_data = json_data.get("randomx", {})
    cpu_data = json_data.get("cpu", {})
    opencl_data = json_data.get("opencl", {})
    cuda_data = json_data.get("cuda", {})
    tls_data = json_data.get("tls", {})
    dns_data = json_data.get("dns", {})
    benchmark_data = json_data.get("benchmark", {})
    config = Config(
        miner_name=miner,
        timestamp=cur_time,
        full_json=json_data,
        api=api_data,
        api_id=api_data.get("id"),
        api_worker_id=api_data.get("worker-id"),
        http=http_data,
        http_enabled=http_data.get("enabled"),
        http_host=http_data.get("host"),
        http_port=http_data.get("port"),
        http_access_token=http_data.get("access-token"),
        http_restricted=http_data.get("restricted"),
        autosave=json_data.get("autosave"),
        background=json_data.get("background"),
        colors=json_data.get("colors"),
        title=json_data.get("title"),
        randomx=randomx_data,
        randomx_init=randomx_data.get("init"),
        randomx_init_avx2=randomx_data.get("init-avx2"),
        randomx_mode=randomx_data.get("mode"),
        randomx_1gb_pages=randomx_data.get("1gb-pages"),
        randomx_rdmsr=randomx_data.get("rdmsr"),
        randomx_wrmsr=randomx_data.get("wrmsr"),
        randomx_cache_qos=randomx_data.get("cache_qos"),
        randomx_numa=randomx_data.get("numa"),
        randomx_scratchpad_prefetch_mode=randomx_data.get("scratchpad_prefetch_mode"),
        cpu=cpu_data,
        cpu_enabled=cpu_data.get("enabled"),
        cpu_huge_pages=cpu_data.get("huge-pages"),
        cpu_huge_pages_jit=cpu_data.get("huge-pages-jit"),
        cpu_hw_aes=cpu_data.get("hw-aes"),
        cpu_priority=cpu_data.get("priority"),
        cpu_memory_pool=cpu_data.get("memory-pool"),
        cpu_yield=cpu_data.get("yield"),
        cpu_max_threads_hint=cpu_data.get("max-threads-hint"),
        cpu_asm=cpu_data.get("asm"),
        cpu_argon2_impl=cpu_data.get("argon2-impl"),
        opencl=opencl_data,
        opencl_enabled=opencl_data.get("enabled"),
        opencl_cache=opencl_data.get("cache"),
        opencl_loader=opencl_data.get("loader"),
        opencl_platform=opencl_data.get("platform"),
        opencl_adl=opencl_data.get("adl"),
        cuda=cuda_data,
        cuda_enabled=cuda_data.get("enabled"),
        cuda_loader=cuda_data.get("loader"),
        cuda_nvml=cuda_data.get("nvml"),
        donate_level=json_data.get("donate-level"),
        donate_over_proxy=json_data.get("donate-over-proxy"),
        log_file=json_data.get("log-file"),
        pools=json_data.get("pools"),
        print_time=json_data.get("print-time"),
        health_print_time=json_data.get("health-print-time"),
        dmi=json_data.get("dmi"),
        retries=json_data.get("retries"),
        retry_pause=json_data.get("retry-pause"),
        syslog=json_data.get("syslog"),
        tls=tls_data,
        tls_enabled=tls_data.get("enabled"),
        tls_protocols=tls_data.get("protocols"),
        tls_cert=tls_data.get("cert"),
        tls_cert_key=tls_data.get("cert_key"),
        tls_ciphers=tls_data.get("ciphers"),
        tls_ciphersuites=tls_data.get("ciphersuites"),
        tls_dhparam=tls_data.get("dhparam"),
        dns=dns_data,
        dns_ipv6=dns_data.get("ipv6"),
        dns_ttl=dns_data.get("ttl"),
        user_agent=json_data.get("user-agent"),
        verbose=json_data.get("verbose"),
        watch=json_data.get("watch"),
        rebench_algo=json_data.get("rebench-algo"),
        bench_algo_time=json_data.get("bench-algo-time"),
        pause_on_battery=json_data.get("pause-on-battery"),
        pause_on_active=json_data.get("pause-on-active"),
        benchmark=benchmark_data,
        benchmark_size=benchmark_data.get("size"),
        benchmark_algo=benchmark_data.get("algo"),
        benchmark_submit=benchmark_data.get("submit"),
        benchmark_verify=benchmark_data.get("verify"),
        benchmark_seed=benchmark_data.get("seed"),
        benchmark_hash=benchmark_data.get("hash-num"),
    )
    session.add(config)

_insert_data_to_db(json_data, miner, endpoint, db_url) classmethod

Inserts JSON data into the specified database table.

Parameters:

Name Type Description Default
json_data dict | list

JSON data to insert.

 required
miner str

Name of the miner.

 required
endpoint str

Endpoint from which the data is retrieved.

 required
db_url str

Database URL for creating the engine.

 required

Raises:

Type Description
XMRigDatabaseError

If an error occurs while inserting data into the database.
Source code in xmrig/db.py 
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
@classmethod
def _insert_data_to_db(cls, json_data, miner, endpoint, db_url):
    """
    Inserts JSON data into the specified database table.

    Args:
        json_data (dict | list): JSON data to insert.
        miner (str): Name of the miner.
        endpoint (str): Endpoint from which the data is retrieved.
        db_url (str): Database URL for creating the engine.

    Raises:
        XMRigDatabaseError: If an error occurs while inserting data into the database.
    """
    try:
        session = cls._get_db_session(db_url)
        cur_time = datetime.now()
        if endpoint == "summary":
            cls._insert_summary_data(session, json_data, miner, cur_time)
        elif endpoint == "config":
            cls._insert_config_data(session, json_data, miner, cur_time)
        elif endpoint == "backends":
            cls._insert_backends_data(session, json_data, miner, cur_time)
        session.commit()
    except Exception as e:
        session.rollback()
        raise XMRigDatabaseError(e, traceback.format_exc(), f"An error occurred inserting data to the database:") from e
    finally:
        session.close()

_insert_summary_data(session, json_data, miner, cur_time) classmethod

Inserts summary data into the database.

This method extracts various pieces of information from the provided JSON data and creates a Summary object which is then added to the database session.

Parameters:

Name Type Description Default
session Session

The database session to add the summary data to.

 required
json_data dict

The JSON data containing the summary information.

 required
miner str

The name of the miner.

 required
cur_time datetime

The current timestamp.

 required
Source code in xmrig/db.py 
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
@classmethod
def _insert_summary_data(cls, session, json_data, miner, cur_time):
    """
    Inserts summary data into the database.

    This method extracts various pieces of information from the provided JSON data
    and creates a Summary object which is then added to the database session.

    Args:
        session (Session): The database session to add the summary data to.
        json_data (dict): The JSON data containing the summary information.
        miner (str): The name of the miner.
        cur_time (datetime): The current timestamp.
    """
    resources_data = json_data.get("resources", {})
    memory_data = resources_data.get("memory", {})
    results_data = json_data.get("results", {})
    connection_data = json_data.get("connection", {})
    cpu_data = json_data.get("cpu", {})
    hashrate_data = json_data.get("hashrate", {})
    summary = Summary(
        miner_name=miner,
        timestamp=cur_time,
        full_json=json_data,
        id=json_data.get("id"),
        worker_id=json_data.get("worker_id"),
        uptime=json_data.get("uptime"),
        restricted=json_data.get("restricted"),
        resources=resources_data,
        resources_memory=memory_data,
        resources_memory_free=memory_data.get("free"),
        resources_memory_total=memory_data.get("total"),
        resources_memory_rsm=memory_data.get("resident_set_memory"),
        resources_load_average=resources_data.get("load_average"),
        resources_hardware_concurrency=resources_data.get("hardware_concurrency"),
        features=json_data.get("features"),
        results=results_data,
        results_diff_current=results_data.get("diff_current"),
        results_shares_good=results_data.get("shares_good"),
        results_shares_total=results_data.get("shares_total"),
        results_avg_time=results_data.get("avg_time"),
        results_avg_time_ms=results_data.get("avg_time_ms"),
        results_hashes_total=results_data.get("hashes_total"),
        results_best=results_data.get("best"),
        algo=json_data.get("algo"),
        connection=connection_data,
        connection_ip=connection_data.get("ip"),
        connection_uptime=connection_data.get("uptime"),
        connection_uptime_ms=connection_data.get("uptime_ms"),
        connection_ping=connection_data.get("ping"),
        connection_failures=connection_data.get("failures"),
        connection_tls=connection_data.get("tls"),
        connection_tls_fingerprint=connection_data.get("tls-fingerprint"),
        connection_algo=connection_data.get("algo"),
        connection_diff=connection_data.get("diff"),
        connection_accepted=connection_data.get("accepted"),
        connection_rejected=connection_data.get("rejected"),
        connection_avg_time=connection_data.get("avg_time"),
        connection_avg_time_ms=connection_data.get("avg_time_ms"),
        connection_hashes_total=connection_data.get("hashes_total"),
        version=json_data.get("version"),
        kind=json_data.get("kind"),
        ua=json_data.get("ua"),
        cpu=cpu_data,
        cpu_brand=cpu_data.get("brand"),
        cpu_family=cpu_data.get("family"),
        cpu_model=cpu_data.get("model"),
        cpu_stepping=cpu_data.get("stepping"),
        cpu_proc_info=cpu_data.get("proc_info"),
        cpu_aes=cpu_data.get("aes"),
        cpu_avx2=cpu_data.get("avx2"),
        cpu_x64=cpu_data.get("x64"),
        cpu_64_bit=cpu_data.get("64_bit"),
        cpu_l2=cpu_data.get("l2"),
        cpu_l3=cpu_data.get("l3"),
        cpu_cores=cpu_data.get("cores"),
        cpu_threads=cpu_data.get("threads"),
        cpu_packages=cpu_data.get("packages"),
        cpu_nodes=cpu_data.get("nodes"),
        cpu_backend=cpu_data.get("backend"),
        cpu_msr=cpu_data.get("msr"),
        cpu_assembly=cpu_data.get("assembly"),
        cpu_arch=cpu_data.get("arch"),
        cpu_flags=cpu_data.get("flags"),
        donate_level=json_data.get("donate_level"),
        paused=json_data.get("paused"),
        algorithms=json_data.get("algorithms"),
        hashrate=hashrate_data,
        hashrate_total=hashrate_data.get("total"),
        hashrate_highest=hashrate_data.get("highest"),
        hugepages=json_data.get("hugepages"),
    )
    session.add(summary)

retrieve_data_from_db(db_url, table_name, miner_name=None, selection='*', start_time=None, end_time=None, limit=1) classmethod

Retrieves data from the specified database table within the given timeframe.

Parameters:

Name Type Description Default
db_url str

Database URL for creating the engine.

 required
table_name str

Name of the table to retrieve data from.

 required
miner_name str

Name of the miner to filter data by.

 None
selection str

Column(s) to select from the table. Defaults to "*".

 '*'
start_time datetime

Start time for the data retrieval. Defaults to None.

 None
end_time datetime

End time for the data retrieval. Defaults to None.

 None
limit int

Limit the number of rows retrieved. Defaults to 1.

 1

Returns:

Name Type Description
list

List of dictionaries containing the retrieved data or "N/A" if no data is found.

Raises:

Type Description
XMRigDatabaseError

If an error occurs while retrieving data from the database.
Source code in xmrig/db.py 
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
@classmethod
def retrieve_data_from_db(cls, db_url, table_name, miner_name = None, selection = "*", start_time = None, end_time = None, limit = 1):
    """
    Retrieves data from the specified database table within the given timeframe.

    Args:
        db_url (str): Database URL for creating the engine.
        table_name (str): Name of the table to retrieve data from.
        miner_name (str): Name of the miner to filter data by.
        selection (str, optional): Column(s) to select from the table. Defaults to "*".
        start_time (datetime, optional): Start time for the data retrieval. Defaults to None.
        end_time (datetime, optional): End time for the data retrieval. Defaults to None.
        limit (int, optional): Limit the number of rows retrieved. Defaults to 1.

    Returns:
        list: List of dictionaries containing the retrieved data or "N/A" if no data is found.

    Raises:
        XMRigDatabaseError: If an error occurs while retrieving data from the database.
    """
    data = "N/A"
    try:
        session = cls._get_db_session(db_url)

        model_class = cls._table_model_map.get(table_name)
        if not model_class:
            raise ValueError(f"Table '{table_name}' does not have a corresponding ORM model class.")

        # Build the query
        query = session.query(model_class)

        # Apply selection
        if selection != "*":
            if isinstance(selection, list):
                query = query.with_entities(*[getattr(model_class, col) for col in selection])
            else:
                query = query.with_entities(getattr(model_class, selection))

        # Apply miner_name filter if provided
        if miner_name:
            query = query.filter(model_class.miner_name == miner_name)

        # Apply time filters
        if start_time:
            query = query.filter(model_class.timestamp >= start_time)
        if end_time:
            query = query.filter(model_class.timestamp <= end_time)

        # Apply limit
        query = query.order_by(model_class.timestamp.desc()).limit(limit)

        # Execute the query and fetch results
        results = query.all()
        if results:
            data = [result._asdict() for result in results]
        else:
            data = "N/A"
    except Exception as e:
        raise XMRigDatabaseError(e, traceback.format_exc(), f"An error occurred retrieving data from the database:") from e
    finally:
        session.close()
    return data