be/src/exec/operator/blackhole_sink_operator.h

// Licensed to the Apache Software Foundation (ASF) under one
// or more contributor license agreements.  See the NOTICE file
// distributed with this work for additional information
// regarding copyright ownership.  The ASF licenses this file
// to you 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.

#pragma once

#include <gen_cpp/PlanNodes_types.h>
#include <gen_cpp/Types_types.h>
#include <stdint.h>

#include <memory>

#include "core/block/block.h"
#include "exec/operator/operator.h"

namespace doris {

class TDataSink;

class Block;

// Forward declaration
class BlackholeSinkOperatorX;

class BlackholeSinkLocalState final : public PipelineXSinkLocalState<FakeSharedState> {
    ENABLE_FACTORY_CREATOR(BlackholeSinkLocalState);

public:
    using Parent = BlackholeSinkOperatorX;
    using Base = PipelineXSinkLocalState<FakeSharedState>;
    BlackholeSinkLocalState(DataSinkOperatorXBase* parent, RuntimeState* state)
            : Base(parent, state) {}

    Status init(RuntimeState* state, LocalSinkStateInfo& info) override;
    Status open(RuntimeState* state) override;
    Status close(RuntimeState* state, Status exec_status) override;

    int64_t _rows_processed = 0;
    int64_t _bytes_processed = 0;

    RuntimeProfile::Counter* _rows_processed_timer = nullptr;
    RuntimeProfile::Counter* _bytes_processed_timer = nullptr;

private:
    friend class BlackholeSinkOperatorX;
};

class BlackholeSinkOperatorX final : public DataSinkOperatorX<BlackholeSinkLocalState> {
public:
    using Base = DataSinkOperatorX<BlackholeSinkLocalState>;

    BlackholeSinkOperatorX(int operator_id);

    Status prepare(RuntimeState* state) override;

    Status init(const TDataSink& tsink) override;

    Status sink(RuntimeState* state, Block* block, bool eos) override;

    Status close(RuntimeState* state) override;

private:
    friend class BlackholeSinkLocalState;

    /**
     * Process a data block by discarding it and collecting metrics.
     * This simulates a "/dev/null" sink - data goes in but nothing comes out.
     */
    Status _process_block(RuntimeState* state, Block* block);
};

} // namespace doris