Package org.apache.drill.exec.proto

Class UserProtos.ResultColumnMetadata

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
org.apache.drill.exec.proto.UserProtos.ResultColumnMetadata
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable, UserProtos.ResultColumnMetadataOrBuilder
Enclosing class:
UserProtos
public static final class UserProtos.ResultColumnMetadata extends com.google.protobuf.GeneratedMessageV3 implements UserProtos.ResultColumnMetadataOrBuilder
 Metadata of a column in query result set
Protobuf type exec.user.ResultColumnMetadata
See Also:

  • Field Details

  • Method Details

    • newInstance

      protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
      Overrides:
      newInstance in class com.google.protobuf.GeneratedMessageV3

    • getUnknownFields

      public final com.google.protobuf.UnknownFieldSet getUnknownFields()
      Specified by:
      getUnknownFields in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getUnknownFields in class com.google.protobuf.GeneratedMessageV3

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

    • hasCatalogName

      public 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;
      Specified by:
      hasCatalogName in interface UserProtos.ResultColumnMetadataOrBuilder
      Returns:
      Whether the catalogName field is set.

    • getCatalogName

      public 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;
      Specified by:
      getCatalogName in interface UserProtos.ResultColumnMetadataOrBuilder
      Returns:
      The catalogName.

    • getCatalogNameBytes

      public 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;
      Specified by:
      getCatalogNameBytes in interface UserProtos.ResultColumnMetadataOrBuilder
      Returns:
      The bytes for catalogName.

    • hasSchemaName

      public 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;
      Specified by:
      hasSchemaName in interface UserProtos.ResultColumnMetadataOrBuilder
      Returns:
      Whether the schemaName field is set.

    • getSchemaName

      public 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;
      Specified by:
      getSchemaName in interface UserProtos.ResultColumnMetadataOrBuilder
      Returns:
      The schemaName.

    • getSchemaNameBytes

      public 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;
      Specified by:
      getSchemaNameBytes in interface UserProtos.ResultColumnMetadataOrBuilder
      Returns:
      The bytes for schemaName.

    • hasTableName

      public 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;
      Specified by:
      hasTableName in interface UserProtos.ResultColumnMetadataOrBuilder
      Returns:
      Whether the tableName field is set.

    • getTableName

      public 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;
      Specified by:
      getTableName in interface UserProtos.ResultColumnMetadataOrBuilder
      Returns:
      The tableName.

    • getTableNameBytes

      public 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;
      Specified by:
      getTableNameBytes in interface UserProtos.ResultColumnMetadataOrBuilder
      Returns:
      The bytes for tableName.

    • hasColumnName

      public boolean hasColumnName()
       column name
      optional string column_name = 4;
      Specified by:
      hasColumnName in interface UserProtos.ResultColumnMetadataOrBuilder
      Returns:
      Whether the columnName field is set.

    • getColumnName

      public String getColumnName()
       column name
      optional string column_name = 4;
      Specified by:
      getColumnName in interface UserProtos.ResultColumnMetadataOrBuilder
      Returns:
      The columnName.

    • getColumnNameBytes

      public com.google.protobuf.ByteString getColumnNameBytes()
       column name
      optional string column_name = 4;
      Specified by:
      getColumnNameBytes in interface UserProtos.ResultColumnMetadataOrBuilder
      Returns:
      The bytes for columnName.

    • hasLabel

      public 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;
      Specified by:
      hasLabel in interface UserProtos.ResultColumnMetadataOrBuilder
      Returns:
      Whether the label field is set.

    • getLabel

      public 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;
      Specified by:
      getLabel in interface UserProtos.ResultColumnMetadataOrBuilder
      Returns:
      The label.

    • getLabelBytes

      public 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;
      Specified by:
      getLabelBytes in interface UserProtos.ResultColumnMetadataOrBuilder
      Returns:
      The bytes for label.

    • hasDataType

      public boolean hasDataType()
       Data type in string format. Value is SQL standard type.
      optional string data_type = 6;
      Specified by:
      hasDataType in interface UserProtos.ResultColumnMetadataOrBuilder
      Returns:
      Whether the dataType field is set.

    • getDataType

      public String getDataType()
       Data type in string format. Value is SQL standard type.
      optional string data_type = 6;
      Specified by:
      getDataType in interface UserProtos.ResultColumnMetadataOrBuilder
      Returns:
      The dataType.

    • getDataTypeBytes

      public com.google.protobuf.ByteString getDataTypeBytes()
       Data type in string format. Value is SQL standard type.
      optional string data_type = 6;
      Specified by:
      getDataTypeBytes in interface UserProtos.ResultColumnMetadataOrBuilder
      Returns:
      The bytes for dataType.

    • hasIsNullable

      public boolean hasIsNullable()
      optional bool is_nullable = 7;
      Specified by:
      hasIsNullable in interface UserProtos.ResultColumnMetadataOrBuilder
      Returns:
      Whether the isNullable field is set.

    • getIsNullable

      public boolean getIsNullable()
      optional bool is_nullable = 7;
      Specified by:
      getIsNullable in interface UserProtos.ResultColumnMetadataOrBuilder
      Returns:
      The isNullable.

    • hasPrecision

      public 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;
      Specified by:
      hasPrecision in interface UserProtos.ResultColumnMetadataOrBuilder
      Returns:
      Whether the precision field is set.

    • getPrecision

      public 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;
      Specified by:
      getPrecision in interface UserProtos.ResultColumnMetadataOrBuilder
      Returns:
      The precision.

    • hasScale

      public 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;
      Specified by:
      hasScale in interface UserProtos.ResultColumnMetadataOrBuilder
      Returns:
      Whether the scale field is set.

    • getScale

      public 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;
      Specified by:
      getScale in interface UserProtos.ResultColumnMetadataOrBuilder
      Returns:
      The scale.

    • hasSigned

      public boolean hasSigned()
       Indicates whether values in the designated column are signed numbers.
      optional bool signed = 10;
      Specified by:
      hasSigned in interface UserProtos.ResultColumnMetadataOrBuilder
      Returns:
      Whether the signed field is set.

    • getSigned

      public boolean getSigned()
       Indicates whether values in the designated column are signed numbers.
      optional bool signed = 10;
      Specified by:
      getSigned in interface UserProtos.ResultColumnMetadataOrBuilder
      Returns:
      The signed.

    • hasDisplaySize

      public boolean hasDisplaySize()
       Maximum number of characters required to display data from the column.
      optional int32 display_size = 11;
      Specified by:
      hasDisplaySize in interface UserProtos.ResultColumnMetadataOrBuilder
      Returns:
      Whether the displaySize field is set.

    • getDisplaySize

      public int getDisplaySize()
       Maximum number of characters required to display data from the column.
      optional int32 display_size = 11;
      Specified by:
      getDisplaySize in interface UserProtos.ResultColumnMetadataOrBuilder
      Returns:
      The displaySize.

    • hasIsAliased

      public 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;
      Specified by:
      hasIsAliased in interface UserProtos.ResultColumnMetadataOrBuilder
      Returns:
      Whether the isAliased field is set.

    • getIsAliased

      public 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;
      Specified by:
      getIsAliased in interface UserProtos.ResultColumnMetadataOrBuilder
      Returns:
      The isAliased.

    • hasSearchability

      public boolean hasSearchability()
      optional .exec.user.ColumnSearchability searchability = 13;
      Specified by:
      hasSearchability in interface UserProtos.ResultColumnMetadataOrBuilder
      Returns:
      Whether the searchability field is set.

    • getSearchability

      public UserProtos.ColumnSearchability getSearchability()
      optional .exec.user.ColumnSearchability searchability = 13;
      Specified by:
      getSearchability in interface UserProtos.ResultColumnMetadataOrBuilder
      Returns:
      The searchability.

    • hasUpdatability

      public boolean hasUpdatability()
       Defaults to READ_ONLY
      optional .exec.user.ColumnUpdatability updatability = 14;
      Specified by:
      hasUpdatability in interface UserProtos.ResultColumnMetadataOrBuilder
      Returns:
      Whether the updatability field is set.

    • getUpdatability

      public UserProtos.ColumnUpdatability getUpdatability()
       Defaults to READ_ONLY
      optional .exec.user.ColumnUpdatability updatability = 14;
      Specified by:
      getUpdatability in interface UserProtos.ResultColumnMetadataOrBuilder
      Returns:
      The updatability.

    • hasAutoIncrement

      public boolean hasAutoIncrement()
       whether the designated column is automatically incremented.
      optional bool auto_increment = 15;
      Specified by:
      hasAutoIncrement in interface UserProtos.ResultColumnMetadataOrBuilder
      Returns:
      Whether the autoIncrement field is set.

    • getAutoIncrement

      public boolean getAutoIncrement()
       whether the designated column is automatically incremented.
      optional bool auto_increment = 15;
      Specified by:
      getAutoIncrement in interface UserProtos.ResultColumnMetadataOrBuilder
      Returns:
      The autoIncrement.

    • hasCaseSensitivity

      public boolean hasCaseSensitivity()
       Whether column's case matters for collations and comparisons. Defaults to true.
      optional bool case_sensitivity = 16;
      Specified by:
      hasCaseSensitivity in interface UserProtos.ResultColumnMetadataOrBuilder
      Returns:
      Whether the caseSensitivity field is set.

    • getCaseSensitivity

      public boolean getCaseSensitivity()
       Whether column's case matters for collations and comparisons. Defaults to true.
      optional bool case_sensitivity = 16;
      Specified by:
      getCaseSensitivity in interface UserProtos.ResultColumnMetadataOrBuilder
      Returns:
      The caseSensitivity.

    • hasSortable

      public boolean hasSortable()
       whether the column can be used in ORDER BY clause
      optional bool sortable = 17;
      Specified by:
      hasSortable in interface UserProtos.ResultColumnMetadataOrBuilder
      Returns:
      Whether the sortable field is set.

    • getSortable

      public boolean getSortable()
       whether the column can be used in ORDER BY clause
      optional bool sortable = 17;
      Specified by:
      getSortable in interface UserProtos.ResultColumnMetadataOrBuilder
      Returns:
      The sortable.

    • hasClassName

      public 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;
      Specified by:
      hasClassName in interface UserProtos.ResultColumnMetadataOrBuilder
      Returns:
      Whether the className field is set.

    • getClassName

      public 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;
      Specified by:
      getClassName in interface UserProtos.ResultColumnMetadataOrBuilder
      Returns:
      The className.

    • getClassNameBytes

      public 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;
      Specified by:
      getClassNameBytes in interface UserProtos.ResultColumnMetadataOrBuilder
      Returns:
      The bytes for className.

    • hasIsCurrency

      public boolean hasIsCurrency()
       Is the data type a currency type? For JDBC only.
      optional bool is_currency = 20;
      Specified by:
      hasIsCurrency in interface UserProtos.ResultColumnMetadataOrBuilder
      Returns:
      Whether the isCurrency field is set.

    • getIsCurrency

      public boolean getIsCurrency()
       Is the data type a currency type? For JDBC only.
      optional bool is_currency = 20;
      Specified by:
      getIsCurrency in interface UserProtos.ResultColumnMetadataOrBuilder
      Returns:
      The isCurrency.

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessageV3

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessageV3
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessageV3

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static UserProtos.ResultColumnMetadata parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static UserProtos.ResultColumnMetadata parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static UserProtos.ResultColumnMetadata parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static UserProtos.ResultColumnMetadata parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static UserProtos.ResultColumnMetadata parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static UserProtos.ResultColumnMetadata parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static UserProtos.ResultColumnMetadata parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static UserProtos.ResultColumnMetadata parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static UserProtos.ResultColumnMetadata parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static UserProtos.ResultColumnMetadata parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static UserProtos.ResultColumnMetadata parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static UserProtos.ResultColumnMetadata parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public UserProtos.ResultColumnMetadata.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static UserProtos.ResultColumnMetadata.Builder newBuilder()

    • newBuilder

      public static UserProtos.ResultColumnMetadata.Builder newBuilder(UserProtos.ResultColumnMetadata prototype)

    • toBuilder

      public UserProtos.ResultColumnMetadata.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected UserProtos.ResultColumnMetadata.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
      Specified by:
      newBuilderForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstance

      public static UserProtos.ResultColumnMetadata getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<UserProtos.ResultColumnMetadata> parser()

    • getParserForType

      public com.google.protobuf.Parser<UserProtos.ResultColumnMetadata> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstanceForType

      public UserProtos.ResultColumnMetadata getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder