org.apache.samza.sql.schema

Class SqlFieldSchema

java.lang.Object

org.apache.samza.sql.schema.SqlFieldSchema

public class SqlFieldSchema
extends java.lang.Object

Schema for the Samza SQL Field.

Method Summary

Modifier and Type	Method and Description
static SqlFieldSchema	createArraySchema(SqlFieldSchema elementType, boolean isNullable, boolean isOptional)
static SqlFieldSchema	createMapSchema(SqlFieldSchema valueType, boolean isNullable, boolean isOptional)
static SqlFieldSchema	createPrimitiveSchema(SamzaSqlFieldType typeName, boolean isNullable, boolean isOptional) Create a primitive field schema.
static SqlFieldSchema	createRowFieldSchema(SqlSchema rowSchema, boolean isNullable, boolean isOptional)
SqlFieldSchema	getElementSchema() Get the element schema if the field type is SamzaSqlFieldType.ARRAY
SamzaSqlFieldType	getFieldType() Get the Type of the Samza SQL Field.
SqlSchema	getRowSchema() Get the row schema if the field type is SamzaSqlFieldType.ROW
SqlFieldSchema	getValueSchema() Get the schema of the value if the field type is SamzaSqlFieldType.MAP
boolean	isNullable() Get if the field type is nullable.
boolean	isOptional() Get if the field type is optional.
boolean	isPrimitiveField()

Methods inherited from class java.lang.Object

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

Method Detail

createPrimitiveSchema

public static SqlFieldSchema createPrimitiveSchema(SamzaSqlFieldType typeName,
                                                   boolean isNullable,
                                                   boolean isOptional)

Create a primitive field schema.

Parameters:

typeName -

createArraySchema

public static SqlFieldSchema createArraySchema(SqlFieldSchema elementType,
                                               boolean isNullable,
                                               boolean isOptional)

createMapSchema

public static SqlFieldSchema createMapSchema(SqlFieldSchema valueType,
                                             boolean isNullable,
                                             boolean isOptional)

createRowFieldSchema

public static SqlFieldSchema createRowFieldSchema(SqlSchema rowSchema,
                                                  boolean isNullable,
                                                  boolean isOptional)

isPrimitiveField

public boolean isPrimitiveField()

Returns:

whether the field is a primitive field type or not.

getFieldType

public SamzaSqlFieldType getFieldType()

Get the Type of the Samza SQL Field.

getElementSchema

public SqlFieldSchema getElementSchema()

Get the element schema if the field type is SamzaSqlFieldType.ARRAY

getValueSchema

public SqlFieldSchema getValueSchema()

Get the schema of the value if the field type is SamzaSqlFieldType.MAP

getRowSchema

public SqlSchema getRowSchema()

Get the row schema if the field type is SamzaSqlFieldType.ROW

isNullable

public boolean isNullable()

Get if the field type is nullable.

isOptional

public boolean isOptional()

Get if the field type is optional.