com.aliyun.odps.udf

Class DataAttributes

java.lang.Object

com.aliyun.odps.udf.DataAttributes

Direct Known Subclasses:

TableOutputerAttributes

public abstract class DataAttributes
extends Object

Provides interfaces to access different attributes of the underlying data, including the attributes provided by the user, as well as different (system) properties that govern the underlying data, such as the record columns, resources used, etc.

This interface is used only for MaxCompute framework to encapsulate the internal representation of attributes. It is not intended for user to implement it.

Constructor Summary

Constructors

Constructor and Description
DataAttributes()

Method Summary

Modifier and Type	Method and Description
abstract Map<String,String>	getAttributes() Get a copy of all user-specified attributes.
abstract String	getCustomizedDataLocation() Get the customized external data location that describes external data storage location other than storage types with built-in support (such as Aliyun OSS/TableStore), user is responsible for parsing and connecting to customized data location in self-defined Extractor and/or Outputer
abstract Column[]	getFullTableColumns() Getter for record columns describing the FULL schema of underlying physical data, represented by the (external) table
abstract Properties	getHiveTableProperties()
Properties	getHiveTableProperties(boolean ignored) Deprecated.
abstract int[]	getNeededIndexes() Getter for needed indexes, this can be used to skip deserialization of non-needed column(s).
abstract Column[]	getRecordColumns() Getter for columns describing expected Record schema: un-used columns may have been pruned and this schema therefore can be either 1.
abstract HashSet<String>	getResources() Getter for set of resources.
abstract String	getValueByKey(String key) Get the attribute value associated with the given key, return null if key not found
abstract void	verifySchema(OdpsType[] expectedSchemas) Check if the Column schemas passed in by data attributes matched the expectation.

Methods inherited from class java.lang.Object

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

Constructor Detail

DataAttributes

public DataAttributes()

Method Detail

getValueByKey

public abstract String getValueByKey(String key)

Get the attribute value associated with the given key, return null if key not found

getAttributes

public abstract Map<String,String> getAttributes()

Get a copy of all user-specified attributes. Note that the modification of the return value does not affect the underlying storage of attributes.

Returns:

All attributes specified by user

getCustomizedDataLocation

public abstract String getCustomizedDataLocation()

Get the customized external data location that describes external data storage location other than storage types with built-in support (such as Aliyun OSS/TableStore), user is responsible for parsing and connecting to customized data location in self-defined Extractor and/or Outputer

Returns:

customized external location defined in LOCATION clause Note: when "oss://" or "tablestore://" scheme is used in LOCATION clause, this returns null instead

getHiveTableProperties

@Deprecated
public Properties getHiveTableProperties(boolean ignored)

Deprecated.

This method is deprecated, use getHiveTableProperties() instead

Parameters:

ignored - this argument will be ignored

Returns:

Serde properties specified in DDL statement and table information (e.g., columns name/type)

getHiveTableProperties

public abstract Properties getHiveTableProperties()

Returns:

Serde properties specified in DDL statement and table information (e.g., columns name/type)

getRecordColumns

public abstract Column[] getRecordColumns()

Getter for columns describing expected Record schema: un-used columns may have been pruned and this schema therefore can be either 1. a subset of full schema that describes physical data underlying an EXTERNAL table, or 2. a subset of joined schemas from multiple input tables

getFullTableColumns

public abstract Column[] getFullTableColumns()

Getter for record columns describing the FULL schema of underlying physical data, represented by the (external) table

getNeededIndexes

public abstract int[] getNeededIndexes()

Getter for needed indexes, this can be used to skip deserialization of non-needed column(s).

getResources

public abstract HashSet<String> getResources()

Getter for set of resources.

verifySchema

public abstract void verifySchema(OdpsType[] expectedSchemas)

Check if the Column schemas passed in by data attributes matched the expectation. A runtime exception will be thrown if there is a mismatch for the schema