Skip to content

P2PoolDatabase

P2Pool Database class.

This class provides methods to interact with the P2Pool database.

Attributes:

Name Type Description
_engines dict

Dictionary containing the database engines.
_table_model_map dict

Dictionary mapping table names to ORM model classes.
Source code in p2pool/db.py 
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 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
class P2PoolDatabase:
    """
    P2Pool Database class.

    This class provides methods to interact with the P2Pool database.

    Attributes:
        _engines (dict): Dictionary containing the database engines.
        _table_model_map (dict): Dictionary mapping table names to ORM model classes.
    """
    _engines = {}
    _table_model_map = {
        "console": Console,
        "p2p": P2P,
        "stratum": Stratum,
        "network_stats": NetworkStats,
        "pool_blocks": PoolBlocks,
        "pool_stats": PoolStats,
        "stats_mod": StatsMod
    }

    @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:
            P2PoolDatabaseError: 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 P2PoolDatabaseError(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:
            P2PoolDatabaseError: If the database engine does not exist.
        """
        try:
            engine = cls._engines[db_url]
            Session = sessionmaker(bind=engine)
            return Session()
        except KeyError as e:
            raise P2PoolDatabaseError(e, traceback.format_exc(), f"Database engine for '{db_url}' does not exist. Please initialize the database first.") from e

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

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

        Raises:
            P2PoolDatabaseError: If an error occurs while inserting data into the database.
        """
        try:
            session = cls._get_db_session(db_url)
            cur_time = datetime.now()
            if endpoint == _local_console_endpoint:
                cls._insert_local_console_data(session, json_data, cur_time)
            elif endpoint == _local_p2p_endpoint:
                cls._insert_local_p2p_data(session, json_data, cur_time)
            elif endpoint == _local_stratum_endpoint:
                cls._insert_local_stratum_data(session, json_data, cur_time)
            elif endpoint == _network_stats_endpoint:
                cls._insert_network_stats_data(session, json_data, cur_time)
            elif endpoint == _pool_blocks_endpoint:
                cls._insert_pool_blocks_data(session, json_data, cur_time)
            elif endpoint == _pool_stats_endpoint:
                cls._insert_pool_stats_data(session, json_data, cur_time)
            elif endpoint == _stats_mod_endpoint:
                cls._insert_stats_mod_data(session, json_data, cur_time)
            session.commit()
        except Exception as e:
            session.rollback()
            raise P2PoolDatabaseError(e, traceback.format_exc(), f"An error occurred inserting data to the database:") from e
        finally:
            session.close()

    @classmethod
    def _insert_local_console_data(cls, session, json_data, cur_time):
        """
        Inserts local console endpoints data into the database.

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

        Args:
            session (Session): The database session to add the local console data to.
            json_data (dict): The JSON data containing the local console information.
            cur_time (datetime): The current timestamp.
        """
        local_console = Console(
            time = cur_time,
            full_json = json_data,
            mode = json_data.get("mode"),
            tcp_port = json_data.get("tcp_port")
        )
        session.add(local_console)

    @classmethod
    def _insert_local_p2p_data(cls, session, json_data, cur_time):
        """
        Inserts local p2p endpoints data into the database.

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

        Args:
            session (Session): The database session to add the local p2p data to.
            json_data (dict): The JSON data containing the local p2p information.
            cur_time (datetime): The current timestamp.
        """
        local_p2p = P2P(
            time = cur_time,
            full_json = json_data,
            connections = json_data.get("connections"),
            incoming_connections = json_data.get("incoming_connections"),
            peer_list_size = json_data.get("peer_list_size"),
            peers = json_data.get("peers"),
            uptime = json_data.get("uptime")
        )
        session.add(local_p2p)

    @classmethod
    def _insert_local_stratum_data(cls, session, json_data, cur_time):
        """
        Inserts local stratum endpoints data into the database.

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

        Args:
            session (Session): The database session to add the local stratum data to.
            json_data (dict): The JSON data containing the local stratum information.
            cur_time (datetime): The current timestamp.
        """
        local_stratum = Stratum(
            time = cur_time,
            full_json = json_data,
            hashrate_15m = json_data.get("hashrate_15m"),
            hashrate_1h = json_data.get("hashrate_1h"),
            hashrate_24h = json_data.get("hashrate_24h"),
            total_hashes = json_data.get("total_hashes"),
            shares_found = json_data.get("shares_found"),
            shares_failed = json_data.get("shares_failed"),
            average_effort = json_data.get("average_effort"),
            current_effort = json_data.get("current_effort"),
            connections = json_data.get("connections"),
            incoming_connections = json_data.get("incoming_connections"),
            block_reward_share_percent = json_data.get("block_reward_share_percent"),
            workers = json_data.get("workers")
        )
        session.add(local_stratum)

    @classmethod
    def _insert_network_stats_data(cls, session, json_data, cur_time):
        """
        Inserts network stats endpoints data into the database.

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

        Args:
            session (Session): The database session to add the network stats data to.
            json_data (dict): The JSON data containing the network stats information.
            cur_time (datetime): The current timestamp.
        """
        network_stats = NetworkStats(
            time = cur_time,
            full_json = json_data,
            difficulty = json_data.get("difficulty"),
            hash_value = json_data.get("hash"),
            height = json_data.get("height"),
            reward = json_data.get("reward"),
            timestamp = json_data.get("timestamp")
        )
        session.add(network_stats)

    @classmethod
    def _insert_pool_blocks_data(cls, session, json_data, cur_time):
        """
        Inserts pool blocks endpoints data into the database.

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

        Args:
            session (Session): The database session to add the pool blocks data to.
            json_data (dict): The JSON data containing the pool blocks information.
            cur_time (datetime): The current timestamp.
        """
        pool_blocks = PoolBlocks(
            time = cur_time,
            full_json = json_data,
        )
        session.add(pool_blocks)

    @classmethod
    def _insert_pool_stats_data(cls, session, json_data, cur_time):
        """
        Inserts pool stats endpoints data into the database.

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

        Args:
            session (Session): The database session to add the pool stats data to.
            json_data (dict): The JSON data containing the pool stats information.
            cur_time (datetime): The current timestamp.
        """
        pool_stats = PoolStats(
            time = cur_time,
            full_json = json_data,
            pool_list = json_data.get("pool_list"),
            pool_statistics = json_data.get("pool_statistics"),
            hashrate = json_data["pool_statistics"].get("hashRate") if json_data.get("pool_statistics") else None,
            miners = json_data["pool_statistics"].get("miners") if json_data.get("pool_statistics") else None,
            total_hashes = json_data["pool_statistics"].get("totalHashes") if json_data.get("pool_statistics") else None,
            last_block_found_time = json_data["pool_statistics"].get("lastBlockFoundTime") if json_data.get("pool_statistics") else None,
            last_block_found = json_data["pool_statistics"].get("lastBlockFound") if json_data.get("pool_statistics") else None,
            total_blocks_found = json_data["pool_statistics"].get("totalBlocksFound") if json_data.get("pool_statistics") else None,
            pplns_weight = json_data["pool_statistics"].get("pplnsWeight") if json_data.get("pool_statistics") else None,
            pplns_window_size = json_data["pool_statistics"].get("pplnsWindowSize") if json_data.get("pool_statistics") else None,
            sidechain_difficulty = json_data["pool_statistics"].get("sidechainDifficulty") if json_data.get("pool_statistics") else None,
            sidechain_height = json_data["pool_statistics"].get("sidechainHeight") if json_data.get("pool_statistics") else None
        )
        session.add(pool_stats)

    @classmethod
    def _insert_stats_mod_data(cls, session, json_data, cur_time):
        """
        Inserts stats mod endpoints data into the database.

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

        Args:
            session (Session): The database session to add the stats mod data to.
            json_data (dict): The JSON data containing the stats mod information.
            cur_time (datetime): The current timestamp.
        """
        stats_mod = StatsMod(
            time = cur_time,
            full_json = json_data,
            config = json_data.get("config"),
            ports = json_data["config"].get("ports") if json_data.get("config") else None,
            fee = json_data["config"].get("fee") if json_data.get("config") else None,
            min_payment_threshold = json_data["config"].get("minPaymentThreshold") if json_data.get("config") else None,
            network = json_data.get("network"),
            height = json_data["network"].get("height") if json_data.get("network") else None,
            pool = json_data.get("pool"),
            stats = json_data["pool"].get("stats") if json_data.get("pool") else None,
            last_block_found = json_data["pool"]["stats"].get("lastBlockFound") if json_data.get("pool") and json_data["pool"].get("stats") else None,
            blocks = json_data["pool"].get("blocks") if json_data.get("pool") else None,
            miners = json_data["pool"].get("miners") if json_data.get("pool") else None,
            hashrate = json_data["pool"].get("hashrate") if json_data.get("pool") else None,
            round_hashes = json_data["pool"].get("roundHashes") if json_data.get("pool") else None
        )
        session.add(stats_mod)

    @classmethod
    def retrieve_data_from_db(cls, db_url, table_name, 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.
            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:
            P2PoolDatabaseError: 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 time filters
            if start_time:
                query = query.filter(model_class.time >= start_time)
            if end_time:
                query = query.filter(model_class.time <= end_time)

            # Apply limit
            query = query.order_by(model_class.time.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 P2PoolDatabaseError(e, traceback.format_exc(), f"An error occurred retrieving data from the database:") from e
        finally:
            session.close()
        return data

_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
P2PoolDatabaseError

If the database engine does not exist.
Source code in p2pool/db.py 
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
@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:
        P2PoolDatabaseError: If the database engine does not exist.
    """
    try:
        engine = cls._engines[db_url]
        Session = sessionmaker(bind=engine)
        return Session()
    except KeyError as e:
        raise P2PoolDatabaseError(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
P2PoolDatabaseError

If an error occurs while initializing the database.
Source code in p2pool/db.py 
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
@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:
        P2PoolDatabaseError: 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 P2PoolDatabaseError(e, traceback.format_exc(), f"An error occurred initializing the database:") from e

_insert_data_into_db(json_data, 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
endpoint str

Endpoint from which the data is retrieved.

 required
db_url str

Database URL for creating the engine.

 required

Raises:

Type Description
P2PoolDatabaseError

If an error occurs while inserting data into the database.
Source code in p2pool/db.py 
 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
@classmethod
def _insert_data_into_db(cls, json_data, endpoint, db_url):
    """
    Inserts JSON data into the specified database table.

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

    Raises:
        P2PoolDatabaseError: If an error occurs while inserting data into the database.
    """
    try:
        session = cls._get_db_session(db_url)
        cur_time = datetime.now()
        if endpoint == _local_console_endpoint:
            cls._insert_local_console_data(session, json_data, cur_time)
        elif endpoint == _local_p2p_endpoint:
            cls._insert_local_p2p_data(session, json_data, cur_time)
        elif endpoint == _local_stratum_endpoint:
            cls._insert_local_stratum_data(session, json_data, cur_time)
        elif endpoint == _network_stats_endpoint:
            cls._insert_network_stats_data(session, json_data, cur_time)
        elif endpoint == _pool_blocks_endpoint:
            cls._insert_pool_blocks_data(session, json_data, cur_time)
        elif endpoint == _pool_stats_endpoint:
            cls._insert_pool_stats_data(session, json_data, cur_time)
        elif endpoint == _stats_mod_endpoint:
            cls._insert_stats_mod_data(session, json_data, cur_time)
        session.commit()
    except Exception as e:
        session.rollback()
        raise P2PoolDatabaseError(e, traceback.format_exc(), f"An error occurred inserting data to the database:") from e
    finally:
        session.close()

_insert_local_console_data(session, json_data, cur_time) classmethod

Inserts local console endpoints data into the database.

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

Parameters:

Name Type Description Default
session Session

The database session to add the local console data to.

 required
json_data dict

The JSON data containing the local console information.

 required
cur_time datetime

The current timestamp.

 required
Source code in p2pool/db.py 
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
@classmethod
def _insert_local_console_data(cls, session, json_data, cur_time):
    """
    Inserts local console endpoints data into the database.

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

    Args:
        session (Session): The database session to add the local console data to.
        json_data (dict): The JSON data containing the local console information.
        cur_time (datetime): The current timestamp.
    """
    local_console = Console(
        time = cur_time,
        full_json = json_data,
        mode = json_data.get("mode"),
        tcp_port = json_data.get("tcp_port")
    )
    session.add(local_console)

_insert_local_p2p_data(session, json_data, cur_time) classmethod

Inserts local p2p endpoints data into the database.

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

Parameters:

Name Type Description Default
session Session

The database session to add the local p2p data to.

 required
json_data dict

The JSON data containing the local p2p information.

 required
cur_time datetime

The current timestamp.

 required
Source code in p2pool/db.py 
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
@classmethod
def _insert_local_p2p_data(cls, session, json_data, cur_time):
    """
    Inserts local p2p endpoints data into the database.

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

    Args:
        session (Session): The database session to add the local p2p data to.
        json_data (dict): The JSON data containing the local p2p information.
        cur_time (datetime): The current timestamp.
    """
    local_p2p = P2P(
        time = cur_time,
        full_json = json_data,
        connections = json_data.get("connections"),
        incoming_connections = json_data.get("incoming_connections"),
        peer_list_size = json_data.get("peer_list_size"),
        peers = json_data.get("peers"),
        uptime = json_data.get("uptime")
    )
    session.add(local_p2p)

_insert_local_stratum_data(session, json_data, cur_time) classmethod

Inserts local stratum endpoints data into the database.

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

Parameters:

Name Type Description Default
session Session

The database session to add the local stratum data to.

 required
json_data dict

The JSON data containing the local stratum information.

 required
cur_time datetime

The current timestamp.

 required
Source code in p2pool/db.py 
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
@classmethod
def _insert_local_stratum_data(cls, session, json_data, cur_time):
    """
    Inserts local stratum endpoints data into the database.

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

    Args:
        session (Session): The database session to add the local stratum data to.
        json_data (dict): The JSON data containing the local stratum information.
        cur_time (datetime): The current timestamp.
    """
    local_stratum = Stratum(
        time = cur_time,
        full_json = json_data,
        hashrate_15m = json_data.get("hashrate_15m"),
        hashrate_1h = json_data.get("hashrate_1h"),
        hashrate_24h = json_data.get("hashrate_24h"),
        total_hashes = json_data.get("total_hashes"),
        shares_found = json_data.get("shares_found"),
        shares_failed = json_data.get("shares_failed"),
        average_effort = json_data.get("average_effort"),
        current_effort = json_data.get("current_effort"),
        connections = json_data.get("connections"),
        incoming_connections = json_data.get("incoming_connections"),
        block_reward_share_percent = json_data.get("block_reward_share_percent"),
        workers = json_data.get("workers")
    )
    session.add(local_stratum)

_insert_network_stats_data(session, json_data, cur_time) classmethod

Inserts network stats endpoints data into the database.

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

Parameters:

Name Type Description Default
session Session

The database session to add the network stats data to.

 required
json_data dict

The JSON data containing the network stats information.

 required
cur_time datetime

The current timestamp.

 required
Source code in p2pool/db.py 
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
@classmethod
def _insert_network_stats_data(cls, session, json_data, cur_time):
    """
    Inserts network stats endpoints data into the database.

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

    Args:
        session (Session): The database session to add the network stats data to.
        json_data (dict): The JSON data containing the network stats information.
        cur_time (datetime): The current timestamp.
    """
    network_stats = NetworkStats(
        time = cur_time,
        full_json = json_data,
        difficulty = json_data.get("difficulty"),
        hash_value = json_data.get("hash"),
        height = json_data.get("height"),
        reward = json_data.get("reward"),
        timestamp = json_data.get("timestamp")
    )
    session.add(network_stats)

_insert_pool_blocks_data(session, json_data, cur_time) classmethod

Inserts pool blocks endpoints data into the database.

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

Parameters:

Name Type Description Default
session Session

The database session to add the pool blocks data to.

 required
json_data dict

The JSON data containing the pool blocks information.

 required
cur_time datetime

The current timestamp.

 required
Source code in p2pool/db.py 
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
@classmethod
def _insert_pool_blocks_data(cls, session, json_data, cur_time):
    """
    Inserts pool blocks endpoints data into the database.

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

    Args:
        session (Session): The database session to add the pool blocks data to.
        json_data (dict): The JSON data containing the pool blocks information.
        cur_time (datetime): The current timestamp.
    """
    pool_blocks = PoolBlocks(
        time = cur_time,
        full_json = json_data,
    )
    session.add(pool_blocks)

_insert_pool_stats_data(session, json_data, cur_time) classmethod

Inserts pool stats endpoints data into the database.

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

Parameters:

Name Type Description Default
session Session

The database session to add the pool stats data to.

 required
json_data dict

The JSON data containing the pool stats information.

 required
cur_time datetime

The current timestamp.

 required
Source code in p2pool/db.py 
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
@classmethod
def _insert_pool_stats_data(cls, session, json_data, cur_time):
    """
    Inserts pool stats endpoints data into the database.

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

    Args:
        session (Session): The database session to add the pool stats data to.
        json_data (dict): The JSON data containing the pool stats information.
        cur_time (datetime): The current timestamp.
    """
    pool_stats = PoolStats(
        time = cur_time,
        full_json = json_data,
        pool_list = json_data.get("pool_list"),
        pool_statistics = json_data.get("pool_statistics"),
        hashrate = json_data["pool_statistics"].get("hashRate") if json_data.get("pool_statistics") else None,
        miners = json_data["pool_statistics"].get("miners") if json_data.get("pool_statistics") else None,
        total_hashes = json_data["pool_statistics"].get("totalHashes") if json_data.get("pool_statistics") else None,
        last_block_found_time = json_data["pool_statistics"].get("lastBlockFoundTime") if json_data.get("pool_statistics") else None,
        last_block_found = json_data["pool_statistics"].get("lastBlockFound") if json_data.get("pool_statistics") else None,
        total_blocks_found = json_data["pool_statistics"].get("totalBlocksFound") if json_data.get("pool_statistics") else None,
        pplns_weight = json_data["pool_statistics"].get("pplnsWeight") if json_data.get("pool_statistics") else None,
        pplns_window_size = json_data["pool_statistics"].get("pplnsWindowSize") if json_data.get("pool_statistics") else None,
        sidechain_difficulty = json_data["pool_statistics"].get("sidechainDifficulty") if json_data.get("pool_statistics") else None,
        sidechain_height = json_data["pool_statistics"].get("sidechainHeight") if json_data.get("pool_statistics") else None
    )
    session.add(pool_stats)

_insert_stats_mod_data(session, json_data, cur_time) classmethod

Inserts stats mod endpoints data into the database.

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

Parameters:

Name Type Description Default
session Session

The database session to add the stats mod data to.

 required
json_data dict

The JSON data containing the stats mod information.

 required
cur_time datetime

The current timestamp.

 required
Source code in p2pool/db.py 
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
@classmethod
def _insert_stats_mod_data(cls, session, json_data, cur_time):
    """
    Inserts stats mod endpoints data into the database.

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

    Args:
        session (Session): The database session to add the stats mod data to.
        json_data (dict): The JSON data containing the stats mod information.
        cur_time (datetime): The current timestamp.
    """
    stats_mod = StatsMod(
        time = cur_time,
        full_json = json_data,
        config = json_data.get("config"),
        ports = json_data["config"].get("ports") if json_data.get("config") else None,
        fee = json_data["config"].get("fee") if json_data.get("config") else None,
        min_payment_threshold = json_data["config"].get("minPaymentThreshold") if json_data.get("config") else None,
        network = json_data.get("network"),
        height = json_data["network"].get("height") if json_data.get("network") else None,
        pool = json_data.get("pool"),
        stats = json_data["pool"].get("stats") if json_data.get("pool") else None,
        last_block_found = json_data["pool"]["stats"].get("lastBlockFound") if json_data.get("pool") and json_data["pool"].get("stats") else None,
        blocks = json_data["pool"].get("blocks") if json_data.get("pool") else None,
        miners = json_data["pool"].get("miners") if json_data.get("pool") else None,
        hashrate = json_data["pool"].get("hashrate") if json_data.get("pool") else None,
        round_hashes = json_data["pool"].get("roundHashes") if json_data.get("pool") else None
    )
    session.add(stats_mod)

retrieve_data_from_db(db_url, table_name, 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
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
P2PoolDatabaseError

If an error occurs while retrieving data from the database.
Source code in p2pool/db.py 
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
@classmethod
def retrieve_data_from_db(cls, db_url, table_name, 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.
        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:
        P2PoolDatabaseError: 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 time filters
        if start_time:
            query = query.filter(model_class.time >= start_time)
        if end_time:
            query = query.filter(model_class.time <= end_time)

        # Apply limit
        query = query.order_by(model_class.time.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 P2PoolDatabaseError(e, traceback.format_exc(), f"An error occurred retrieving data from the database:") from e
    finally:
        session.close()
    return data