Table (ODPS SDK Core 0.38.4-public API)

java.lang.Object
- com.aliyun.odps.LazyLoad
- - com.aliyun.odps.Table

```
public class Table
extends LazyLoad
```
Table表示ODPS中的表

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`Table.ClusterInfo`
`static class`	`Table.SortColumn`
`static class`	`Table.TableTypeConverter` Convert `TableType` to/from `String`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`createPartition(PartitionSpec spec)` 增加分区
`void`	`createPartition(PartitionSpec spec, boolean ifNotExists)` 增加分区
`void`	`createShards(long shardCount)` 在Table上创建Shards
`void`	`deletePartition(PartitionSpec spec)` 删除指定分区
`void`	`deletePartition(PartitionSpec spec, boolean ifExists)` 删除指定分区
`Table.ClusterInfo`	`getClusterInfo()` 返回 cluster range 表的 cluster 信息
`String`	`getComment()` 获取注释
`Date`	`getCreatedTime()` 获取创建时间
`String`	`getCryptoAlgoName()` 获取表加密算法名称
`long`	`getFileNum()` 返回表数据所占的盘古文件数
`long`	`getHubLifecycle()` 获取表的datahub生命周期值，单位：天
`String`	`getJsonSchema()`
`Date`	`getLastDataModifiedTime()` 获取数据最后修改时间
`Date`	`getLastMetaModifiedTime()` 获取最后修改时间
`long`	`getLife()` 获取表的生命周期值，单位：天
`String`	`getLocation()` 返回外部表数据存储位置
`String`	`getMaxExtendedLabel()`
`String`	`getMaxLabel()` 获取最高的label级别 Label的定义分两部分： 1.
`String`	`getName()` 获取表名
`String`	`getOwner()` 获取表所属用户
`Partition`	`getPartition(PartitionSpec spec)` 获取指定分区信息
`Iterator<Partition>`	`getPartitionIterator()` 获取分区迭代器
`Iterator<Partition>`	`getPartitionIterator(PartitionSpec spec)` 获取分区迭代器
`List<Partition>`	`getPartitions()` 获取所有分区信息
`List<Partition>`	`getPartitions(PartitionSpec lowerBound, PartitionSpec upperBound)` Get partitions by range.
`List<PartitionSpec>`	`getPartitionSpecs()` Get list of partition specs.
`long`	`getPhysicalSize()` 查看表所占磁盘的物理大小
`String`	`getProject()` 获取表所属`Project`名称
`long`	`getRecordNum()` 获取表的Record数, 若无准确数据，则返回-1
`String`	`getReserved()` 返回扩展信息的保留字段 json 字符串
`String`	`getResources()` 返回外部表使用的资源
`TableSchema`	`getSchema()` 获取表结构定义
`Map<String,String>`	`getSerDeProperties()` 返回外部表序列化和反序列化属性
`Shard`	`getShard()` 返回Shard
`long`	`getSize()` 获取内部存储大小，单位：Byte
`String`	`getStorageHandler()` 返回外部表数据处理句柄
`List<String>`	`getTableExtendedLabels()`
`String`	`getTableID()` 获取表 ID
`String`	`getTableLabel()`
`String`	`getViewText()` 获取视图的文本内容
`boolean`	`hasPartition(PartitionSpec spec)` 判断指定分区是否存在
`boolean`	`isArchived()` 查看表是否进行过归档操作
`boolean`	`isExternalTable()` 判断表是否为外部表
`boolean`	`isMaterializedView()` Return if this table is a materialized view.
`boolean`	`isMaterializedViewOutdated()` Return if this materialized view is outdated.
`boolean`	`isMaterializedViewRewriteEnabled()` Return if this materialized view could be used by query rewrite.
`boolean`	`isPartitioned()` 判断是否 Partition 表
`boolean`	`isTransactional()` 查看表是否事务化
`boolean`	`isVirtualView()` 判断表是否为虚拟视图
`static Table.ClusterInfo`	`parseClusterInfo(com.google.gson.JsonObject jsonObject)`
`RecordReader`	`read(int limit)` 读取表内的数据
`RecordReader`	`read(PartitionSpec partition, List<String> columns, int limit)` 读取表内的数据读取数据时，最多返回 1W 条记录，若超过，数据将被截断。另外，读取的数据大小不能超过 10MB，否则将抛出异常。
`RecordReader`	`read(PartitionSpec partition, List<String> columns, int limit, String timezone)` 读取表内的数据读取数据时，最多返回 1W 条记录，若超过，数据将被截断。另外，读取的数据大小不能超过 10MB，否则将抛出异常。
`void`	`reload()` 重新加载属性值
`void`	`reload(com.aliyun.odps.Table.TableModel model)`
`void`	`truncate()` 删除表数据

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - reload
```
public void reload()
            throws OdpsException
```
    Description copied from class: LazyLoad
    
    重新加载属性值
    
    Specified by:
    
    reload in class LazyLoad
    
    Throws:
    
    OdpsException
  - reload
```
public void reload(com.aliyun.odps.Table.TableModel model)
            throws OdpsException
```
    Throws:
    
    OdpsException
  - getName
```
public String getName()
```
    获取表名
    
    Returns:
    
    表名称
  - getComment
```
public String getComment()
```
    获取注释
    
    Returns:
    
    表的相关注释信息
  - getOwner
```
public String getOwner()
```
    获取表所属用户
    
    Returns:
    
    所属用户
  - getCreatedTime
```
public Date getCreatedTime()
```
    获取创建时间
    
    Returns:
    
    创建时间
  - getTableLabel
```
public String getTableLabel()
```
  - getTableExtendedLabels
```
public List<String> getTableExtendedLabels()
```
  - getTableID
```
public String getTableID()
```
    获取表 ID
    
    Returns:
    
    tableId
  - getCryptoAlgoName
```
public String getCryptoAlgoName()
```
    获取表加密算法名称
    
    Returns:
    
    算法名称
  - getMaxExtendedLabel
```
public String getMaxExtendedLabel()
```
  - getMaxLabel
```
public String getMaxLabel()
```
    获取最高的label级别 Label的定义分两部分： 1. 业务分类：C，S，B 2. 数据等级：1，2，3，4 二者是正交关系，即C1,C2,C3,C4,S1,S2,S3,S4,B1,B2,B3,B4。 MaxLabel的语意： 1. MaxLabel=max(TableLabel, ColumnLabel), max(...)函数的语意由Label中的数据等级决定：4>3>2>1 2. MaxLabel显示：当最高等级Label只出现一次时，MaxLabel=业务分类+数据等级，例如：B4, C3，S2 当最高等级Labe出现多次，但业务分类也唯一，MaxLabel=业务分类+数据等级，例如：B4, C3，S2 当最高等级Labe出现多次，且业务不唯一，MaxLabel=L+数据等级，例如：L4， L3
    
    Returns:
    
    表示最高label，如果没有任何label的设置，返回空字符串
  - getLastMetaModifiedTime
```
public Date getLastMetaModifiedTime()
```
    获取最后修改时间
    
    Returns:
    
    最后修改时间
  - getProject
```
public String getProject()
```
    获取表所属Project名称
    
    Returns:
    
    Project名称
  - isVirtualView
```
public boolean isVirtualView()
```
    判断表是否为虚拟视图
    
    Returns:
    
    如果是虚拟视图返回true, 否则返回false
  - isMaterializedView
```
public boolean isMaterializedView()
```
    Return if this table is a materialized view.
  - isMaterializedViewRewriteEnabled
```
public boolean isMaterializedViewRewriteEnabled()
```
    Return if this materialized view could be used by query rewrite.
    
    Throws:
    
    IllegalStateException - If this table is not a materialized view.
  - isMaterializedViewOutdated
```
public boolean isMaterializedViewOutdated()
```
    Return if this materialized view is outdated.
    
    Throws:
    
    IllegalStateException - If this table is not a materialized view.
  - isExternalTable
```
public boolean isExternalTable()
```
    判断表是否为外部表
    
    Returns:
    
    如果是外部表返回true, 否则返回false
  - getViewText
```
public String getViewText()
```
    获取视图的文本内容
    
    Returns:
    
    文本内容
  - getLastDataModifiedTime
```
public Date getLastDataModifiedTime()
```
    获取数据最后修改时间
    
    Returns:
    
    最后修改时间
  - getSize
```
public long getSize()
```
    获取内部存储大小，单位：Byte
    
    Returns:
    
    存储大小
  - getRecordNum
```
public long getRecordNum()
```
    获取表的Record数, 若无准确数据，则返回-1
    
    Returns:
    
    表的record数
  - getLife
```
public long getLife()
```
    获取表的生命周期值，单位：天
    
    Returns:
    
    生命周期值
  - getHubLifecycle
```
public long getHubLifecycle()
```
    获取表的datahub生命周期值，单位：天
    
    Returns:
    
    datahub生命周期值
  - getSchema
```
public TableSchema getSchema()
```
    获取表结构定义
    
    Returns:
    
    表示表结构的TableSchema对象
  - getJsonSchema
```
public String getJsonSchema()
```
  - isArchived
```
public boolean isArchived()
```
    查看表是否进行过归档操作
    
    Returns:
    
    返回true表示进行过archive操作，false表示未进行过
  - isTransactional
```
public boolean isTransactional()
```
    查看表是否事务化
    
    Returns:
    
    返回true表示进行过 transactional 操作，false表示未进行过
  - getPhysicalSize
```
public long getPhysicalSize()
```
    查看表所占磁盘的物理大小
    
    Returns:
    
    物理大小
  - getFileNum
```
public long getFileNum()
```
    返回表数据所占的盘古文件数
    
    Returns:
    
    文件数
  - getLocation
```
public String getLocation()
```
    返回外部表数据存储位置
    
    Returns:
    
    外部表数据存储位置
  - getStorageHandler
```
public String getStorageHandler()
```
    返回外部表数据处理句柄
    
    Returns:
    
    外部表数据处理句柄
  - getResources
```
public String getResources()
```
    返回外部表使用的资源
    
    Returns:
    
    外部表使用的资源
  - getSerDeProperties
```
public Map<String,String> getSerDeProperties()
```
    返回外部表序列化和反序列化属性
    
    Returns:
    
    外部表序列化和反序列化属性
  - getReserved
```
public String getReserved()
```
    返回扩展信息的保留字段 json 字符串
    
    Returns:
    
    保留字段
  - getClusterInfo
```
public Table.ClusterInfo getClusterInfo()
```
    返回 cluster range 表的 cluster 信息
    
    Returns:
    
    cluster info
  - getShard
```
public Shard getShard()
```
    返回Shard
    
    Returns:
    
    shard 如果没有shard返回null
  - read
```
public RecordReader read(int limit)
                  throws OdpsException
```
    读取表内的数据
    
    Parameters:
    
    limit - 最多读取的记录行数
    
    Returns:
    
    RecordReader对象
    
    Throws:
    
    OdpsException
  - read
```
public RecordReader read(PartitionSpec partition,
                         List<String> columns,
                         int limit)
                  throws OdpsException
```
    读取表内的数据
    读取数据时，最多返回 1W 条记录，若超过，数据将被截断。
    另外，读取的数据大小不能超过 10MB，否则将抛出异常。
    
    Parameters:
    
    partition - 表的分区PartitionSpec。如不指定分区可传入null。
    
    columns - 所要读取的列名的列表。如果读取全表可传入null
    
    limit - 最多读取的记录行数。
    
    Returns:
    
    RecordReader对象
    
    Throws:
    
    OdpsException
  - read
```
public RecordReader read(PartitionSpec partition,
                         List<String> columns,
                         int limit,
                         String timezone)
                  throws OdpsException
```
    读取表内的数据
    读取数据时，最多返回 1W 条记录，若超过，数据将被截断。
    另外，读取的数据大小不能超过 10MB，否则将抛出异常。
    
    Parameters:
    
    partition - 表的分区PartitionSpec。如不指定分区可传入null。
    
    columns - 所要读取的列名的列表。如果读取全表可传入null
    
    limit - 最多读取的记录行数。
    
    timezone - 设置 datetime 类型数据的时区
    
    Returns:
    
    RecordReader对象
    
    Throws:
    
    OdpsException
  - parseClusterInfo
```
public static Table.ClusterInfo parseClusterInfo(com.google.gson.JsonObject jsonObject)
```
  - createPartition
```
public void createPartition(PartitionSpec spec)
                     throws OdpsException
```
    增加分区
    
    Parameters:
    
    spec - 分区定义 PartitionSpec
    
    Throws:
    
    OdpsException
  - createPartition
```
public void createPartition(PartitionSpec spec,
                            boolean ifNotExists)
                     throws OdpsException
```
    增加分区
    
    Parameters:
    
    spec - 分区定义 PartitionSpec
    
    ifNotExists - 在创建分区时，如果为 false 而存在同名分区，则返回出错；若为 true，则无论是否存在同名分区，即使分区结构与要创建的目标分区结构不一致，均返回成功。已存在的同名分区的元信息不会被改动。
    
    Throws:
    
    OdpsException
  - deletePartition
```
public void deletePartition(PartitionSpec spec)
                     throws OdpsException
```
    删除指定分区
    
    Parameters:
    
    spec - 分区定义 PartitionSpec
    
    Throws:
    
    OdpsException
  - deletePartition
```
public void deletePartition(PartitionSpec spec,
                            boolean ifExists)
                     throws OdpsException
```
    删除指定分区
    
    Parameters:
    
    spec - 分区定义 PartitionSpec
    
    ifExists - 如果 false 而分区不存在，则返回异常；若为 true，无论分区是否存在，皆返回成功。
    
    Throws:
    
    OdpsException
  - getPartitionSpecs
```
public List<PartitionSpec> getPartitionSpecs()
                                      throws OdpsException
```
    Get list of partition specs. The returned partition specs are ordered lexicographically.
    
    Returns:
    
    list of PartitionSpec
    
    Throws:
    
    OdpsException
  - createShards
```
public void createShards(long shardCount)
                  throws OdpsException
```
    在Table上创建Shards
    
    Parameters:
    
    shardCount - 创建Shard的个数
    
    Throws:
    
    OdpsException
  - getPartitionIterator
```
public Iterator<Partition> getPartitionIterator()
```
    获取分区迭代器
    
    Returns:
    
    Partition 分区迭代器
  - getPartitionIterator
```
public Iterator<Partition> getPartitionIterator(PartitionSpec spec)
```
    获取分区迭代器
    
    Parameters:
    
    spec - 指定的上级分区 PartitionSpec
    
    Returns:
    
    Partition迭代器
  - getPartitions
```
public List<Partition> getPartitions()
```
    获取所有分区信息
    
    Returns:
    
    Partition列表
  - getPartitions
```
public List<Partition> getPartitions(PartitionSpec lowerBound,
                                     PartitionSpec upperBound)
                              throws OdpsException
```
    Get partitions by range. Partitions are ordered with their partition spec string lexicographically. If lowerBound == null and upperBound != null, partitions greater than the lowerBound would be returned.
    
    Parameters:
    
    lowerBound - lower bound
    
    upperBound - upper bound
    
    Returns:
    
    list of Partition
    
    Throws:
    
    IllegalArgumentException - if the lowerBound argument is null
    
    OdpsException
  - getPartition
```
public Partition getPartition(PartitionSpec spec)
```
    获取指定分区信息
    
    Parameters:
    
    spec - 分区定义 PartitionSpec
    
    Returns:
    
    分区信息 Partition
  - hasPartition
```
public boolean hasPartition(PartitionSpec spec)
                     throws OdpsException
```
    判断指定分区是否存在
    
    Parameters:
    
    spec - 分区定义 PartitionSpec
    
    Returns:
    
    如果指定分区存在，则返回true，否则返回false
    
    Throws:
    
    OdpsException
  - truncate
```
public void truncate()
              throws OdpsException
```
    删除表数据
    
    Throws:
    
    OdpsException
  - isPartitioned
```
public boolean isPartitioned()
                      throws OdpsException
```
    判断是否 Partition 表
    
    Returns:
    
    是否为 Partition 表
    
    Throws:
    
    OdpsException

Class Table

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Method Detail

reload

reload

getName

getComment

getOwner

getCreatedTime

getTableLabel

getTableExtendedLabels

getTableID

getCryptoAlgoName

getMaxExtendedLabel

getMaxLabel

getLastMetaModifiedTime

getProject

isVirtualView

isMaterializedView

isMaterializedViewRewriteEnabled

isMaterializedViewOutdated

isExternalTable

getViewText

getLastDataModifiedTime

getSize

getRecordNum

getLife

getHubLifecycle

getSchema

getJsonSchema

isArchived

isTransactional

getPhysicalSize

getFileNum

getLocation

getStorageHandler

getResources

getSerDeProperties

getReserved

getClusterInfo

getShard

read

read

read

parseClusterInfo

createPartition

createPartition

deletePartition

deletePartition

getPartitionSpecs

createShards

getPartitionIterator

getPartitionIterator

getPartitions

getPartitions

getPartition

hasPartition

truncate

isPartitioned