diff --git a/black.md b/black.md deleted file mode 100644 index 25b65b9..0000000 --- a/black.md +++ /dev/null @@ -1,174 +0,0 @@ -# Js实现db接口简要说明(待更新) - -## 表结构以及需要实现的接口说明 - -> 所有的db接口返回值，统一由errCode,errMsg,data字段转换为字符串异步返回 - -### 黑名单表 - -- 表名： - -```sqlite： -create table local_blacks -( - owner_user_id varchar(64), - block_user_id varchar(64), - nickname varchar(255), - face_url varchar(255), - gender INTEGER, - create_time INTEGER, - add_source INTEGER, - operator_user_id varchar(64), - ex varchar(1024), - attached_info varchar(1024), - primary key (owner_user_id, block_user_id) -); -``` - -#### 接口说明： - -- getBlackList - -**无输入参数** - -| 返回参数 | 类型 | 说明 | 备注 | -| --------- |--------| ----- |-----| -| errCode | number | 自定义即可，0成功，非0失败 | | -| errMsg | string | 详细的err信息 | | -| data | string | LocalBlack（表对象数据） |对象转换成string| - -**参考sql语句说明：** - -```sqlite -SELECT * -FROM `local_blacks` -``` - -- getBlackListUserID - -**无输入参数** - -| 返回参数 | 类型 | 说明 | 备注 | -| --------- |--------| ----- |-----| -| errCode | number | 自定义即可，0成功，非0失败 | | -| errMsg | string | 详细的err信息 | | -| data | blackListUid[]string | | || data | errerror | | | - -**参考sql语句说明：** - -```sqlite -SELECT `block_user_id` -FROM `local_blacks` -``` - -- getBlackInfoByBlockUserID - -| 输入参数 | 类型 | 说明 | 备注 | -| --------- |--------| ----- |-----| -| blockUserID | string | | | -| ownerUserID | string | | | - -| 返回参数 | 类型 | 说明 | 备注 | -| --------- |--------| ----- |-----| -| errCode | number | 自定义即可，0成功，非0失败 | | -| errMsg | string | 详细的err信息 | | -| data | string | LocalBlack（表对象数据） |对象转换成string| - -**参考sql语句说明：** - -```sqlite -SELECT * -FROM `local_blacks` -WHERE owner_user_id = "3433303585" - AND block_user_id = "456" -LIMIT 1 -``` - -- getBlackInfoList - -| 输入参数 | 类型 | 说明 | 备注 | -| --------- |--------| ----- |-----| -| blockUserIDList | []string | | | - -| 返回参数 | 类型 | 说明 | 备注 | -| --------- |--------| ----- |-----| -| errCode | number | 自定义即可，0成功，非0失败 | | -| errMsg | string | 详细的err信息 | | -| data | string | LocalBlack（表对象数据） |对象转换成string| - -**参考sql语句说明：** - -```sqlite -SELECT * -FROM `local_blacks` -WHERE block_user_id IN ("456") -``` - -- insertBlack - -| 输入参数 | 类型 | 说明 | 备注 | -| --------- |--------| ----- |-----| -| LocalBlack | string |（表对象数据） |对象转换成string| - -| 返回参数 | 类型 | 说明 | 备注 | -| --------- |--------| ----- |-----| -| errCode | number | 自定义即可，0成功，非0失败 | | -| errMsg | string | 详细的err信息 | | - -**参考sql语句说明：** - -```sqlite -INSERT INTO `local_blacks` (`owner_user_id`, `block_user_id`, `nickname`, `face_url`, `gender`, `create_time`, - `add_source`, `operator_user_id`, `ex`, `attached_info`) -VALUES ("123", "456", "hello", "", 1, 1666866302, 1, "789", "asdasdasa", "asdasds") -``` - -- updateBlack - -| 输入参数 | 类型 | 说明 | 备注 | -| --------- |--------| ----- |-----| -| LocalBlack | string |（表对象数据） |对象转换成string| - -| 返回参数 | 类型 | 说明 | 备注 | -| --------- |--------| ----- |-----| -| errCode | number | 自定义即可，0成功，非0失败 | | -| errMsg | string | 详细的err信息 | | - -**参考sql语句说明：** - -```sqlite -UPDATE `local_blacks` -SET `nickname`="hello", - `gender`=1, - `create_time`=1666866338, - `add_source`=1, - `operator_user_id`="789", - `ex`="asdasdasa", - `attached_info`="asdasds" -WHERE `owner_user_id` = "123" - AND `block_user_id` = "456" -``` - -- deleteBlack - -| 输入参数 | 类型 | 说明 | 备注 | -| --------- |--------| ----- |-----| -| blockUserID | string | | | -| ownerUserId | string | | - -| 返回参数 | 类型 | 说明 | 备注 | -| --------- |--------| ----- |-----| -| errCode | number | 自定义即可，0成功，非0失败 | | -| errMsg | string | 详细的err信息 | | - -**参考sql语句说明：** - -```sqlite -DELETE -FROM `local_blacks` -WHERE owner_user_id = "3433303585" - and block_user_id = "456" -``` - - - diff --git a/cache_message.md b/cache_message.md index 11988cc..497cdca 100644 --- a/cache_message.md +++ b/cache_message.md @@ -1,3 +1,8 @@ +# Js实现db接口简要说明(已废弃) +## 表结构以及需要实现的接口说明 +>所有的db接口返回值，统一由errCode,errMsg,data字段转换为字符串异步返回 +### 消息扩展信息表 + **参考sql语句说明：** ```sql CREATE TABLE "temp_cache_local_chat_logs" ( @@ -40,7 +45,11 @@ CREATE TABLE "temp_cache_local_chat_logs" ( **参考sql语句说明：** ```sql -INSERT INTO `temp_cache_local_chat_logs` (`client_msg_id`,`server_msg_id`,`send_id`,`recv_id`,`sender_platform_id`,`sender_nick_name`,`sender_face_url`,`session_type`,`msg_from`,`content_type`,`content`,`is_read`,`status`,`seq`,`send_time`,`create_time`,`attached_info`,`ex`) VALUES ("1","1","1","1",1,"1","1",1,100,200,"xxx",false,100,0,0,0,"",""),("1","1","1","1",1,"1","1",1,100,200,"xxx",false,100,0,0,0,"","") +INSERT INTO `temp_cache_local_chat_logs` +(`client_msg_id`, `server_msg_id`, `send_id`, `recv_id`, `sender_platform_id`, `sender_nick_name`, `sender_face_url`, `session_type`, `msg_from`, `content_type`, `content`, `is_read`, `status`, `seq`, `send_time`, `create_time`, `attached_info`, `ex`) +VALUES +("1", "1", "1", "1", 1, "1", "1", 1, 100, 200, "xxx", false, 100, 0, 0, 0, "", ""), +("1", "1", "1", "1", 1, "1", "1", 1, 100, 200, "xxx", false, 100, 0, 0, 0, "", ""); ``` - InsertTempCacheMessage @@ -54,7 +63,7 @@ INSERT INTO `temp_cache_local_chat_logs` (`client_msg_id`,`server_msg_id`,`send_ | --------- | ------------------------------------------------------------ | ----- |-----------------------| | errCode | number | 自定义即可，0成功，非0失败| 失败报错| | errMsg | string | 详细的err信息 || -| data | string | 可为"" || +| data | string | 可为" " || **参考sql语句说明：** diff --git a/local_chat_logs.md b/chat_logs_conversationID.md similarity index 54% rename from local_chat_logs.md rename to chat_logs_conversationID.md index 5ce6272..76d394e 100644 --- a/local_chat_logs.md +++ b/chat_logs_conversationID.md @@ -2,9 +2,37 @@ ## 表结构以及需要实现的接口说明 >所有的db接口返回值，统一由errCode,errMsg,data字段转换为字符串异步返回 ### 消息表(写扩散消息表) -- 表名：local_chat_logs +### 读扩散消息表 +- 表名：chat_logs_si_7788_7789 +>注：读扩散表为动态生成，表名也是，规则为chat_logs_+conversationID， +原有代码中，是在 `GetMessage`、`GetMessageBySeq`、`BatchInsertMessageList`、`GetConversationNormalMsgSeq`、`GetLatestActiveMessage` 和 `GetMessageListNoTime` 这六个函数中进行判断，如果没有就动态生成该表 + ```sqlite -CREATE TABLE `local_chat_logs` (`client_msg_id` char(64),`server_msg_id` char(64),`send_id` char(64),`recv_id` char(64),`sender_platform_id` integer,`sender_nick_name` varchar(255),`sender_face_url` varchar(255),`session_type` integer,`msg_from` integer,`content_type` integer,`content` varchar(1000),`is_read` numeric,`status` integer,`seq` integer DEFAULT 0,`send_time` integer,`create_time` integer,`attached_info` varchar(1024),`ex` varchar(1024),`is_react` numeric,`is_external_extensions` numeric,`msg_first_modify_time` integer,PRIMARY KEY (`client_msg_id`)) +CREATE TABLE `chat_logs_si_7788_7789` ( + `client_msg_id` char(32), + `server_msg_id` char(32), + `send_id` char(32), + `recv_id` char(32), + `sender_platform_id` smallint, + `sender_nick_name` varchar(255), + `sender_face_url` varchar(255), + `session_type` smallint, + `msg_from` smallint, + `content_type` smallint, + `content` varchar(1000), + `is_read` tinyint(1), + `status` smallint, + `seq` int DEFAULT 0, + `send_time` int, + `create_time` int, + `attached_info` varchar(1024), + `ex` varchar(1024), + `local_ex` varchar(1024), + `is_react` tinyint(1), + `is_external_extensions` tinyint(1), + `msg_first_modify_time` int, + PRIMARY KEY (`client_msg_id`) +); ``` - 表结构特别说明 @@ -18,8 +46,9 @@ CREATE TABLE `local_chat_logs` (`client_msg_id` char(64),`server_msg_id` char(64 #### 接口说明： - getMessage -| 输入参数 | 类型 | 说明 |备注| -| --------- | ------------------------------------------------------------ | ----- |-----------------------| +| 输入参数 | 类型 | 说明 |备注| +| --------- | ------------------------------------------------------------ |------|-----------------------| +| conversationID | string | 会话ID || | clientMsgID | string | 消息ID || | 返回参数 | 类型 | 说明 |备注| @@ -27,66 +56,203 @@ CREATE TABLE `local_chat_logs` (`client_msg_id` char(64),`server_msg_id` char(64 | errCode | number | 自定义即可，0成功，非0失败 |如果获取不到消息也需要返回错误| | errMsg | string | 详细的err信息 || | data | string | LocalChatLog（消息表对象数据） |对象转换成string| + **参考sql语句说明：** ```sql -SELECT * FROM `local_chat_logs` WHERE client_msg_id = "063031b86f8e503c6038efb2b835f216" LIMIT 1 +SELECT * FROM `chat_logs_si_7788_7789` WHERE client_msg_id = "063031b86f8e503c6038efb2b835f216" LIMIT 1 +``` +- getAlreadyExistSeqList + +| 参数名称 | 类型 | 说明 | 备注 | +| -------------- |--------|--------------------------| ---- | +| conversationID | string | 会话 ID | | +| lostSeqList | string | 丢失的序列号列表,为整型数组转换后的string | | + +#### 输出参数 + +| 参数名称 | 参数类型 | 参数说明 | 备注 | +| -------- |--------|---------------------------------------| ---- | +| errCode | number | 自定义即可，0 表示成功，非 0 表示失败 | | +| errMsg | string | 详细的错误信息 | | +| data | string | 已经存在的序列号列表 整型数组转换后的string，如果没有则返回空字符串 | | +```sql +SELECT seq FROM `chat_logs_si_7788_7789` WHERE seq IN (1,2,3,4); ``` + + - getMessageList -| 输入参数 | 类型 | 说明 |备注| -| --------- | ------------------------------------------------------------ | ----- |-----------------------| -| sourceID | string | 关于某人的ID也可能是写扩散模式下群ID| -| sessionType | number | 会话类型，单聊1、读扩散群2、大群为3 || -| count | number | 获取消息的数量 || -| startTime | number | 消息发送时间，毫秒 || -| isReverse | boolean | 消息为正向拉取还是反向拉取|默认情况为false，即为正向拉取（从新消息到老消息），order by 后面的排序规则为send_time DESC 降序排列，send_time为 <;当为true的情况，即为反向拉取，order by 后面的排序规则为send_time ASC 升序排列,send_time为 >| -| loginUserID | string | 用户登录ID |需要根据会话的类型和sourceID判断，当sessionType为1并且sourceID为登录者ID时候，搜索sql为 AND| +| 输入参数 | 类型 | 说明 | 备注 | +| --------- |--------|------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------| +| conversationID | string | 会话 ID | | +| count | number | 获取消息的数量 || +| startTime | number | 消息发送时间，毫秒 || +| startClientMsgID | string | 起始消息的msgID || + +| isReverse | boolean | 消息为正向拉取还是反向拉取| 默认情况为false，即为正向拉取（从新消息到老消息），order by 后面的排序规则为send_time DESC,seq DESC 降序排列，send_time为 <=;当为true的情况，即为反向拉取，order by 后面的排序规则为send_time ASC,seq ASC 升序排列,send_time为 >= | | 返回参数 | 类型 | 说明 |备注| | --------- | ------------------------------------------------------------ | ----- |-----------------------| | errCode | number | 自定义即可，0成功，非0失败 |获取不到的时候返回空数组不需要返回错误| | errMsg | string | 详细的err信息 || -| data | string | []LocalChatLog（消息表对象数组数据） || +| data | string | []LocalChatLog（消息表对象数组数据） |对象转换成string| **参考sql语句说明：** ```sql --- 1、sessionType == 1 && sourceID == d.loginUserID -SELECT * FROM `local_chat_logs` WHERE send_id = "812146266" And recv_id = "812146266" AND status <=1 And session_type = 3 And send_time < 1664357584025 ORDER BY send_time DESC LIMIT 30; --- 注：其中status固定为3 --- 2、其他场景 -SELECT * FROM `local_chat_logs` WHERE send_id = "812146266" OR recv_id = "812146266" AND status <=1 And session_type = 3 And send_time < 1664357584025 ORDER BY send_time DESC LIMIT 30; +#如果startTime>0 +SELECT * FROM `chat_logs_si_7788_7789` WHERE send_time <= 1664357584025 and client_msg_id != cb75fb34f166dae6f8c20a641a8f4d5b ORDER BY send_time DESC,seq DESC LIMIT 30; +#否则 +SELECT * FROM `chat_logs_si_7788_7789` ORDER BY send_time DESC LIMIT 30; ``` -- getMessageListNoTime -| 输入参数 | 类型 | 说明 |备注| + + +- getMessageBySeq + +| 输入参数 | 类型 | 说明 | 备注 | +| -------- | ------ | -------- | ---- | +| conversationID | string | 会话 ID | | +| seq | number | 消息序列 | | + +| 返回参数 | 类型 | 说明 | 备注 | +| -------- | ------ | ------------------------------ | ------------------------------ | +| errCode | number | 自定义即可，0成功，非0失败 | 如果获取不到消息也需要返回错误 | +| errMsg | string | 详细的err信息 | | +| data | string | LocalChatLog（消息表对象数据） | 对象转换成string | + +参考 SQL 语句说明： + +```sql +SELECT * FROM `chat_logs_si_7788_7789` WHERE seq = 1000 LIMIT 1; +``` + +- getMessageByUserID + +| 输入参数 | 类型 | 说明 | 备注 | +|----------------|--------|-------| ---- | +| conversationID | string | 会话 ID | | +| userID | string | 用户ID | | + +| 返回参数 | 类型 | 说明 | 备注 | +| -------- | ------ | ------------------------------ | ------------------------------ | +| errCode | number | 自定义即可，0成功，非0失败 | 如果获取不到消息也需要返回错误 | +| errMsg | string | 详细的err信息 | | +| data | string | []LocalChatLog（消息表对象数组数据）| 对象转换成string | + +参考 SQL 语句说明： + +```sql +SELECT * FROM `chat_logs_si_7788_7789` WHERE user_id = "1552662" LIMIT 1; +``` + +- getMessagesByClientMsgIDs + +| 输入参数 | 类型 | 说明 | 备注 | +| -------------- | -------- | ------- | ---- | +| conversationID | string | 会话 ID | | +| msgIDs | string | 消息 ID | 消息id数组 转为String | + +| 返回参数 | 类型 | 说明 | 备注 | +| -------- |--------|-----------------------| ------------------------------ | +| errCode | number | 自定义即可，0成功，非0失败 | 如果获取不到消息也需要返回错误 | +| errMsg | string | 详细的err信息 | | +| data | string | LocalChatLog（消息表对象数组） | 对象转换成 string | + +**参考sql语句说明：** + +``` +SELECT * FROM `chat_logs_si_7788_7789` WHERE client_msg_id IN ("063031b86f8e503c6038efb2b835f216","063031b86f8e503c6038efb2b835f217") ORDER BY send_time DESC +``` + + + +- getMessagesBySeqs + +| 输入参数 | 类型 | 说明 | 备注 | +| -------- | -------- | -------------- | ---- | +| conversationID | string | 会话 ID | | +| seqs | number[] | 消息序列号数组 | | + +| 返回参数 | 类型 | 说明 | 备注 | +| -------- | ------ | ------------------------------------ | -------------------------------------- | +| errCode | number | 自定义即可，0成功，非0失败 | 获取不到的时候返回空数组不需要返回错误 | +| errMsg | string | 详细的err信息 | | +| data | string | []LocalChatLog（消息表对象数组数据） | 对象转换成string | + +参考 SQL 语句说明： + +``` +SELECT * FROM `chat_logs_si_7788_7789` WHERE seq IN (1,2,3,4) ORDER BY send_time DESC; +``` + + + + + +- getConversationNormalMsgSeq + +| 输入参数 | 类型 | 说明 |备注| +|----------------| ------------------------------------------------------------ |---------------------|-----------------------| +| conversationID | string | 会话ID | + +| 返回参数 | 类型 | 说明 |备注| | --------- | ------------------------------------------------------------ | ----- |-----------------------| -| sourceID | string | 关于某人的ID也可能是写扩散模式下群ID| -| sessionType | number | 会话类型，单聊1、读扩散群2、大群为3 || -| count | number | 获取消息的数量 || -| isReverse | boolean | 消息为正向拉取还是反向拉取|默认情况为false，即为正向拉取（从新消息到老消息），order by 后面的排序规则为send_time DESC 降序排列，当为true的情况，即为反向拉取，order by 后面的排序规则为send_time ASC 升序排列| -| loginUserID | string | 用户登录ID |需要根据会话的类型和sourceID判断，当sessionType为1并且sourceID为登录者ID时候，搜索sql为 AND| +| errCode | number | 自定义即可，0成功，非0失败 || +| errMsg | string | 详细的err信息 || +| data | number | 消息表中最大seq || + +**参考sql语句说明：** + +```sql +SELECT IFNULL(max(seq),0) FROM `local_chat_logs`; +``` + +- CheckConversationNormalMsgSeq + +| 输入参数 | 类型 | 说明 |备注| +|----------------| ------------------------------------------------------------ |---------------------|-----------------------| +| conversationID | string | 会话ID | | 返回参数 | 类型 | 说明 |备注| | --------- | ------------------------------------------------------------ | ----- |-----------------------| -| errCode | number | 自定义即可，0成功，非0失败 |获取不到的时候返回空数组不需要返回错误| +| errCode | number | 自定义即可，0成功，非0失败 || | errMsg | string | 详细的err信息 || -| data | string | []LocalChatLog（消息表对象数组数据） || +| data | number | 消息表中最大seq || **参考sql语句说明：** ```sql --- 1、sessionType == 1 && sourceID == d.loginUserID -SELECT * FROM `local_chat_logs` WHERE send_id = "812146266" And recv_id = "812146266" AND status <=3 And session_type = 1 ORDER BY send_time DESC LIMIT 30; --- 注：其中status固定为3 --- 2、其他场景 -SELECT * FROM `local_chat_logs` WHERE send_id = "812146266" OR recv_id = "812146266" AND status <=3 And session_type = 1 ORDER BY send_time DESC LIMIT 30; +SELECT IFNULL(max(seq),0) FROM `local_chat_logs`; ``` -[comment]: <> "- setChatLogFailedStatus" -- getSendingMessageList +- getConversationPeerNormalMsgSeq + +| 输入参数 | 类型 | 说明 | 备注 | +| -------------- | ------ |--| ---- | +| conversationID | string | 会话ID | | +| loginUserID | string | 用户ID | | + + +| 返回参数 | 类型 | 说明 | 备注 | +| -------- | ------ |-----------------| ------------------------------ | +| errCode | number | 自定义即可，0成功，非0失败 | 如果获取不到消息也需要返回错误 | +| errMsg | string | 详细的err信息 | | +| data | number | int64（对方最大的seq） | | + +**参考 sql 语句说明：** + +``` +SELECT IFNULL(MAX(seq), 0) FROM `chat_logs_si_7788_7789` WHERE send_id != "7788"; +``` + + + +[//]: # (- GetConversationAbnormalMsgSeq) +- +- getSendingMessageList(暂时没用) **无输入参数** @@ -99,7 +265,7 @@ SELECT * FROM `local_chat_logs` WHERE send_id = "812146266" OR recv_id = "81214 **参考sql语句说明：** ```sql -select * from local_chat_logs where status = 1; +select * from chat_logs_si_7788_7789 where status = 1; -- 消息状态： -- MsgStatusSending = 1 -- MsgStatusSendSuccess = 2 @@ -109,28 +275,15 @@ select * from local_chat_logs where status = 1; -- MsgStatusFiltered = 6 ``` -- getNormalMsgSeq - - -**无输入参数** - -| 返回参数 | 类型 | 说明 |备注| -| --------- | ------------------------------------------------------------ | ----- |-----------------------| -| errCode | number | 自定义即可，0成功，非0失败 || -| errMsg | string | 详细的err信息 || -| data | number | 消息表中最大seq || -**参考sql语句说明：** -```sql -SELECT IFNULL(max(seq),0) FROM `local_chat_logs`; -``` - updateMessageTimeAndStatus | 输入参数 | 类型 | 说明 |备注| | --------- | ------------------------------------------------------------ | ----- |-----------------------| +| conversationID | string | 会话ID | | | clientMsgID | string | 客户端消息ID || | serverMsgID | string | 服务器消息ID || | sendTime | number | 消息发送时间，毫秒 || @@ -145,17 +298,18 @@ SELECT IFNULL(max(seq),0) FROM `local_chat_logs`; **参考sql语句说明：** ```sql - UPDATE `local_chat_logs` SET `server_msg_id`="75dee2fbd6c4f28e7895f8410be4984f",`status`=2,`send_time`=1663658950513 WHERE client_msg_id="985261c57242cf647753839854038154" And seq=0; + UPDATE `chat_logs_si_7788_7789` SET `server_msg_id`="75dee2fbd6c4f28e7895f8410be4984f",`status`=2,`send_time`=1663658950513 WHERE client_msg_id="985261c57242cf647753839854038154" And seq=0; ``` -BatchUpdateMessageList + - updateMessage | 输入参数 | 类型 | 说明 |备注| | --------- | ------------------------------------------------------------ | ----- |-----------------------| +| conversationID | string | 会话ID | | | clientMsgID | string | 客户端消息ID || -| args | object | 更新字段参数对象 |内部是kv，k为字段名，v为需要更新的字段内容Js实现db接口简要说明| +| args | object | 更新字段参数对象 |内部是kv，k为字段名，v为需要更新的字段内容| | 返回参数 | 类型 | 说明 |备注| | --------- | ------------------------------------------------------------ | ----- |-----------------------| @@ -166,13 +320,34 @@ BatchUpdateMessageList **参考sql语句说明：** ```sql - UPDATE `local_chat_logs` SET `server_msg_id`="8c6dc2ace8ff5706880018de43916c39",`recv_id`="2041671273",`session_type`=1,`status`=2,`seq`=14 WHERE `client_msg_id` = "6edad80249cc0cf626edb88e64f8fb6d"; + UPDATE `chat_logs_si_7788_7789` SET `server_msg_id`="8c6dc2ace8ff5706880018de43916c39",`recv_id`="2041671273",`session_type`=1,`status`=2,`seq`=14 WHERE `client_msg_id` = "6edad80249cc0cf626edb88e64f8fb6d"; +``` + +- updateMessageBySeq + +| 输入参数 | 类型 | 说明 |备注| +|----------------|--------|----------|-----------------------| +| conversationID | string | 会话ID | | +| seq | number | 消息的序列号 || +| args | object | 更新字段参数对象 |内部是kv，k为字段名，v为需要更新的字段内容| + +| 返回参数 | 类型 | 说明 |备注| +| --------- | ------------------------------------------------------------ | ----- |-----------------------| +| errCode | number | 自定义即可，0成功，非0失败 |如果没更新到任何一行消息也返回错误| +| errMsg | string | 详细的err信息 || +| data | string | 可为"" || + +**参考sql语句说明：** + +```sql + UPDATE `chat_logs_si_7788_7789` SET `server_msg_id`="8c6dc2ace8ff5706880018de43916c39",`recv_id`="2041671273",`session_type`=1,`status`=2 WHERE `seq` = 5; ``` - batchInsertMessageList | 输入参数 | 类型 | 说明 |备注| | --------- | ------------------------------------------------------------ | ----- |-----------------------| +| conversationID | string | 会话ID | | | messageList | string | []LocalChatLog（消息表对象数组数据）|对象数组转换成string | 返回参数 | 类型 | 说明 |备注| @@ -184,13 +359,14 @@ BatchUpdateMessageList **参考sql语句说明：** ```sql - INSERT INTO `local_chat_logs` (`client_msg_id`,`server_msg_id`,`send_id`,`recv_id`,`sender_platform_id`,`sender_nick_name`,`sender_face_url`,`session_type`,`msg_from`,`content_type`,`content`,`is_read`,`status`,`seq`,`send_time`,`create_time`,`attached_info`,`ex`) VALUES ("01d22adafe309482391fc54f728c96a7","5cb3ecb6092843e9376fd229a72b24e0","3045326383","openIMAdmin",0,"","",1,200,1303,"{\"detail\":\"CgozMDQ1MzI2Mzgz\",\"defaultTips\":\"remove a blocked user\",\"jsonDetail\":\"{\\"userID\\":\\"3045326383\\"}\"}",false,6,1,1663557189653,1663557189652,"",""),("3492347bc55280d3c5c32398f78eae50","2b0a01eff07f502da31751fb459966bc","3045326383","openIMAdmin",0,"","",1,200,1303,"{\"detail\":\"CgozMDQ1MzI2Mzgz\",\"defaultTips\":\"remove a blocked user\",\"jsonDetail\":\"{\\"userID\\":\\"3045326383\\"}\"}",false,6,2,1663557324330,1663557324329,"",""); + INSERT INTO `chat_logs_si_7788_7789` (`client_msg_id`,`server_msg_id`,`send_id`,`recv_id`,`sender_platform_id`,`sender_nick_name`,`sender_face_url`,`session_type`,`msg_from`,`content_type`,`content`,`is_read`,`status`,`seq`,`send_time`,`create_time`,`attached_info`,`ex`) VALUES ("01d22adafe309482391fc54f728c96a7","5cb3ecb6092843e9376fd229a72b24e0","3045326383","openIMAdmin",0,"","",1,200,1303,"{\"detail\":\"CgozMDQ1MzI2Mzgz\",\"defaultTips\":\"remove a blocked user\",\"jsonDetail\":\"{\\"userID\\":\\"3045326383\\"}\"}",false,6,1,1663557189653,1663557189652,"",""),("3492347bc55280d3c5c32398f78eae50","2b0a01eff07f502da31751fb459966bc","3045326383","openIMAdmin",0,"","",1,200,1303,"{\"detail\":\"CgozMDQ1MzI2Mzgz\",\"defaultTips\":\"remove a blocked user\",\"jsonDetail\":\"{\\"userID\\":\\"3045326383\\"}\"}",false,6,2,1663557324330,1663557324329,"",""); ``` - insertMessage | 输入参数 | 类型 | 说明 |备注| | --------- | ------------------------------------------------------------ | ----- |-----------------------| +| conversationID | string | 会话ID | | | message | string | LocalChatLog（消息表对象）|对象转换成string | 返回参数 | 类型 | 说明 |备注| @@ -202,11 +378,11 @@ BatchUpdateMessageList **参考sql语句说明：** ```sql - INSERT INTO `local_chat_logs` (`client_msg_id`,`server_msg_id`,`send_id`,`recv_id`,`sender_platform_id`,`sender_nick_name`,`sender_face_url`,`session_type`,`msg_from`,`content_type`,`content`,`is_read`,`status`,`seq`,`send_time`,`create_time`,`attached_info`,`ex`) VALUES ("6edad80249cc0cf626edb88e64f8fb6d","","3045326383","2041671273",1,"Gordon111","ic_avatar_01",1,100,101,"Single chat test3045326383:2041671273:",false,1,0,1663658716992,1663658716992,"",""); + INSERT INTO `chat_logs_si_7788_7789` (`client_msg_id`,`server_msg_id`,`send_id`,`recv_id`,`sender_platform_id`,`sender_nick_name`,`sender_face_url`,`session_type`,`msg_from`,`content_type`,`content`,`is_read`,`status`,`seq`,`send_time`,`create_time`,`attached_info`,`ex`) VALUES ("6edad80249cc0cf626edb88e64f8fb6d","","3045326383","2041671273",1,"Gordon111","ic_avatar_01",1,100,101,"Single chat test3045326383:2041671273:",false,1,0,1663658716992,1663658716992,"",""); ``` -- getMultipleMessage +- getMultipleMessage（暂未使用） | 输入参数 | 类型 | 说明 |备注| | --------- | ------------------------------------------------------------ | ----- |-----------------------| @@ -228,13 +404,13 @@ SELECT * FROM `local_sg_chat_logs_4280368097` WHERE client_msg_id IN ("d9ef1e4e6 | 输入参数 | 类型 | 说明 |备注| | --------- | ------------------------------------------------------------ | ----- |-----------------------| +| conversationID | string | 会话ID | | | contentType | string | 消息类型列表，为整型数组转换后的string| +| senderUserIDList |string| 发送者用户ID列表，为字符串数组转换后的string| | keywordList | string | 关键字列表，为字符串数组转换后的string | | keywordListMatchType | 0为or匹配, 1为and匹配 | | -| sourceID | string | | 来源id 可以为用户和普通群群ID | startTime | number | 开始时间戳 | | endTime | number | 结束时间戳 | -| sessionType | number | 会话类型 | | offset | number | 偏移数 | | count | number | 获取总数 | @@ -247,21 +423,20 @@ SELECT * FROM `local_sg_chat_logs_4280368097` WHERE client_msg_id IN ("d9ef1e4e6 **参考sql语句说明：** ```sql - SELECT * FROM `local_chat_logs` WHERE session_type==1 And (send_id=="1889848740" OR recv_id=="1889848740") And send_time between 0 and 1666766907000 AND status <=3 And content_type IN (101,106) And (content like '%1%') ORDER BY send_time DESC LIMIT 20 OFFSET 0; + SELECT * FROM `chat_logs_si_7788_7789` WHERE send_time between 0 and 1666766907000 AND status <=3 And content_type IN (101,106) And (content like '%1%') And send_id IN ("123123") ORDER BY send_time DESC LIMIT 20 OFFSET 0; ``` - - searchMessageByContentType | 输入参数 | 类型 | 说明 |备注| | --------- | ------------------------------------------------------------ | ----- |-----------------------| -| contentType | string | 消息类型列表，为整型数组转换后的string| -| sourceID | string | 源ID， 可以为用户， 普通群id | +| conversationID | string | 会话ID | | +| contentType | string | 消息类型列表，为整型数组转换后的string| +| senderUserIDList |string| 发送者用户ID列表，为字符串数组转换后的string| | startTime | number | 开始时间戳 | | endTime | number | 结束时间戳 | -| sessionType | number | 会话类型 | 不能填3 | offset | number | 偏移数 | | count | number | 获取总数 | @@ -274,7 +449,7 @@ SELECT * FROM `local_sg_chat_logs_4280368097` WHERE client_msg_id IN ("d9ef1e4e6 **参考sql语句说明：** ```sql -SELECT * FROM `local_chat_logs` WHERE session_type==1 And (send_id=="3433303585" OR recv_id=="3433303585") And send_time between 0 and 1666767929000 AND status <=3 And content_type IN (101,106) ORDER BY send_time DESC LIMIT 20 OFFSET 0; +SELECT * FROM `chat_logs_sg_3123123637673` WHERE send_time between 0 AND 1730271722000 AND status <= 3 AND content_type IN (105) And send_id IN ("91750") ORDER BY send_time DESC LIMIT 20 ``` @@ -284,7 +459,9 @@ SELECT * FROM `local_chat_logs` WHERE session_type==1 And (send_id=="3433303585" | 输入参数 | 类型 | 说明 |备注| | --------- | ------------------------------------------------------------ | ----- |-----------------------| +| conversationID | string | 会话ID | | | contentType | string | 消息类型列表，为整型数组转换后的string| +| senderUserIDList |string|发送者用户ID列表，为字符串数组转换后的string| | keywordList | string | 关键字列表，为字符串数组转换后的string | | keywordListMatchType | 0为or匹配, 1为and匹配 | | | startTime | number | 开始时间戳 | @@ -300,10 +477,10 @@ SELECT * FROM `local_chat_logs` WHERE session_type==1 And (send_id=="3433303585" **参考sql语句说明：** ```sql -SELECT * FROM `local_chat_logs` WHERE send_time between 0 and 1666769211000 AND status <=3 And content_type IN (101,106) ORDER BY send_time DESC +SELECT * FROM `chat_logs_si_7788_7789` WHERE send_time between 0 and 1666769211000 AND status <=3 And content_type IN (101,106) And (content like '%1%' or content liken '%2%') AND send_id IN ("3377881") ORDER BY send_time DESC ``` -- messageIfExists +- messageIfExists（暂未使用） | 输入参数 | 类型 | 说明 |备注| | --------- | ------------------------------------------------------------ | ----- |-----------------------| @@ -318,10 +495,10 @@ SELECT * FROM `local_chat_logs` WHERE send_time between 0 and 1666769211000 AND **参考sql语句说明：** ```sql -SELECT count(*) FROM `local_chat_logs` WHERE client_msg_id == "xxx"; +SELECT count(*) FROM `chat_logs_si_7788_7789` WHERE client_msg_id == "xxx"; ``` -- isExistsInErrChatLogBySeq +- isExistsInErrChatLogBySeq（暂未使用） | 输入参数 | 类型 | 说明 |备注| | --------- | ------------------------------------------------------------ | ----- |-----------------------| @@ -339,7 +516,7 @@ SELECT count(*) FROM `local_chat_logs` WHERE client_msg_id == "xxx"; SELECT count(*) FROM `local_err_chat_logs` WHERE seq == 1; ``` -- MessageIfExistsBySeq +- MessageIfExistsBySeq（暂未使用） | 输入参数 | 类型 | 说明 |备注| | --------- | ------------------------------------------------------------ | ----- |-----------------------| @@ -354,10 +531,10 @@ SELECT count(*) FROM `local_err_chat_logs` WHERE seq == 1; **参考sql语句说明：** ```sql -SELECT count(*) FROM `local_chat_logs` WHERE seq == 1; +SELECT count(*) FROM `chat_logs_si_7788_7789` WHERE seq == 1; ``` -- UpdateGroupMessageHasRead +- UpdateGroupMessageHasRead（暂未使用） | 输入参数 | 类型 | 说明 |备注| | --------- | ------------------------------------------------------------ | ----- |-----------------------| | msgIDList | string | 消息ID列表转换后的string | @@ -371,11 +548,11 @@ SELECT count(*) FROM `local_chat_logs` WHERE seq == 1; ```sql -UPDATE `local_chat_logs` SET `is_read`=1 WHERE session_type=2 AND client_msg_id in ("a43fe26849cf4f9225262297967979f1") +UPDATE `chat_logs_si_7788_7789` SET `is_read`=1 WHERE session_type=2 AND client_msg_id in ("a43fe26849cf4f9225262297967979f1") ``` -- getMultipleMessage +- getMultipleMessage（暂未使用） | 输入参数 | 类型 | 说明 |备注| | --------- | ------------------------------------------------------------ | ----- |-----------------------| @@ -389,10 +566,10 @@ UPDATE `local_chat_logs` SET `is_read`=1 WHERE session_type=2 AND client_msg_id **参考sql语句说明：** ```sql -SELECT * FROM `local_chat_logs` WHERE client_msg_id IN ("a43fe26849cf4f9225262297967979f1") ORDER BY send_time DESC +SELECT * FROM `chat_logs_si_7788_7789` WHERE client_msg_id IN ("a43fe26849cf4f9225262297967979f1") ORDER BY send_time DESC ``` -- updateMsgSenderNickname +- updateMsgSenderNickname（暂未使用） | 输入参数 | 类型 | 说明 |备注| | --------- | ------------------------------------------------------------ | ----- |-----------------------| @@ -409,10 +586,10 @@ SELECT * FROM `local_chat_logs` WHERE client_msg_id IN ("a43fe26849cf4f922526229 **参考sql语句说明：** ```sql -UPDATE `local_chat_logs` SET `sender_nick_name`="xx" WHERE send_id = "ss" and session_type = 1 and sender_nick_name != "xx" +UPDATE `chat_logs_si_7788_7789` SET `sender_nick_name`="xx" WHERE send_id = "ss" and session_type = 1 and sender_nick_name != "xx" ``` -- updateMsgSenderFaceURL +- updateMsgSenderFaceURL（暂未使用） | 输入参数 | 类型 | 说明 |备注| | --------- | ------------------------------------------------------------ | ----- |-----------------------| @@ -429,17 +606,17 @@ UPDATE `local_chat_logs` SET `sender_nick_name`="xx" WHERE send_id = "ss" and se **参考sql语句说明：** ```sql -UPDATE `local_chat_logs` SET `sender_face_url`="xx" WHERE send_id = "ss" and session_type = 1 and sender_face_url != "xx" +UPDATE `chat_logs_si_7788_7789` SET `sender_face_url`="xx" WHERE send_id = "ss" and session_type = 1 and sender_face_url != "xx" ``` - updateMsgSenderFaceURLAndSenderNickname | 输入参数 | 类型 | 说明 |备注| | --------- | ------------------------------------------------------------ | ----- |-----------------------| +| conversationID | string | 会话ID | | | sendID | string | | | faceURL | string | | | nickname | string | | -| sType | int | sessionType | 返回参数 | 类型 | 说明 |备注| @@ -450,11 +627,11 @@ UPDATE `local_chat_logs` SET `sender_face_url`="xx" WHERE send_id = "ss" and ses **参考sql语句说明：** ```sql -UPDATE `local_chat_logs` SET `sender_face_url`="xx",`sender_nick_name`="" WHERE send_id = "ss" and session_type = 1 +UPDATE `chat_logs_si_7788_7789` SET `sender_face_url`="xx",`sender_nick_name`="" WHERE send_id = "ss" ``` -- getMsgSeqByClientMsgID +- getMsgSeqByClientMsgID（暂未使用） | 输入参数 | 类型 | 说明 |备注| | --------- | ------------------------------------------------------------ | ----- |-----------------------| @@ -469,10 +646,10 @@ UPDATE `local_chat_logs` SET `sender_face_url`="xx",`sender_nick_name`="" WHERE **参考sql语句说明：** ```sql -SELECT `seq` FROM `local_chat_logs` WHERE client_msg_id="ss" LIMIT 1 +SELECT `seq` FROM `chat_logs_si_7788_7789` WHERE client_msg_id="ss" LIMIT 1 ``` -- getMsgSeqListByGroupID +- getMsgSeqListByGroupID（暂未使用） | 输入参数 | 类型 | 说明 |备注| | --------- | ------------------------------------------------------------ | ----- |-----------------------| @@ -487,11 +664,11 @@ SELECT `seq` FROM `local_chat_logs` WHERE client_msg_id="ss" LIMIT 1 **参考sql语句说明：** ```sql -SELECT `seq` FROM `local_chat_logs` WHERE recv_id="ss" +SELECT `seq` FROM `chat_logs_si_7788_7789` WHERE recv_id="ss" ``` -- getMsgSeqListByPeerUserID +- getMsgSeqListByPeerUserID（暂未使用） | 输入参数 | 类型 | 说明 |备注| | --------- | ------------------------------------------------------------ | ----- |-----------------------| @@ -506,10 +683,10 @@ SELECT `seq` FROM `local_chat_logs` WHERE recv_id="ss" **参考sql语句说明：** ```sql -SELECT `seq` FROM `local_chat_logs` WHERE recv_id="ss" or send_id="ss" +SELECT `seq` FROM `chat_logs_si_7788_7789` WHERE recv_id="ss" or send_id="ss" ``` -- getMsgSeqListBySelfUserID +- getMsgSeqListBySelfUserID（暂未使用） | 输入参数 | 类型 | 说明 |备注| | --------- | ------------------------------------------------------------ | ----- |-----------------------| @@ -524,118 +701,200 @@ SELECT `seq` FROM `local_chat_logs` WHERE recv_id="ss" or send_id="ss" **参考sql语句说明：** ```sql - SELECT `seq` FROM `local_chat_logs` WHERE recv_id="ss" and send_id="ss" + SELECT `seq` FROM `chat_logs_si_7788_7789` WHERE recv_id="ss" and send_id="ss" ``` -local_err_chat_logs表 -```sql -CREATE TABLE "local_err_chat_logs" ( - "seq" integer, - "client_msg_id" char(64), - "server_msg_id" char(64), - "send_id" char(64), - "recv_id" char(64), - "sender_platform_id" integer, - "sender_nick_name" varchar(255), - "sender_face_url" varchar(255), - "session_type" integer, - "msg_from" integer, - "content_type" integer, - "content" varchar(1000), - "is_read" numeric, - "status" integer, - "send_time" integer, - "create_time" integer, - "attached_info" varchar(1024), - "ex" varchar(1024), - PRIMARY KEY ("seq") -); -``` -- getAbnormalMsgSeq +- deleteAllMessage（暂未使用） | 输入参数 | 类型 | 说明 |备注| | --------- | ------------------------------------------------------------ | ----- |-----------------------| | 返回参数 | 类型 | 说明 |备注| | --------- | ------------------------------------------------------------ | ----- |-----------------------| -| errCode | number | 自定义即可，0成功，非0失败 |获取不到的时候返回空数组不需要返回错误| +| errCode | number | 自定义即可，0成功，非0失败 || | errMsg | string | 详细的err信息 | -| data | uint32 | | +| data | []uint32 | 没有返回空列表| ```sql -SELECT IFNULL(max(seq),0) FROM `local_err_chat_logs` +UPDATE `chat_logs_si_7788_7789` SET `content`="",`status`=4 ``` -- getAbnormalMsgSeqList +- getAllUnDeleteMessageSeqList（暂未使用） | 输入参数 | 类型 | 说明 |备注| | --------- | ------------------------------------------------------------ | ----- |-----------------------| | 返回参数 | 类型 | 说明 |备注| | --------- | ------------------------------------------------------------ | ----- |-----------------------| -| errCode | number | 自定义即可，0成功，非0失败 |获取不到的时候返回空数组不需要返回错误| +| errCode | number | 自定义即可，0成功，非0失败 || | errMsg | string | 详细的err信息 | | data | []uint32 | 没有返回空列表| ```sql -SELECT `seq` FROM `local_err_chat_logs` +SELECT `seq` FROM `chat_logs_si_7788_7789` WHERE status != 4 ``` -- batchInsertExceptionMsg -| 输入参数 | 类型 | 说明 |备注| -| --------- | ------------------------------------------------------------ | ----- |-----------------------| -| messageList | []LocalErrChatLog | | -| 返回参数 | 类型 | 说明 |备注| -| --------- | ------------------------------------------------------------ | ----- |-----------------------| -| errCode | number | 自定义即可，0成功，非0失败 |获取不到的时候返回空数组不需要返回错误| -| errMsg | string | 详细的err信息 | -| data | []uint32 | 没有返回空列表| +- deleteConversationAllMessages +| 输入参数 | 类型 | 说明 | 备注 | +| -------------- | ------ | ------ | ---- | +| conversationID | string | 会话ID | | -```sql - INSERT INTO `local_err_chat_logs` (`client_msg_id`,`server_msg_id`,`send_id`,`recv_id`,`sender_platform_id`,`sender_nick_name`,`sender_face_url`,`session_type`,`msg_from`,`content_type`,`content`,`is_read`,`status`,`send_time`,`create_time`,`attached_info`,`ex`,`seq`) VALUES ("1","1","1","1",0,"1","1",0,0,0,"",false,0,0,0,"","",1) RETURNING `seq` +| 返回参数 | 类型 | 说明 | 备注 | +| -------- | ------ | -------------------------- | ---- | +| errCode | number | 自定义即可，0成功，非0失败 | | +| errMsg | string | 详细的err信息 | | +| data | string | 无 | | + +**参考sql语句说明：** + +``` +DELETE FROM `chat_logs_si_7788_7789` WHERE 1=1; ``` -- deleteAllMessage -| 输入参数 | 类型 | 说明 |备注| -| --------- | ------------------------------------------------------------ | ----- |-----------------------| ++ markDeleteConversationAllMessages -| 返回参数 | 类型 | 说明 |备注| -| --------- | ------------------------------------------------------------ | ----- |-----------------------| -| errCode | number | 自定义即可，0成功，非0失败 || -| errMsg | string | 详细的err信息 | -| data | []uint32 | 没有返回空列表| +| 输入参数 | 类型 | 说明 | 备注 | +| -------------- | ------ | ------ | ---- | +| conversationID | string | 会话ID | | -```sql -UPDATE `local_chat_logs` SET `content`="",`status`=4 +| 返回参数 | 类型 | 说明 | 备注 | +| -------- | ------ | -------------------------- | ------------------------ | +| errCode | number | 自定义即可，0成功，非0失败 | 如果删除失败需要返回错误 | +| errMsg | string | 详细的err信息 | | + +**参考sql语句说明：** + +``` +UPDATE `chat_logs_si_7788_7789` SET `status` = 2 WHERE (1 = 1) AND (`conversation_id` = 'conversationID'); ``` -- getAllUnDeleteMessageSeqList -| 输入参数 | 类型 | 说明 |备注| -| --------- | ------------------------------------------------------------ | ----- |-----------------------| ++ getUnreadMessage -| 返回参数 | 类型 | 说明 |备注| -| --------- | ------------------------------------------------------------ | ----- |-----------------------| -| errCode | number | 自定义即可，0成功，非0失败 || -| errMsg | string | 详细的err信息 | -| data | []uint32 | 没有返回空列表| +| 输入参数 | 类型 | 说明 | 备注 | +|----------------| ------ |--| ---- | +| conversationID | string | 会话ID | | +| loginUserID | string | 用户ID | | + + +| 返回参数 | 类型 | 说明 | 备注 | +|---------| ------ |-------------------------------------|--------------| +| errCode | number | 自定义即可，0成功，非0失败 | 如果找不到不需要返回错误 | +| errMsg | string | 详细的err信息 | | +| data | string | []LocalChatLog（消息表对象数组数据）转换后的string | | + +**参考sql语句说明：** + +``` +select * from chat_logs_si_7788_7789 where send_id != "7788" And is_read = 0; +``` + + + ++ markConversationMessageAsReadBySeqs + +| 输入参数 | 类型 | 说明 | 备注 | +|----------------| ------ |--| ---- | +| conversationID | string | 会话ID | | +| seqs | string | 整型数组转换后的string | | +| loginUserID | string | 用户ID | | + + +| 返回参数 | 类型 | 说明 | 备注 | +|---------|--------|-------------------|--------------| +| errCode | number | 自定义即可，0成功，非0失败 | | +| errMsg | string | 详细的err信息 | | +| data | number | 更新影响的行数 | | + +**参考sql语句说明：** -```sql -SELECT `seq` FROM `local_chat_logs` WHERE status != 4 ``` +UPDATE `chat_logs_si_7788_7789` SET `is_read`=1 WHERE `seq` IN (1,2) And send_id != "7788"; +``` + + + + ++ markConversationMessageAsReadDB + +| 输入参数 | 类型 | 说明 | 备注 | +|----------------| ------ |--| ---- | +| conversationID | string | 会话ID | | +| msgIDs | string | 消息ID字符串数组转换后的string | | +| loginUserID | string | 用户ID | | + + +| 返回参数 | 类型 | 说明 | 备注 | +|---------|--------|-------------------|--------------| +| errCode | number | 自定义即可，0成功，非0失败 | | +| errMsg | string | 详细的err信息 | | +| data | number | 更新影响的行数 | | + +**参考sql语句说明：** + +``` +UPDATE `chat_logs_si_7788_7789` SET `is_read`=1 WHERE `client_msg_id` IN ("34343434","234234324234") And send_id != "7788"; +``` + + + ++ updateColumnsMessage + +| 输入参数 | 类型 | 说明 | 备注 | +|----------------| ------ |--| ---- | +| conversationID | string | 会话ID | | +| clientMsgID | string | 消息ID | | +| args | string | map转换成的string | | + + +| 返回参数 | 类型 | 说明 | 备注 | +|---------|--------|------------------|--------------| +| errCode | number | 自定义即可，0成功，非0失败 | | +| errMsg | string | 详细的err信息 | | +| data | string | | | + +**参考sql语句说明：** + +``` +UPDATE `chat_logs_si_7788_7789` SET `attached_info`="24234" WHERE `client_msg_id` = '2342342343'; + +``` + -- updateSingleMessageHasRead ++ deleteConversationMsgs + +| 输入参数 | 类型 | 说明 | 备注 | +| -------------- |--------|-----------------------------------| ---- | +| conversationID | string | 会话ID | | +| msgIDs | string | 待删除消息的 clientMsgID 字符串数组转换的string | | + +| 返回参数 | 类型 | 说明 | 备注 | +| -------- | ------ | -------------------------- | ---- | +| errCode | number | 自定义即可，0成功，非0失败 | | +| errMsg | string | 详细的err信息 | | +| data | | | | + +**参考sql语句说明：** + +``` +DELETE FROM `chat_logs_si_7788_7789` WHERE client_msg_id IN ('063031b86f8e503c6038efb2b835f216', '063031b86f8e503c6038efb2b835f217', '063031b86f8e503c6038efb2b835f218'); +``` + + + + +- updateSingleMessageHasRead(暂未使用) | 输入参数 | 类型 | 说明 |备注| | --------- | ------------------------------------------------------------ | ----- |-----------------------| @@ -650,12 +909,12 @@ SELECT `seq` FROM `local_chat_logs` WHERE status != 4 | data | []uint32 | 没有返回空列表| ```sql -UPDATE `local_chat_logs` SET `is_read`=1 WHERE send_id="s" AND session_type=1 AND client_msg_id in ("sss") +UPDATE `chat_logs_si_7788_7789` SET `is_read`=1 WHERE send_id="s" AND session_type=1 AND client_msg_id in ("sss") ``` -- updateGroupMessageHasRead +- updateGroupMessageHasRead(暂未使用) | 输入参数 | 类型 | 说明 |备注| | --------- | ------------------------------------------------------------ | ----- |-----------------------| @@ -670,10 +929,10 @@ UPDATE `local_chat_logs` SET `is_read`=1 WHERE send_id="s" AND session_type=1 A | data | number | | ```sql -UPDATE `local_chat_logs` SET `is_read`=1 WHERE session_type=3 AND client_msg_id in ("12","ds") +UPDATE `chat_logs_si_7788_7789` SET `is_read`=1 WHERE session_type=3 AND client_msg_id in ("12","ds") ``` -- updateMessageStatusBySourceID +- updateMessageStatusBySourceID(暂未使用) | 输入参数 | 类型 | 说明 |备注| | --------- | ------------------------------------------------------------ | ----- |-----------------------| @@ -682,8 +941,6 @@ UPDATE `local_chat_logs` SET `is_read`=1 WHERE session_type=3 AND client_msg_id | sessionType | number | 会话类型，单聊1、读扩散群2、大群为3 || | loginUserID | string | 用户登录ID |需要根据会话的类型和sourceID判断，当sessionType为1并且sourceID为登录者ID时候，sql为 AND| - - | 返回参数 | 类型 | 说明 |备注| | --------- | ------------------------------------------------------------ | ----- |-----------------------| | errCode | number | 自定义即可，0成功，非0失败 |如果没更新到任何一行消息也返回错误| @@ -692,16 +949,62 @@ UPDATE `local_chat_logs` SET `is_read`=1 WHERE session_type=3 AND client_msg_id ```sql -- 1、sessionType == 1 && sourceID == d.loginUserID -UPDATE `local_chat_logs` SET `status`=4, WHERE session_type=1 AND send_id= "ss" AND recv_id="ss" +UPDATE `chat_logs_si_7788_7789` SET `status`=4, WHERE session_type=1 AND send_id= "ss" AND recv_id="ss" -- 2、 -UPDATE `local_chat_logs` SET `status`=4, WHERE session_type=1 AND (send_id= "ss" or recv_id="ss") +UPDATE `chat_logs_si_7788_7789` SET `status`=4, WHERE session_type=1 AND (send_id= "ss" or recv_id="ss") +``` + + + ++ MarkConversationAllMessageAsRead + +| 输入参数 | 类型 | 说明 | 备注 | +|----------------| ------ |--| ---- | +| conversationID | string | 会话ID | | +| loginUserID | string | 用户ID | | + + +| 返回参数 | 类型 | 说明 | 备注 | +|---------|--------|-------------------|--------------| +| errCode | number | 自定义即可，0成功，非0失败 | | +| errMsg | string | 详细的err信息 | | +| data | number | 更新影响的行数 | | + +**参考sql语句说明：** + +``` +UPDATE `chat_logs_si_7788_7789` SET `is_read`=1 WHERE `is_read`=0 And send_id != "7788"; +``` + + + ++ deleteConversationMsgsBySeqs（暂未使用） + +| 输入参数 | 类型 | 说明 | 备注 | +| -------------- | -------- | ---------------------------------------------------- | ---- | +| conversationID | string | 会话ID | | +| seqs | []number | 需要删除的消息序列号，可以传入多个序列号，以数组形式 | | + +| 返回参数 | 类型 | 说明 | 备注 | +| -------- | ------ | -------------------------- | ---- | +| errCode | number | 自定义即可，0成功，非0失败 | | +| errMsg | string | 详细的err信息 | | +| data | | | | + +**参考 sql 语句说明：** + +```sql +DELETE FROM `chat_logs_si_7788_7789` WHERE seq IN (1, 2, 3); ``` + + - searchAllMessageByContentType -| 输入参数 | 类型 | 说明 |备注| -| --------- | ------------------------------------------------------------ | ----- |-----------------------| -| contentType | number | 消息类型 || +| 输入参数 | 类型 | 说明 |备注| +|----------------|--------|------|-----------------------| +| conversationID | string | 会话ID || +| contentType | number | 消息类型 || | 返回参数 | 类型 | 说明 |备注| | --------- | ------------------------------------------------------------ | ----- |-----------------------| @@ -711,6 +1014,54 @@ UPDATE `local_chat_logs` SET `status`=4, WHERE session_type=1 AND (send_id= "ss" **参考sql语句说明：** ```sql -SELECT * FROM `local_chat_logs` WHERE content_type = 114 +SELECT * FROM `chat_logs_si_7788_7789` WHERE content_type = 114 + +``` + + +- getLatestActiveMessage + +| 输入参数 | 类型 | 说明 |备注| +|----------------| ------------------------------------------------------------ |---------------------|-----------------------| +| conversationID | string | 会话ID | +| isReverse | boolean | 消息为正向拉取还是反向拉取 |默认情况为false，即为正向拉取（从新消息到老消息），order by 后面的排序规则为send_time DESC 降序排列，当为true的情况，即为反向拉取，order by 后面的排序规则为send_time ASC 升序排列| + + +| 返回参数 | 类型 | 说明 |备注| +| --------- | ------------------------------------------------------------ | ----- |-----------------------| +| errCode | number | 自定义即可，0成功，非0失败 |获取不到的时候返回空数组不需要返回错误| +| errMsg | string | 详细的err信息 || +| data | string | []LocalChatLog（消息表对象数组数据） |对象转换成string| + +**参考sql语句说明：** + +```sql +SELECT * FROM `chat_logs_si_7788_7789` +WHERE `status` < 4 +ORDER BY `send_time` DESC +LIMIT 1; + +``` + +- getLatestValidServerMessage +>>获取有效的带seq的消息，用于内部消息块之间断层检测 +> +| 输入参数 | 类型 | 说明 | 备注 | +|----------------| ------------------------------------------------------------ |---------------------|------------------------------------------------------------------------------------------------------------------------------------------------| +| conversationID | string | 会话ID | +| startTime | number | 消息发送时间，毫秒 || +| isReverse | boolean | 消息为正向拉取还是反向拉取 | isReverse为true send_time < startTime,order by 后面的排序规则为send_time DESC 降序排列，当为false的情况，order by 后面的排序规则为send_time send_time > startTime ASC 升序排列 | + + +| 返回参数 | 类型 | 说明 |备注| +| --------- | ------------------------------------------------------------ | ----- |-----------------------| +| errCode | number | 自定义即可，0成功，非0失败 | 如果获取不到消息也需要返回错误 | +| errMsg | string | 详细的err信息 || +| data | string | LocalChatLog（消息表对象数据） | 对象转换成string | + +**参考sql语句说明：** + +```sql +SELECT * FROM `chat_logs_sg_93606743` WHERE send_time < 1710774468519 AND seq != 0 ORDER BY send_time DESC LIMIT 1 ``` \ No newline at end of file diff --git a/local_app_sdk_version.md b/local_app_sdk_version.md new file mode 100644 index 0000000..151b30d --- /dev/null +++ b/local_app_sdk_version.md @@ -0,0 +1,57 @@ +# Js 实现 db 接口简要说明(待更新) + +## 表结构以及需要实现的接口说明 + +> 所有的 db 接口返回值，统一由 `errCode`, `errMsg`, `data` 字段转换为字符串异步返回 + +### APP SDK 版本表 + +- 表名：local_app_sdk_version + +```sqlite +CREATE TABLE `local_app_sdk_version` ( + `version` varchar(255), + `installed` numeric, + PRIMARY KEY (`version`) +) +``` + +#### 接口说明： + +- getAppSDKVersion + +**无输入参数** + +| 返回参数 | 类型 | 说明 | 备注 | +| -------- | ------ | --------------------------------- | ------------------------ | +| errCode | number | 自定义即可，0 成功，非 0 失败 | 如果获取不到信息需要返回错误 | +| errMsg | string | 详细的 err 信息 | | +| data | string | LocalAppSDKVersion （表对象数据） | 对象转换成 string | + +**参考 sql 语句说明：** + +```sqlite +SELECT * FROM `local_app_sdk_version` LIMIT 1 +``` + +- setAppSDKVersion + +| 输入参数 | 类型 | 说明 | 备注 | +| ------------------ | ------ | -------------- | ----------------- | +| LocalAppSDKVersion | string | （表对象数据） | 对象转换成 string | + +| 返回参数 | 类型 | 说明 | 备注 | +| -------- | ------ | ----------------------------- | ---- | +| errCode | number | 自定义即可，0 成功，非 0 失败 | | +| errMsg | string | 详细的 err 信息 | | + +```sql +-- 若初始化未找到版本，则创建 +INSERT INTO `local_app_sdk_version` (`version`) VALUES ("3.8.0"); + +-- 若已经存在版本，则更新 +UPDATE `local_app_sdk_version` +SET `version`= "4.0.0" +WHERE + `version` = "3.8.0" +``` diff --git a/local_black.md b/local_black.md index c751f6d..39dc03c 100644 --- a/local_black.md +++ b/local_black.md @@ -6,7 +6,7 @@ ### 黑名单表 -- 表名：local_blacks +- 表名： ```sqlite create table local_blacks @@ -31,11 +31,13 @@ create table local_blacks **无输入参数** -| 返回参数 | 类型 | 说明 | 备注 | -|---------|--------|----------------|-----| -| errCode | number | 自定义即可，0成功，非0失败 | | -| errMsg | string | 详细的err信息 | | -| data | string | []LocalBlack （表对象数据） |对象转换成string| +| 返回参数 | 类型 | 说明 | 备注 | +| --------- |--------| ----- |-----| +| errCode | number | 自定义即可，0成功，非0失败 | | +| errMsg | string | 详细的err信息 | | +| data | string | []LocalBlack（表对象数据） |数组对象转换成string| + +**参考sql语句说明：** ```sqlite SELECT * @@ -46,91 +48,127 @@ FROM `local_blacks` **无输入参数** -| 返回参数 | 类型 | 说明 | 备注 | -|---------|--------|-------------------|-----| -| errCode | number | 自定义即可，0成功，非0失败 | | -| errMsg | string | 详细的err信息 | | -| data | string | []string （表对象数据） |对象转换成string| +| 返回参数 | 类型 | 说明 | 备注 | +| --------- |--------| ----- |-----| +| errCode | number | 自定义即可，0成功，非0失败 | | +| errMsg | string | 详细的err信息 | | +| data | string |[]blackListUid | 对象转换成string | + +**参考sql语句说明：** ```sqlite SELECT `block_user_id` FROM `local_blacks` ``` +- getBlackInfoByBlockUserID + +| 输入参数 | 类型 | 说明 | 备注 | +| --------- |--------| ----- |-----| +| blockUserID | string | | | +| ownerUserID | string | | | + +| 返回参数 | 类型 | 说明 | 备注 | +| --------- |--------| ----- |-----| +| errCode | number | 自定义即可，0成功，非0失败 | | +| errMsg | string | 详细的err信息 | | +| data | string | LocalBlack（表对象数据） |对象转换成string| + +**参考sql语句说明：** + +```sqlite +SELECT * +FROM `local_blacks` +WHERE owner_user_id = "3433303585" + AND block_user_id = "456" +LIMIT 1 +``` + - getBlackInfoList -| 输入参数 | 类型 | 说明 | 备注 | -|-------------------|----------|-----|-----| -| blockUserIDList | []string | | | +| 输入参数 | 类型 | 说明 | 备注 | +| --------- |--------| ----- |-----| +| blockUserIDList | string |[]string | 黑名单userid数组转为String| + +| 返回参数 | 类型 | 说明 | 备注 | +| --------- |--------| ----- |-----| +| errCode | number | 自定义即可，0成功，非0失败 | | +| errMsg | string | 详细的err信息 | | +| data | string | []LocalBlack（表对象数据） |数组对象转换成string| -| 返回参数 | 类型 | 说明 | 备注 | -|---------|--------|-----------------------|-----| -| errCode | number | 自定义即可，0成功，非0失败 | | -| errMsg | string | 详细的err信息 | | -| data | string | []LocalGroup （表对象数据） |对象转换成string| +**参考sql语句说明：** ```sqlite SELECT * FROM `local_blacks` -WHERE block_user_id IN ("123") +WHERE block_user_id IN ("456") ``` - insertBlack -| 输入参数 | 类型 | 说明 | 备注 | -| --------- |--------| ----- |----------| -|LocalBlack | string | （表对象数据） |对象转换成string| +| 输入参数 | 类型 | 说明 | 备注 | +| --------- |--------| ----- |-----| +| LocalBlack | string |（表对象数据） |对象转换成string| -| 返回参数 | 类型 | 说明 | 备注 | -| --------- | ------------ | ----- |-----| -| errCode | number | 自定义即可，0成功，非0失败 | | -| errMsg | string | 详细的err信息 | | +| 返回参数 | 类型 | 说明 | 备注 | +| --------- |--------| ----- |-----| +| errCode | number | 自定义即可，0成功，非0失败 | | +| errMsg | string | 详细的err信息 | | **参考sql语句说明：** ```sqlite INSERT INTO `local_blacks` (`owner_user_id`, `block_user_id`, `nickname`, `face_url`, `gender`, `create_time`, `add_source`, `operator_user_id`, `ex`, `attached_info`) -VALUES ("123", "456", "HELLO", "", 1, 1666779750, 1, "789", "", "") +VALUES ("123", "456", "hello", "", 1, 1666866302, 1, "789", "asdasdasa", "asdasds") +``` + +- updateBlack + +| 输入参数 | 类型 | 说明 | 备注 | +| --------- |--------| ----- |-----| +| LocalBlack | string |（表对象数据） |对象转换成string| + +| 返回参数 | 类型 | 说明 | 备注 | +| --------- |--------| ----- |-----| +| errCode | number | 自定义即可，0成功，非0失败 | | +| errMsg | string | 详细的err信息 | | + +**参考sql语句说明：** + +```sqlite +UPDATE `local_blacks` +SET `nickname`="hello", + `gender`=1, + `create_time`=1666866338, + `add_source`=1, + `operator_user_id`="789", + `ex`="asdasdasa", + `attached_info`="asdasds" +WHERE `owner_user_id` = "123" + AND `block_user_id` = "456" ``` - deleteBlack -| 输入参数 | 类型 | 说明 | 备注 | -| --------- |--------|-----|-----| -|blockUserID| string | | | +| 输入参数 | 类型 | 说明 | 备注 | +| --------- |--------| ----- |-----| +| blockUserID | string | | | | ownerUserId | string | | -| 返回参数 | 类型 | 说明 | 备注 | -| --------- | ------------ | ----- |-----| -| errCode | number | 自定义即可，0成功，非0失败 | | -| errMsg | string | 详细的err信息 | | +| 返回参数 | 类型 | 说明 | 备注 | +| --------- |--------| ----- |-----| +| errCode | number | 自定义即可，0成功，非0失败 | | +| errMsg | string | 详细的err信息 | | + +**参考sql语句说明：** ```sqlite DELETE FROM `local_blacks` WHERE owner_user_id = "3433303585" - and block_user_id = "123" + and block_user_id = "456" ``` -- updateBlack -| 输入参数 | 类型 | 说明 | 备注 | -| --------- |--------| ----- |----------| -|LocalBlack | string |（表对象数据） |对象转换成string| -| 返回参数 | 类型 | 说明 | 备注 | -| --------- | ------------ | ----- |-----| -| errCode | number | 自定义即可，0成功，非0失败 | 获取不到报错 | -| errMsg | string | 详细的err信息 | | - -```sqlite -UPDATE `local_blacks` -SET `nickname`="HELLO", - `gender`=1, - `create_time`=1666779794, - `add_source`=1, - `operator_user_id`="789" -WHERE `owner_user_id` = "123" - AND `block_user_id` = "456" -``` \ No newline at end of file diff --git a/local_chat_log_reaction_extensions.md b/local_chat_log_reaction_extensions.md index 89467c3..2c1dafd 100644 --- a/local_chat_log_reaction_extensions.md +++ b/local_chat_log_reaction_extensions.md @@ -1,4 +1,4 @@ -# Js实现db接口简要说明(待更新) +# Js实现db接口简要说明(暂时不实现) ## 表结构以及需要实现的接口说明 >所有的db接口返回值，统一由errCode,errMsg,data字段转换为字符串异步返回 ### 消息扩展信息表 diff --git a/local_conversation.md b/local_conversation.md index d15fda9..ececc8c 100644 --- a/local_conversation.md +++ b/local_conversation.md @@ -30,7 +30,12 @@ create table local_conversations is_not_in_group numeric, update_unread_count_time INTEGER, attached_info varchar(1024), - ex varchar(1024) + ex varchar(1024), + `max_seq` integer, + `min_seq` integer, + `has_read_seq` integer, + `msg_destruct_time` integer DEFAULT 604800, + `is_msg_destruct` numeric DEFAULT false, ); create index index_latest_msg_send_time @@ -115,6 +120,64 @@ SELECT * FROM `local_conversations` ``` +- findAllUnreadConversationConversationID + +**无输入参数** + +| 返回参数 | 类型 | 说明 | 备注 | +| --------- |--------|------------------|--------| +| errCode | number | 自定义即可，0成功，非0失败 | | +| errMsg | string | 详细的err信息 | | +| data | string | []ConversationID | 会话ID列表 | + +**参考sql语句说明：** + +```sqlite +SELECT conversation_id +FROM `local_conversations` +WHERE unread_count > 0 +``` + ++ getAllSingleConversationIDList + +| 输入参数 | 类型 | 说明 | 备注 | +| -------- | ---- | ---- | ---- | +| | | | | + +| 返回参数 | 类型 | 说明 | 备注 | +| -------- | -------- | -------------------------------------------- | ---- | +| errCode | number | 自定义即可，0成功，非0失败 | | +| errMsg | string | 详细的err信息 | | +| data | string | 所有单聊会话的 conversation_id（会话ID）列表 | 会话id数组 转 String | + +参考 SQL 语句说明： + +``` +SELECT conversation_id FROM `local_conversations` WHERE conversation_type = 1 +``` + + + ++ getAllConversationIDList + +| 输入参数 | 类型 | 说明 | 备注 | +| -------- | ---- | ---- | ---- | +| | | | | + +| 返回参数 | 类型 | 说明 | 备注 | +| -------- | -------- | -------------------------------------------- | ---- | +| errCode | number | 自定义即可，0成功，非0失败 | | +| errMsg | string | 详细的err信息 | | +| data | string | 所有单聊会话的 conversation_id（会话ID）列表 | 单聊会话id数组 转 String | + +参考 SQL 语句说明： + +``` +SELECT conversation_id FROM `local_conversations`; +``` + + + - getConversationListSplit | 输入参数 | 类型 | 说明 | 备注 | @@ -163,6 +226,34 @@ VALUES ("123141", 0, "123", "12", "1213121", "", 0, 0, 0, "", 1666851360, "", 16 "", "") ``` + + +- UpdateOrCreateConversations(暂时忽略) + +| 输入参数 | 类型 | 说明 | 备注 | +| ---------------- | ------------------------ | ---------------- | ---- | +| conversationList | []LocalConversation 对象 | 会话列表对象数组 | | + +| 返回参数 | 类型 | 说明 | 备注 | +| -------- | ------ | --------------- | ------------------ | +| errCode | number | 自定义即可 | 0为成功，非0为失败 | +| errMsg | string | 详细的 err 信息 | | +| data | string | 无 | 对象转换成string | + + + +**参考sql语句说明：** + +```sql +-- 获取所有 conversation_id +SELECT conversation_id FROM `local_conversations` ; + +-- 插入会话列表 +INSERT INTO `local_conversations` (`conversation_id`,`session_type`,`source_id`,`target_id`,`unread_count`,`update_time`) VALUES (?,?,?,?,?,?) ON DUPLICATE KEY UPDATE `unread_count`=VALUES(`unread_count`); +``` + + + - insertConversation | 输入参数 | 类型 | 说明 | 备注 | @@ -205,6 +296,23 @@ FROM `local_conversations` WHERE conversation_id = "123141" ``` +- deleteAllConversation + +**无输入参数** + +| 返回参数 | 类型 | 说明 | 备注 | +| --------- |--------| ----- |-----| +| errCode | number | 自定义即可，0成功，非0失败 | | +| errMsg | string | 详细的err信息 | | + +**参考sql语句说明：** + + +```sql +DELETE FROM local_conversations; +``` + + - getConversation | 输入参数 | 类型 | 说明 | 备注 | @@ -480,10 +588,10 @@ where conversation_id = "123141" | conversationID | string | | | | args | map[string]interface{} | | | -| 返回参数 | 类型 | 说明 | 备注 | -| --------- |--------| ----- |---------| -| errCode | number | 自定义即可，0成功，非0失败 | 获取不到报错 | -| errMsg | string | 详细的err信息 | | +| 返回参数 | 类型 | 说明 | 备注 | +| --------- |--------| ----- |--| +| errCode | number | 自定义即可，0成功，非0失败 | 未更新到一行需要报错 | +| errMsg | string | 详细的err信息 | | **参考sql语句说明：** @@ -571,7 +679,7 @@ WHERE `conversation_id` = "123141" ```sqlite SELECT `unread_count` FROM `local_conversations` -WHERE recv_msg_opt < 2 +WHERE recv_msg_opt < 2 and latest_msg_send_time > 0 ``` - setMultipleConversationRecvMsgOpt @@ -637,5 +745,25 @@ WHERE conversation_id = "123141" LIMIT 1 ``` +- getAllConversations + +**无输入参数** + +| 返回参数 | 类型 | 说明 | 备注 | +| --------- |--------|----------------------------|-----| +| errCode | number | 自定义即可，0成功，非0失败 |获取不到报错 | +| errMsg | string | 详细的err信息 | | +| data | string | []LocalConversation（表对象数据） |对象转换成string| + + +**参考sql语句说明：** + +```sqlite +select * from local_conversations; +``` + + + + diff --git a/local_friend.md b/local_friend.md index 4c583b7..cc28e27 100644 --- a/local_friend.md +++ b/local_friend.md @@ -19,10 +19,10 @@ create table local_friends operator_user_id varchar(64), name varchar(255), face_url varchar(255), - gender INTEGER, - phone_number varchar(32), - birth INTEGER, - email varchar(64), +-- gender INTEGER, +-- phone_number varchar(32), +-- birth INTEGER, +-- email varchar(64), ex varchar(1024), attached_info varchar(1024), primary key (owner_user_id, friend_user_id) @@ -48,17 +48,17 @@ create table local_friends ```sqlite INSERT INTO `local_friends` (`owner_user_id`, `friend_user_id`, `remark`, `create_time`, `add_source`, - `operator_user_id`, `name`, `face_url`, `gender`, `phone_number`, `birth`, `email`, `ex`, + `operator_user_id`, `name`, `face_url`, `ex`, `attached_info`) -VALUES ("123", "456", "hello", 1666778999, 0, "789", "hhhh", "", 1, "13000000000", 1666778999, "123@qq.com", "", "") +VALUES ("123", "456", "hello", 1666778999, 0, "789", "hhhh", "", "", "") ``` - deleteFriend -| 输入参数 | 类型 | 说明 | 备注 | -| --------- |--------|-----|-----| -|friendUserID| string | | | -|ownerUserID| string | | | +| 输入参数 | 类型 | 说明 | 备注 | +|--------------|--------|-----|-----| +| friendUserID | string | | | +| loginUserID | string | | | | 返回参数 | 类型 | 说明 | 备注 | @@ -70,6 +70,20 @@ VALUES ("123", "456", "hello", 1666778999, 0, "789", "hhhh", "", 1, "13000000000 DELETE FROM `local_friends` WHERE owner_user_id="3433303585" and friend_user_id="x" ``` +- getFriendListCount + +**无输入参数** + +| 返回参数 | 类型 | 说明 | 备注 | +| --------- | ------------ | ----- |-----| +| errCode | number | 自定义即可，0成功，非0失败 | 如果获取不到信息需要返回错误 | +| errMsg | string | 详细的err信息 | | +| data | string | FriendListCount || + +```sqlite +SELECT COUNT(*) FROM `local_friends`; +``` + - updateFriend | 输入参数 | 类型 | 说明 | 备注 | @@ -91,14 +105,10 @@ SET `owner_user_id`="123", `operator_user_id`="789", `name`="hhhh", `face_url`="", - `gender`=1, - `phone_number`="13000000000", - `birth`=1666779080, - `email`="123@qq.com", `ex`="", `attached_info`="" -WHERE `owner_user_id` = "123" - AND `friend_user_id` = "456" +where `owner_user_id`="123" + and `friend_user_id`="456" ``` - getAllFriendList @@ -121,6 +131,59 @@ FROM `local_friends` WHERE owner_user_id = "3433303585" ``` +- getPageFriendList + +| 输入参数 | 类型 | 说明 | 备注 | +|--------|-----|-----|--------| +| offset | int | | 跳过数据行数 | +| count | int | | 取出数据数量 | +|ownerUserID | string | | | + + +| 返回参数 | 类型 | 说明 | 备注 | +|---------|--------|----------------|-----| +| errCode | number | 自定义即可，0成功，非0失败 | | +| errMsg | string | 详细的err信息 | | +| data | string | []LocalFriend （表对象数据） |对象转换成string| + +```sqlite +SELECT * +FROM `local_friends` +WHERE owner_user_id = "3433303585" +ORDER BY name +LIMIT 5 +offset 10 +``` + +- batchInsertFriend + +| 输入参数 | 类型 | 说明 | 备注 | +| --------- |--------| ----- |----------| +|LocalFriend | string | （表对象数据）数组 |数组对象转换成string| + +| 返回参数 | 类型 | 说明 | 备注 | +| --------- | ------------ | ----- |-----| +| errCode | number | 自定义即可，0成功，非0失败 | | +| errMsg | string | 详细的err信息 | | + +```sqlite +INSERT INTO `local_friends` (`owner_user_id`, `friend_user_id`, `remark`, `create_time`, `add_source`, `operator_user_id`, `name`, `face_url`, `ex`, `attached_info`, `is_pinned`) + VALUES('1695766238', '1234567890', 'hello', 1666778999, 0, '789', 'hhhh', '', '', '', FALSE), ('1695766238', '1234567891', 'hi', 1666779000, 1, '790', 'aaaa', 'https://example.com/face.png', 'example', 'info', TRUE), ; +``` + +- deleteAllFriend + +**无输入参数** + +| 返回参数 | 类型 | 说明 | 备注 | +| --------- | ------------ | ----- |-----| +| errCode | number | 自定义即可，0成功，非0失败 | | +| errMsg | string | 详细的err信息 | | + +``` sqlite +DELETE FROM `local_friends` +``` + - searchFriendList | 输入参数 | 类型 | 说明 | 备注 | @@ -152,11 +215,11 @@ ORDER BY create_time DESC | friendUserID | string | | | | ownerUserID | string | | | -| 返回参数 | 类型 | 说明 | 备注 | -|---------|--------|----------------|-----| -| errCode | number | 自定义即可，0成功，非0失败 | | -| errMsg | string | 详细的err信息 | | -| data | string | LocalGroup （表对象数据） |对象转换成string| +| 返回参数 | 类型 | 说明 | 备注 | +|---------|--------|----------------------|-----| +| errCode | number | 自定义即可，0成功，非0失败 | | +| errMsg | string | 详细的err信息 | | +| data | string | LocalFriend （表对象数据） |对象转换成string| ```sqlite SELECT * diff --git a/local_friend_request.md b/local_friend_request.md index 6c65d04..72095ea 100644 --- a/local_friend_request.md +++ b/local_friend_request.md @@ -14,11 +14,11 @@ create table local_friend_requests from_user_id varchar(64), from_nickname varchar(255), from_face_url varchar(255), - from_gender INTEGER, +-- from_gender INTEGER, to_user_id varchar(64), to_nickname varchar(255), to_face_url varchar(255), - to_gender INTEGER, +-- to_gender INTEGER, handle_result INTEGER, req_msg varchar(255), create_time INTEGER, @@ -47,11 +47,11 @@ create table local_friend_requests **参考sql语句说明：** ```sqlite -INSERT INTO `local_friend_requests` (`from_user_id`, `from_nickname`, `from_face_url`, `from_gender`, `to_user_id`, - `to_nickname`, `to_face_url`, `to_gender`, `handle_result`, `req_msg`, +INSERT INTO `local_friend_requests` (`from_user_id`, `from_nickname`, `from_face_url`, `to_user_id`, + `to_nickname`, `to_face_url`, , `handle_result`, `req_msg`, `create_time`, `handler_user_id`, `handle_msg`, `handle_time`, `ex`, `attached_info`) -VALUES ("123", "123", "", 1, "457", "457", "", 1, 0, "", 1666838764, "", "", 1666838764, "", "") +VALUES ("123", "123", "", "457", "457", "", 0, "", 1666838764, "", "", 1666838764, "", "") ``` - deleteFriendRequestBothUserID @@ -89,11 +89,9 @@ UPDATE `local_friend_requests` SET `from_user_id`="123", `from_nickname`="123", `from_face_url`="", - `from_gender`=1, `to_user_id`="457", `to_nickname`="457", `to_face_url`="", - `to_gender`=1, `handle_result`=0, `req_msg`="", `create_time`=1666838873, @@ -151,7 +149,7 @@ ORDER BY create_time DESC | 输入参数 | 类型 | 说明 | 备注 | | --------- |--------|-----|-----| |fromUserID | string | | | -|toUserID | boolean | | | +|toUserID | string | | | | 返回参数 | 类型 | 说明 | 备注 | |---------|--------|----------------|-----| @@ -165,4 +163,24 @@ FROM `local_friend_requests` WHERE from_user_id = "457" AND to_user_id = "123" LIMIT 1 +``` + +- GetBothFriendReq + +| 输入参数 | 类型 | 说明 | 备注 | +| --------- |--------| ----- |----------| +|fromUserID | string | || +|toUserID | string | || + + +| 返回参数 | 类型 | 说明 | 备注 | +| --------- | ------------ | ----- |-----| +| errCode | number | 自定义即可，0成功，非0失败 | 获取不到报错 | +| errMsg | string | 详细的err信息 | | +| data | string | []string | 对象转换成string | + + + +```sqlite +SELECT * FROM `friend_requests` WHERE (from_user_id = '3489932643' AND to_user_id = '5345125128') OR (from_user_id = '5345125128' AND to_user_id = '3489932643') ``` \ No newline at end of file diff --git a/local_group.md b/local_group.md index 85c2762..d275f41 100644 --- a/local_group.md +++ b/local_group.md @@ -9,26 +9,28 @@ - 表名：local_groups ```sqlite -CREATE TABLE local_groups +CREATE TABLE `local_groups` ( - group_id varchar(64) PRIMARY KEY, - name TEXT, - notification varchar(255), - introduction varchar(255), - face_url varchar(255), - create_time INTEGER, - status INTEGER, - creator_user_id varchar(64), - group_type INTEGER, - owner_user_id varchar(64), - member_count INTEGER, - ex varchar(1024), - attached_info varchar(1024), - need_verification INTEGER, - look_member_info INTEGER, - apply_member_friend INTEGER, - notification_update_time INTEGER, - notification_user_id TEXT + `group_id` varchar(64), + `name` text, + `notification` varchar(255), + `introduction` varchar(255), + `face_url` varchar(255), + `create_time` integer, + `status` integer, + `creator_user_id` varchar(64), + `group_type` integer, + `owner_user_id` varchar(64), + `member_count` integer, + `ex` varchar(1024), + `attached_info` varchar(1024), + `need_verification` integer, + `look_member_info` integer, + `apply_member_friend` integer, + `notification_update_time` integer, + `notification_user_id` text, + `display_is_read` numeric, + PRIMARY KEY (`group_id`) ) ``` @@ -38,7 +40,7 @@ CREATE TABLE local_groups | 输入参数 | 类型 | 说明 | 备注 | | --------- |--------| ----- |----------| -|LocalGroup | string | （表对象数据） |对象转换成string| +|LocalGroup | string | （LocalGroup 表对象数据） |对象转换成string| | 返回参数 | 类型 | 说明 | 备注 | | --------- | ------------ | ----- |-----| @@ -51,10 +53,12 @@ CREATE TABLE local_groups INSERT INTO `local_groups` (`group_id`, `name`, `notification`, `introduction`, `face_url`, `create_time`, `status`, `creator_user_id`, `group_type`, `owner_user_id`, `member_count`, `ex`, `attached_info`, `need_verification`, `look_member_info`, `apply_member_friend`, `notification_update_time`, - `notification_user_id`) -VALUES ("1234567", "测试1234", "", "", "", 1666777417, 0, "", 0, "", 0, "", "", 0, 0, 0, 0, "") + `notification_user_id`, `display_is_read`) +VALUES ("1234567", "测试1234", "", "", "", 1666777417, 0, "", 0, "", 0, "", "", 0, 0, 0, 0, "", true) ``` + + - deleteGroup | 输入参数 | 类型 | 说明 | 备注 | @@ -67,17 +71,16 @@ VALUES ("1234567", "测试1234", "", "", "", 1666777417, 0, "", 0, "", 0, "", "" | errMsg | string | 详细的err信息 | | ```sqlite -DELETE -FROM `local_conversation_unread_messages` -WHERE conversation_id = "super_group_748402675" - and send_time <= 0 +DELETE FROM `local_groups` WHERE `group_id` = '1728503199'; ``` + + - updateGroup | 输入参数 | 类型 | 说明 | 备注 | | --------- |--------| ----- |----------| -|LocalGroup | string |（表对象数据） |对象转换成string| +|LocalGroup | string |（LocalGroup 表对象数据） |对象转换成string| | 返回参数 | 类型 | 说明 | 备注 | | --------- | ------------ | ----- |-----| @@ -103,11 +106,44 @@ SET `group_id`="1234567", `look_member_info`=0, `apply_member_friend`=0, `notification_update_time`=0, - `notification_user_id`="" + `notification_user_id`="", + `display_is_read`=false WHERE `group_id` = "1234567" ``` -- getJoinedGroupList +- batchInsertGroup + +| 输入参数 | 类型 | 说明 | 备注 | +| --------- |--------| ----- |----------| +|LocalGroup | string | []LocalGroup 表对象数据 | 数组对象转换成string | + +| 返回参数 | 类型 | 说明 | 备注 | +| --------- | ------------ | ----- |-----| +| errCode | number | 自定义即可，0成功，非0失败 | | +| errMsg | string | 详细的err信息 | | + + +```sql +INSERT INTO `local_groups` (`group_id`, `name`, `notification`, `introduction`, `face_url`, `create_time`, `status`, `creator_user_id`, `group_type`, `owner_user_id`, `member_count`, `ex`, `attached_info`, `need_verification`, `look_member_info`, `apply_member_friend`, `notification_update_time`, `notification_user_id`, `display_is_read`) + VALUES("1234567", "测试1234", "", "", "", 1666777417, 0, "", 0, "", 0, "", "", "", 0, 0, 0, 0, ""), ("1234568", "测试5678", "新的通知", "这是一个测试组", "https://example.com/face.png", 1666777420, 1, "user123", 1, "user456", 10, "ex", "Attach", 1, 1, 1, 1666777425, "user789", true); +``` + + +- DeleteAllGroup + +**无输入参数** + +| 返回参数 | 类型 | 说明 | 备注 | +|---------|--------|----------------|-----| +| errCode | number | 自定义即可，0成功，非0失败 | | +| errMsg | string | 详细的err信息 | | + + +```sql +DELETE FROM `local_groups` +``` + +- getJoinedGroupListDB **无输入参数** @@ -118,10 +154,11 @@ WHERE `group_id` = "1234567" | data | string | []LocalGroup （表对象数据） |对象转换成string| ```sqlite -SELECT * -FROM `local_groups` +SELECT * FROM `local_groups` ``` + + - getGroupInfoByGroupID | 输入参数 | 类型 | 说明 | 备注 | @@ -135,11 +172,11 @@ FROM `local_groups` | data | string | LocalGroup （表对象数据） |对象转换成string| ```sqlite -SELECT * -FROM `local_group_members` -WHERE group_id = "748402675" +SELECT * FROM `local_groups` WHERE group_id = "1728503199" ``` + + - getAllGroupInfoByGroupIDOrGroupName | 输入参数 | 类型 | 说明 | 备注 | @@ -180,21 +217,56 @@ ORDER BY create_time DESC ```sql UPDATE `local_groups` SET `member_count`=member_count-1 WHERE `group_id` = "groupID" ``` - - + + + + - addMemberCount - + | 输入参数 | 类型 | 说明 |备注| | --------- | ------------------------------------------------------------ | ----- |-----------------------| | groupID | string | | - - + + | 返回参数 | 类型 | 说明 |备注| | --------- | ------------------------------------------------------------ | ----- |-----------------------| | errCode | number | 自定义即可，0成功，非0失败 || | errMsg | string | 详细的err信息 | | data | number | | - + ```sql - UPDATE `local_groups` SET `member_count`=member_count+1 WHERE `group_id` = "s" - ``` \ No newline at end of file + UPDATE `local_groups` SET `member_count`= member_count+1 WHERE `group_id` = "1728503199" + ``` + + + ++ getGroupMemberAllGroupIDs + + +| 返回参数 | 类型 | 说明 | 备注 | +| -------- | ------ | -------------------------- | ---------------- | +| errCode | number | 自定义即可，0成功，非0失败 | | +| errMsg | string | 详细的err信息 | | +| data | string | []string | 对象转换成string | + +```sqlite +SELECT DISTINCT group_id FROM local_group_members +``` + + + ++ getGroups + + | 输入参数 | 类型 | 说明 |备注| + | --------- | ------------------------------------------------------------ | ----- |-----------------------| + | groupIDs | string |群id数组 转换为String | + +| 返回参数 | 类型 | 说明 | 备注 | +| -------- | ------ | -------------------------- | ---------------- | +| errCode | number | 自定义即可，0成功，非0失败 | | +| errMsg | string | 详细的err信息 | | +| data | string | []string | 对象转换成string | + +```sqlite +SELECT * FROM local_groups where group_id in ("id1", "id2"); +``` diff --git a/group_member.md b/local_group_member.md similarity index 78% rename from group_member.md rename to local_group_member.md index dd5e4bb..8b4f7b1 100644 --- a/group_member.md +++ b/local_group_member.md @@ -34,7 +34,7 @@ CREATE TABLE "local_group_members" ( | errCode | number | 自定义即可，0成功，非0失败|没有返回空数组不报错| | errMsg | string | 详细的err信息 || | data | string | 可为"" []LocalGroupMember || -**参考sql语句说明：** +|**参考sql语句说明：**|||转化为 string 类型| ```sql SELECT * FROM `local_group_members` WHERE group_id = "x" AND user_id = "x2" LIMIT 1 ``` @@ -49,8 +49,8 @@ SELECT * FROM `local_group_members` WHERE group_id = "x" AND user_id = "x2" LIMI | --------- | ------------------------------------------------------------ | ----- |-----------------------| | errCode | number | 自定义即可，0成功，非0失败|没有返回空数组不报错| | errMsg | string | 详细的err信息 || -| data | string | 可为"" []LocalGroupMember || -**参考sql语句说明：** +| data | string | 可为"" []LocalGroupMember |转化为 string 类型| +|**参考sql语句说明：**|||| ```sql SELECT * FROM `local_group_members` ``` @@ -65,8 +65,8 @@ SELECT * FROM `local_group_members` | --------- | ------------------------------------------------------------ | ----- |-----------------------| | errCode | number | 自定义即可，0成功，非0失败|没有返回空数组不报错| | errMsg | string | 详细的err信息 || -| data | string | 可为"" []LocalGroupMember || -**参考sql语句说明：** +| data | string | 可为"" []LocalGroupMember |转化为 string 类型| +|**参考sql语句说明：**|||| ```sql SELECT * FROM `local_group_members` ``` @@ -82,8 +82,8 @@ SELECT * FROM `local_group_members` | --------- | ------------------------------------------------------------ | ----- |-----------------------| | errCode | number | 自定义即可，0成功，非0失败|| | errMsg | string | 详细的err信息 || -| data | int | || -**参考sql语句说明：** +| data | int | |转化为 float64 类型| +|**参考sql语句说明：**|||| ```sql SELECT count(*) FROM `local_group_members` WHERE group_id = "x" @@ -96,19 +96,19 @@ SELECT count(*) FROM `local_group_members` WHERE group_id = "x" | 输入参数 | 类型 | 说明 |备注| | --------- | ------------------------------------------------------------ | ----- |-----------------------| | groupID |string | || -| userIDList |[]string | || +| userIDList |string | userid数组转为String || | 返回参数 | 类型 | 说明 |备注| | --------- | ------------------------------------------------------------ | ----- |-----------------------| | errCode | number | 自定义即可，0成功，非0失败|没有返回空数组不报错| | errMsg | string | 详细的err信息 || -| data | string | 可为"" []LocalGroupMember || +| data | string | 可为"" []LocalGroupMember |转化为 string 类型| **参考sql语句说明：** ```sql SELECT * FROM `local_group_members` WHERE group_id = "x" And user_id IN ("1") -``` +``` - getGroupAdminID @@ -120,12 +120,12 @@ SELECT * FROM `local_group_members` WHERE group_id = "x" And user_id IN ("1") | --------- | ------------------------------------------------------------ | ----- |-----------------------| | errCode | number | 自定义即可，0成功，非0失败|没有返回空数组不报错| | errMsg | string | 详细的err信息 || -| data | string | 可为"" []string || +| data | string | 可为"" []string |转化为 string 类型| **参考sql语句说明：** ```sql SELECT `user_id` FROM `local_group_members` WHERE group_id = "x" And role_level = 3 -``` +``` - getGroupMemberListByGroupID @@ -137,33 +137,88 @@ SELECT `user_id` FROM `local_group_members` WHERE group_id = "x" And role_level | --------- | ------------------------------------------------------------ | ----- |-----------------------| | errCode | number | 自定义即可，0成功，非0失败|没有返回空数组不报错| | errMsg | string | 详细的err信息 || -| data | string | 可为"" []LocalGroupMember || +| data | string | 可为"" []LocalGroupMember |转化为 string 类型| **参考sql语句说明：** ```sql SELECT * FROM `local_group_members` WHERE group_id = "x" -``` +``` -- getGroupMemberListSplit +- GetGroupMemberListByUserIDs -| 输入参数 | 类型 | 说明 |备注| +| 输入参数 | 类型 | 说明 | 备注 | +| --------- | ------------------------------------------------------------ | ----- |--| +| groupID |string | | | +| filter |int | | 总共7种取值，下面说明 | +| userIDs | string |userid数组转为String | | + +| 返回参数 | 类型 | 说明 |备注| | --------- | ------------------------------------------------------------ | ----- |-----------------------| -| groupID |string | | | -| filter |int | | 为0时,role_level>0。为1,2,3时，role_level=1,2,3, 为4时 role_level = 1 OR role_level = 3 | -| offset |int | 偏移 | | -| count |int | 获取总数 | | +| errCode | number | 自定义即可，0成功，非0失败|没有返回空数组不报错| +| errMsg | string | 详细的err信息 || +| data | string | 可为"" []LocalGroupMember |转化为 string 类型| + +**参考sql语句说明：** +```sql + -- filter为0: (获取所有的群成员) +SELECT * FROM `local_group_members` +WHERE group_id = "x" AND user_id IN ("userID1", "userID2") ; + +-- filter为1: (获取群主) +SELECT * FROM `local_group_members` +WHERE group_id = "x" AND role_level = 100 AND user_id IN ("userID1", "userID2") ; + +-- filter为2: (获取群管理员) +SELECT * FROM `local_group_members` +WHERE group_id = "x" AND role_level = 60 AND user_id IN ("userID1", "userID2") ; + +-- filter为3: (获取普通成员) +SELECT * FROM `local_group_members` +WHERE group_id = "x" AND role_level = 20 AND user_id IN ("userID1", "userID2") ; + +-- filter为4: (获取群管理员与普通成员) +SELECT * FROM `local_group_members` +WHERE group_id = "x" AND (role_level = 60 OR role_level = 20) AND user_id IN ("userID1", "userID2") ; + +-- filter为5: (获取群主与管理员) +SELECT * FROM `local_group_members` +WHERE group_id = "x" AND (role_level = 100 OR role_level = 60) AND user_id IN ("userID1", "userID2") ; + +``` + +- getGroupMemberListSplit + +| 输入参数 | 类型 | 说明 | 备注 | +| --------- | ------------------------------------------------------------ | ----- |--| +| groupID |string | | | +| filter |int | | 总共7种取值，下面说明 | +| offset |int | 偏移 | | +| count |int | 获取总数 | | +| loginUserID | string | |登陆者实例ID | | 返回参数 | 类型 | 说明 |备注| | --------- | ------------------------------------------------------------ | ----- |-----------------------| | errCode | number | 自定义即可，0成功，非0失败|没有返回空数组不报错| | errMsg | string | 详细的err信息 || -| data | string | 可为"" []LocalGroupMember || +| data | string | 可为"" []LocalGroupMember |转化为 string 类型| **参考sql语句说明：** ```sql - filter为0: SELECT * FROM `local_group_members` WHERE group_id = "x" And role_level > 0 ORDER BY role_level DESC,join_time ASC LIMIT 20 OFFSET 10 - filter为1: SELECT * FROM `local_group_members` WHERE group_id = "x" And role_level = 1 ORDER BY join_time ASC LIMIT 20 OFFSET 10 - filter为4: SELECT * FROM `local_group_members` WHERE group_id = "x" And ( role_level = 1 OR role_level = 3 ) ORDER BY role_level DESC,join_time ASC LIMIT 20 OFFSET 10 + filter为0:(获取所有的群成员) + SELECT * FROM `local_group_members` WHERE group_id = "x" ORDER BY role_level DESC,join_time ASC LIMIT 20 OFFSET 10 + filter为1:(获取群主) + SELECT * FROM `local_group_members` WHERE group_id = "x" And role_level = 100 LIMIT 20 OFFSET 10 + filter为2:(获取群管理员) + SELECT * FROM `local_group_members` WHERE group_id = "x" And role_level = 60 ORDER BY join_time ASC LIMIT 20 OFFSET 10 + filter为3:(获取普通成员) + SELECT * FROM `local_group_members` WHERE group_id = "x" And role_level = 20 ORDER BY join_time ASC LIMIT 20 OFFSET 10 + filter为4:(获取群管理员与普通成员) + SELECT * FROM `local_group_members` WHERE group_id = "x" And (role_level = 60 or role_level = 20) ORDER BY role_level DESC,join_time ASC LIMIT 20 OFFSET 10 + filter为5:(获取群主与管理员) + SELECT * FROM `local_group_members` WHERE group_id = "x" And (role_level = 100 or role_level = 60) ORDER BY role_level DESC,join_time ASC LIMIT 20 OFFSET 10 + filter为6:(获取群成员不包含自己,其中user_id为登陆者实例ID) + SELECT * FROM `local_group_members` WHERE group_id = "x" And user_id != xx LIMIT 20 OFFSET 10 + ``` - getGroupMemberOwnerAndAdmin @@ -176,12 +231,12 @@ SELECT * FROM `local_group_members` WHERE group_id = "x" | --------- | ------------------------------------------------------------ | ----- |-----------------------| | errCode | number | 自定义即可，0成功，非0失败|没有返回空数组不报错| | errMsg | string | 详细的err信息 || -| data | string | 可为"" []LocalGroupMember || +| data | string | 可为"" []LocalGroupMember |转化为 string 类型| **参考sql语句说明：** ```sql SELECT * FROM `local_group_members` WHERE group_id = "x" And role_level > 1 ORDER BY join_time DESC -``` +``` - getGroupMemberOwner @@ -193,7 +248,7 @@ SELECT * FROM `local_group_members` WHERE group_id = "x" And role_level > 1 ORDE | --------- | ------------------------------------------------------------ | ----- |-----------------------| | errCode | number | 自定义即可，0成功，非0失败|没有返回空数组不报错| | errMsg | string | 详细的err信息 || -| data | string | 可为"" []LocalGroupMember || +| data | string | 可为"" []LocalGroupMember |转化为 string 类型| **参考sql语句说明：** ```sql @@ -209,13 +264,13 @@ SELECT * FROM `local_group_members` WHERE group_id = "x" And role_level = 2 | count |int | || | joinTimeBegin |string | || | joinTimeEnd |int | || -| userIDList | []string | || +| userIDList | string | userid数组转为String || | 返回参数 | 类型 | 说明 |备注| | --------- | ------------------------------------------------------------ | ----- |-----------------------| | errCode | number | 自定义即可，0成功，非0失败|没有返回空数组不报错| | errMsg | string | 详细的err信息 || -| data | string | 可为"" []LocalGroupMember || +| data | string | 可为"" []LocalGroupMember |转化为 string 类型| **参考sql语句说明：** ```sql @@ -233,7 +288,7 @@ SELECT * FROM `local_group_members` WHERE group_id = "x" And role_level = 2 | --------- | ------------------------------------------------------------ | ----- |-----------------------| | errCode | number | 自定义即可，0成功，非0失败|没有返回空数组不报错| | errMsg | string | 详细的err信息 || -| data | string | 可为"" []LocalGroupMember || +| data | string | 可为"" []LocalGroupMember |转化为 string 类型| **参考sql语句说明：** ```sql @@ -250,7 +305,7 @@ SELECT * FROM `local_group_members` WHERE group_id = "x" AND role_level > 1 | --------- | ------------------------------------------------------------ | ----- |-----------------------| | errCode | number | 自定义即可，0成功，非0失败|没有返回空数组不报错| | errMsg | string | 详细的err信息 || -| data | string | 可为"" []string || +| data | string | 可为"" []string |转化为 string 类型| **参考sql语句说明：** ```sql @@ -279,7 +334,7 @@ INSERT INTO `local_group_members` (`group_id`,`user_id`,`nickname`,`user_group_f | 输入参数 | 类型 | 说明 |备注| | --------- | ------------------------------------------------------------ | ----- |-----------------------| -| groupMember |[]LocalGroupMember | | | +| groupMember | string | []LocalGroupMember 表对象数据 |数组对象转换成String | | 返回参数 | 类型 | 说明 |备注| | --------- | ------------------------------------------------------------ | ----- |-----------------------| @@ -364,7 +419,7 @@ UPDATE `local_group_members` SET `group_id`="1",`user_id`="1",`nickname`="1",`us ```sql UPDATE `local_group_members` SET `nickname`="x" WHERE `group_id` = "1" AND `user_id` = "1" -``` +``` - searchGroupMembers @@ -377,6 +432,7 @@ UPDATE `local_group_members` SET `nickname`="x" WHERE `group_id` = "1" AND `user | offset | int | | count| int | + | 返回参数 | 类型 | 说明 |备注| | --------- | ------------------------------------------------------------ | ----- |-----------------------| | errCode | number | 自定义即可，0成功，非0失败| | @@ -385,7 +441,25 @@ UPDATE `local_group_members` SET `nickname`="x" WHERE `group_id` = "1" AND `user **参考sql语句说明：** ```sql -groupID不为""SELECT * FROM `local_group_members` WHERE ( user_id like "%1%" or nickname like "%1%" ) and group_id IN ("sad1") ORDER BY join_time DESC LIMIT 20 OFFSET 10 -groupID为"" SELECT * FROM `local_group_members` WHERE user_id like "%1%" or nickname like "%1%" ORDER BY join_time DESC LIMIT 20 OFFSET 10 -SELECT * FROM `local_group_members` WHERE user_id like "%1%" ORDER BY join_time DESC LIMIT 20 OFFSET 10 -``` \ No newline at end of file +groupID不为""SELECT * FROM `local_group_members` WHERE ( user_id like "%1%" or nickname like "%1%" ) and group_id IN ("sad1") ORDER BY role_level DESC,join_time DESC LIMIT 20 OFFSET 10 +groupID为"" SELECT * FROM `local_group_members` WHERE user_id like "%1%" or nickname like "%1%" ORDER BY role_level DESC,join_time DESC LIMIT 20 OFFSET 10 +SELECT * FROM `local_group_members` WHERE user_id like "%1%" ORDER BY role_level DESC,join_time DESC LIMIT 20 OFFSET 10 +``` + + +- GetUserJoinedGroupIDs + +| 输入参数 | 类型 | 说明 |备注| +| --------- | ------------------------------------------------------------ | ----- |-----------------------| +| userID | string| | + +| 返回参数 | 类型 | 说明 |备注| +| --------- | ------------------------------------------------------------ | ----- |-----------------------| +| errCode | number | 自定义即可，0成功，非0失败| | +| errMsg | string | 详细的err信息 || +| data | string | []string|| + +**参考sql语句说明：** +```sql +select group_id from `local_group_members` where user_id = ?; +``` diff --git a/group_request.md b/local_group_request.md similarity index 63% rename from group_request.md rename to local_group_request.md index 402bee5..919ee7c 100644 --- a/group_request.md +++ b/local_group_request.md @@ -1,53 +1,57 @@ 加群申请表 -- 表名：local_group_request +- 表名：local_group_requests ```sql - CREATE TABLE "local_group_requests" ( - "group_id" varchar(64), - "group_name" text, - "notification" varchar(255), - "introduction" varchar(255), - "face_url" varchar(255), - "create_time" integer, - "status" integer, - "creator_user_id" varchar(64), - "group_type" integer, - "owner_user_id" varchar(64), - "member_count" integer, - "user_id" varchar(64), - "nickname" varchar(255), - "user_face_url" varchar(255), - "gender" integer, - "handle_result" integer, - "req_msg" varchar(255), - "handle_msg" varchar(255), - "req_time" integer, - "handle_user_id" varchar(64), - "handle_time" integer, - "ex" varchar(1024), - "attached_info" varchar(1024), - "join_source" integer, - "inviter_user_id" text, - PRIMARY KEY ("group_id", "user_id") - ); +CREATE TABLE `local_group_requests` +( + `group_id` varchar(64), + `group_name` text, + `notification` varchar(255), + `introduction` varchar(255), + `face_url` varchar(255), + `create_time` integer, + `status` integer, + `creator_user_id` varchar(64), + `group_type` integer, + `owner_user_id` varchar(64), + `member_count` integer, + `user_id` varchar(64), + `nickname` varchar(255), + `user_face_url` varchar(255), + `handle_result` integer, + `req_msg` varchar(255), + `handle_msg` varchar(255), + `req_time` integer, + `handle_user_id` varchar(64), + `handle_time` integer, + `ex` varchar(1024), + `attached_info` varchar(1024), + `join_source` integer, + `inviter_user_id` text, + PRIMARY KEY (`group_id`, `user_id`) +) ``` + + - insertGroupRequest | 输入参数 | 类型 | 说明 |备注| | --------- | ------------------------------------------------------------ | ----- |-----------------------| -| groupRequest |LocalGroupRequest | || +| groupRequest |string | LocalGroupRequest（用户表对象数据） |对象转换成 string| | 返回参数 | 类型 | 说明 |备注| | --------- | ------------------------------------------------------------ | ----- |-----------------------| | errCode | number | 自定义即可，0成功，非0失败|| | errMsg | string | 详细的err信息 || -| data | string | 可为"" || **参考sql语句说明：** + ```sql -INSERT INTO `local_group_requests` (`group_id`,`group_name`,`notification`,`introduction`,`face_url`,`create_time`,`status`,`creator_user_id`,`group_type`,`owner_user_id`,`member_count`,`user_id`,`nickname`,`user_face_url`,`gender`,`handle_result`,`req_msg`,`handle_msg`,`req_time`,`handle_user_id`,`handle_time`,`ex`,`attached_info`,`join_source`,`inviter_user_id`) VALUES ("x","x","x","x","x",123123123,1,"x",0,"",0,"123","123","132",0,0,"123","213",0,"",0,"","",0,"") +INSERT INTO `local_group_requests` (`group_id`,`group_name`,`notification`,`introduction`,`face_url`,`create_time`,`status`,`creator_user_id`,`group_type`,`owner_user_id`,`member_count`,`user_id`,`nickname`,`user_face_url`,`handle_result`,`req_msg`,`handle_msg`,`req_time`,`handle_user_id`,`handle_time`,`ex`,`attached_info`,`join_source`,`inviter_user_id`) VALUES ("x","x","x","x","x",123123123,1,"x",0,"",0,"123","123","132",0,"123","213",0,"",0,"","",0,"") ``` + + - deleteGroupRequest | 输入参数 | 类型 | 说明 |备注| @@ -59,30 +63,32 @@ INSERT INTO `local_group_requests` (`group_id`,`group_name`,`notification`,`intr | --------- | ------------------------------------------------------------ | ----- |-----------------------| | errCode | number | 自定义即可，0成功，非0失败|| | errMsg | string | 详细的err信息 || -| data | string | 可为"" || **参考sql语句说明：** ```sql DELETE FROM `local_group_requests` WHERE group_id="x" and user_id="user" ``` + + - updateGroupRequest | 输入参数 | 类型 | 说明 |备注| | --------- | ------------------------------------------------------------ | ----- |-----------------------| -| groupRequest |LocalGroupRequest | || +| groupRequest | string | LocalGroupRequest（用户表对象数据） |对象转换成 string| | 返回参数 | 类型 | 说明 |备注| | --------- | ------------------------------------------------------------ | ----- |-----------------------| | errCode | number | 自定义即可，0成功，非0失败|没更新上报错| | errMsg | string | 详细的err信息 || -| data | string | 可为"" || **参考sql语句说明：** ```sql - UPDATE `local_group_requests` SET `group_id`="x",`group_name`="x",`notification`="x",`introduction`="x",`face_url`="x",`create_time`=123123123,`status`=1,`creator_user_id`="x",`group_type`=0,`owner_user_id`="",`member_count`=0,`user_id`="123",`nickname`="123",`user_face_url`="132",`gender`=0,`handle_result`=0,`req_msg`="123",`handle_msg`="213",`req_time`=0,`handle_user_id`="",`handle_time`=0,`ex`="",`attached_info`="",`join_source`=0,`inviter_user_id`="" WHERE `group_id` = "x" AND `user_id` = "123" + UPDATE `local_group_requests` SET `group_id`="x",`group_name`="x",`notification`="x",`introduction`="x",`face_url`="x",`create_time`=123123123,`status`=1,`creator_user_id`="x",`group_type`=0,`owner_user_id`="",`member_count`=0,`user_id`="123",`nickname`="123",`user_face_url`="132",`handle_result`=0,`req_msg`="123",`handle_msg`="213",`req_time`=0,`handle_user_id`="",`handle_time`=0,`ex`="",`attached_info`="",`join_source`=0,`inviter_user_id`="" WHERE `group_id` = "x" AND `user_id` = "123" ``` + + - getSendGroupApplication | 输入参数 | 类型 | 说明 |备注| @@ -92,7 +98,6 @@ DELETE FROM `local_group_requests` WHERE group_id="x" and user_id="user" | --------- | ------------------------------------------------------------ | ----- |-----------------------| | errCode | number | 自定义即可，0成功，非0失败|| | errMsg | string | 详细的err信息 || -| data | string | 可为"" || **参考sql语句说明：** @@ -100,56 +105,64 @@ DELETE FROM `local_group_requests` WHERE group_id="x" and user_id="user" SELECT * FROM `local_group_requests` ORDER BY create_time DESC ``` -- 表名：local_group_request -```sql -CREATE TABLE "local_admin_group_requests" ( - "group_id" varchar(64), - "group_name" text, - "notification" varchar(255), - "introduction" varchar(255), - "face_url" varchar(255), - "create_time" integer, - "status" integer, - "creator_user_id" varchar(64), - "group_type" integer, - "owner_user_id" varchar(64), - "member_count" integer, - "user_id" varchar(64), - "nickname" varchar(255), - "user_face_url" varchar(255), - "gender" integer, - "handle_result" integer, - "req_msg" varchar(255), - "handle_msg" varchar(255), - "req_time" integer, - "handle_user_id" varchar(64), - "handle_time" integer, - "ex" varchar(1024), - "attached_info" varchar(1024), - "join_source" integer, - "inviter_user_id" text, - PRIMARY KEY ("group_id", "user_id") -); + + + +- 表名：local_admin_group_requests + +```sqlite +CREATE TABLE `local_admin_group_requests` +( + `group_id` varchar(64), + `group_name` text, + `notification` varchar(255), + `introduction` varchar(255), + `face_url` varchar(255), + `create_time` integer, + `status` integer, + `creator_user_id` varchar(64), + `group_type` integer, + `owner_user_id` varchar(64), + `member_count` integer, + `user_id` varchar(64), + `nickname` varchar(255), + `user_face_url` varchar(255), + `handle_result` integer, + `req_msg` varchar(255), + `handle_msg` varchar(255), + `req_time` integer, + `handle_user_id` varchar(64), + `handle_time` integer, + `ex` varchar(1024), + `attached_info` varchar(1024), + `join_source` integer, + `inviter_user_id` text, + PRIMARY KEY (`group_id`, `user_id`) +) ``` + + - insertAdminGroupRequest | 输入参数 | 类型 | 说明 |备注| | --------- | ------------------------------------------------------------ | ----- |-----------------------| -| groupRequest |LocalGroupRequest | || +| groupRequest | string | LocalGroupRequest（用户表对象数据） |对象转换成 string| | 返回参数 | 类型 | 说明 |备注| | --------- | ------------------------------------------------------------ | ----- |-----------------------| | errCode | number | 自定义即可，0成功，非0失败|没更新上报错| | errMsg | string | 详细的err信息 || -| data | string | 可为"" || **参考sql语句说明：** + ```sql - INSERT INTO `local_admin_group_requests` (`group_id`,`group_name`,`notification`,`introduction`,`face_url`,`create_time`,`status`,`creator_user_id`,`group_type`,`owner_user_id`,`member_count`,`user_id`,`nickname`,`user_face_url`,`gender`,`handle_result`,`req_msg`,`handle_msg`,`req_time`,`handle_user_id`,`handle_time`,`ex`,`attached_info`,`join_source`,`inviter_user_id`) VALUES ("1","1","","","",0,0,"",0,"",0,"1","1","1",0,0,"1","1",0,"",0,"","",0,"") +INSERT INTO `local_admin_group_requests` (`group_id`,`group_name`,`notification`,`introduction`,`face_url`,`create_time`,`status`,`creator_user_id`,`group_type`,`owner_user_id`,`member_count`,`user_id`,`nickname`,`user_face_url`,`handle_result`,`req_msg`,`handle_msg`,`req_time`,`handle_user_id`,`handle_time`,`ex`,`attached_info`,`join_source`,`inviter_user_id`) VALUES ("1","1","","","",0,0,"",0,"",0,"1","1","1",0,"1","1",0,"",0,"","",0,"") ``` + + - deleteAdminGroupRequest | 输入参数 | 类型 | 说明 |备注| @@ -161,30 +174,32 @@ CREATE TABLE "local_admin_group_requests" ( | --------- | ------------------------------------------------------------ | ----- |-----------------------| | errCode | number | 自定义即可，0成功，非0失败|没更新上报错| | errMsg | string | 详细的err信息 || -| data | string | 可为"" || **参考sql语句说明：** ```sql - DELETE FROM `local_admin_group_requests` WHERE group_id="x" and user_id="user" +DELETE FROM `local_admin_group_requests` WHERE group_id="x" and user_id="user" ``` + + - updateAdminGroupRequest | 输入参数 | 类型 | 说明 |备注| | --------- | ------------------------------------------------------------ | ----- |-----------------------| -| groupRequest |LocalGroupRequest | || +| groupRequest | string | LocalGroupRequest（用户表对象数据） |对象转换成 string| | 返回参数 | 类型 | 说明 |备注| | --------- | ------------------------------------------------------------ | ----- |-----------------------| | errCode | number | 自定义即可，0成功，非0失败|没更新上报错| | errMsg | string | 详细的err信息 || -| data | string | 可为"" || **参考sql语句说明：** ```sql -UPDATE `local_admin_group_requests` SET `group_id`="1",`group_name`="1",`notification`="",`introduction`="",`face_url`="",`create_time`=0,`status`=0,`creator_user_id`="",`group_type`=0,`owner_user_id`="",`member_count`=0,`user_id`="1",`nickname`="1",`user_face_url`="1",`gender`=0,`handle_result`=0,`req_msg`="1",`handle_msg`="1",`req_time`=0,`handle_user_id`="",`handle_time`=0,`ex`="",`attached_info`="",`join_source`=0,`inviter_user_id`="" WHERE `group_id` = "1" AND `user_id` = "1" +UPDATE `local_admin_group_requests` SET `group_id`="1",`group_name`="1",`notification`="",`introduction`="",`face_url`="",`create_time`=0,`status`=0,`creator_user_id`="",`group_type`=0,`owner_user_id`="",`member_count`=0,`user_id`="1",`nickname`="1",`user_face_url`="1",`handle_result`=0,`req_msg`="1",`handle_msg`="1",`req_time`=0,`handle_user_id`="",`handle_time`=0,`ex`="",`attached_info`="",`join_source`=0,`inviter_user_id`="" WHERE `group_id` = "1" AND `user_id` = "1" ``` + + - getAdminGroupApplication @@ -195,7 +210,6 @@ UPDATE `local_admin_group_requests` SET `group_id`="1",`group_name`="1",`notific | --------- | ------------------------------------------------------------ | ----- |-----------------------| | errCode | number | 自定义即可，0成功，非0失败|没更新上报错| | errMsg | string | 详细的err信息 || -| data | string | 可为"" || **参考sql语句说明：** ```sql diff --git a/local_notification.md b/local_notification.md new file mode 100644 index 0000000..b8e4d1d --- /dev/null +++ b/local_notification.md @@ -0,0 +1,76 @@ +# Js实现db接口简要说明(待更新) + +## 表结构以及需要实现的接口说明 + +> 所有的db接口返回值，统一由errCode,errMsg,data字段转换为字符串异步返回 + +### 通知表 + ++ 表名：local_notification_seqs + +```sqlite +CREATE TABLE `local_notification_seqs` +( + `conversation_id` char(128), + `seq` integer, + PRIMARY KEY (`conversation_id`) +) +``` + +#### 接口说明： + ++ setNotificationSeq + +| 输入参数 | 类型 | 说明 | 备注 | +| -------------- | ------ | ---- | ---- | +| conversationID | string | | | +| seq | int64 | | | + +| 返回参数 | 类型 | 说明 | 备注 | +| -------- | ------ | -------------------------- | ---- | +| errCode | number | 自定义即可，0成功，非0失败 | | +| errMsg | string | 详细的err信息 | | + +**参考sql语句说明：** + +```sqlite +先： +UPDATE local_notification_seqs set seq = 56 where conversation_id = '10001' +如果一行都未更新到，则： +INSERT INTO `local_notification_seqs` (`conversation_id`, `seq`) VALUES ("10001", "56") +``` + + + ++ getNotificationAllSeqs ++ + **无输入参数** + +| 返回参数 | 类型 | 说明 | 备注 | +| -------- | ------ |-------------------------------------------| ---- | +| errCode | number | 自定义即可，0成功，非0失败 | | +| errMsg | string | 详细的err信息 | | +| data | string | []local_notification_seqs（通知会话seq表对象数组数据） |对象转换成string| + +**参考sql语句说明：** + +```sqlite +SELECT * from local_notification_seqs where 1 = 1; +``` + +- batchInsertNotificationSeq + +| 输入参数 | 类型 | 说明 | 备注 | +| -------------- | ------ | ---- | ---- | +| local_notification_seqs | string | []local_notification_seq 表对象数据 |数组对象转换成String| + + +| 返回参数 | 类型 | 说明 | 备注 | +| -------- | ------ |-------------------------------------------| ---- | +| errCode | number | 自定义即可，0成功，非0失败 | | +| errMsg | string | 详细的err信息 | | + +```sql +INSERT INTO `local_notification_seqs` (`conversation_id`, `seq`) +VALUES ("n_2882899447_69085919821", 2), ("n_2882899447_69085919822", 3); +``` \ No newline at end of file diff --git a/local_sending_messages.md b/local_sending_messages.md new file mode 100644 index 0000000..03787e8 --- /dev/null +++ b/local_sending_messages.md @@ -0,0 +1,83 @@ +# Js实现db接口简要说明(待更新) + +## 表结构以及需要实现的接口说明 + +> 所有的db接口返回值，统一由errCode,errMsg,data字段转换为字符串异步返回 + +### 发送消息临时缓存表 + +- 表名：local_sending_messages + +```sqlite +create table local_sending_messages +( + conversation_id varchar(128), + client_msg_id varchar(64), + ex varchar(1024), + + PRIMARY KEY ("conversation_id", "client_msg_id") +); +``` + +#### 接口说明： + +- insertSendingMessage + +| 输入参数 | 类型 | 说明 | 备注 | +| --------- |--------| ----- |----------| +|message | string | （表对象数据） |对象转换成string| + +| 返回参数 | 类型 | 说明 | 备注 | +| --------- | ------------ | ----- |-----| +| errCode | number | 自定义即可，0成功，非0失败 | | +| errMsg | string | 详细的err信息 | | + +**参考sql语句说明：** + +```sqlite +INSERT INTO `local_sending_messages` (`conversation_id`, `client_msg_id`, `ex`) +VALUES ("123", "123", "") +``` + +- deleteSendingMessage + + + + +| 输入参数 | 类型 | 说明 | 备注 | +| --------- |--------| ----- |----------| +|conversationID| string | 会话ID | | +|clientMsgID| string | 消息ID | | + + + + +| 返回参数 | 类型 | 说明 | 备注 | +| --------- | ------------ | ----- |-----| +| errCode | number | 自定义即可，0成功，非0失败 | | +| errMsg | string | 详细的err信息 | | + +```sqlite +DELETE +FROM `local_sending_messages` +WHERE conversation_id = "457" + and client_msg_id = "123" +``` + + +- getAllSendingMessages + +**无输入参数** + + +| 返回参数 | 类型 | 说明 | 备注 | +|---------|--------|-----------------------------------|-----| +| errCode | number | 自定义即可，0成功，非0失败 | | +| errMsg | string | 详细的err信息 | | +| data | string | []LocalSendingMessages （表对象数组数据） |对象转换成string| + +```sqlite +SELECT * +FROM `local_sending_messages` +``` + diff --git a/local_sg_chat_logs_groupID.md b/local_sg_chat_logs_groupID.md index bb8fed6..2b91a47 100644 --- a/local_sg_chat_logs_groupID.md +++ b/local_sg_chat_logs_groupID.md @@ -1,10 +1,11 @@ -# Js实现db接口简要说明(待更新) +# Js实现db接口简要说明(已废弃) ## 表结构以及需要实现的接口说明 >所有的db接口返回值，统一由errCode,errMsg,data字段转换为字符串异步返回 ### 读扩散消息表 - 表名：local_sg_chat_logs_3592883556 >注：读扩散表为动态生成，表名也是，规则为local_sg_chat_logs_+groupID， 原有代码中，是在SuperGroupGetMessageListNoTime和SuperGroupGetMessage这两个函数中进行判断，如果没有就动态生成该表 + ```sqlite CREATE TABLE `local_sg_chat_logs_3592883556` (`client_msg_id` char(64),`server_msg_id` char(64),`send_id` char(64),`recv_id` char(64),`sender_platform_id` integer,`sender_nick_name` varchar(255),`sender_face_url` varchar(255),`session_type` integer,`msg_from` integer,`content_type` integer,`content` varchar(1000),`is_read` numeric,`status` integer,`seq` integer DEFAULT 0,`send_time` integer,`create_time` integer,`attached_info` varchar(1024),`ex` varchar(1024),PRIMARY KEY (`client_msg_id`)) ``` diff --git a/local_super_group_chat_log.md b/local_super_group_chat_log.md index 35e15b1..da74e1b 100644 --- a/local_super_group_chat_log.md +++ b/local_super_group_chat_log.md @@ -1,4 +1,4 @@ -# Js实现db接口简要说明(待更新) +# Js实现db接口简要说明(已废弃) ## 表结构以及需要实现的接口说明 @@ -39,7 +39,7 @@ create table local_sg_chat_logs | 输入参数 | 类型 | 说明 | 备注 | | --------- |--------| ----- |-----| -| LocalChatLog | string |（表对象数据） |对象转换成string| +| LocalChatLog | string |（表对象数据） |数组对象转换成string| | groupID | string | | | | 返回参数 | 类型 | 说明 | 备注 | diff --git a/local_super_groups.md b/local_super_groups.md index 2775a37..e39f553 100644 --- a/local_super_groups.md +++ b/local_super_groups.md @@ -1,4 +1,4 @@ -# Js实现db接口简要说明(待更新) +# Js实现db接口简要说明(已废弃) ## 表结构以及需要实现的接口说明 >所有的db接口返回值，统一由errCode,errMsg,data字段转换为字符串异步返回 ### 读扩散大群表 diff --git a/local_table_master.md b/local_table_master.md new file mode 100644 index 0000000..8214e68 --- /dev/null +++ b/local_table_master.md @@ -0,0 +1,40 @@ +# Js实现db接口简要说明(待更新) + +## 表结构以及需要实现的接口说明 + +> 所有的db接口返回值，统一由errCode,errMsg,data字段转换为字符串异步返回 + + +### 主Table结构表 +> 该表为 sqlite 自动生成的表，不需要进行手动创建！ + +- 表名：`sqlite_master` + +```sql +create table sqlite_master +( + type TEXT, + name TEXT, + tbl_name TEXT, + rootpage INT, + sql TEXT +); + +``` + +#### 接口说明： + +- getExistedTables + +**无输入参数** + +| 返回参数 | 类型 | 说明 | 备注 | +| --------- |--------| ----- |-----| +| errCode | number | 自定义即可，0成功，非0失败 | | +| errMsg | string | 详细的err信息 | | +| data | string | []name |数组转换成string| + + +```sql +SELECT name FROM sqlite_master WHERE type='table' +``` \ No newline at end of file diff --git a/local_users.md b/local_users.md index 84b8f14..3e2526d 100644 --- a/local_users.md +++ b/local_users.md @@ -4,7 +4,18 @@ ### 用户表 - 表名：local_users ```sqlite -CREATE TABLE `local_users` (`user_id` varchar(64),`name` varchar(255),`face_url` varchar(255),`gender` integer,`phone_number` varchar(32),`birth` integer,`email` varchar(64),`create_time` integer,`app_manger_level` integer,`ex` varchar(1024),`attached_info` varchar(1024),`global_recv_msg_opt` integer,PRIMARY KEY (`user_id`)) +CREATE TABLE `local_users` +( + `user_id` varchar(64), + `name` varchar(255), + `face_url` varchar(255), + `create_time` integer, + `app_manger_level` integer, + `ex` varchar(1024), + `attached_info` varchar(1024), + `global_recv_msg_opt` integer, + PRIMARY KEY (`user_id`) +) ``` #### 接口说明： @@ -25,11 +36,13 @@ CREATE TABLE `local_users` (`user_id` varchar(64),`name` varchar(255),`face_url` ```sql SELECT * FROM `local_users` WHERE user_id = "3045326383" LIMIT 1; ``` + + - insertLoginUser | 输入参数 | 类型 | 说明 |备注| | --------- | ------------------------------------------------------------ | ----- |-----------------------| -| user | string |LocalUser（用户表对象数据）|对象转换成string +| user | string |LocalUser（用户表对象数据）|对象转换成string| | 返回参数 | 类型 | 说明 |备注| | --------- | ------------------------------------------------------------ | ----- |-----------------------| @@ -39,15 +52,16 @@ SELECT * FROM `local_users` WHERE user_id = "3045326383" LIMIT 1; **参考sql语句说明：** ```sql -INSERT INTO `local_users` (`user_id`,`name`,`face_url`,`gender`,`phone_number`,`birth`,`email`,`create_time`,`app_manger_level`,`ex`,`attached_info`,`global_recv_msg_opt`) VALUES ("3045326383","Gordon","ic_avatar_01",0,"18349115126",0," ",0,1,"","",0) - +INSERT INTO `local_users` (`user_id`, `name`, `face_url`, `create_time`, `app_manger_level`, `ex`, `attached_info`, `global_recv_msg_opt`) +VALUES ('example_user', 'bantanger', 'http://example.com/face.jpg', 1618906879, 18, 'example', 'info', 1); ``` -- updateLoginUserByMap + + +- updateLoginUser | 输入参数 | 类型 | 说明 |备注| | --------- | ------------------------------------------------------------ | ----- |-----------------------| -| userID |string | 用户ID || -| args |object | 更新字段参数对象 |内部是kv，k为字段名，v为需要更新的字段内容| +| user | string | LocalUser（用户表对象数据） | 对象转换成 string
没有变化的字段不传入即可 | | 返回参数 | 类型 | 说明 |备注| | --------- | ------------------------------------------------------------ | ----- |-----------------------| @@ -57,6 +71,9 @@ INSERT INTO `local_users` (`user_id`,`name`,`face_url`,`gender`,`phone_number`,` **参考sql语句说明：** ```sql -UPDATE `local_users` SET `app_manger_level`=1,`attached_info`="",`birth`=0,`create_time`=0,`email`=" ",`ex`="",`face_url`="ic_avatar_01",`gender`=0,`global_recv_msg_opt`=0,`name`="Gordon111",`phone_number`="18349115126" WHERE `user_id` = "3045326383"; +UPDATE `local_users` SET `name`="test",`app_manger_level` = 18 WHERE `user_id` = "7204255074" ``` + + ++ updateLoginUserByMap（暂时废弃） diff --git a/local_version_sync.md b/local_version_sync.md new file mode 100644 index 0000000..bb1bf57 --- /dev/null +++ b/local_version_sync.md @@ -0,0 +1,97 @@ +# Js 实现 db 接口简要说明(待更新) + +## 表结构以及需要实现的接口说明 + +> 所有的 db 接口返回值，统一由 errCode,errMsg,data 字段转换为字符串异步返回 + +### 版本同步记录表 + +- 表名：local_sync_version + +```sqlite +CREATE TABLE `local_sync_version` ( + `table` varchar(255), + `entity_id` varchar(255), + `version_id` text, + `version` integer, + `create_time` integer, + `id_list` text, + PRIMARY KEY (`table`, `entity_id`) + ); +``` + +#### 接口说明： + +- getVersionSync + +| 输入参数 | 类型 | 说明 | 备注 | +| --------- | ------ | ---- | ---- | +| tablename | string | 如果为`local_friends`，表示本地好友版本变动。
如果为`local_groups`，表示本地群组版本变动。
如果为`local_group_entities_version`，表示群组内部版本变动。 | 变动类型版本表 | +| entityID | string | 如果为`local_friends` 和 `local_groups`，entityID为当前用户ID。
如果为`local_group_entities_version`，entityID为群组ID。 | 变动类型版本表 | 版本表对应的实体ID | + +| 返回参数 | 类型 | 说明 | 备注 | +| -------- | ------ | ------------------------------- | ----------------- | +| errCode | number | 自定义即可，0 成功，非 0 失败 | 如果获取不到信息需要返回错误 | +| errMsg | string | 详细的 err 信息 | | +| data | string | LocalVersionSync （表对象数据） | 对象转换成 string | + +**参考 sql 语句说明：** + +```sqlite +SELECT + * +FROM + `local_sync_version` +WHERE + `table` = local_friends + AND `entity_id` = 12345323 +LIMIT 1 +``` + +- setVersionSync + +| 输入参数 | 类型 | 说明 | 备注 | +| ----------- | ------ | -------------- | ----------------- | +| LocalVersionSync | string | （表对象数据） | 对象转换成 string | + +| 返回参数 | 类型 | 说明 | 备注 | +| -------- | ------ | ----------------------------- | ------------ | +| errCode | number | 自定义即可，0 成功，非 0 失败 | 获取不到报错 | +| errMsg | string | 详细的 err 信息 | | + +```sql +-- 第一次设置版本表时为创建 +INSERT INTO `local_sync_version` (`table`, `entity_id`, `version_id`, `version`, `create_time`, `id_list`) + VALUES('local_group_entities_version', '1076204769', '667aabe3417b67f0f0d3cdee', 1076204769, 0, '["8879166186","1695766238","2882899447","5292156665"]'); + +-- 第二次调用时为更新 +UPDATE + `local_sync_version` +SET + `table` = "local_group_entities_version", + `entity_id` = "1076204769", + `version_id` = "667aabe3417b67f0f0d3cdee", + `version` = 1076204769, + `id_list` = "[\"8879166186\",\"1695766238\",\"2882899447\",\"5292156665\"]" +WHERE + `table` = "local_group_entities_version" + AND `entity_id` = "1076204769"; +``` + +- deleteVersionSync + +| 输入参数 | 类型 | 说明 | 备注 | +| ------------ | ------ | ---- | ---- | +| tablename | string | 如果为`local_friends`，表示本地好友版本变动。
如果为`local_groups`，表示本地群组版本变动。
如果为`local_group_entities_version`，表示群组内部版本变动。 | 变动类型版本表 | +| entityID | string | 如果为`local_friends` 和 `local_groups`，entityID为当前用户ID。
如果为`local_group_entities_version`，entityID为群组ID。 | 变动类型版本表 | 版本表对应的实体ID | + +| 返回参数 | 类型 | 说明 | 备注 | +| -------- | ------ | ----------------------------- | ---- | +| errCode | number | 自定义即可，0 成功，非 0 失败 | | +| errMsg | string | 详细的 err 信息 | | + +```sqlite +DDELETE FROM `local_sync_version` +WHERE (`local_sync_version`.`table`, `local_sync_version`.`entity_id`) + IN(('local_group_entities_version', '3378458183')); +```