query/query_engine/
context.rs

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
// Copyright 2023 Greptime Team
//
// 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::sync::Arc;

use common_query::logical_plan::SubstraitPlanDecoderRef;
use common_telemetry::tracing_context::TracingContext;
use datafusion::execution::context::{SessionState, TaskContext};
use session::context::QueryContextRef;

use crate::query_engine::default_serializer::DefaultPlanDecoder;

#[derive(Debug)]
pub struct QueryEngineContext {
    state: SessionState,
    query_ctx: QueryContextRef,
}

impl QueryEngineContext {
    pub fn new(state: SessionState, query_ctx: QueryContextRef) -> Self {
        Self { state, query_ctx }
    }

    #[inline]
    pub fn state(&self) -> &SessionState {
        &self.state
    }

    #[inline]
    pub fn query_ctx(&self) -> QueryContextRef {
        self.query_ctx.clone()
    }

    pub fn build_task_ctx(&self) -> Arc<TaskContext> {
        let dbname = self.query_ctx.get_db_string();
        let state = &self.state;
        let tracing_context = TracingContext::from_current_span();

        // pass tracing context in session_id
        let session_id = tracing_context.to_json();

        Arc::new(TaskContext::new(
            Some(dbname),
            session_id,
            state.config().clone(),
            state.scalar_functions().clone(),
            state.aggregate_functions().clone(),
            state.window_functions().clone(),
            state.runtime_env().clone(),
        ))
    }

    /// Creates a [`LogicalPlan`] decoder
    pub fn new_plan_decoder(&self) -> crate::error::Result<SubstraitPlanDecoderRef> {
        Ok(Arc::new(DefaultPlanDecoder::new(
            self.state.clone(),
            &self.query_ctx,
        )?))
    }

    /// Mock an engine context for unit tests.
    #[cfg(test)]
    pub fn mock() -> Self {
        use common_base::Plugins;
        use session::context::QueryContext;

        use crate::query_engine::QueryEngineState;

        let state = Arc::new(QueryEngineState::new(
            catalog::memory::new_memory_catalog_manager().unwrap(),
            None,
            None,
            None,
            None,
            false,
            Plugins::default(),
        ));

        QueryEngineContext::new(state.session_state(), QueryContext::arc())
    }
}