Tables (ODPS SDK Core 0.32.5-public API)

java.lang.Object
- com.aliyun.odps.Tables

All Implemented Interfaces:

Iterable<Table>
```
public class Tables
extends Object
implements Iterable<Table>
```
Tables表示ODPS中所有Table的集合

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`create(String projectName, String tableName, TableSchema schema)` 创建表
`void`	`create(String projectName, String tableName, TableSchema schema, boolean ifNotExists)` 创建表
`void`	`create(String projectName, String tableName, TableSchema schema, boolean ifNotExists, Long shardNum, Long hubLifecycle)` 创建表
`void`	`create(String projectName, String tableName, TableSchema schema, String comment, boolean ifNotExists)` 创建表
`void`	`create(String projectName, String tableName, TableSchema schema, String comment, boolean ifNotExists, Long shardNum, Long hubLifecycle)` 创建表
`void`	`create(String projectName, String tableName, TableSchema schema, String comment, boolean ifNotExists, Long lifeCycle, Map<String,String> hints, Map<String,String> aliases)` 创建表
`void`	`create(String tableName, TableSchema schema)` 创建表
`void`	`create(String tableName, TableSchema schema, boolean ifNotExists)` 创建表
`void`	`createExternal(String projectName, String tableName, TableSchema schema, String location, String storedBy, List<String> usingJars, Map<String,String> serdeProperties, String comment, boolean ifNotExists, Long lifeCycle, Map<String,String> hints, Map<String,String> aliases)` 创建外部表
`void`	`createTableWithLifeCycle(String projectName, String tableName, TableSchema schema, String comment, boolean ifNotExists, Long lifeCycle)` 创建表
`void`	`delete(String tableName)` 删除表
`void`	`delete(String tableName, boolean ifExists)` 删除表
`void`	`delete(String projectName, String tableName)` 删除表
`void`	`delete(String projectName, String tableName, boolean ifExists)` 删除表
`boolean`	`exists(String tableName)` 判断指定表是否存在
`boolean`	`exists(String projectName, String tableName)` 判断指定表是否存在
`Table`	`get(String tableName)` 获得指定表信息
`Table`	`get(String projectName, String tableName)` 获得指定表信息
`Iterable<Table>`	`iterable()` 获取默认`Project`的所有表信息迭代器 iterable
`Iterable<Table>`	`iterable(String projectName)` 获取表信息迭代器 iterable
`Iterable<Table>`	`iterable(String projectName, TableFilter filter)` 获得表信息迭代器 iterable
`Iterable<Table>`	`iterable(TableFilter filter)` 获取默认Project的表信息迭代器 iterable
`Iterator<Table>`	`iterator()` 获取默认`Project`的所有表信息迭代器
`Iterator<Table>`	`iterator(String projectName)` 获取表信息迭代器
`Iterator<Table>`	`iterator(String projectName, TableFilter filter)` 获得表信息迭代器
`Iterator<Table>`	`iterator(TableFilter filter)` 获取默认Project的表信息迭代器
`List<Table>`	`loadTables(Collection<String> tableNames)` 批量加载表信息
`List<Table>`	`loadTables(String projectName, Collection<String> tableNames)` 批量加载表信息
`List<Table>`	`reloadTables(Collection<Table> tables)` 批量加载表信息
`List<Table>`	`reloadTables(Iterator<Table> tables)` 批量加载表信息 rest api 对请求数量有限制, 目前一次操作最多可请求 100 张表信息; 返回的表数据,与操作权限有关.

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

Methods inherited from interface java.lang.Iterable
forEach, spliterator

- Method Detail
  - get
```
public Table get(String tableName)
```
    获得指定表信息
    
    Parameters:
    
    tableName - 表名
    
    Returns:
    
    指定表的信息Table
  - get
```
public Table get(String projectName,
                 String tableName)
```
    获得指定表信息
    
    Parameters:
    
    projectName - 所在Project名称
    
    tableName - 表名
    
    Returns:
    
    指定表的信息Table
  - exists
```
public boolean exists(String tableName)
               throws OdpsException
```
    判断指定表是否存在
    
    Parameters:
    
    tableName - 表名
    
    Returns:
    
    存在返回true, 否则返回false
    
    Throws:
    
    OdpsException
  - exists
```
public boolean exists(String projectName,
                      String tableName)
               throws OdpsException
```
    判断指定表是否存在
    
    Parameters:
    
    projectName - 所在Project名称
    
    tableName - 表名
    
    Returns:
    
    存在返回true, 否则返回flase
    
    Throws:
    
    OdpsException
  - iterator
```
public Iterator<Table> iterator()
```
    获取默认Project的所有表信息迭代器
    
    Specified by:
    
    iterator in interface Iterable<Table>
    
    Returns:
    
    Table迭代器
  - iterator
```
public Iterator<Table> iterator(String projectName)
```
    获取表信息迭代器
    
    Parameters:
    
    projectName - 指定Project名称
    
    Returns:
    
    Table迭代器
  - iterator
```
public Iterator<Table> iterator(TableFilter filter)
```
    获取默认Project的表信息迭代器
    
    Parameters:
    
    filter - 过滤条件
    
    Returns:
    
    Table迭代器
  - iterator
```
public Iterator<Table> iterator(String projectName,
                                TableFilter filter)
```
    获得表信息迭代器
    
    Parameters:
    
    projectName - 所在Project名称
    
    filter - 过滤条件
    
    Returns:
    
    Table迭代器
  - iterable
```
public Iterable<Table> iterable()
```
    获取默认Project的所有表信息迭代器 iterable
    
    Returns:
    
    Table迭代器
  - iterable
```
public Iterable<Table> iterable(String projectName)
```
    获取表信息迭代器 iterable
    
    Parameters:
    
    projectName - 指定Project名称
    
    Returns:
    
    Table迭代器
  - iterable
```
public Iterable<Table> iterable(TableFilter filter)
```
    获取默认Project的表信息迭代器 iterable
    
    Parameters:
    
    filter - 过滤条件
    
    Returns:
    
    Table迭代器
  - iterable
```
public Iterable<Table> iterable(String projectName,
                                TableFilter filter)
```
    获得表信息迭代器 iterable
    
    Parameters:
    
    projectName - 所在Project名称
    
    filter - 过滤条件
    
    Returns:
    
    Table迭代器
  - create
```
public void create(String tableName,
                   TableSchema schema)
            throws OdpsException
```
    创建表
    
    Parameters:
    
    tableName - 表名
    
    schema - 表结构 TableSchema
    
    Throws:
    
    OdpsException
  - create
```
public void create(String tableName,
                   TableSchema schema,
                   boolean ifNotExists)
            throws OdpsException
```
    创建表
    
    Parameters:
    
    tableName - 表名
    
    schema - 表结构 TableSchema
    
    ifNotExists - 在创建表时，如果为 false 而存在同名表，则返回出错；若为 true，则无论是否存在同名表，即使原表结构与要创建的目标表结构不一致，均返回成功。已存在的同名表的元信息不会被改动。
    
    Throws:
    
    OdpsException
  - create
```
public void create(String projectName,
                   String tableName,
                   TableSchema schema,
                   boolean ifNotExists,
                   Long shardNum,
                   Long hubLifecycle)
            throws OdpsException
```
    创建表
    
    Parameters:
    
    projectName - 目标表所在Project名称
    
    tableName - 表名
    
    schema - 表结构 TableSchema
    
    ifNotExists - 在创建表时，如果为 false 而存在同名表，则返回出错；若为 true，则无论是否存在同名表，即使原表结构与要创建的目标表结构不一致，均返回成功。已存在的同名表的元信息不会被改动。
    
    shardNum - 表中shard数量，小于0表示未设置
    
    hubLifecycle - Hub表生命周期，小于0表示未设置
    
    Throws:
    
    OdpsException
  - create
```
public void create(String projectName,
                   String tableName,
                   TableSchema schema)
            throws OdpsException
```
    创建表
    
    Parameters:
    
    projectName - 目标表所在Project名称
    
    tableName - 所要创建的Table名称
    
    schema - 表结构 TableSchema
    
    Throws:
    
    OdpsException
  - create
```
public void create(String projectName,
                   String tableName,
                   TableSchema schema,
                   boolean ifNotExists)
            throws OdpsException
```
    创建表
    
    Parameters:
    
    projectName - 目标表所在Project名称
    
    tableName - 所要创建的Table名称
    
    schema - 表结构 TableSchema
    
    ifNotExists - 在创建表时，如果为 false 而存在同名表，则返回出错；若为 true，则无论是否存在同名表，即使原表结构与要创建的目标表结构不一致，均返回成功。已存在的同名表的元信息不会被改动。
    
    Throws:
    
    OdpsException
  - create
```
public void create(String projectName,
                   String tableName,
                   TableSchema schema,
                   String comment,
                   boolean ifNotExists,
                   Long shardNum,
                   Long hubLifecycle)
            throws OdpsException
```
    创建表
    
    Parameters:
    
    projectName - 目标表所在Project名称
    
    tableName - 所要创建的Table名称
    
    schema - 表结构 TableSchema
    
    comment - 表注释, 其中不能带有单引号
    
    ifNotExists - 在创建表时，如果为 false 而存在同名表，则返回出错；若为 true，则无论是否存在同名表，即使原表结构与要创建的目标表结构不一致，均返回成功。已存在的同名表的元信息不会被改动。
    
    shardNum - 表中shard数量，小于0表示未设置
    
    hubLifecycle - Hub表生命周期，小于0表示未设置
    
    Throws:
    
    OdpsException
  - create
```
public void create(String projectName,
                   String tableName,
                   TableSchema schema,
                   String comment,
                   boolean ifNotExists)
            throws OdpsException
```
    创建表
    
    Parameters:
    
    projectName - 目标表所在Project名称
    
    tableName - 所要创建的Table名称
    
    schema - 表结构 TableSchema
    
    comment - 表注释, 其中不能带有单引号
    
    ifNotExists -
    
    Throws:
    
    OdpsException
  - createTableWithLifeCycle
```
public void createTableWithLifeCycle(String projectName,
                                     String tableName,
                                     TableSchema schema,
                                     String comment,
                                     boolean ifNotExists,
                                     Long lifeCycle)
                              throws OdpsException
```
    创建表
    
    Parameters:
    
    projectName - 目标表所在Project名称
    
    tableName - 所要创建的Table名称
    
    schema - 表结构 TableSchema
    
    comment - 表注释, 其中不能带有单引号
    
    ifNotExists -
    
    lifeCycle - 表生命周期
    
    Throws:
    
    OdpsException
  - create
```
public void create(String projectName,
                   String tableName,
                   TableSchema schema,
                   String comment,
                   boolean ifNotExists,
                   Long lifeCycle,
                   Map<String,String> hints,
                   Map<String,String> aliases)
            throws OdpsException
```
    创建表
    
    Parameters:
    
    projectName - 目标表所在Project名称
    
    tableName - 所要创建的Table名称
    
    schema - 表结构 TableSchema
    
    comment - 表注释, 其中不能带有单引号
    
    ifNotExists -
    
    lifeCycle - 表生命周期
    
    hints - 能够影响SQL执行的Set信息，例如：odps.mapred.map.split.size等
    
    aliases - Alias信息。详情请参考用户手册中alias命令的相关介绍
    
    Throws:
    
    OdpsException
  - createExternal
```
public void createExternal(String projectName,
                           String tableName,
                           TableSchema schema,
                           String location,
                           String storedBy,
                           List<String> usingJars,
                           Map<String,String> serdeProperties,
                           String comment,
                           boolean ifNotExists,
                           Long lifeCycle,
                           Map<String,String> hints,
                           Map<String,String> aliases)
                    throws OdpsException
```
    创建外部表
    
    Parameters:
    
    projectName - 目标表所在Project名称
    
    tableName - 所要创建的Table名称
    
    schema - 表结构 TableSchema
    
    location - 外部数据存储地址URI String，比如"oss://path/to/directory/", 具体格式参考外部表使用手册
    
    storedBy - 处理外部数据使用的StorageHandler名字, 比如"com.aliyun.odps.TsvStorageHandler"
    
    usingJars - (nullable) 如果是自定义的StorageHandler, 这里指定其所依赖的jar名字。这些jar必须事先用ADD JAR命令添加
    
    serdeProperties - (nullable) 对StorageHandler的参数指定(if any)，每个参数为一个String/String的key value
    
    comment - (nullable) 表注释, 其中不能带有单引号
    
    ifNotExists -
    
    lifeCycle - (nullable) 表生命周期
    
    hints - (nullable) 能够影响SQL执行的Set信息，例如：odps.mapred.map.split.size等
    
    aliases - (nullable) Alias信息。详情请参考用户手册中alias命令的相关介绍
    
    Throws:
    
    OdpsException
  - delete
```
public void delete(String tableName)
            throws OdpsException
```
    删除表
    
    Parameters:
    
    tableName - 表名
    
    Throws:
    
    OdpsException
  - delete
```
public void delete(String tableName,
                   boolean ifExists)
            throws OdpsException
```
    删除表
    
    Parameters:
    
    tableName - 表名
    
    ifExists - 如果为 false 表不存在，则返回异常；若为 true，无论表是否存在，皆返回成功。
    
    Throws:
    
    OdpsException
  - delete
```
public void delete(String projectName,
                   String tableName)
            throws OdpsException
```
    删除表
    
    Parameters:
    
    projectName - 表所在Project
    
    tableName - 表名
    
    Throws:
    
    OdpsException
  - delete
```
public void delete(String projectName,
                   String tableName,
                   boolean ifExists)
            throws OdpsException
```
    删除表
    
    Parameters:
    
    projectName - 表所在Project
    
    tableName - 表名
    
    ifExists - 如果为 false 表不存在，则返回异常；若为 true，无论表是否存在，皆返回成功。
    
    Throws:
    
    OdpsException
  - loadTables
```
public List<Table> loadTables(Collection<String> tableNames)
                       throws OdpsException
```
    批量加载表信息
    
    Parameters:
    
    tableNames - 表名
    
    Returns:
    
    加载后的 Table 列表
    
    Throws:
    
    OdpsException
  - loadTables
```
public List<Table> loadTables(String projectName,
                              Collection<String> tableNames)
                       throws OdpsException
```
    批量加载表信息
    
    Parameters:
    
    projectName - 指定Project名称
    
    tableNames - 表名
    
    Returns:
    
    加载后的 Table 列表
    
    Throws:
    
    OdpsException
  - reloadTables
```
public List<Table> reloadTables(Collection<Table> tables)
                         throws OdpsException
```
    批量加载表信息
    
    Parameters:
    
    tables - 请求表的容器
    
    Returns:
    
    加载后的 Table 列表
    
    Throws:
    
    OdpsException
  - reloadTables
```
public List<Table> reloadTables(Iterator<Table> tables)
                         throws OdpsException
```
    批量加载表信息
    rest api 对请求数量有限制, 目前一次操作最多可请求 100 张表信息;
    返回的表数据,与操作权限有关.
    
    Parameters:
    
    tables - 请求表的迭代器
    
    Returns:
    
    加载后的 Table 列表
    
    Throws:
    
    OdpsException

Class Tables

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface java.lang.Iterable

Method Detail

get

get

exists

exists

iterator

iterator

iterator

iterator

iterable

iterable

iterable

iterable

create

create

create

create

create

create

create

createTableWithLifeCycle

create

createExternal

delete

delete

delete

delete

loadTables

loadTables

reloadTables

reloadTables