SqlType (Google Cloud Bigtable 2.78.1 API)

Type Parameters:

T - the corresponding java type

All Superinterfaces:

Serializable

All Known Subinterfaces:

SqlType.Array<Elem>, SqlType.Enum<T>, SqlType.Map<K,V>, SqlType.Proto<T>, SqlType.Struct

All Known Implementing Classes:

Type.Array, Type.Bool, Type.Bytes, Type.Date, Type.Enum, Type.Float32, Type.Float64, Type.Int64, Type.Map, Type.Proto, Type.SchemalessEnum, Type.SchemalessProto, Type.SchemalessStruct, Type.String, Type.StructWithSchema, Type.Timestamp
```
public interface SqlType<T>
extends Serializable
```
Represents a data type in a SQL query.
Complex types (SqlType.Map, SqlType.Array, & SqlType.Struct provide additional information about the schema of the type.

Nested Class Summary

Nested Classes
Modifier and Type	Interface and Description
`static interface`	`SqlType.Array<Elem>` Represents an array type in SQL.
`static class`	`SqlType.Code`
`static interface`	`SqlType.Enum<T extends com.google.protobuf.ProtocolMessageEnum>` Represents a protobuf enum type in SQL.
`static interface`	`SqlType.Map<K,V>` Represents a map type in SQL.
`static interface`	`SqlType.Proto<T extends com.google.protobuf.AbstractMessage>` Represents a protobuf message type in SQL.
`static interface`	`SqlType.Struct` Represents a struct type in SQL.

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`static <Elem> SqlType.Array<Elem>`	`arrayOf(SqlType<Elem> elemType)` returns a `SqlType` for an `ARRAY` with elements of type `elemType`
`static SqlType<Boolean>`	`bool()` returns a `SqlType` for the `BOOL` type.
`static SqlType<com.google.protobuf.ByteString>`	`bytes()` returns a `SqlType` for the `BYTES` type.
`static SqlType<com.google.cloud.Date>`	`date()` returns a `SqlType` for the `DATE` type.
`static <T extends com.google.protobuf.ProtocolMessageEnum> SqlType.Enum<T>`	`enumOf(Function<Integer,T> method)` Returns a `SqlType` for a protobuf enum.
`static SqlType<Float>`	`float32()` returns a `SqlType` for the `FLOAT32` type.
`static SqlType<Double>`	`float64()` returns a `SqlType` for the `FLOAT64` type.
`static SqlType<?>`	`fromProto(Type proto)` Creates a `SqlType` from the protobuf representation of Types.
`SqlType.Code`	`getCode()`
`static String`	`getUnqualifiedName(String fullName)` Extracts the unqualified name from a fully qualified proto message or enum name.
`static SqlType.Map<com.google.protobuf.ByteString,List<Struct>>`	`historicalMap()` returns the `SqlType` for the type returned for column families in `with_history` queries.
`static SqlType<Long>`	`int64()` returns a `SqlType` for the `INT64` type.
`static <K,V> SqlType.Map<K,V>`	`mapOf(SqlType<K> keyType, SqlType<V> valType)` returns a `SqlType` for a @code MAP} with keys of type `keyType` and values of type `valType`
`static <T extends com.google.protobuf.AbstractMessage> SqlType.Proto<T>`	`protoOf(T message)` Returns a `SqlType` for a protobuf message.
`static SqlType<String>`	`string()` returns a `SqlType` for the `STRING` type.
`static SqlType.Struct`	`struct()` returns a fake `STRUCT type` for use on in `StructReader` methods that require a `SqlType` to validate against.
`static SqlType<Instant>`	`timestamp()` returns a `SqlType` for the `TIMESTAMP` type.
`static boolean`	`typesMatch(SqlType<?> left, SqlType<?> right)` This can be used to check whether `StructReader` get calls are being called for the correct type when compared to the schema.

- Method Detail
  - getCode
```
SqlType.Code getCode()
```
    Returns:
    
    SqlType.Code enum for this type
  - bytes
```
static SqlType<com.google.protobuf.ByteString> bytes()
```
    returns a SqlType for the BYTES type.
  - string
```
static SqlType<String> string()
```
    returns a SqlType for the STRING type.
  - int64
```
static SqlType<Long> int64()
```
    returns a SqlType for the INT64 type.
  - float64
```
static SqlType<Double> float64()
```
    returns a SqlType for the FLOAT64 type.
  - float32
```
static SqlType<Float> float32()
```
    returns a SqlType for the FLOAT32 type.
  - bool
```
static SqlType<Boolean> bool()
```
    returns a SqlType for the BOOL type.
  - timestamp
```
static SqlType<Instant> timestamp()
```
    returns a SqlType for the TIMESTAMP type.
  - date
```
static SqlType<com.google.cloud.Date> date()
```
    returns a SqlType for the DATE type.
  - struct
```
static SqlType.Struct struct()
```
    returns a fake STRUCT type for use on in StructReader methods that require a SqlType to validate against. This does not specify a schema because the struct schem will be validated on calls to the structs data accessors.
    Attempts to access the schema of a struct created this way will throw exceptions.
    Example usage:
```
   List<Struct> structList = resultSet.getList("column", SqlType.arrayOf(SqlType.struct()));
 
```
  - arrayOf
```
static <Elem> SqlType.Array<Elem> arrayOf(SqlType<Elem> elemType)
```
    returns a SqlType for an ARRAY with elements of type elemType
  - mapOf
```
static <K,V> SqlType.Map<K,V> mapOf(SqlType<K> keyType,
                                    SqlType<V> valType)
```
    returns a SqlType for a @code MAP} with keys of type keyType and values of type valType
  - historicalMap
```
static SqlType.Map<com.google.protobuf.ByteString,List<Struct>> historicalMap()
```
    returns the SqlType for the type returned for column families in with_history queries. This is equivalent to SqlType.mapOf(SqlType.bytes(), SqlType.arrayOf(SqlType.struct()))
  - protoOf
```
@BetaApi(value="This feature is currently experimental and can change in the future")
static <T extends com.google.protobuf.AbstractMessage> SqlType.Proto<T> protoOf(T message)
```
    Returns a SqlType for a protobuf message.
    
    Type Parameters:
    
    T - the message type
    
    Parameters:
    
    message - an instance of the message. MyMessage.getDefaultInstance() can be used.
  - enumOf
```
@BetaApi(value="This feature is currently experimental and can change in the future")
static <T extends com.google.protobuf.ProtocolMessageEnum> SqlType.Enum<T> enumOf(Function<Integer,T> method)
```
    Returns a SqlType for a protobuf enum.
    
    Type Parameters:
    
    T - the enum type
    
    Parameters:
    
    method - a function to convert an integer to the enum value. This is usually MyEnum::forNumber
  - getUnqualifiedName
```
@InternalApi
static String getUnqualifiedName(String fullName)
```
    Extracts the unqualified name from a fully qualified proto message or enum name. For example, "my.package.MyMessage" becomes "MyMessage".
    This is considered an internal implementation detail and not meant to be used by applications.
  - fromProto
```
@InternalApi
static SqlType<?> fromProto(Type proto)
```
    Creates a SqlType from the protobuf representation of Types.
    This is considered an internal implementation detail and not meant to be used by applications.
  - typesMatch
```
@InternalApi
static boolean typesMatch(SqlType<?> left,
                                       SqlType<?> right)
```
    This can be used to check whether StructReader get calls are being called for the correct type when compared to the schema. This is different that equals because we do not require users to specify the full struct schema for struct get calls. This is safe because the struct schema will be validated on calls to the struct.
    This is considered an internal implementation detail and not meant to be used by applications.

Interface SqlType<T>

Nested Class Summary

Method Summary

Method Detail

getCode

bytes

string

int64

float64

float32

bool

timestamp

date

struct

arrayOf

mapOf

historicalMap

protoOf

enumOf

getUnqualifiedName

fromProto

typesMatch