org.apache.drill.exec.proto

Interface UserProtos.ResultColumnMetadataOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

UserProtos.ResultColumnMetadata, UserProtos.ResultColumnMetadata.Builder

Enclosing class:

UserProtos

public static interface UserProtos.ResultColumnMetadataOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
boolean	getAutoIncrement() whether the designated column is automatically incremented.
boolean	getCaseSensitivity() Whether column's case matters for collations and comparisons.
String	getCatalogName() Designated column's catalog name.
com.google.protobuf.ByteString	getCatalogNameBytes() Designated column's catalog name.
String	getClassName() A fully-qualified name of the Java class whose instances are created if the method ResultSet.getObject is called to retrieve a value from the column.
com.google.protobuf.ByteString	getClassNameBytes() A fully-qualified name of the Java class whose instances are created if the method ResultSet.getObject is called to retrieve a value from the column.
String	getColumnName() column name
com.google.protobuf.ByteString	getColumnNameBytes() column name
String	getDataType() Data type in string format.
com.google.protobuf.ByteString	getDataTypeBytes() Data type in string format.
int	getDisplaySize() Maximum number of characters required to display data from the column.
boolean	getIsAliased() Is the column an aliased column.
boolean	getIsCurrency() Is the data type a currency type? For JDBC only.
boolean	getIsNullable() optional bool is_nullable = 7;
String	getLabel() Column label name for display or print purposes.
com.google.protobuf.ByteString	getLabelBytes() Column label name for display or print purposes.
int	getPrecision() For numeric data, this is the maximum precision.
int	getScale() Column's number of digits to right of the decimal point.
String	getSchemaName() Designated column's schema name.
com.google.protobuf.ByteString	getSchemaNameBytes() Designated column's schema name.
UserProtos.ColumnSearchability	getSearchability() optional .exec.user.ColumnSearchability searchability = 13;
boolean	getSigned() Indicates whether values in the designated column are signed numbers.
boolean	getSortable() whether the column can be used in ORDER BY clause
String	getTableName() Designated column's table name.
com.google.protobuf.ByteString	getTableNameBytes() Designated column's table name.
UserProtos.ColumnUpdatability	getUpdatability() Defaults to READ_ONLY
boolean	hasAutoIncrement() whether the designated column is automatically incremented.
boolean	hasCaseSensitivity() Whether column's case matters for collations and comparisons.
boolean	hasCatalogName() Designated column's catalog name.
boolean	hasClassName() A fully-qualified name of the Java class whose instances are created if the method ResultSet.getObject is called to retrieve a value from the column.
boolean	hasColumnName() column name
boolean	hasDataType() Data type in string format.
boolean	hasDisplaySize() Maximum number of characters required to display data from the column.
boolean	hasIsAliased() Is the column an aliased column.
boolean	hasIsCurrency() Is the data type a currency type? For JDBC only.
boolean	hasIsNullable() optional bool is_nullable = 7;
boolean	hasLabel() Column label name for display or print purposes.
boolean	hasPrecision() For numeric data, this is the maximum precision.
boolean	hasScale() Column's number of digits to right of the decimal point.
boolean	hasSchemaName() Designated column's schema name.
boolean	hasSearchability() optional .exec.user.ColumnSearchability searchability = 13;
boolean	hasSigned() Indicates whether values in the designated column are signed numbers.
boolean	hasSortable() whether the column can be used in ORDER BY clause
boolean	hasTableName() Designated column's table name.
boolean	hasUpdatability() Defaults to READ_ONLY

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

hasCatalogName

boolean hasCatalogName()

 Designated column's catalog name. Empty string if not applicable.
 Defaults to "DRILL" as drill has only one catalog.
 

optional string catalog_name = 1;

Returns:

Whether the catalogName field is set.

getCatalogName

String getCatalogName()

 Designated column's catalog name. Empty string if not applicable.
 Defaults to "DRILL" as drill has only one catalog.
 

optional string catalog_name = 1;

Returns:

The catalogName.

getCatalogNameBytes

com.google.protobuf.ByteString getCatalogNameBytes()

 Designated column's catalog name. Empty string if not applicable.
 Defaults to "DRILL" as drill has only one catalog.
 

optional string catalog_name = 1;

Returns:

The bytes for catalogName.

hasSchemaName

boolean hasSchemaName()

 Designated column's schema name. Not set if not applicable. Initial implementation
 defaults to no value as we use LIMIT 0 queries to get the schema and schema info
 is lost. If we derive the schema from plan, we may get the right value.
 

optional string schema_name = 2;

Returns:

Whether the schemaName field is set.

getSchemaName

String getSchemaName()

 Designated column's schema name. Not set if not applicable. Initial implementation
 defaults to no value as we use LIMIT 0 queries to get the schema and schema info
 is lost. If we derive the schema from plan, we may get the right value.
 

optional string schema_name = 2;

Returns:

The schemaName.

getSchemaNameBytes

com.google.protobuf.ByteString getSchemaNameBytes()

 Designated column's schema name. Not set if not applicable. Initial implementation
 defaults to no value as we use LIMIT 0 queries to get the schema and schema info
 is lost. If we derive the schema from plan, we may get the right value.
 

optional string schema_name = 2;

Returns:

The bytes for schemaName.

hasTableName

boolean hasTableName()

 Designated column's table name. Not set if not applicable. Initial implementation
 defaults to no value as we use LIMIT 0 queries to get the schema and table info
 is lost. If we derive the schema from query plan, we may get the right value.
 

optional string table_name = 3;

Returns:

Whether the tableName field is set.

getTableName

String getTableName()

 Designated column's table name. Not set if not applicable. Initial implementation
 defaults to no value as we use LIMIT 0 queries to get the schema and table info
 is lost. If we derive the schema from query plan, we may get the right value.
 

optional string table_name = 3;

Returns:

The tableName.

getTableNameBytes

com.google.protobuf.ByteString getTableNameBytes()

 Designated column's table name. Not set if not applicable. Initial implementation
 defaults to no value as we use LIMIT 0 queries to get the schema and table info
 is lost. If we derive the schema from query plan, we may get the right value.
 

optional string table_name = 3;

Returns:

The bytes for tableName.

hasColumnName

boolean hasColumnName()

 column name
 

optional string column_name = 4;

Returns:

Whether the columnName field is set.

getColumnName

String getColumnName()

 column name
 

optional string column_name = 4;

Returns:

The columnName.

getColumnNameBytes

com.google.protobuf.ByteString getColumnNameBytes()

 column name
 

optional string column_name = 4;

Returns:

The bytes for columnName.

hasLabel

boolean hasLabel()

 Column label name for display or print purposes.
 Ex. a column named "empName" might be labeled as "Employee Name".
 

optional string label = 5;

Returns:

Whether the label field is set.

getLabel

String getLabel()

 Column label name for display or print purposes.
 Ex. a column named "empName" might be labeled as "Employee Name".
 

optional string label = 5;

Returns:

The label.

getLabelBytes

com.google.protobuf.ByteString getLabelBytes()

 Column label name for display or print purposes.
 Ex. a column named "empName" might be labeled as "Employee Name".
 

optional string label = 5;

Returns:

The bytes for label.

hasDataType

boolean hasDataType()

 Data type in string format. Value is SQL standard type.
 

optional string data_type = 6;

Returns:

Whether the dataType field is set.

getDataType

String getDataType()

 Data type in string format. Value is SQL standard type.
 

optional string data_type = 6;

Returns:

The dataType.

getDataTypeBytes

com.google.protobuf.ByteString getDataTypeBytes()

 Data type in string format. Value is SQL standard type.
 

optional string data_type = 6;

Returns:

The bytes for dataType.

hasIsNullable

boolean hasIsNullable()

optional bool is_nullable = 7;

Returns:

Whether the isNullable field is set.

getIsNullable

boolean getIsNullable()

optional bool is_nullable = 7;

Returns:

The isNullable.

hasPrecision

boolean hasPrecision()

 For numeric data, this is the maximum precision.
 For character data, this is the length in characters.
 For datetime datatypes, this is the length in characters of the String representation
    (assuming the maximum allowed precision of the fractional seconds component).
 For binary data, this is the length in bytes.
 For all other types 0 is returned where the column size is not applicable.
 

optional int32 precision = 8;

Returns:

Whether the precision field is set.

getPrecision

int getPrecision()

 For numeric data, this is the maximum precision.
 For character data, this is the length in characters.
 For datetime datatypes, this is the length in characters of the String representation
    (assuming the maximum allowed precision of the fractional seconds component).
 For binary data, this is the length in bytes.
 For all other types 0 is returned where the column size is not applicable.
 

optional int32 precision = 8;

Returns:

The precision.

hasScale

boolean hasScale()

 Column's number of digits to right of the decimal point.
 0 is returned for types where the scale is not applicable
 

optional int32 scale = 9;

Returns:

Whether the scale field is set.

getScale

int getScale()

 Column's number of digits to right of the decimal point.
 0 is returned for types where the scale is not applicable
 

optional int32 scale = 9;

Returns:

The scale.

hasSigned

boolean hasSigned()

 Indicates whether values in the designated column are signed numbers.
 

optional bool signed = 10;

Returns:

Whether the signed field is set.

getSigned

boolean getSigned()

 Indicates whether values in the designated column are signed numbers.
 

optional bool signed = 10;

Returns:

The signed.

hasDisplaySize

boolean hasDisplaySize()

 Maximum number of characters required to display data from the column.
 

optional int32 display_size = 11;

Returns:

Whether the displaySize field is set.

getDisplaySize

int getDisplaySize()

 Maximum number of characters required to display data from the column.
 

optional int32 display_size = 11;

Returns:

The displaySize.

hasIsAliased

boolean hasIsAliased()

 Is the column an aliased column. Initial implementation defaults to
 true as we derive schema from LIMIT 0 query and not the query plan.
 

optional bool is_aliased = 12;

Returns:

Whether the isAliased field is set.

getIsAliased

boolean getIsAliased()

 Is the column an aliased column. Initial implementation defaults to
 true as we derive schema from LIMIT 0 query and not the query plan.
 

optional bool is_aliased = 12;

Returns:

The isAliased.

hasSearchability

boolean hasSearchability()

optional .exec.user.ColumnSearchability searchability = 13;

Returns:

Whether the searchability field is set.

getSearchability

UserProtos.ColumnSearchability getSearchability()

optional .exec.user.ColumnSearchability searchability = 13;

Returns:

The searchability.

hasUpdatability

boolean hasUpdatability()

 Defaults to READ_ONLY
 

optional .exec.user.ColumnUpdatability updatability = 14;

Returns:

Whether the updatability field is set.

getUpdatability

UserProtos.ColumnUpdatability getUpdatability()

 Defaults to READ_ONLY
 

optional .exec.user.ColumnUpdatability updatability = 14;

Returns:

The updatability.

hasAutoIncrement

boolean hasAutoIncrement()

 whether the designated column is automatically incremented.
 

optional bool auto_increment = 15;

Returns:

Whether the autoIncrement field is set.

getAutoIncrement

boolean getAutoIncrement()

 whether the designated column is automatically incremented.
 

optional bool auto_increment = 15;

Returns:

The autoIncrement.

hasCaseSensitivity

boolean hasCaseSensitivity()

 Whether column's case matters for collations and comparisons. Defaults to true.
 

optional bool case_sensitivity = 16;

Returns:

Whether the caseSensitivity field is set.

getCaseSensitivity

boolean getCaseSensitivity()

 Whether column's case matters for collations and comparisons. Defaults to true.
 

optional bool case_sensitivity = 16;

Returns:

The caseSensitivity.

hasSortable

boolean hasSortable()

 whether the column can be used in ORDER BY clause
 

optional bool sortable = 17;

Returns:

Whether the sortable field is set.

getSortable

boolean getSortable()

 whether the column can be used in ORDER BY clause
 

optional bool sortable = 17;

Returns:

The sortable.

hasClassName

boolean hasClassName()

 A fully-qualified name of the Java class whose instances are created
 if the method ResultSet.getObject is called to retrieve
 a value from the column. Applicable only to JDBC clients.
 

optional string class_name = 18;

Returns:

Whether the className field is set.

getClassName

String getClassName()

 A fully-qualified name of the Java class whose instances are created
 if the method ResultSet.getObject is called to retrieve
 a value from the column. Applicable only to JDBC clients.
 

optional string class_name = 18;

Returns:

The className.

getClassNameBytes

com.google.protobuf.ByteString getClassNameBytes()

 A fully-qualified name of the Java class whose instances are created
 if the method ResultSet.getObject is called to retrieve
 a value from the column. Applicable only to JDBC clients.
 

optional string class_name = 18;

Returns:

The bytes for className.

hasIsCurrency

boolean hasIsCurrency()

 Is the data type a currency type? For JDBC only.
 

optional bool is_currency = 20;

Returns:

Whether the isCurrency field is set.

getIsCurrency

boolean getIsCurrency()

 Is the data type a currency type? For JDBC only.
 

optional bool is_currency = 20;

Returns:

The isCurrency.