request.rs

// Copyright 2021 Datafuse Labs
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

use std::collections::BTreeMap;

use crate::session::SessionState;
use serde::Serialize;

#[derive(Serialize, Debug)]
pub struct QueryRequest<'a> {
    #[serde(skip_serializing_if = "Option::is_none")]
    session: Option<SessionState>,
    sql: &'a str,
    #[serde(skip_serializing_if = "Option::is_none")]
    pagination: Option<PaginationConfig>,
    #[serde(skip_serializing_if = "Option::is_none")]
    stage_attachment: Option<StageAttachmentConfig<'a>>,
}

#[derive(Serialize, Debug)]
pub struct PaginationConfig {
    #[serde(skip_serializing_if = "Option::is_none")]
    pub wait_time_secs: Option<i64>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub max_rows_in_buffer: Option<i64>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub max_rows_per_page: Option<i64>,
}

#[derive(Serialize, Debug)]
pub struct StageAttachmentConfig<'a> {
    pub location: &'a str,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub file_format_options: Option<BTreeMap<&'a str, &'a str>>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub copy_options: Option<BTreeMap<&'a str, &'a str>>,
}

impl<'r, 't: 'r> QueryRequest<'r> {
    pub fn new(sql: &'r str) -> QueryRequest<'r> {
        QueryRequest {
            session: None,
            sql,
            pagination: None,
            stage_attachment: None,
        }
    }

    pub fn with_session(mut self, session: Option<SessionState>) -> Self {
        self.session = session;
        self
    }

    pub fn with_pagination(mut self, pagination: Option<PaginationConfig>) -> Self {
        self.pagination = pagination;
        self
    }

    pub fn with_stage_attachment(
        mut self,
        stage_attachment: Option<StageAttachmentConfig<'t>>,
    ) -> Self {
        self.stage_attachment = stage_attachment;
        self
    }
}

#[cfg(test)]
mod test {
    use super::*;
    use crate::error::Result;

    #[test]
    fn build_request() -> Result<()> {
        let mut session = SessionState::default();
        session.set_database("default");
        let req = QueryRequest::new("select 1")
            .with_session(Some(session))
            .with_pagination(Some(PaginationConfig {
                wait_time_secs: Some(1),
                max_rows_in_buffer: Some(1),
                max_rows_per_page: Some(1),
            }))
            .with_stage_attachment(Some(StageAttachmentConfig {
                location: "@~/my_location",
                file_format_options: None,
                copy_options: None,
            }));
        assert_eq!(
            serde_json::to_string(&req)?,
            r#"{"session":{"database":"default"},"sql":"select 1","pagination":{"wait_time_secs":1,"max_rows_in_buffer":1,"max_rows_per_page":1},"stage_attachment":{"location":"@~/my_location"}}"#
        );
        Ok(())
    }
}