Skip to main content

common_wal/options/
object_store.rs

1// Copyright 2023 Greptime Team
2//
3// Licensed under the Apache License, Version 2.0 (the "License");
4// you may not use this file except in compliance with the License.
5// You may obtain a copy of the License at
6//
7//     http://www.apache.org/licenses/LICENSE-2.0
8//
9// Unless required by applicable law or agreed to in writing, software
10// distributed under the License is distributed on an "AS IS" BASIS,
11// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12// See the License for the specific language governing permissions and
13// limitations under the License.
14
15use serde::{Deserialize, Serialize};
16
17/// Object store wal options allocated to a region.
18#[derive(Debug, Clone, Serialize, Deserialize, PartialEq, Eq)]
19pub struct ObjectStoreWalOptions {
20    /// Path prefix of the WAL objects the region belongs to.
21    ///
22    /// Persisted so that reopening the region can detect a prefix that differs
23    /// from the process configuration.
24    pub prefix: String,
25}
26
27impl ObjectStoreWalOptions {
28    /// Creates object store WAL options with the prefix.
29    pub fn new(prefix: String) -> Self {
30        Self { prefix }
31    }
32}