diff --git a/docs/sqlite_database_structure.md b/docs/sqlite_database_structure.md index 0480f9c..6062336 100644 --- a/docs/sqlite_database_structure.md +++ b/docs/sqlite_database_structure.md @@ -2,94 +2,79 @@ Note: this documentation was generated automatically from the tasks.py code usin **activity table** - -|Column|Description +|Column|Description| |---|---| -|event_name|The kind of activity event. Examples of events include 'message_sent', 'guild_joined', 'application_command_used', etc.| -|day|The date when the event occurred, represented in 'YYYY-MM-DD' format.| -|hour|The hour when the event occurred (in 24-hour format).| -|occurence_count|The number of times the event occurred.| -|associated_channel_id|The channel ID associated with the event (if applicable).| -|associated_guild_id|The guild ID associated with the event (if applicable).| -|associated_user_id|The user ID associated with the event (if applicable).| -|extra_field_1|Extra data associated with the event, its use varies depending on the event type.| -|extra_field_2|Another field for extra data associated with the event, its use varies depending on the event type.| - +|event_name|The type of event that occurred. Examples might include 'message_sent', 'guild_joined', 'application_command_used', etc.| +|day|The day of the event, formatted as 'YYYY-mm-dd'.| +|hour|The hour of the event, as an integer in 24-hour format.| +|occurence_count|The number of occurrences of the event within the given hour.| +|associated_channel_id|The ID of the channel where the event occurred, if applicable.| +|associated_guild_id|The ID of the guild where the event occurred, if applicable.| +|associated_user_id|The ID of the user associated with the event, if applicable.| +|extra_field_1|Extra data related to the event, the nature of which varies based on the event type.| +|extra_field_2|Additional extra data related to the event, depending on the event type.| **dm_channels_data table** - |Column|Description| |---|---| -|channel_id|The unique identifier of the Direct Message (DM) channel.| -|dm_user_id|The unique identifier of the user in the DM channel.| -|user_name|The username of the user in the DM channel.| -|display_name|The display name of the user in the DM channel.| -|user_avatar_url|The URL of the user's avatar.| -|total_message_count|The total number of messages in the DM channel.| -|total_voice_channel_duration|The total duration of voice channel usage in the DM.| -|sentiment_score|The sentiment score associated with the DM channel.| - +|channel_id|The unique ID of the Direct Message channel.| +|dm_user_id|The ID of the user with whom the DM conversation was held.| +|user_name|The username of the DM conversation partner.| +|display_name|The display name of the DM conversation partner.| +|user_avatar_url|The URL of the avatar of the DM conversation partner.| +|total_message_count|The total number of messages exchanged in the DM channel.| +|total_voice_channel_duration|The total duration of voice interaction in the DM channel, in minutes.| +|sentiment_score|The sentiment score of the channel, calculated based on the content of the messages.| **guild_channels_data table** - |Column|Description| |---|---| -|channel_id|The unique identifier of the guild channel.| -|guild_id|The unique identifier of the guild.| -|channel_name|The name of the channel.| -|total_message_count|The total number of messages in the guild channel.| -|total_voice_channel_duration|The total duration of voice channel usage in the guild.| - +|channel_id|The ID of the guild channel.| +|guild_id|The ID of the guild to which the channel belongs.| +|channel_name|The name of the guild channel.| +|total_message_count|The total number of messages exchanged in the channel.| +|total_voice_channel_duration|The total duration of voice interactions in the guild channel, in minutes.| **guilds table** - |Column|Description| |---|---| -|guild_id|The unique identifier of the guild.| +|guild_id|The unique ID of the guild.| |guild_name|The name of the guild.| -|total_message_count|The total number of messages in the guild.| - +|total_message_count|The total number of messages exchanged within the guild.| **payments table** - |Column|Description| |---|---| -|payment_id|The unique identifier of the payment.| -|payment_date|The date when the payment was made, represented in 'YYYY-MM-DD' format.| +|payment_id|The unique ID of the payment transaction.| +|payment_date|The date of the payment transaction, formatted as 'YYYY-mm-dd'.| |payment_amount|The amount of the payment.| -|payment_currency|The currency of the payment.| -|payment_description|A description of the payment.| - +|payment_currency|The currency used for the payment.| +|payment_description|A description or note associated with the payment.| **voice_sessions table** - |Column|Description| |---|---| -|channel_id|The unique identifier of the channel where the voice session took place.| -|guild_id|The unique identifier of the guild where the voice session took place.| -|duration_mins|The duration of the voice session in minutes.| -|started_date|The date and time when the voice session started.| -|ended_date|The date and time when the voice session ended.| - +|channel_id|The ID of the channel in which the voice session took place.| +|guild_id|The ID of the guild in which the voice session took place.| +|duration_mins|The duration of the voice session, in minutes.| +|started_date|The start date and time of the voice session, formatted as 'YYYY-mm-dd HH:MM:SS'.| +|ended_date|The end date and time of the voice session, formatted as 'YYYY-mm-dd HH:MM:SS'.| **sessions table** - |Column|Description| |---|---| -|duration_mins|The duration of the session in minutes.| -|started_date|The date and time when the session started.| -|ended_date|The date and time when the session ended.| -|device_os|The operating system of the device used in the session.| - +|duration_mins|The duration of the app session, in minutes.| +|started_date|The start date and time of the app session, formatted as 'YYYY-mm-dd HH:MM:SS'.| +|ended_date|The end date and time of the app session, formatted as 'YYYY-mm-dd HH:MM:SS'.| +|device_os|The operating system of the device used for the app session.| **package_data table** - |Column|Description| |---|---| -|package_id|The unique identifier of the data package.| -|package_version|The version of the data package.| -|package_owner_id|The unique identifier of the owner of the data package.| -|package_owner_name|The name of the owner of the data package.| -|package_owner_display_name|The display name of the owner of the data package.| -|package_owner_avatar_url|The URL of the owner's avatar.| -|package_is_partial|A boolean value indicating whether the data package is partial (1) or complete (0).| \ No newline at end of file +|package_id|The unique ID of the package.| +|package_version|The version of the package.| +|package_owner_id|The ID of the owner of the package.| +|package_owner_name|The username of the owner of the package.| +|package_owner_display_name|The display name of the owner of the package.| +|package_owner_avatar_url|The URL of the avatar of the owner of the package.| +|package_is_partial|A boolean signifying whether the package is partial (1) or complete (0).| \ No newline at end of file diff --git a/requirements.txt b/requirements.txt index b354836..5500e84 100644 --- a/requirements.txt +++ b/requirements.txt @@ -21,7 +21,7 @@ idna==3.4 importlib-resources==5.12.0 itsdangerous==2.1.2 Jinja2==3.1.2 -joblib==1.2.0 +joblib==1.3.2 kombu==5.2.4 limits==3.5.0 markdown-it-py==3.0.0