ColumnDescriptor.h

Go to the documentation of this file.

/*
 * Copyright 2022 HEAVY.AI, Inc.
 *
 * Licensed 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.
 */

#ifndef COLUMN_DESCRIPTOR_H
#define COLUMN_DESCRIPTOR_H

#include <cassert>
#include <optional>
#include <string>
#include "../Shared/StringTransform.h"
#include "../Shared/sqltypes.h"
#include "../Shared/toString.h"

struct ColumnDescriptor {
  int tableId;
  int columnId;
  std::string columnName;
  std::string sourceName;
  SQLTypeInfo columnType;
  std::string chunks;
  bool isSystemCol;
  bool isVirtualCol;
  std::string virtualExpr;
  bool isDeletedCol;
  bool isGeoPhyCol{false};
  std::optional<std::string> default_value;
  int32_t db_id;

  ColumnDescriptor() : isSystemCol(false), isVirtualCol(false), isDeletedCol(false) {}
  ColumnDescriptor(const int tableId,
                   const int columnId,
                   const std::string& columnName,
                   const SQLTypeInfo columnType,
                   int32_t db_id)
      : tableId(tableId)
      , columnId(columnId)
      , columnName(columnName)
      , sourceName(columnName)
      , columnType(columnType)
      , isSystemCol(false)
      , isVirtualCol(false)
      , isDeletedCol(false)
      , db_id(db_id) {}
  ColumnDescriptor(const bool isGeoPhyCol) : ColumnDescriptor() {
    this->isGeoPhyCol = isGeoPhyCol;
  }

  std::string toString() const {
    return ::typeName(this) + "(tableId=" + ::toString(tableId) +
           ", columnId=" + ::toString(columnId) +
           ", columnName=" + ::toString(columnName) +
           ", columnType=" + ::toString(columnType) +
           ", defaultValue=" + ::toString(default_value) +
           ", db_id=" + ::toString(db_id) + ")";
  }

  std::string getDefaultValueLiteral() const {
    // some preprocessing of strings, arrays and especially arrays of strings
    CHECK(default_value.has_value());
    if (columnType.is_string() || columnType.is_geometry() || columnType.is_time()) {
      return "\'" + default_value.value() + "\'";
    } else if (columnType.is_array()) {
      auto value = default_value.value();
      CHECK(value.front() == '{' && value.back() == '}');
      value = value.substr(1, value.length() - 2);
      if (columnType.is_string_array() || is_datetime(columnType.get_subtype())) {
        auto elements = split(value, ", ");
        value = "ARRAY[";
        for (size_t i = 0; i < elements.size(); ++i) {
          value += "'" + elements[i] + "'";
          if (i != elements.size() - 1) {
            value += ", ";
          }
        }
        value += "]";
      } else {
        value = "ARRAY[" + value + "]";
      }
      return value;
    } else {
      return default_value.value();
    }
  }
};

#endif  // COLUMN_DESCRIPTOR