Package | Description |
---|---|
com.aliyun.odps |
提供操作ODPS基本资源的类
|
com.aliyun.odps.commons | |
com.aliyun.odps.ml |
提供机器学习相关操作类
|
com.aliyun.odps.security |
提供ODPS支持的账号类型。
|
com.aliyun.odps.sqa | |
com.aliyun.odps.sqa.commandapi | |
com.aliyun.odps.sqa.commandapi.utils | |
com.aliyun.odps.task |
提供ODPS支持的Task定义
|
com.aliyun.odps.tunnel |
ODPS Tunnel服务用于上传、下载数据到ODPS
|
Modifier and Type | Class and Description |
---|---|
class |
NoSuchObjectException
ODPS对象不存在
|
Modifier and Type | Method and Description |
---|---|
void |
Classification.addAttributeDefinition(String attribute,
Classification.AttributeDefinition definition) |
void |
Function.addSimpleTag(String category,
String key,
String value)
Attach a simple tag to this function.
|
void |
Table.addSimpleTag(String category,
String key,
String value)
Attach a simple tag to this table.
|
void |
Resource.addSimpleTag(String category,
String key,
String value)
Attach a simple tag to this resource.
|
void |
Partition.addSimpleTag(String category,
String key,
String value)
Attach a simple tag to a partition.
|
void |
Table.addSimpleTag(String category,
String key,
String value,
List<String> columnNames)
Attach a simple tag to this table or some of its columns.
|
void |
Partition.addSimpleTag(String category,
String key,
String value,
List<String> columnNames)
Attach a simple tag to a partition or some of its columns.
|
void |
Function.addTag(Tag tag)
Attach a
Tag to this function. |
void |
Table.addTag(Tag tag)
Attach a
Tag to this table. |
void |
Resource.addTag(Tag tag)
Attach a
Tag to this resource. |
void |
Partition.addTag(Tag tag)
Attach a
Tag to a partition. |
void |
Table.addTag(Tag tag,
List<String> columnNames)
Attach a
Tag to this table. |
void |
Partition.addTag(Tag tag,
List<String> columnNames)
Attach a
Tag to a partition. |
abstract void |
OdpsHook.after(Instance instance,
Odps odps)
instance 结束后,框架会将 Instance 和 odps 对象传入 hook
|
void |
OdpsHooks.after(Instance instance,
Odps odps)
调用 Hook 的 after
|
static Session |
Session.attach(Odps odps,
String sessionName)
attach 指定名字的 session
此调用会立即返回,不会等待 session 启动完成。 可以手动调用
Session.waitForStart(long) 来等待启动。 |
static Session |
Session.attach(Odps odps,
String sessionName,
Map<String,String> hints)
attach 指定名字的 session
此调用会立即返回,不会等待 session 启动完成。 可以手动调用
Session.waitForStart(long) 来等待启动。 |
static Session |
Session.attach(Odps odps,
String sessionName,
Map<String,String> hints,
Long timeout)
attach 指定名字的 session
|
static Session |
Session.attach(Odps odps,
String sessionName,
Map<String,String> hints,
Long timeout,
String taskName)
attach 指定名字的 session
|
static Session |
Session.attach(Odps odps,
String sessionName,
Map<String,String> hints,
Long timeout,
String runningCluster,
String taskName)
attach 指定名字的 session
|
abstract void |
OdpsHook.before(Job job,
Odps odps)
提交代码前,框架会将 Job 和 Odps 对象传入 Hook
|
void |
OdpsHooks.before(Job job,
Odps odps)
调用 Hook 的 before
|
void |
Session.cancelQuery(int queryId) |
void |
Resources.create(FileResource r,
InputStream in)
创建文件资源
|
void |
Functions.create(Function func)
创建函数
|
Instance |
Instances.create(Job job)
|
static Session |
Session.create(Odps odps,
int workerCount,
int workerMemory)
创建 session
此调用会立即返回,不会等待 session 启动完成。 可以手动调用
Session.waitForStart(long) 来等待启动。 |
static Session |
Session.create(Odps odps,
int workerCount,
int workerMemory,
String sessionName)
创建 session
此调用会立即返回,不会等待 session 启动完成。 可以手动调用
Session.waitForStart(long) 来等待启动。 |
static Session |
Session.create(Odps odps,
int workerCount,
int workerMemory,
String sessionName,
String projectName,
String workerSpareSpan,
Map<String,String> hints,
Long timeout)
创建 session
|
static Session |
Session.create(Odps odps,
int workerCount,
int workerMemory,
String sessionName,
String projectName,
String workerSpareSpan,
Map<String,String> hints,
Long timeout,
Integer priority)
创建 session
|
static Session |
Session.create(Odps odps,
int workerCount,
int workerMemory,
String sessionName,
String projectName,
String workerSpareSpan,
Map<String,String> hints,
Long timeout,
Integer priority,
String runningCluster)
创建 session
|
static Session |
Session.create(Odps odps,
int workerCount,
int workerMemory,
String sessionName,
String projectName,
String workerSpareSpan,
Map<String,String> hints,
Long timeout,
Integer priority,
String runningCluster,
String taskName)
创建 session
|
static Session |
Session.create(Odps odps,
String sessionName,
String projectName,
Map<String,String> hints,
Long timeout)
创建 session
|
static Session |
Session.create(Odps odps,
String sessionName,
String projectName,
Map<String,String> hints,
Long timeout,
Integer priority)
创建 session
|
static Session |
Session.create(Odps odps,
String sessionName,
String projectName,
Map<String,String> hints,
Long timeout,
Integer priority,
String runningCluster)
创建 session
|
void |
Resources.create(String projectName,
FileResource r,
InputStream in)
创建文件资源
|
void |
Functions.create(String projectName,
Function func)
创建函数
|
void |
Classifications.create(String name,
Map<String,Classification.AttributeDefinition> attributes,
boolean ifNotExists) |
void |
Volumes.create(String volumeName,
String comment)
Deprecated.
call #create(String, String, Volume.TYPE) instead.
|
void |
Resources.create(String project,
String schema,
FileResource resource,
InputStream in)
Create a file resource.
|
void |
Functions.create(String projectName,
String schemaName,
Function function)
Create a function.
|
void |
Volumes.create(String projectName,
String volumeName,
String comment)
Deprecated.
call #create(String, String, String, Volume.TYPE) instead.
|
void |
Tables.create(String projectName,
String schemaName,
String tableName,
TableSchema schema,
String comment,
boolean ifNotExists,
Long lifeCycle,
Map<String,String> hints,
Map<String,String> aliases)
Create a table.
|
void |
Volumes.create(String projectName,
String volumeName,
String comment,
Volume.Type type)
创建Volume
|
void |
Volumes.create(String projectName,
String volumeName,
String comment,
Volume.Type type,
Long lifecycle)
创建Volume
|
void |
Resources.create(String projectName,
String schemaName,
TableResource resource)
Create a table resource.
|
void |
Tables.create(String projectName,
String tableName,
TableSchema schema)
创建表
|
void |
Tables.create(String projectName,
String tableName,
TableSchema schema,
boolean ifNotExists)
创建表
|
void |
Tables.create(String projectName,
String tableName,
TableSchema schema,
boolean ifNotExists,
Long shardNum,
Long hubLifecycle)
创建表
|
void |
Tables.create(String projectName,
String tableName,
TableSchema schema,
String comment,
boolean ifNotExists)
创建表
|
void |
Tables.create(String projectName,
String tableName,
TableSchema schema,
String comment,
boolean ifNotExists,
Long shardNum,
Long hubLifecycle)
创建表
|
void |
Tables.create(String projectName,
String tableName,
TableSchema schema,
String comment,
boolean ifNotExists,
Long lifeCycle,
Map<String,String> hints,
Map<String,String> aliases)
创建表
|
void |
Volumes.create(String volumeName,
String comment,
Volume.Type type)
创建Volume
|
void |
Resources.create(String projectName,
TableResource resource)
创建表资源
|
void |
Tables.create(String tableName,
TableSchema schema)
创建表
|
void |
Tables.create(String tableName,
TableSchema schema,
boolean ifNotExists)
创建表
|
Instance |
Instances.create(String projectName,
Task task)
为给定的
Task 创建Instance |
Instance |
Instances.create(String projectName,
Task task,
int priority)
为给定的
Task 创建Instance |
Instance |
Instances.create(String projectName,
Task task,
Integer priority,
String runningCluster)
为给定的
Task 创建Instance |
Instance |
Instances.create(String projectName,
Task task,
Integer priority,
String runningCluster,
String jobName)
为给定的
Task 创建Instance |
Instance |
Instances.create(String projectName,
Task task,
int priority,
String runningCluster)
为给定的
Task 创建Instance |
void |
Resources.create(String projectName,
VolumeResource resource)
创建 Volume 资源
|
void |
Resources.create(TableResource resource)
创建表资源
|
void |
Tags.create(Tag tag,
boolean ifNotExists) |
void |
Tags.create(Tags.TagBuilder tagBuilder,
boolean ifNotExists) |
Instance |
Instances.create(Task task)
|
Instance |
Instances.create(Task task,
int priority)
为给定的
Task 创建Instance |
Instance |
Instances.create(Task task,
int priority,
String runningCluster)
为给定的
Task 创建Instance |
void |
Resources.create(VolumeResource resource)
创建 Volume 资源
|
void |
Volumes.create(Volumes.VolumeBuilder builder)
创建 volume
|
void |
XFlows.create(XFlow.XFlowModel model)
创建 XFlow 对象
|
void |
XFlows.create(XFlow.XFlowModel model,
String projectName)
创建 XFlow 对象
|
void |
Tables.createExternal(String projectName,
String schemaName,
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)
Create an external table.
|
void |
Tables.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 |
Projects.createExternalProject(String projectName,
String comment,
String refProjectName,
Project.ExternalProjectProperties extProperties)
创建 external 项目
|
void |
Table.createPartition(PartitionSpec spec)
增加分区
|
void |
Table.createPartition(PartitionSpec spec,
boolean ifNotExists)
增加分区
|
void |
Table.createShards(long shardCount)
在Table上创建Shards
|
void |
Tables.createTableWithLifeCycle(String projectName,
String tableName,
TableSchema schema,
String comment,
boolean ifNotExists,
Long lifeCycle)
创建表
|
FileResource |
Resources.createTempFileResource(String projectName,
String schemaName,
String filePath,
Resource.Type type)
Create a temporary file resource.
|
FileResource |
Resources.createTempResource(String fileName)
上传临时文件资源
|
FileResource |
Resources.createTempResource(String projectName,
String fileName)
上传临时文件资源
|
FileResource |
Resources.createTempResource(String projectName,
String filePath,
Resource.Type type) |
void |
Tables.delete(String tableName)
删除表
|
void |
Resources.delete(String resourceName)
删除资源
|
void |
Volumes.delete(String volumeName)
删除Volume
|
void |
Classifications.delete(String name) |
void |
XFlows.delete(String name)
删除 XFlow 对象
|
void |
Functions.delete(String name)
删除函数
|
void |
Tables.delete(String tableName,
boolean ifExists)
删除表
|
void |
Tables.delete(String projectName,
String tableName)
删除表
|
void |
Resources.delete(String projectName,
String resourceName)
删除资源
|
void |
Volumes.delete(String projectName,
String volumeName)
删除Volume
|
void |
XFlows.delete(String name,
String projectName)
删除 XFlow 对象
|
void |
Functions.delete(String projectName,
String name)
删除函数
|
void |
Tables.delete(String projectName,
String tableName,
boolean ifExists)
删除表
|
void |
Resources.delete(String projectName,
String schemaName,
String resourceName)
Delete designated resource.
|
void |
Functions.delete(String projectName,
String schemaName,
String functionName)
Delete designated function.
|
void |
Tables.delete(String projectName,
String schemaName,
String tableName,
boolean ifExists)
Delete designated table.
|
void |
Projects.deleteExternalProject(String projectName)
删除 external 项目,只允许 project owner 删除。
|
void |
Table.deletePartition(PartitionSpec spec)
删除指定分区
|
void |
Table.deletePartition(PartitionSpec spec,
boolean ifExists)
删除指定分区
|
void |
Volume.deleteVolumePartition(String partitionName)
删除指定分区
|
Instance |
XFlows.execute(XFlows.XFlowInstance xFlowInstance) |
Instance |
XFlows.execute(XFlows.XFlowInstance xFlowInstance,
String project) |
boolean |
Tables.exists(String tableName)
判断指定表是否存在
|
boolean |
Projects.exists(String projectName)
检查
Project 是否存在 |
boolean |
Quotas.exists(String name) |
boolean |
Resources.exists(String resourceName)
判断指定资源是否存在
|
boolean |
Volumes.exists(String volumeName)
判断指定Volume是否存在
|
boolean |
Instances.exists(String id)
判断指定 Instance 是否存在
|
boolean |
Classifications.exists(String name) |
boolean |
Tags.exists(String name) |
boolean |
XFlows.exists(String name)
判断 XFlow 对象是否存在
|
boolean |
Functions.exists(String functionName)
判断 Function 是否存在
|
boolean |
Tables.exists(String projectName,
String tableName)
判断指定表是否存在
|
boolean |
Quotas.exists(String regionId,
String name) |
boolean |
Resources.exists(String projectName,
String resourceName)
判断指定资源是否存在
|
boolean |
Volumes.exists(String projectName,
String volumeName)
判断指定Volume是否存在
|
boolean |
Instances.exists(String projectName,
String id)
判断指定 Instance 是否存在
|
boolean |
XFlows.exists(String name,
String projectName)
判断 XFlow 对象是否存在
|
boolean |
Functions.exists(String projectName,
String functionName)
判断 Function 是否存在
|
boolean |
Tables.exists(String projectName,
String schemaName,
String tableName)
Check if designated table exists.
|
boolean |
Resources.exists(String projectName,
String schemaName,
String resourceName)
Check if designated resource exists.
|
boolean |
Functions.exists(String projectName,
String schemaName,
String functionName)
Check if designated function exists.
|
String |
LogView.generateInstanceToken(Instance instance,
long hours)
生成带有 instance 访问权限的 token
|
String |
LogView.generateLogView(Instance instance,
long hours)
生成 logview 链接
|
String |
LogView.generateSubQueryLogView(Instance instance,
int queryId,
long hours)
生成 session subquery logview 链接
|
Project |
Projects.get()
获得默认
Project 对象 |
Project |
Projects.get(String projectName)
获取指定
Project |
Function |
Functions.get(String functionName)
获取 Function 对象
|
Map<String,String> |
Project.getAllProperties()
获取 Project 全部可配置的属性, 包含从 group 继承来的配置信息
|
Map<String,String> |
Project.getExtendedProperties()
获取 Project 扩展配置信息
|
String |
Session.getInformation(String key)
getInformation
|
String |
Instance.getJobName()
获取 Instance 的 Job name
|
String |
Instance.getLog(String workerId,
LogType logType,
int size)
获取Worker运行的LOG内容
|
String |
Session.getLogView() |
int |
Instance.getPriority()
获取 Instance 的优先级
|
String |
Session.getQueryStats()
get sqlstats of subqyery
|
String |
Session.getQueryStats(int queryId)
get sqlstats of subqyery
|
Instance.InstanceQueueingInfo |
Instance.getQueueingInfo()
获取运行中 instance 的排队信息
|
Session.SubQueryResult |
Session.getRawSubQueryResult(int queryId)
getInformation查询SubQuery的原始结果.
|
String |
Instance.getRawSubqueryResults(String subqueryId,
String taskName)
获取SQLRT Instance中Subquery的原始运行结果
|
List<Instance.InstanceResultModel.TaskResult> |
Instance.getRawTaskResults()
获取Instance中Task的原始运行结果
|
InputStream |
Resources.getResourceAsStream(String resourceName)
获得资源文件的字节流
|
InputStream |
Resources.getResourceAsStream(String projectName,
String resourceName)
获得资源文件的字节流
|
InputStream |
Resources.getResourceAsStream(String projectName,
String schemaName,
String resourceName) |
Session.SessionProgress |
Session.getStartProgress()
获取 session 启动的进度
|
Session.SubQueryResult |
Session.getSubQueryResult(int queryId)
getInformation查询SubQuery结果.
|
Session.SubQueryResult |
Session.getSubQueryResultFromWorker(int queryId)
从odps_worker查询SubQuery结果
|
Instance.TaskCost |
Instance.getTaskCost(String taskName)
获得 Instance 中 Task 的运行资源消耗信息
当且仅当 Task 产生计量信息时,返回资源消耗信息,否则返回 null
|
String |
Instance.getTaskDetailJson(String taskName) |
String |
Instance.getTaskDetailJson2(String taskName) |
String |
Instance.getTaskInfo(String taskName,
String infoKey)
获得 Instance 中 Task 运行时的指定相关信息
|
Set<String> |
Instance.getTaskNames()
获得Instance所包含的所有
Task 的名称 |
List<Instance.StageProgress> |
Instance.getTaskProgress(String taskName)
查询指定Task的Stage进度
|
String |
Instance.getTaskQuotaJson(String taskName)
获取 task 运行 quota group 信息以及 quota group 中作业排队情况
注意,此接口的调用频率受限,两次调用间隔不能少于 30s, 否则返回字符串为 {}。
|
Map<String,String> |
Instance.getTaskResults()
获得Instance中Task的运行结果
|
Map<String,Instance.Result> |
Instance.getTaskResultsWithFormat()
获得Instance中
Task 的运行结果 |
List<Task> |
Instance.getTasks()
返回与作业运行实例相关的作业
Task 实例。 |
Map<String,Instance.TaskStatus> |
Instance.getTaskStatus()
查询Instance中所有
Task 的执行状态 |
Instance.TaskSummary |
Instance.getTaskSummary(String taskName)
获得Instance中Task的运行汇总信息 当 Server 端返回信息,但是信息格式错误时,返回 null
|
String |
TenantSecurityManager.getTenantRolePolicy(String roleName) |
String |
Session.getToken()
返回当前 attach session 可复用的 token
|
String |
Project.getTunnelEndpoint() |
String |
Project.getTunnelEndpoint(String quotaName) |
Project.ProjectType |
Project.getType()
获取Project类型
|
XFlows.XFlowInstance |
XFlows.getXFlowInstance(Instance instance) |
Map<String,XFlows.XResult> |
XFlows.getXResults(Instance xInstance) |
String |
XFlows.getXSource(Instance xInstance) |
boolean |
Table.hasPartition(PartitionSpec spec)
判断指定分区是否存在
|
boolean |
Table.isPartitioned()
判断是否 Partition 表
|
boolean |
Session.isStarted()
判断 session 是否已经成功启动
|
boolean |
Instance.isSuccessful()
检查
Instance 是否执行成功 |
List<Table> |
Tables.loadTables(Collection<String> tableNames)
批量加载表信息
|
List<Table> |
Tables.loadTables(String projectName,
Collection<String> tableNames)
批量加载表信息
|
List<Table> |
Tables.loadTables(String projectName,
String schemaName,
Collection<String> tableNames)
Batch loading tables.
|
void |
OdpsHook.onInstanceCreated(Instance instance,
Odps odps)
向远程提交 job 并产生 instance 时,将 Instance 和 Odps 对象传入 Hook
|
void |
OdpsHooks.onInstanceCreated(Instance instance,
Odps odps)
调用 Hook 的 ready
|
void |
Session.printLogView() |
void |
TenantSecurityManager.putTenantRolePolicy(String roleName,
String policy) |
RecordReader |
Table.read(int limit)
读取表内的数据
|
RecordReader |
Table.read(PartitionSpec partition,
List<String> columns,
int limit)
读取表内的数据
读取数据时,最多返回 1W 条记录,若超过,数据将被截断。 另外,读取的数据大小不能超过 10MB,否则将抛出异常。 |
RecordReader |
Table.read(PartitionSpec partition,
List<String> columns,
int limit,
String timezone)
读取表内的数据
读取数据时,最多返回 1W 条记录,若超过,数据将被截断。 另外,读取的数据大小不能超过 10MB,否则将抛出异常。 |
void |
Volume.reload() |
void |
Classification.reload() |
void |
Tenant.reload() |
void |
VolumeFSFile.reload() |
void |
Function.reload() |
void |
Project.reload() |
void |
VolumePartition.reload() |
void |
Tag.reload() |
void |
Table.reload() |
void |
Instance.reload() |
abstract void |
LazyLoad.reload()
重新加载属性值
|
void |
Schema.reload() |
void |
Resource.reload() |
void |
Partition.reload() |
void |
XFlow.reload() |
void |
Quota.reload() |
void |
Table.reload(com.aliyun.odps.Table.TableModel model) |
List<Table> |
Tables.reloadTables(Collection<Table> tables)
批量加载表信息
rest api 对请求数量有限制, 目前一次操作最多可请求 100 张表信息; 返回的表数据,与操作权限有关. |
List<Table> |
Tables.reloadTables(Iterator<Table> tables)
批量加载表信息
rest api 对请求数量有限制, 目前一次操作最多可请求 100 张表信息; 返回的表数据,与操作权限有关. |
void |
Function.removeSimpleTag(String category,
String key,
String value)
Remove a simple tag.
|
void |
Table.removeSimpleTag(String category,
String key,
String value)
Remove a simple tag.
|
void |
Resource.removeSimpleTag(String category,
String key,
String value)
Remove a simple tag.
|
void |
Partition.removeSimpleTag(String category,
String key,
String value)
Remove a simple tag.
|
void |
Table.removeSimpleTag(String category,
String key,
String value,
List<String> columnNames)
Remove a simple tag from columns.
|
void |
Partition.removeSimpleTag(String category,
String key,
String value,
List<String> columnNames)
Remove a simple tag from columns.
|
void |
Function.removeTag(Tag tag)
Remove a
Tag . |
void |
Table.removeTag(Tag tag)
Remove a
Tag . |
void |
Resource.removeTag(Tag tag)
Remove a
Tag . |
void |
Partition.removeTag(Tag tag)
Remove a
Tag . |
void |
Table.removeTag(Tag tag,
List<String> columnNames)
Remove a
Tag from columns. |
void |
Partition.removeTag(Tag tag,
List<String> columnNames)
Remove a
Tag from columns. |
SessionQueryResult |
Session.run(String sql)
Deprecated.
|
SecurityManager.AuthorizationQueryInstance |
TenantSecurityManager.run(String query,
boolean jsonOutput) |
SessionQueryResult |
Session.run(String sql,
Map<String,String> hints)
Deprecated.
|
Session.SubQueryInfo |
Session.runSubQuery(String sql,
Map<String,String> hints)
提交查询
|
String |
Session.setInformation(String key,
String value)
setInformation
|
Instance.SetInformationResult |
Instance.setInformation(String taskName,
String infoKey,
String infoValue)
设置 Instance 中 Task 运行时的指定相关信息,返回结构化response
|
String |
Instance.setTaskInfo(String taskName,
String infoKey,
String infoValue)
Deprecated.
|
List<String> |
Session.showVariables(Map<String,String> hints)
查询当前CacheOn的变量列表
|
String |
Instance.startDebug(String workerId,
String debugId)
以 debug 模式,启动 instance
本接口是提供给内部 debug 工具使用的,不建议用户直接使用
|
void |
Session.stop()
停止 session
|
void |
Instance.stop()
停止正在执行的Instance
注意:停止动作为异步执行,如果需要确保 Instance 停止,可以在调用本方法后轮询 Instance.isTerminated() 直至返回 true
|
String |
Job.toXmlString() |
boolean |
Project.triggerAutoMvCreation() |
void |
Table.truncate()
删除表数据
|
void |
Resources.update(FileResource r,
InputStream in)
更新文件资源
|
void |
Functions.update(Function func)
更新 Function
|
void |
Resources.update(String projectName,
FileResource r,
InputStream in)
更新文件资源
|
void |
Functions.update(String projectName,
Function func)
更新 Function
|
void |
Resources.update(String projectName,
String schemaName,
FileResource resource,
InputStream in)
Update designated file resource.
|
void |
Functions.update(String projectName,
String schemaName,
Function function)
Update designated function.
|
void |
Resources.update(String projectName,
String schemaName,
TableResource resource)
Update designated table resource.
|
void |
Resources.update(String projectName,
TableResource r)
更新表资源
|
void |
Volumes.update(String projectName,
Volume volume)
更新 volume meta, 目前只支持更改 lifecycle
|
void |
Resources.update(String projectName,
VolumeResource r)
更新 Volume 资源
|
void |
Resources.update(TableResource r)
更新表资源
|
void |
Tags.update(Tag tag) |
void |
Volumes.update(Volume volume) |
void |
Resources.update(VolumeResource resource)
更新 Volume 资源
|
void |
XFlows.update(XFlow.XFlowModel model)
更新 XFlow 对象
|
void |
XFlows.update(XFlow.XFlowModel model,
String projectName)
更新 XFlow 对象
|
void |
Function.updateOwner(String newOwner) |
void |
Resource.updateOwner(String newOwner)
更新 资源的 owner
需要是 project owner
|
void |
Projects.updateProject(String projectName,
Map<String,String> properties)
更新 Project
|
void |
Session.waitAttachSuccess(long timeout)
等待 attach session 返回
|
void |
Session.waitForStart()
阻塞等待 session 启动
|
void |
Session.waitForStart(long timeout)
等待 session 启动
|
Session.SubQueryResponse |
Session.waitForSubqueryTerminated(int queryId)
等待SubQuery执行结束获取查询结果
|
void |
Instance.waitForSuccess()
阻塞当前线程, 直到Instance结束
|
void |
Instance.waitForSuccess(long interval)
阻塞当前线程, 直到Instance结束
|
Modifier and Type | Method and Description |
---|---|
URI |
GeneralConfiguration.getEndpoint(String projectName) |
URI |
GeneralConfiguration.getURI(String projectName,
String tableName)
取得URI
|
Modifier and Type | Method and Description |
---|---|
Instance |
OfflineModels.copy(String project,
OfflineModelInfo modelInfo)
创建离线模型, 返回负责复制离线模型的XmodelTask的instance
|
Instance |
OfflineModels.create(OfflineModelInfo modelInfo)
创建离线模型, 返回负责创建离线模型的XmodelTask的instance
|
OnlineModel |
OnlineModels.create(OnlineModelInfo modelInfo) |
OnlineModel |
OnlineModels.create(OnlineModelInfoNew modelInfo) |
Instance |
OfflineModels.create(String project,
OfflineModelInfo modelInfo)
创建离线模型, 返回负责创建离线模型的XmodelTask的instance
|
OnlineModel |
OnlineModels.create(String modelName,
String offlinemodelProject,
String offlinemodelName,
short qos)
将训练完成的离线模型发布为在线模型
|
OnlineModel |
OnlineModels.create(String modelName,
String offlinemodelProject,
String offlinemodelName,
short qos,
String serviceTag) |
OnlineModel |
OnlineModels.create(String projectName,
String modelName,
String offlinemodelProject,
String offlinemodelName,
short qos)
将训练完成的离线模型发布为在线模型
|
OnlineModel |
OnlineModels.create(String projectName,
String modelName,
String offlinemodelProject,
String offlinemodelName,
short qos,
String serviceTag) |
void |
OnlineModels.delete(String modelName)
删除在线模型
|
void |
OfflineModels.delete(String modelName)
删除离线模型
|
void |
OnlineModels.delete(String projectName,
String modelName)
删除在线模型
|
void |
OfflineModels.delete(String projectName,
String modelName)
删除离线模型
|
boolean |
OnlineModels.exists(String modelName)
判断指定在线模型是否存在
|
boolean |
OfflineModels.exists(String modelName)
判断指定离线模型是否存在
|
boolean |
OnlineModels.exists(String projectName,
String modelName)
判断指定在线模型是否存在
|
boolean |
OfflineModels.exists(String projectName,
String modelName)
判断指定离线模型是否存在
|
String |
OfflineModel.getModel() |
void |
OnlineModel.reload() |
void |
OfflineModel.reload() |
void |
OnlineModel.update(ModelAbTestInfo abTestInfo) |
void |
OnlineModel.update(OnlineModelInfo modelInfo) |
void |
OnlineModel.update(OnlineModelInfoNew modelInfo) |
void |
OnlineModel.update(String offlinemodelProject,
String offlinemodelName)
更新在线模型
|
void |
OnlineModel.update(String offlinemodelProject,
String offlinemodelName,
short qos,
short instanceNum)
更新在线模型
|
void |
OnlineModel.updateInstanceNumber(short instanceNum) |
void |
OnlineModel.updateQos(short qos)
更新在线模型
|
Modifier and Type | Method and Description |
---|---|
CheckPermissionConstants.CheckPermissionResult |
SecurityManager.checkPermission(CheckPermissionConstants.ObjectType type,
String objectName,
CheckPermissionConstants.ActionType action)
Deprecated.
|
CheckPermissionConstants.CheckPermissionResult |
SecurityManager.checkPermission(CheckPermissionConstants.ObjectType type,
String objectName,
CheckPermissionConstants.ActionType action,
List<String> columns)
Deprecated.
|
CheckPermissionConstants.CheckPermissionResult |
SecurityManager.checkPermission(CheckPermissionConstants.ObjectType type,
String objectName,
CheckPermissionConstants.ActionType action,
String projectName)
Deprecated.
|
CheckPermissionConstants.CheckPermissionResult |
SecurityManager.checkPermission(CheckPermissionConstants.ObjectType type,
String objectName,
CheckPermissionConstants.ActionType action,
String projectName,
List<String> columns)
Deprecated.
|
SecurityManager.CheckPermissionResultInfo |
SecurityManager.checkPermission(SecurityManager.PermissionDesc desc)
Check permission
|
String |
SecurityManager.generateAuthorizationToken(String policy,
String type) |
String |
SecurityManager.getProjectPolicy() |
String |
SecurityConfiguration.getProjectProtectionExceptionPolicy() |
String |
SecurityManager.AuthorizationQueryInstance.getResult() |
String |
SecurityManager.getRolePolicy(String roleName) |
String |
SecurityManager.getSecurityPolicy() |
SecurityManager.AuthorizationQueryStatus |
SecurityManager.AuthorizationQueryInstance.getStatus() |
User |
SecurityManager.getUserById(String id) |
User |
SecurityManager.getUserByName(String name) |
boolean |
SecurityManager.AuthorizationQueryInstance.isTerminated() |
List<Role> |
SecurityManager.listRoles() |
List<Role> |
SecurityManager.listRolesForUser(String uid)
Deprecated.
|
List<Role> |
SecurityManager.listRolesForUserID(String uid)
获取指定用户 id 的角色列表
|
List<Role> |
SecurityManager.listRolesForUserName(String userName)
获取制定用户名的角色列表
|
List<User> |
SecurityManager.listUsers() |
List<User> |
SecurityManager.listUsersForRole(String roleName) |
void |
SecurityManager.putProjectPolicy(String policy) |
void |
SecurityManager.putRolePolicy(String roleName,
String policy) |
void |
SecurityManager.putSecurityPolicy(String securityPolicy) |
void |
Role.reload() |
void |
SecurityConfiguration.reload() |
void |
User.reload() |
SecurityManager.AuthorizationQueryInstance |
SecurityManager.run(String query,
Boolean jsonOutput)
执行安全命令, 返回 query 实例
|
SecurityManager.AuthorizationQueryInstance |
SecurityManager.run(String query,
Boolean jsonOutput,
String supervisionToken)
执行安全命令, 返回 query 实例
|
SecurityManager.AuthorizationQueryInstance |
SecurityManager.run(String query,
Boolean jsonOutput,
String supervisionToken,
Map<String,String> settings)
执行安全命令, 返回 query 实例
|
String |
SecurityManager.runQuery(String query,
Boolean jsonOutput)
执行安全命令, 返回 query 结果
|
String |
SecurityManager.runQuery(String query,
Boolean jsonOutput,
String supervisionToken)
执行安全命令, 返回 query 结果
|
String |
SecurityManager.runQuery(String query,
Boolean jsonOutput,
String supervisionToken,
Map<String,String> settings) |
void |
SecurityManager.setSecurityConfiguration(SecurityConfiguration securityConfigration) |
void |
SecurityManager.setSecurityConfiguration(SecurityConfiguration securityConfigration,
String supervisionToken) |
String |
SecurityManager.AuthorizationQueryInstance.waitForSuccess() |
String |
SecurityManager.AuthorizationQueryInstance.waitForSuccess(long interval) |
Modifier and Type | Method and Description |
---|---|
SQLExecutor |
SQLExecutorBuilder.build() |
SQLExecutorPool |
SQLExecutorPoolBuilder.build() |
void |
SQLExecutor.cancel()
取消当前查询
|
SQLExecutor |
SQLExecutorPool.getExecutor()
获取一个连接,在最大连接数限制内会进行初始化动作
|
List<Instance.StageProgress> |
SQLExecutor.getProgress()
获取当前查询的进度信息
|
List<Record> |
SQLExecutor.getResult()
通过InstanceTunnel获取所有结果
|
List<Record> |
SQLExecutor.getResult(Long countLimit)
通过InstanceTunnel获取有限集结果
|
List<Record> |
SQLExecutor.getResult(Long countLimit,
Long sizeLimit)
通过InstanceTunnel获取有限集结果
|
List<Record> |
SQLExecutor.getResult(Long offset,
Long countLimit,
Long sizeLimit)
通过InstanceTunnel获取有限集结果
|
List<Record> |
SQLExecutor.getResult(Long offset,
Long countLimit,
Long sizeLimit,
boolean limitEnabled)
通过InstanceTunnel获取有限集结果
|
ResultSet |
SQLExecutor.getResultSet()
通过InstanceTunnel获取结果的迭代器
|
ResultSet |
SQLExecutor.getResultSet(Long countLimit)
通过InstanceTunnel获取有限集结果的迭代器
|
ResultSet |
SQLExecutor.getResultSet(Long countLimit,
Long sizeLimit)
通过InstanceTunnel获取有限集结果的迭代器
|
ResultSet |
SQLExecutor.getResultSet(Long offset,
Long countLimit,
Long sizeLimit)
通过InstanceTunnel获取有限集结果的迭代器
|
ResultSet |
SQLExecutor.getResultSet(Long offset,
Long countLimit,
Long sizeLimit,
boolean limitEnabled)
通过InstanceTunnel获取有限集结果的迭代器
|
String |
SQLExecutor.getSummary()
获取当前查询的Summary信息
|
void |
SQLExecutor.run(String sql,
Map<String,String> hint)
提交一个query
|
Modifier and Type | Method and Description |
---|---|
RecordIter |
Command.run(Odps odps,
CommandInfo commandInfo) |
Modifier and Type | Method and Description |
---|---|
static String |
CommandUtil.runJob(Task task,
Odps odps) |
Modifier and Type | Method and Description |
---|---|
static String |
SQLTask.getRawResult(Instance instance) |
static String |
SQLTask.getRawResult(Instance instance,
String taskName) |
static List<Record> |
SQLTask.getResult(Instance instance)
Return 1W records at most.
|
static List<Record> |
SQLTask.getResult(Instance instance,
String taskName)
Return 1W records at most.
|
static List<Record> |
SQLTask.getResultByInstanceTunnel(Instance instance)
使用 instance tunnel 的方式获取 Anonymous task 的结果
|
static List<Record> |
SQLTask.getResultByInstanceTunnel(Instance instance,
Long limit)
使用 instance tunnel 的方式获取 Anonymous task 的结果
|
static List<Record> |
SQLTask.getResultByInstanceTunnel(Instance instance,
String taskName)
使用 instance tunnel 的方式获取 instance 结果
当数据量不大于
#SQL_TASK_RESULT_LIMIT 条时,成功;
若数据量量大于 #SQL_TASK_RESULT_LIMIT 条, 返回 SQL_TASK_RESULT_LIMIT 条结果;
可使用 SQLTask.getResultByInstanceTunnel(Instance, String, Long) 接口调整 limit 参数, 来获取更多数据; |
static List<Record> |
SQLTask.getResultByInstanceTunnel(Instance instance,
String taskName,
Long limit)
Return 1W records with completed schema info at most.
|
static TableSchema |
SQLTask.getResultSchema(Instance instance)
获取运行 SQL 运行结果的 schema 信息。
|
static ResultSet |
SQLTask.getResultSet(Instance instance)
通过instance获取记录迭代器,从而可以让用户通过迭代器逐条获取记录来避免一次性获取全量数据到本地时撑爆内存的问题
注:本接口使用 instance tunnel 实现,没有记录数限制,可获取instance对应query结果集的全量数据。
但是只有instance的owner本人可以使用本接口,且当对应project打开protection时,
需要提前在policy中为对应SQL中涉及的相应表和视图添加exception,否则无权下载
|
static ResultSet |
SQLTask.getResultSet(Instance instance,
Long limit)
通过instance获取记录迭代器,从而可以让用户通过迭代器逐条获取记录来避免一次性获取全量数据到本地时撑爆内存的问题
注:本接口使用 instance tunnel 实现,没有记录数限制,可获取instance对应query结果集的全量数据。
但是只有instance的owner本人可以使用本接口,且当对应project打开protection时,
需要提前在policy中为对应SQL中涉及的相应表和视图添加exception,否则无权下载
|
static ResultSet |
SQLTask.getResultSet(Instance instance,
String taskName)
通过instance获取记录迭代器,从而可以让用户通过迭代器逐条获取记录来避免一次性获取全量数据到本地时撑爆内存的问题
注:本接口使用 instance tunnel 实现,没有记录数限制,可获取instance对应query结果集的全量数据。
但是只有instance的owner本人可以使用本接口,且当对应project打开protection时,
需要提前在policy中为对应SQL中涉及的相应表和视图添加exception,否则无权下载
|
static ResultSet |
SQLTask.getResultSet(Instance instance,
String taskName,
InstanceTunnel instanceTunnel,
Long limit,
boolean limitHint) |
static ResultSet |
SQLTask.getResultSet(Instance instance,
String taskName,
Long limit)
通过instance获取记录迭代器,从而可以让用户通过迭代器逐条获取记录来避免一次性获取全量数据到本地时撑爆内存的问题
注:本接口使用 instance tunnel 实现,没有记录数限制,可获取instance对应query结果集的全量数据。
但是只有instance的owner本人可以使用本接口,且当对应project打开protection时,
需要提前在policy中为对应SQL中涉及的相应表和视图添加exception,否则无权下载
|
static ResultSet |
SQLTask.getResultSet(Instance instance,
String taskName,
Long limit,
boolean limitHint)
通过instance获取记录迭代器,从而可以让用户通过迭代器逐条获取记录来避免一次性获取全量数据到本地时撑爆内存的问题
注:
1.只有instance的owner本人可以使用本接口
2.当limitHint为true时,结果最多只能获得1条记录,超过将截断,但无需进行逐表的权限检查
3.当limitHint为false时,没有记录数限制,可获取instance对应query结果集的全量数据。但前提是需要逐表(SQL中
涉及的表与视图)对用户进行权限检查,所以当查询涉及表所在project打开protection时,需要提前在policy中为相应表
和视图添加exception,否则无权下载
|
static ResultSet |
SQLTask.getResultSet(Instance instance,
String taskName,
Long limit,
boolean limitHint,
URI tunnelEndpoint)
通过instance获取记录迭代器,从而可以让用户通过迭代器逐条获取记录来避免一次性获取全量数据到本地时撑爆内存的问题
注:本接口使用 instance tunnel 实现,没有记录数限制,可获取instance对应query结果集的全量数据。
1.只有instance的owner本人可以使用本接口
2.当limitHint为true时,结果最多只能获得1条记录,超过将截断,但无需进行逐表的权限检查
3.当limitHint为false时,没有记录数限制,可获取instance对应query结果集的全量数据。但前提是需要逐表(SQL中
涉及的表与视图)对用户进行权限检查,所以当查询涉及表所在project打开protection时,需要提前在policy中为相应表
和视图添加exception,否则无权下载
|
static List<String> |
SQLTask.getSqlWarning(Instance instance)
获取运行 SQL 的编译警告信息,可能有多条.
|
static List<String> |
SQLTask.getSqlWarning(Instance instance,
String taskName)
获取运行 SQL 的编译警告信息,可能有多条.
|
static List<Record> |
SQLTask.parseCsvRecord(String csvResult)
解析 CSV 格式的数据字符串,转换为 record 列表
|
static Instance |
SQLCostTask.run(Odps odps,
String sql)
通过匿名Instance运行SQLCostTask
|
static Instance |
SQLTask.run(Odps odps,
String sql)
运行 SQL.
特别注意,在执行数据读取操作时: 正常情况下的 task 执行后,task 的状态为 SUCCESS,并正常返回数据结果。 但是,当读取数据量超过 10MB,task 的状态将是 FAILED,返回的数据结果为 error message。 因此,大量数据的获取建议使用 TableTunnel 进行操作。示例代码: |
static Instance |
LOTTask.run(Odps odps,
String input,
boolean runSQL)
通过匿名Instance运行LOTTask
|
static Instance |
GraphTask.run(Odps odps,
String project,
GraphTask graphTask,
int priority,
String runningCluster) |
static Instance |
LOTTask.run(Odps odps,
String project,
String input,
boolean runSQL,
Map<String,String> hints,
Map<String,String> aliases)
通过匿名Instance运行LOTTask
|
static Instance |
LOTTask.run(Odps odps,
String project,
String input,
boolean runSQL,
String taskName,
Map<String,String> hints,
Map<String,String> aliases)
运行LOTTask
|
static Instance |
CupidTask.run(Odps odps,
String project,
String plan,
Map<String,String> hints) |
static Instance |
MoyeTask.run(Odps odps,
String project,
String plan,
Map<String,String> hints) |
static Instance |
SQLCostTask.run(Odps odps,
String project,
String sql,
Map<String,String> hints)
通过匿名Instance运行SQLCostTask
|
static Instance |
CupidTask.run(Odps odps,
String project,
String plan,
Map<String,String> hints,
int priority) |
static Instance |
MoyeTask.run(Odps odps,
String project,
String plan,
Map<String,String> hints,
int priority) |
static Instance |
CupidTask.run(Odps odps,
String project,
String plan,
Map<String,String> hints,
Integer priority,
String runningCluster,
String jobName) |
static Instance |
SQLTask.run(Odps odps,
String project,
String sql,
Map<String,String> hints,
Map<String,String> aliases)
运行SQL
|
static Instance |
KubeTask.run(Odps odps,
String project,
String taskName,
String yamlPath) |
static Instance |
KubeTask.run(Odps odps,
String project,
String taskName,
String yamlPath,
int priority) |
static Instance |
KubeTask.run(Odps odps,
String project,
String taskName,
String appId,
KubeTask.Command command) |
static Instance |
KubeTask.run(Odps odps,
String project,
String taskName,
String appId,
KubeTask.Command command,
int priority) |
static Instance |
SQLCostTask.run(Odps odps,
String project,
String sql,
String taskName,
Map<String,String> hints)
运行SQLCostTask
|
static Instance |
SQLTask.run(Odps odps,
String project,
String sql,
String taskName,
Map<String,String> hints,
Map<String,String> aliases) |
static Instance |
SQLTask.run(Odps odps,
String project,
String sql,
String taskName,
Map<String,String> hints,
Map<String,String> aliases,
int priority)
运行SQL
|
static Instance |
KubeTask.run(Odps odps,
String project,
String taskName,
String appId,
String resourceName,
String labels,
KubeTask.Command command,
KubeTask.Kind kind) |
static Instance |
KubeTask.run(Odps odps,
String project,
String taskName,
String appId,
String resourceName,
String labels,
KubeTask.Command command,
KubeTask.Kind kind,
int priority) |
Modifier and Type | Class and Description |
---|---|
class |
TunnelException
该异常在DataTunnel服务访问失败时抛出。
|
Copyright © 2023 Alibaba Cloud Computing. All rights reserved.