scouter-sql 0.25.0

Sql library to use with scouter-server
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117

use crate::sql::schema::Entity;
use crate::sql::{query::Queries, utils::parse_pg_rows};
use chrono::{DateTime, Utc};

use crate::sql::error::SqlError;
use scouter_types::{RecordType, ServerRecords};
use sqlx::{Pool, Postgres};

use std::result::Result::Ok;

use async_trait::async_trait;

#[async_trait]
pub trait ArchiveSqlLogic {
    /// Function to get entities for archival
    ///
    /// # Arguments
    /// * `record_type` - The type of record to get entities for
    /// * `retention_period` - The retention period to get entities for
    ///
    async fn get_entities_to_archive(
        pool: &Pool<Postgres>,
        record_type: &RecordType,
        retention_period: &i32,
    ) -> Result<Vec<Entity>, SqlError> {
        let query = match record_type {
            RecordType::Spc => Queries::GetSpcEntities.get_query(),
            RecordType::Psi => Queries::GetBinCountEntities.get_query(),
            RecordType::Custom => Queries::GetCustomEntities.get_query(),
            RecordType::GenAIEval => Queries::GetEvalRecordEntitiesForArchive.get_query(),
            RecordType::GenAITask => Queries::GetGenAIEvalTaskResultEntitiesForArchive.get_query(),
            RecordType::GenAIWorkflow => {
                Queries::GetGenAIEvalWorkflowEntitiesForArchive.get_query()
            }
            _ => {
                return Err(SqlError::InvalidRecordTypeError(record_type.to_string()));
            }
        };

        let entities: Vec<Entity> = sqlx::query_as(query)
            .bind(retention_period)
            .fetch_all(pool)
            .await?;

        Ok(entities)
    }

    /// Function to get data for archival
    ///
    /// # Arguments
    /// * `record_type` - The type of record to get data for
    /// * `days` - The number of days to get data for
    ///
    /// # Returns
    /// * `Result<ServerRecords, SqlError>` - Result of the query
    ///
    /// # Errors
    /// * `SqlError` - If the query fails
    async fn get_data_to_archive(
        entity_id: &i32,
        begin_timestamp: &DateTime<Utc>,
        end_timestamp: &DateTime<Utc>,
        record_type: &RecordType,
        db_pool: &Pool<Postgres>,
    ) -> Result<ServerRecords, SqlError> {
        let query = match record_type {
            RecordType::Spc => Queries::GetSpcDataForArchive.get_query(),
            RecordType::Psi => Queries::GetBinCountDataForArchive.get_query(),
            RecordType::Custom => Queries::GetCustomDataForArchive.get_query(),
            RecordType::GenAIEval => Queries::GetEvalRecordDataForArchive.get_query(),
            RecordType::GenAITask => Queries::GetGenAITaskResultDataForArchive.get_query(),
            RecordType::GenAIWorkflow => Queries::GetGenAIWorkflowResultDataForArchive.get_query(),
            _ => {
                return Err(SqlError::InvalidRecordTypeError(record_type.to_string()));
            }
        };
        let rows = sqlx::query(query)
            .bind(begin_timestamp)
            .bind(end_timestamp)
            .bind(entity_id)
            .fetch_all(db_pool)
            .await
            .map_err(SqlError::SqlxError)?;

        // need to convert the rows to server records (storage dataframe expects this)
        parse_pg_rows(&rows, record_type)
    }

    async fn update_data_to_archived(
        entity_id: &i32,
        begin_timestamp: &DateTime<Utc>,
        end_timestamp: &DateTime<Utc>,
        record_type: &RecordType,
        db_pool: &Pool<Postgres>,
    ) -> Result<(), SqlError> {
        let query = match record_type {
            RecordType::Spc => Queries::UpdateSpcEntities.get_query(),
            RecordType::Psi => Queries::UpdateBinCountEntities.get_query(),
            RecordType::Custom => Queries::UpdateCustomEntities.get_query(),
            RecordType::GenAIEval => Queries::UpdateGenAIEvalEntities.get_query(),
            RecordType::GenAITask => Queries::UpdateGenAITaskEntities.get_query(),
            RecordType::GenAIWorkflow => Queries::UpdateGenAIWorkflowEntities.get_query(),
            _ => {
                return Err(SqlError::InvalidRecordTypeError(record_type.to_string()));
            }
        };
        sqlx::query(query)
            .bind(begin_timestamp)
            .bind(end_timestamp)
            .bind(entity_id)
            .execute(db_pool)
            .await
            .map_err(SqlError::SqlxError)?;

        Ok(())
    }
}