be/src/exprs/function/geo/functions_geo.h

Source
// 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 <stddef.h>

#include <memory>
#include <string>
#include <vector>

#include "common/status.h"
#include "core/block/column_numbers.h"
#include "core/data_type/data_type.h"
#include "core/types.h"
#include "exprs/function/function.h"
#include "exprs/function_context.h"

namespace doris {
class GeoShape;

class Block;
} // namespace doris

namespace doris {

struct StConstructState {
    StConstructState() : is_null(false) {}
    ~StConstructState() {}

    bool is_null;
    std::string encoded_buf;
};

struct StContainsState {
    StContainsState() : is_null(false), shapes {nullptr, nullptr} {}
    ~StContainsState() {}
    bool is_null;
    std::vector<std::shared_ptr<GeoShape>> shapes;
};

#ifdef BE_TEST
size_t geography_calculation_edges_for_test(const std::string& left, const std::string& right,
                                            size_t* exact_proofs = nullptr,
                                            size_t* candidate_visits = nullptr);
#endif

Status validate_spatial_wkb_inputs(const Block& block, const ColumnNumbers& arguments);

// Decode physical binary storage using the spatial identity supplied by the table schema.
Status append_spatial_wkb(const ColumnPtr& source, IColumn& destination,
                          const DataTypePtr& spatial_type,
                          const NullMap::value_type* null_map = nullptr);

template <typename Impl>
class GeoFunction : public IFunction {
public:
    static constexpr auto name = Impl::NAME;
    using ReturnType = typename Impl::Type;
    static FunctionPtr create() { return std::make_shared<GeoFunction<Impl>>(); }
    String get_name() const override { return name; }
    size_t get_number_of_arguments() const override { return Impl::NUM_ARGS; }
    bool is_variadic() const override { return false; }
    DataTypePtr get_return_type_impl(const DataTypes& arguments) const override {
        return make_nullable(std::make_shared<ReturnType>());
    }

    Status execute_impl(FunctionContext* context, Block& block, const ColumnNumbers& arguments,
                        uint32_t result, size_t input_rows_count) const override {
        return Impl::execute(block, arguments, result);
    }
};

// Spatial WKB columns must remain visible to the implementation so it can validate the
// serialized value before any file data is consumed.  Do not use this wrapper for legacy
// geo functions or numeric constructors: their nullable arguments rely on the default
// null propagation supplied by IFunction.
template <typename Impl>
class SpatialWkbGeoFunction : public GeoFunction<Impl> {
public:
    static FunctionPtr create() { return std::make_shared<SpatialWkbGeoFunction<Impl>>(); }
    bool use_default_implementation_for_nulls() const override { return false; }

    Status execute_impl(FunctionContext* context, Block& block, const ColumnNumbers& arguments,
                        uint32_t result, size_t input_rows_count) const override {
        RETURN_IF_ERROR(validate_spatial_wkb_inputs(block, arguments));
        return GeoFunction<Impl>::execute_impl(context, block, arguments, result, input_rows_count);
    }
};

} // namespace doris

Coverage Report

Created: 2026-10-27 15:35