/**
* 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.
*/
package org.apache.drill.exec.store.ischema;
import static org.slf4j.LoggerFactory.getLogger;
import org.apache.calcite.avatica.util.TimeUnit;
import org.apache.calcite.rel.type.RelDataType;
import org.apache.calcite.rel.type.RelDataTypeField;
import org.apache.calcite.sql.type.SqlTypeName;
import org.apache.drill.exec.planner.types.DrillRelDataTypeSystem;
import org.slf4j.Logger;
import com.google.common.base.MoreObjects;
public class Records {
/** Pojo object for a record in INFORMATION_SCHEMA.TABLES */
public static class Table {
public final String TABLE_CATALOG;
public final String TABLE_SCHEMA;
public final String TABLE_NAME;
public final String TABLE_TYPE;
public Table(String catalog, String schema, String name, String type) {
this.TABLE_CATALOG = catalog;
this.TABLE_SCHEMA = schema;
this.TABLE_NAME = name;
this.TABLE_TYPE = type;
}
}
/** Pojo object for a record in INFORMATION_SCHEMA.COLUMNS */
public static class Column {
private static final Logger logger = getLogger( Column.class );
// TODO: Resolve: Do we have such a constant elsewhere? If so, use it.
// If not, where should this really live?:
private static final int MAX_UTF8_BYTES_PER_CHARACTER = 4;
public final String TABLE_CATALOG;
public final String TABLE_SCHEMA;
public final String TABLE_NAME;
public final String COLUMN_NAME;
public final int ORDINAL_POSITION;
public final String COLUMN_DEFAULT;
public final String IS_NULLABLE;
public final String DATA_TYPE;
public final Integer COLUMN_SIZE;
public final Integer CHARACTER_MAXIMUM_LENGTH;
public final Integer CHARACTER_OCTET_LENGTH;
public final Integer NUMERIC_PRECISION;
public final Integer NUMERIC_PRECISION_RADIX;
public final Integer NUMERIC_SCALE;
public final Integer DATETIME_PRECISION;
public final String INTERVAL_TYPE;
public final Integer INTERVAL_PRECISION;
// See:
// - ISO/IEC 9075-11:2011(E) 5.21 COLUMNS view
// - ISO/IEC 9075-11:2011(E) 6.22 DATA_TYPE_DESCRIPTOR base table
public Column(String catalog, String schemaName, String tableName, RelDataTypeField field) {
this.TABLE_CATALOG = catalog;
this.TABLE_SCHEMA = schemaName;
this.TABLE_NAME = tableName;
this.COLUMN_NAME = field.getName();
final RelDataType relDataType = field.getType();
// (Like SQL data type names, but not standard ones.)
final SqlTypeName sqlTypeName = relDataType.getSqlTypeName();
// Get 1-based column ordinal position from 0-based field/column index:
this.ORDINAL_POSITION = 1 + field.getIndex();
this.COLUMN_DEFAULT = null;
this.IS_NULLABLE = relDataType.isNullable() ? "YES" : "NO";
switch ( sqlTypeName ) {
// 1. SqlTypeName enumerators whose names (currently) match SQL's values
// for DATA_TYPE (those which have been seen in tests and verified):
case BOOLEAN:
case TINYINT:
case SMALLINT:
case INTEGER:
case BIGINT:
case DECIMAL:
case FLOAT:
case REAL:
case DOUBLE:
case DATE:
case TIME:
case TIMESTAMP:
// INTERVAL_YEAR_MONTH - Not identical; see below.
// INTERVAL_DAY_TIME - Not identical; see below.
// CHAR - Not identical; see below.
// VARCHAR - Not identical; see below.
case BINARY:
// VARBINARY - Not identical; see below.
// TODO(DRILL-3253): Update these once we have test plugin supporting
// all needed types:
// NULL - Not seen/explicitly addressed.
// ANY - " "
// SYMBOL - " "
// MULTISET - " "
case ARRAY:
case MAP:
// DISTINCT - Not seen/explicitly addressed.
// STRUCTURED - " "
// ROW - " "
// OTHER - " "
// CURSOR - " "
// COLUMN_LIST - " "
this.DATA_TYPE = sqlTypeName.name();
break;
// 2. SqlTypeName enumerators whose names (currently) do not match SQL's
// values for DATA_TYPE:
case CHAR: this.DATA_TYPE = "CHARACTER"; break;
case VARCHAR: this.DATA_TYPE = "CHARACTER VARYING"; break;
case VARBINARY: this.DATA_TYPE = "BINARY VARYING"; break;
case INTERVAL_YEAR_MONTH: this.DATA_TYPE = "INTERVAL"; break;
case INTERVAL_DAY_TIME: this.DATA_TYPE = "INTERVAL"; break;
// 3: SqlTypeName enumerators not yet seen and confirmed or handled.
default:
logger.warn( "Type not handled explicitly (code needs review): "
+ sqlTypeName );
this.DATA_TYPE = sqlTypeName.toString();
break;
}
// Note: The branches are in the same order as SQL constraint
// DATA_TYPE_DESCRIPTOR_DATA_TYPE_CHECK_COMBINATIONS.
switch ( sqlTypeName ) {
case CHAR:
case VARCHAR:
this.CHARACTER_MAXIMUM_LENGTH = relDataType.getPrecision();
if ( this.CHARACTER_MAXIMUM_LENGTH
< Integer.MAX_VALUE / MAX_UTF8_BYTES_PER_CHARACTER ) {
this.CHARACTER_OCTET_LENGTH =
this.CHARACTER_MAXIMUM_LENGTH * MAX_UTF8_BYTES_PER_CHARACTER;
}
else {
this.CHARACTER_OCTET_LENGTH = Integer.MAX_VALUE;
}
// Column size is the number of characters
this.COLUMN_SIZE = this.CHARACTER_MAXIMUM_LENGTH;
this.NUMERIC_PRECISION = null;
this.NUMERIC_PRECISION_RADIX = null;
this.NUMERIC_SCALE = null;
this.DATETIME_PRECISION = null;
this.INTERVAL_TYPE = null;
this.INTERVAL_PRECISION = null;
break;
case BINARY:
case VARBINARY:
this.CHARACTER_MAXIMUM_LENGTH = relDataType.getPrecision();
this.CHARACTER_OCTET_LENGTH = this.CHARACTER_MAXIMUM_LENGTH;
// Column size is the number of bytes
this.COLUMN_SIZE = this.CHARACTER_MAXIMUM_LENGTH;
this.NUMERIC_PRECISION = null;
this.NUMERIC_PRECISION_RADIX = null;
this.NUMERIC_SCALE = null;
this.DATETIME_PRECISION = null;
this.INTERVAL_TYPE = null;
this.INTERVAL_PRECISION = null;
break;
case BOOLEAN:
this.COLUMN_SIZE = 1;
this.CHARACTER_MAXIMUM_LENGTH = null;
this.CHARACTER_OCTET_LENGTH = null;
this.NUMERIC_PRECISION = null;
this.NUMERIC_PRECISION_RADIX = null;
this.NUMERIC_SCALE = null;
this.DATETIME_PRECISION = null;
this.INTERVAL_TYPE = null;
this.INTERVAL_PRECISION = null;
break;
case TINYINT:
case SMALLINT:
case INTEGER:
case BIGINT:
this.CHARACTER_MAXIMUM_LENGTH = null;
this.CHARACTER_OCTET_LENGTH = null;
// This NUMERIC_PRECISION is in bits since NUMERIC_PRECISION_RADIX is 2.
switch ( sqlTypeName ) {
case TINYINT: NUMERIC_PRECISION = 8; break;
case SMALLINT: NUMERIC_PRECISION = 16; break;
case INTEGER: NUMERIC_PRECISION = 32; break;
case BIGINT: NUMERIC_PRECISION = 64; break;
default:
throw new AssertionError(
"Unexpected " + sqlTypeName.getClass().getName() + " value "
+ sqlTypeName );
//break;
}
this.NUMERIC_PRECISION_RADIX = 2;
// Column size is the number of digits, based on the precision radix
this.COLUMN_SIZE = NUMERIC_PRECISION;
this.NUMERIC_SCALE = 0;
this.DATETIME_PRECISION = null;
this.INTERVAL_TYPE = null;
this.INTERVAL_PRECISION = null;
break;
case DECIMAL:
this.CHARACTER_MAXIMUM_LENGTH = null;
this.CHARACTER_OCTET_LENGTH = null;
// This NUMERIC_PRECISION is in decimal digits since
// NUMERIC_PRECISION_RADIX is 10.
this.NUMERIC_PRECISION = relDataType.getPrecision();
this.NUMERIC_PRECISION_RADIX = 10;
// Column size is the number of digits, based on the precision radix
this.COLUMN_SIZE = NUMERIC_PRECISION;
this.NUMERIC_SCALE = relDataType.getScale();
this.DATETIME_PRECISION = null;
this.INTERVAL_TYPE = null;
this.INTERVAL_PRECISION = null;
break;
case REAL:
case FLOAT:
case DOUBLE:
this.CHARACTER_MAXIMUM_LENGTH = null;
this.CHARACTER_OCTET_LENGTH = null;
// This NUMERIC_PRECISION is in bits since NUMERIC_PRECISION_RADIX is 2.
switch ( sqlTypeName ) {
case REAL: NUMERIC_PRECISION = 24; break;
case FLOAT: NUMERIC_PRECISION = 24; break;
case DOUBLE: NUMERIC_PRECISION = 53; break;
default:
throw new AssertionError(
"Unexpected type " + sqlTypeName + " in approximate-types branch" );
//break;
}
this.NUMERIC_PRECISION_RADIX = 2;
// Column size is the number of digits, based on the precision radix
this.COLUMN_SIZE = NUMERIC_PRECISION;
this.NUMERIC_SCALE = null;
this.DATETIME_PRECISION = null;
this.INTERVAL_TYPE = null;
this.INTERVAL_PRECISION = null;
break;
case DATE:
case TIME:
case TIMESTAMP:
this.CHARACTER_MAXIMUM_LENGTH = null;
this.CHARACTER_OCTET_LENGTH = null;
this.NUMERIC_PRECISION = null;
this.NUMERIC_PRECISION_RADIX = null;
this.NUMERIC_SCALE = null;
// TODO: Resolve whether this gets _SQL_-defined precision.
// (RelDataType.getPrecision()'s doc. says "JDBC-defined
// precision.")
this.DATETIME_PRECISION = relDataType.getPrecision();
this.INTERVAL_TYPE = null;
this.INTERVAL_PRECISION = null;
switch(sqlTypeName) {
case DATE: this.COLUMN_SIZE = 10; break;// yyyy-MM-dd
case TIME: this.COLUMN_SIZE = this.DATETIME_PRECISION == 0
? 8 // HH::mm::ss
: 8 + 1 + this.DATETIME_PRECISION;
break;
case TIMESTAMP: this.COLUMN_SIZE = this.DATETIME_PRECISION == 0
? 10 + 1 + 8 // date + "T" + time
: 10 + 1 + 8 + 1 + this.DATETIME_PRECISION;
break;
default:
throw new AssertionError(
"Unexpected type " + sqlTypeName + " in approximate-types branch" );
}
break;
case INTERVAL_YEAR_MONTH:
case INTERVAL_DAY_TIME:
this.CHARACTER_MAXIMUM_LENGTH = null;
this.CHARACTER_OCTET_LENGTH = null;
this.NUMERIC_PRECISION = null;
this.NUMERIC_PRECISION_RADIX = null;
this.NUMERIC_SCALE = null;
switch ( sqlTypeName ) {
case INTERVAL_YEAR_MONTH:
// NOTE: Apparently can't get use RelDataType, etc.; it seems to
// apply a default fractional seconds precision of 6 for SECOND,
// even though SECOND does not exist for this case.
this.DATETIME_PRECISION = 0;
break;
case INTERVAL_DAY_TIME:
this.DATETIME_PRECISION =
relDataType
.getIntervalQualifier()
.getFractionalSecondPrecision(
DrillRelDataTypeSystem.DRILL_REL_DATATYPE_SYSTEM );
break;
default:
throw new AssertionError(
"Unexpected type " + sqlTypeName + " in interval-types branch" );
//break;
}
this.INTERVAL_PRECISION =
relDataType
.getIntervalQualifier()
.getStartPrecision(DrillRelDataTypeSystem.DRILL_REL_DATATYPE_SYSTEM);
{
final TimeUnit start = relDataType.getIntervalQualifier().getStartUnit();
// NOTE: getEndUnit() returns null instead of YEAR for "INTERVAL YEAR".
final TimeUnit end = MoreObjects.firstNonNull(relDataType.getIntervalQualifier().getEndUnit(), start);
if ( start == end ) {
this.INTERVAL_TYPE = start.name();
}
else {
this.INTERVAL_TYPE = start + " TO " + end;
}
// extra size for fractional types
final int extraSecondIntervalSize = this.DATETIME_PRECISION > 0
? DATETIME_PRECISION + 1 // add 1 for decimal point
: 0;
switch(start) {
case YEAR:
switch(end) {
case YEAR: this.COLUMN_SIZE = INTERVAL_PRECISION + 2; break;// P..Y
case MONTH: this.COLUMN_SIZE = this.INTERVAL_PRECISION + 5; break; // P..Y12M
default:
throw new AssertionError("Unexpected interval type " + this.INTERVAL_TYPE + " in interval-types branch" );
}
break;
case MONTH:
switch(end) {
case MONTH: this.COLUMN_SIZE = this.INTERVAL_PRECISION + 2; break; // P..M
default:
throw new AssertionError("Unexpected interval type " + this.INTERVAL_TYPE + " in interval-types branch" );
}
break;
case DAY:
switch(end) {
case DAY: this.COLUMN_SIZE = this.INTERVAL_PRECISION + 2; break; // P..D
case HOUR: this.COLUMN_SIZE = this.INTERVAL_PRECISION + 6; break; // P..DT12H
case MINUTE: this.COLUMN_SIZE = this.INTERVAL_PRECISION + 9; break; // P..DT12H60M
case SECOND: this.COLUMN_SIZE = this.INTERVAL_PRECISION + 12 + extraSecondIntervalSize; break; // P..DT12H60M60....S
default:
throw new AssertionError("Unexpected interval type " + this.INTERVAL_TYPE + " in interval-types branch" );
}
break;
case HOUR:
switch(end) {
case HOUR: this.COLUMN_SIZE = this.INTERVAL_PRECISION + 3; break; // PT..H
case MINUTE: this.COLUMN_SIZE = this.INTERVAL_PRECISION + 6; break; // PT..H60M
case SECOND: this.COLUMN_SIZE = this.INTERVAL_PRECISION + 9 + extraSecondIntervalSize; break; // PT..H12M60....S
default:
throw new AssertionError("Unexpected interval type " + this.INTERVAL_TYPE + " in interval-types branch" );
}
break;
case MINUTE:
switch(end) {
case MINUTE: this.COLUMN_SIZE = this.INTERVAL_PRECISION + 3; break; // PT...M
case SECOND: this.COLUMN_SIZE = this.INTERVAL_PRECISION + 6 + extraSecondIntervalSize; break; // PT..M60....S
default:
throw new AssertionError("Unexpected interval type " + this.INTERVAL_TYPE + " in interval-types branch" );
}
break;
case SECOND:
switch(end) {
case SECOND: this.COLUMN_SIZE = this.INTERVAL_PRECISION + 3 + extraSecondIntervalSize; break; // PT....S
default:
throw new AssertionError("Unexpected interval type " + this.INTERVAL_TYPE + " in interval-types branch" );
}
break;
default:
throw new AssertionError("Unexpected interval type " + this.INTERVAL_TYPE + " in interval-types branch" );
}
}
break;
default:
this.NUMERIC_PRECISION_RADIX = null;
this.CHARACTER_MAXIMUM_LENGTH = null;
this.CHARACTER_OCTET_LENGTH = null;
this.NUMERIC_PRECISION = null;
this.NUMERIC_SCALE = null;
this.DATETIME_PRECISION = null;
this.INTERVAL_TYPE = null;
this.INTERVAL_PRECISION = null;
this.COLUMN_SIZE = null;
break;
}
}
}
/** Pojo object for a record in INFORMATION_SCHEMA.VIEWS */
public static class View {
public final String TABLE_CATALOG;
public final String TABLE_SCHEMA;
public final String TABLE_NAME;
public final String VIEW_DEFINITION;
public View(String catalog, String schema, String name, String definition) {
this.TABLE_CATALOG = catalog;
this.TABLE_SCHEMA = schema;
this.TABLE_NAME = name;
this.VIEW_DEFINITION = definition;
}
}
/** Pojo object for a record in INFORMATION_SCHEMA.CATALOGS */
public static class Catalog {
public final String CATALOG_NAME;
public final String CATALOG_DESCRIPTION;
public final String CATALOG_CONNECT;
public Catalog(String name, String description, String connect) {
this.CATALOG_NAME = name;
this.CATALOG_DESCRIPTION = description;
this.CATALOG_CONNECT = connect;
}
}
/** Pojo object for a record in INFORMATION_SCHEMA.SCHEMATA */
public static class Schema {
public final String CATALOG_NAME;
public final String SCHEMA_NAME;
public final String SCHEMA_OWNER;
public final String TYPE;
public final String IS_MUTABLE;
public Schema(String catalog, String name, String owner, String type, boolean isMutable) {
this.CATALOG_NAME = catalog;
this.SCHEMA_NAME = name;
this.SCHEMA_OWNER = owner;
this.TYPE = type;
this.IS_MUTABLE = isMutable ? "YES" : "NO";
}
}
}