objects.h

// 在 Apache Software Foundation (ASF) 许可下发布。
// 根据一份或多份贡献者许可协议。 请参阅 NOTICE 文件
// 随此作品分发以获取其他信息
// 有关版权所有权的信息。 ASF 许可此文件
// 根据 Apache License 2.0 版（简称
// “许可证”）；除非遵守
// 许可证的规定，否则您不得使用此文件。 您可以在以下网址获取许可证副本：
//
// https://apache.org/licenses/LICENSE-2.0
//
// 除非适用法律要求或书面同意，
// 否则按“原样”分发，不提供任何形式的
// 明示或暗示的保证或条件。
// 有关管理权限和限制的特定语言，请参阅许可证
// 根据许可证。
// 根据许可证。
 
#pragma once
 
#include <optional>
#include <string_view>
#include <vector>
 
#include <arrow-adbc/adbc.h>
#include "driver/framework/status.h"
#include "driver/framework/type_fwd.h"
 
namespace adbc::driver {


Status MakeGetObjectsSchema(ArrowSchema* schema);

enum class GetObjectsDepth {
 kCatalogs,
 kSchemas,
 kTables,
 kColumns,
};

struct GetObjectsHelper {
 virtual ~GetObjectsHelper() = default;
 
 struct Table {
 std::string_view name;
 std::string_view type;
  };
 
 struct ColumnXdbc {
 std::optional<int16_t> xdbc_data_type;
 std::optional<std::string_view> xdbc_type_name;
 std::optional<int32_t> xdbc_column_size;
 std::optional<int16_t> xdbc_decimal_digits;
 std::optional<int16_t> xdbc_num_prec_radix;
 std::optional<int16_t> xdbc_nullable;
 std::optional<std::string_view> xdbc_column_def;
 std::optional<int16_t> xdbc_sql_data_type;
 std::optional<int16_t> xdbc_datetime_sub;
 std::optional<int32_t> xdbc_char_octet_length;
 std::optional<std::string_view> xdbc_is_nullable;
 std::optional<std::string_view> xdbc_scope_catalog;
 std::optional<std::string_view> xdbc_scope_schema;
 std::optional<std::string_view> xdbc_scope_table;
 std::optional<bool> xdbc_is_autoincrement;
 std::optional<bool> xdbc_is_generatedcolumn;
  };
 
 struct Column {
 std::string_view column_name;
 int32_t ordinal_position;
 std::optional<std::string_view> remarks;
 std::optional<ColumnXdbc> xdbc;
  };
 
 struct ConstraintUsage {
 std::optional<std::string_view> catalog;
 std::optional<std::string_view> schema;
 std::string_view table;
 std::string_view column;
  };
 
 struct Constraint {
 std::optional<std::string_view> name;
 std::string_view type;
 std::vector<std::string_view> column_names;
 std::optional<std::vector<ConstraintUsage>> usage;
  };
 
 Status Close() { return status::Ok(); }

 virtual Status Load(GetObjectsDepth depth,
 std::optional<std::string_view> catalog_filter,
 std::optional<std::string_view> schema_filter,
 std::optional<std::string_view> table_filter,
 std::optional<std::string_view> column_filter,
 const std::vector<std::string_view>& table_types) {
 return status::NotImplemented("GetObjects");
  }
 
 virtual Status LoadCatalogs(std::optional<std::string_view> catalog_filter) {
 return status::NotImplemented("GetObjects at depth = catalog");
  };
 
 virtual Result<std::optional<std::string_view>> NextCatalog() { return std::nullopt; }
 
 virtual Status LoadSchemas(std::string_view catalog,
 std::optional<std::string_view> schema_filter) {
 return status::NotImplemented("GetObjects at depth = schema");
  };
 
 virtual Result<std::optional<std::string_view>> NextSchema() { return std::nullopt; }
 
 virtual Status LoadTables(std::string_view catalog, std::string_view schema,
 std::optional<std::string_view> table_filter,
 const std::vector<std::string_view>& table_types) {
 return status::NotImplemented("GetObjects at depth = table");
  };
 
 virtual Result<std::optional<Table>> NextTable() { return std::nullopt; }
 
 virtual Status LoadColumns(std::string_view catalog, std::string_view schema,
 std::string_view table,
 std::optional<std::string_view> column_filter) {
 return status::NotImplemented("GetObjects at depth = column");
  };
 
 virtual Result<std::optional<Column>> NextColumn() { return std::nullopt; }
 
 virtual Result<std::optional<Constraint>> NextConstraint() { return std::nullopt; }
};

Status BuildGetObjects(GetObjectsHelper* helper, GetObjectsDepth depth,
 std::optional<std::string_view> catalog_filter,
 std::optional<std::string_view> schema_filter,
 std::optional<std::string_view> table_filter,
 std::optional<std::string_view> column_filter,
 const std::vector<std::string_view>& table_types,
 ArrowArrayStream* out);
} // namespace adbc::driver