Skip to content

Event Instances - Comments

EventInstanceComments(perfdb)

Class used for handling event comments. Can be accessed via perfdb.events.instances.comments.

Parameters:

  • perfdb

    (PerfDB) –

    Top level object carrying all functionality and the connection handler.

Source code in echo_postgres/perfdb_root.py 
def __init__(self, perfdb: e_pg.PerfDB) -> None:
    """Base class that all subclasses should inherit from.

    Parameters
    ----------
    perfdb : PerfDB
        Top level object carrying all functionality and the connection handler.

    """
    self._perfdb: e_pg.PerfDB = perfdb

insert(event_id, comment, bazefield_user)

Inserts a comment for a given event.

Parameters:

  • event_id

    (int) –

    Event id

  • comment

    (str) –

    Comment to be inserted

  • bazefield_user

    (str) –

    Bazefield user name (author of the comment)

Returns:

  • int –

    New comment id

Source code in echo_postgres/event_instance_comments.py 
@validate_call
def insert(self, event_id: int, comment: str, bazefield_user: str) -> int:
    """Inserts a comment for a given event.

    Parameters
    ----------
    event_id : int
        Event id
    comment : str
        Comment to be inserted
    bazefield_user : str
        Bazefield user name (author of the comment)

    Returns
    -------
    int
        New comment id
    """
    query = sql.SQL("SELECT * FROM fn_create_event_comment({event_id}, {comment}, {bazefield_user})").format(
        event_id=sql.Literal(event_id),
        comment=sql.Literal(comment),
        bazefield_user=sql.Literal(bazefield_user),
    )
    with self._perfdb.conn.reconnect() as conn:
        comment_id = conn.execute(query, skip_retry=True).fetchone()[0]

    return comment_id