From 7aac4bfc835148be24209d9744626b8de70dbdd6 Mon Sep 17 00:00:00 2001 From: link2xt Date: Tue, 11 Jul 2023 01:11:08 +0000 Subject: [PATCH] docs: document WebXDC-related SQL tables --- src/webxdc.rs | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/src/webxdc.rs b/src/webxdc.rs index 46ada2fab..f01a495da 100644 --- a/src/webxdc.rs +++ b/src/webxdc.rs @@ -1,4 +1,18 @@ //! # Handle webxdc messages. +//! +//! Internally status updates are stored in the `msgs_status_updates` SQL table. +//! `msgs_status_updates` contains the following columns: +//! - `id` - status update serial number +//! - `msg_id` - ID of the message in the `msgs` table +//! - `update_item` - JSON representation of the status update +//! +//! Status updates are scheduled for sending by adding a record +//! to `smtp_status_updates_table` SQL table. +//! `smtp_status_updates` contains the following columns: +//! - `msg_id` - ID of the message in the `msgs` table +//! - `first_serial` - serial number of the first status update to send +//! - `last_serial` - serial number of the last status update to send +//! - `descr` - text to send along with the updates use std::convert::TryFrom; use std::path::Path;