snews_cs.snews_sql

Attributes

current_script_directory
parent_directory

Classes

Storage

Class for interacting with the SNEWS SQL database.

Module Contents

snews_cs.snews_sql.current_script_directory

snews_cs.snews_sql.parent_directory

class snews_cs.snews_sql.Storage(env=None, drop_db=True)

Class for interacting with the SNEWS SQL database.

Parameters:

• env (str, optional) – Path to env file, defaults to ‘./etc/test-config.env’

• drop_db (bool, optional) – drops all items in the DB every time Storage is initialized, defaults to False

mgs_expiration

coinc_threshold

db_path

db

conn

cursor

insert_mgs(mgs, tier)

Inserts a message into the all_mgs table.

Parameters:

mgs (dict) – dictionary of the SNEWS message

insert_alert(alert, tier)

drop_expired()

Drops all expired messages from the all_mgs table.

get_all_messages(sort_order='ASC')

Returns all messages in the all_mgs table.

get_all_coinc_alerts(sort_order='ASC')

Returns all messages in the all_mgs table.

get_all_sig_alerts(sort_order='ASC')

get_all_time_alerts(sort_order='ASC')

get_all_sig_messages(sort_order='ASC')

Returns all messages in the all_mgs table.

get_all_time_messages(sort_order='ASC')

Returns all messages in the all_mgs table.

get_all_coinc_messages(sort_order='ASC')

Returns all messages in the all_mgs table.

retract_message(message_id, tier)

Retracts a message from the all_mgs table.

Parameters:

message_id (str) – unique id for each message

update_message(message, tier)

Updates a message in the all_mgs table and corresponding tier tabe.

show_tables()

Returns all tables in the SQL database.

get_table_schema(table_name)

Returns the schema for a given table.

insert_coinc_cache(cache)

Inserts coincidence cache dataframe into the coincidence_tier_archive table.

Parameters:

cache (dataframe) – dictionary of the SNEWS message

retrieve_coinc_cache()

Returns coincidence cache dataframe from the coincidence_tier_archive table and saves it as a dataframe.