io.cdap.cdap.api.dataset.lib

Class ObjectMappedTableProperties.Builder

java.lang.Object

io.cdap.cdap.api.dataset.DatasetProperties.Builder

io.cdap.cdap.api.dataset.table.TableProperties.AbstractBuilder<ObjectMappedTableProperties.Builder>

io.cdap.cdap.api.dataset.lib.ObjectMappedTableProperties.Builder

Enclosing class:

ObjectMappedTableProperties

public static class ObjectMappedTableProperties.Builder
extends TableProperties.AbstractBuilder<ObjectMappedTableProperties.Builder>

A Builder to construct properties for ObjectMappedTable datasets.

Method Summary

Modifier and Type	Method and Description
DatasetProperties	build() Create a DatasetProperties from this builder.
ObjectMappedTableProperties.Builder	setRowKeyExploreName(String name) Sets the row key column name in the corresponding Hive table for an ObjectMappedTable.
ObjectMappedTableProperties.Builder	setRowKeyExploreType(Schema.Type type) Sets the column type for the row key column in the corresponding Hive table for an ObjectMappedTable.
ObjectMappedTableProperties.Builder	setType(Type type) Sets the type of object stored in the table.

Methods inherited from class io.cdap.cdap.api.dataset.table.TableProperties.AbstractBuilder

setColumnFamily, setColumnFamily, setConflictDetection, setReadlessIncrementSupport, setRowFieldName, setSchema, setTablePermissions, setTTL

Methods inherited from class io.cdap.cdap.api.dataset.DatasetProperties.Builder

add, add, add, addAll, setDescription

Methods inherited from class java.lang.Object

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

Method Detail

setType

public ObjectMappedTableProperties.Builder setType(Type type)
                                            throws UnsupportedTypeException

Sets the type of object stored in the table. The schema of the Hive table for an ObjectMappedTable is derived from the object type set here and the row key explore name set by setRowKeyExploreName(String). For example, if the type set here has three fields - "id", "name", and "price", the corresponding Hive table for this Dataset will contain four columns - "rowkey", "id", "name", and "price".

Throws:

UnsupportedTypeException

setRowKeyExploreName

public ObjectMappedTableProperties.Builder setRowKeyExploreName(String name)

Sets the row key column name in the corresponding Hive table for an ObjectMappedTable. The schema of the Hive table for an ObjectMappedTable is derived from the object type set by setType(Type) and the row key explore name set here. The name set here cannot be the same as any of the fields in the object type. For example, if you are storing an Object with a single string field named "id", the corresponding Hive table will have a schema of (rowkey binary, id string). If you set the name of the row key to "name", the corresponding Hive table will instead have the schema (name binary, id string).

setRowKeyExploreType

public ObjectMappedTableProperties.Builder setRowKeyExploreType(Schema.Type type)

Sets the column type for the row key column in the corresponding Hive table for an ObjectMappedTable. By default, the type of the row key in your Hive table will be binary. You can set the type using this method. Only Schema.Type.BYTES and Schema.Type.STRING are allowed. For example, if you are storing an Object with a single string field named "id", the corresponding Hive table will have a schema of (rowkey binary, id string). If you set the type to a string using this method, the corresponding Hive table will instead have the schema (rowkey string, id string).

build

public DatasetProperties build()

Create a DatasetProperties from this builder.

Overrides:

build in class DatasetProperties.Builder