com.google.cloud.bigtable.common

Class Type.SchemalessStruct

java.lang.Object

com.google.cloud.bigtable.common.Type.SchemalessStruct

All Implemented Interfaces:

Type, SqlType<Struct>, SqlType.Struct, Serializable

Enclosing interface:

Type

public abstract static class Type.SchemalessStruct
extends Object
implements Type, SqlType.Struct

This is a special version of struct that is intended to only be used in the StructReader getters that require types. We don't want users to need to specify the struct schema when the schema will be validated on calls to StructReader methods on the struct.

Any attempts to interact with the schema will throw an exception.

For example the historical map data type uses this as follows:

 Map<ByteString, List<Struct>> historicalMap =
     resultSet.getMap(
        "cf",
        SqlType.mapOf(SqlType.bytes(), SqlType.arrayOf(SqlType.struct())));
 Struct struct = historicalMap.get("column").get(0);
 // Struct schema will be validated here so there's no need for users to pass the schema to getMap above
 ByteString value = struct.getBytes("value");
 

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface com.google.cloud.bigtable.common.Type

Type.Array<Elem>, Type.Bool, Type.Bytes, Type.Date, Type.DefaultInstances, Type.Enum<T extends com.google.protobuf.ProtocolMessageEnum>, Type.Float32, Type.Float64, Type.Int64, Type.Map<K,V>, Type.Proto<T extends com.google.protobuf.AbstractMessage>, Type.SchemalessEnum, Type.SchemalessProto, Type.SchemalessStruct, Type.String, Type.StructWithSchema, Type.Timestamp

Nested classes/interfaces inherited from interface com.google.cloud.bigtable.data.v2.models.sql.SqlType.Struct

SqlType.Struct.Field

Nested classes/interfaces inherited from interface com.google.cloud.bigtable.data.v2.models.sql.SqlType

SqlType.Code, SqlType.Struct

Constructor Summary

Constructors

Constructor and Description
SchemalessStruct()

Method Summary

Modifier and Type	Method and Description
static Type.SchemalessStruct	create()
SqlType.Code	getCode()
int	getColumnIndex(String fieldName)
List<SqlType.Struct.Field>	getFields()
SqlType<?>	getType(int fieldIndex)
SqlType<?>	getType(String fieldName)
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.cloud.bigtable.data.v2.models.sql.SqlType

arrayOf, bool, bytes, date, enumOf, float32, float64, fromProto, getUnqualifiedName, historicalMap, int64, mapOf, protoOf, string, struct, timestamp, typesMatch

Constructor Detail

SchemalessStruct

public SchemalessStruct()

Method Detail

create

public static Type.SchemalessStruct create()

getCode

public SqlType.Code getCode()

Specified by:

getCode in interface SqlType<Struct>

Returns:

SqlType.Code enum for this type

getFields

public List<SqlType.Struct.Field> getFields()

Specified by:

getFields in interface SqlType.Struct

Returns:

the ordered list of SqlType.Struct.Fields for the struct

getType

public SqlType<?> getType(int fieldIndex)

Specified by:

getType in interface SqlType.Struct

Parameters:

fieldIndex - index of the field

Returns:

the SqlType of the field at the given index

getType

public SqlType<?> getType(String fieldName)

Specified by:

getType in interface SqlType.Struct

Parameters:

fieldName - name of the field

Returns:

the SqlType of the field with the given name

getColumnIndex

public int getColumnIndex(String fieldName)

Specified by:

getColumnIndex in interface SqlType.Struct

Parameters:

fieldName - name of the field

Returns:

the field index of the field with the given name

toString

public final String toString()

Overrides:

toString in class Object