risingwave_common/row/
compacted_row.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
// Copyright 2024 RisingWave 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 bytes::Bytes;
use risingwave_common_estimate_size::EstimateSize;

use super::{OwnedRow, Row, RowDeserializer};
use crate::types::DataType;
use crate::util::value_encoding;

/// `CompactedRow` is used in streaming executors' cache, which takes less memory than `Vec<Datum>`.
/// Executors need to serialize Row into `CompactedRow` before writing into cache.
#[derive(Clone, Debug, Default, PartialEq, Eq, Hash, EstimateSize)]
pub struct CompactedRow {
    pub row: Bytes,
}

impl CompactedRow {
    /// Create a new [`CompactedRow`] from given bytes. Caller must ensure the bytes are in valid
    /// value-encoding row format.
    pub fn new(value_encoding_bytes: Bytes) -> Self {
        Self {
            row: value_encoding_bytes,
        }
    }

    /// Deserialize [`CompactedRow`] into [`OwnedRow`] with given types.
    pub fn deserialize(&self, data_types: &[DataType]) -> value_encoding::Result<OwnedRow> {
        RowDeserializer::new(data_types).deserialize(self.row.as_ref())
    }
}

impl<R: Row> From<R> for CompactedRow {
    fn from(row: R) -> Self {
        Self {
            row: row.value_serialize_bytes(),
        }
    }
}