Files
doris/be/src/exec/schema_scanner.h
hongbin e61d296486 [Refactor] Replace '#ifndef' with '#pragma once' (#9456)
* Replace '#ifndef' with '#pragma once'
2022-05-10 09:25:59 +08:00

98 lines
3.0 KiB
C++

// 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 <string>
#include "common/object_pool.h"
#include "common/status.h"
#include "gen_cpp/Descriptors_types.h"
#include "gen_cpp/Types_types.h"
#include "runtime/mem_pool.h"
#include "runtime/tuple.h"
namespace doris {
// forehead declare class, because jni function init in DorisServer.
class DorisServer;
class RuntimeState;
// scanner parameter from frontend
struct SchemaScannerParam {
const std::string* db;
const std::string* table;
const std::string* wild;
const std::string* user; // deprecated
const std::string* user_ip; // deprecated
const TUserIdentity* current_user_ident; // to replace the user and user ip
const std::string* ip; // frontend ip
int32_t port; // frontend thrift port
int64_t thread_id;
SchemaScannerParam()
: db(nullptr),
table(nullptr),
wild(nullptr),
user(nullptr),
user_ip(nullptr),
current_user_ident(nullptr),
ip(nullptr),
port(0) {}
};
// virtual scanner for all schema table
class SchemaScanner {
public:
struct ColumnDesc {
const char* name;
PrimitiveType type;
int size;
bool is_null;
};
SchemaScanner(ColumnDesc* columns, int column_num);
virtual ~SchemaScanner();
// init object need information, schema etc.
virtual Status init(SchemaScannerParam* param, ObjectPool* pool);
// Start to work
virtual Status start(RuntimeState* state);
virtual Status get_next_row(Tuple* tuple, MemPool* pool, bool* eos);
// factory function
static SchemaScanner* create(TSchemaTableType::type type);
const TupleDescriptor* tuple_desc() const { return _tuple_desc; }
static void set_doris_server(DorisServer* doris_server) { _s_doris_server = doris_server; }
protected:
Status create_tuple_desc(ObjectPool* pool);
bool _is_init;
// this is used for sub class
SchemaScannerParam* _param;
// pointer to schema table's column desc
ColumnDesc* _columns;
// num of columns
int _column_num;
TupleDescriptor* _tuple_desc;
static DorisServer* _s_doris_server;
};
} // namespace doris