RainClient (sdk-client dev-0.1.1-SNAPSHOT API)

RainClient

pom导入

        <dependency>
            <groupId>org.rainhub.connect</groupId>
            <artifactId>sdk-client</artifactId>
            <version>dev-0.1.1-SNAPSHOT</version>
        </dependency>

构造方法概述

构造方法	描述
RainClient(String accessKey, String accessSecret, String endpoint)	初始化 RainClient 类的新实例。

方法概述

实例方法

修饰符和返回值类型	方法	描述
boolean	alterTable(String databaseName, String tableName, String schema, String description)	修改表的 schema。
boolean	alterView(String databaseName, String viewName, String code, String language, String schema, String sources)	修改视图。
String	createBinlogTable(String databaseName, String tableName, String schema, String description, boolean overwrite)	创建 binlog 表。
boolean	createDatabase(String databaseName, String permission, boolean overwrite, String description)	创建数据库。
boolean	createFunction(String databaseName, String functionName, String code, String language, String description, boolean overwrite)	创建函数。
String	createTable(String databaseName, String tableName, String schema, String description, boolean overwrite, String tableType)	创建表。
boolean	createView(String databaseName, String viewName, String code, String language, String schema, String sources, String description, boolean overwrite)	创建视图。
boolean	createVolume(String databaseName, String volumeName, String description, boolean overwrite)	创建卷。
boolean	dataBaseExists(String databaseName)	检查数据库是否存在。
void	describeHistory(String databaseName, String tableName)	描述表的历史记录。
boolean	dropDatabase(String databaseName, boolean IgnoreIfExists, boolean cascade)	删除数据库。
boolean	dropFunction(String databaseName, String functionName, boolean ignoreIfExists)	删除函数。
boolean	dropTable(String databaseName, String tableName, boolean ignoreIfExists, boolean purge)	删除表。
boolean	dropView(String databaseName, String viewName, boolean ignoreIfExists)	删除视图。
boolean	dropVolume(String databaseName, String volumeName, boolean ignoreIfExists, boolean purge)	删除卷。
void	getFromTable(String databaseName, String tableName, String target)	从表中获取数据，并保存到目标文件。
Map<String, String>	getOssTokenProperties()	获取 OSS token 属性。
String	getTableTokenFromExistTable(String tableName, String databaseName)	获取现有表的 token。
String	getTableType(String tableName, String databaseName)	获取现有表的类型。
String[]	listDatabases()	列出所有数据库。
List<RequestResponses.TableInfo>	listTables(String databaseName, String pattern, boolean isDropped)	列出数据库中的所有表。
void	loadAsTable(String[] sources, String databaseName, String tableName, String description, boolean overwrite)	将数据加载到表中。如果表不存在，则会创建该表。
void	loadIntoTable(String[] sources, String databaseName, String tableName)	将数据加载到表中。
void	loadIntoTable(String[] sources, String databaseName, String tableName, boolean isStreaming)	将数据以流的形式加载到表中。
boolean	renameTable(String oldDatabaseName, String oldTableName, String newTableName)	重命名表。
boolean	restoreTable(String databaseName, String tableName, int version)	将表恢复到指定版本。
boolean	submitCommit(String tableToken, org.apache.drc.stripe.FileCommit fileCommit, String metaSchema, long startTime, long endTime)	提交 commit。
boolean	submitStream(String tableToken, org.apache.drc.stripe.FileCommit fileCommit, String metaSchema, long startTime, long endTime)	提交streaming。
boolean	tableExists(String databaseName, String tableName)	检查表是否存在。
boolean	unDropTable(String databaseName, String tableName)	恢复之前被删除的表。

方法详情

loadAsTable

描述：

将数据加载到表中。如果指定的表不存在，则会创建该表。如果表已存在且 overwrite 为 false，将抛出异常。

参数：

sources：包含要加载数据的源文件路径数组。
databaseName：目标数据库的名称。
tableName：表的名称。
description：表的描述（如果创建新表时使用）。
formatOptions - 指定数据源解析格式Options
overwrite：是否覆盖现有表。

抛出：

IOException：在加载数据过程中出现错误时抛出。

loadIntoTable

描述：

将数据加载到现有表中。如果表不存在，将创建表。

参数：

sources：包含要加载数据的源文件路径数组。
databaseName：目标数据库的名称。
tableName：表的名称。
formatOptions - 指定数据源解析格式Options

抛出：

IOException：在加载数据过程中出现错误时抛出。

loadIntoTable (Streaming)

描述：

以流模式将数据加载到表中。如果指定的表不存在，将会创建表。

参数：

sources：包含要加载数据的源文件路径数组。
databaseName：目标数据库的名称。
tableName：表的名称。
isStreaming：是否以流模式加载数据。

抛出：

IOException：如果在加载过程中发生错误。

getFromTable

描述：

从表中获取数据，并将数据保存到目标文件中。

参数：

databaseName：表所在的数据库名称。
tableName：需要获取数据的表名称。
target：目标文件路径（应以 .format 为扩展名）。

抛出：

IOException：如果在获取过程中发生错误。

createDatabase

描述：

创建一个新数据库。如果数据库已存在且 overwrite 为 false，将抛出异常。

参数：

databaseName：数据库的名称。
permission：数据库的权限。
overwrite：是否覆盖现有数据库。
description：数据库的描述。

返回值：

boolean：如果数据库创建成功，返回 true；否则返回 false。

抛出：

IOException：如果在创建过程中发生错误。

dropDatabase

描述：

删除数据库。如果数据库不存在且 IgnoreIfExists 为 false，将抛出异常。

参数：

databaseName：要删除的数据库名称。
IgnoreIfExists：是否在数据库不存在时忽略操作。
cascade：是否删除数据库及其所有表。

返回值：

boolean：如果数据库删除成功，返回 true；否则返回 false。

抛出：

IOException：如果在删除过程中发生错误。

createBinlogTable

描述：

创建 binlog 表。如果表已存在且 overwrite 为 false，将抛出异常。

参数：

databaseName：表所在的数据库名称。
tableName：要创建的表名称。
schema：表的 schema（JSON 格式）。
description：表的描述。
overwrite：是否覆盖现有表。

返回值：

String：创建表的 token。

抛出：

IOException：如果在创建过程中发生错误。

createTable

描述：

创建表。如果表已存在且 overwrite 为 false，将抛出异常。

参数：

databaseName：表所在的数据库名称。
tableName：要创建的表名称。
schema：表的 schema（JSON 格式）。
description：表的描述。
overwrite：是否覆盖现有表。
tableType：表的类型。

返回值：

String：创建表的 token。

抛出：

IOException：如果在创建过程中发生错误。

dropTable

描述：

删除表。如果表不存在且 ignoreIfExists 为 false，将抛出异常。

参数：

databaseName：表所在的数据库名称。
tableName：要删除的表名称。
ignoreIfExists：是否在表不存在时忽略操作。
purge：是否清理表。

返回值：

boolean：如果表删除成功，返回 true；否则返回 false。

抛出：

IOException：如果在删除过程中发生错误。

renameTable

描述：

重命名表。

参数：

oldDatabaseName：当前表所在的数据库名称。
oldTableName：当前表的名称。
newTableName：表的新名称。

返回值：

boolean：如果表重命名成功，返回 true；否则返回 false。

抛出：

IOException：如果在执行重命名操作时发生错误。

restoreTable

描述：

将表恢复到指定的版本。

参数：

databaseName：表所在的数据库名称。
tableName：需要恢复的表名称。
version：要恢复的版本号。

返回值：

boolean：如果表恢复成功，返回 true；否则返回 false。

抛出：

IOException：如果在执行恢复操作时发生错误。

submitCommit

描述：

提交一个 commit。

参数：

tableToken：表的令牌。
fileCommit：提交的文件（类型为 org.apache.drc.stripe.FileCommit）。
metaSchema：提交的元数据 schema。
startTime：提交的开始时间。
endTime：提交的结束时间。

返回值：

boolean：如果提交成功，返回 true；否则返回 false。

submitStream

描述：

提交流式数据。

参数：

tableToken：表的令牌。
fileCommit：需要提交的文件（类型为 org.apache.drc.stripe.FileCommit）。
metaSchema：元数据 schema。
startTime：提交流的开始时间。
endTime：提交流的结束时间。

返回值：

boolean：如果流提交成功，返回 true；否则返回 false。

tableExists

描述：

检查表是否存在。

参数：

databaseName：表所在的数据库名称。
tableName：需要检查的表名称。

返回值：

boolean：如果表存在，返回 true；否则返回 false。

抛出：

IOException：如果在检查时发生错误。

unDropTable

描述：

恢复之前被删除的表。

参数：

databaseName：表所在的数据库名称。
tableName：需要恢复的表名称。

返回值：

boolean：如果表恢复成功，返回 true；否则返回 false。

抛出：

IOException：如果在执行恢复操作时发生错误。

describeHistory

描述：

描述指定表的历史记录。

参数：

databaseName：表所在的数据库名称。
tableName：需要描述历史记录的表名称。

抛出：

IOException：如果在获取历史记录时发生错误。

alterTable

描述：

修改表的 schema。

参数：

databaseName：表所在的数据库名称。
tableName：需要修改的表名称。
schema：表的新 schema。
description：表的描述。

返回值：

boolean：如果表 schema 修改成功，返回 true；否则返回 false。

抛出：

IOException：如果在修改 schema 时发生错误。

alterView

描述：

修改视图。

参数：

databaseName：视图所在的数据库名称。
viewName：需要修改的视图名称。
code：视图的代码。
language：视图语言。
schema：视图的 schema。
sources：视图的来源。

返回值：

boolean：如果视图修改成功，返回 true；否则返回 false。

抛出：

IOException：如果在修改视图时发生错误。

createFunction

描述：

创建函数。

参数：

databaseName：函数所在的数据库名称。
functionName：函数的名称。
code：函数的代码。
language：函数的语言。
description：函数的描述。
overwrite：是否覆盖现有函数。

返回值：

boolean：如果函数创建成功，返回 true；否则返回 false。

抛出：

IOException：如果在创建函数时发生错误。

dropFunction

描述：

删除函数。

参数：

databaseName：函数所在的数据库名称。
functionName：需要删除的函数名称。
ignoreIfExists：如果为 true，在函数不存在时忽略操作。

返回值：

boolean：如果函数删除成功，返回 true；否则返回 false。

抛出：

IOException：如果在删除函数时发生错误。

listDatabases

描述：

列出所有数据库。

返回值：

String[]：包含所有数据库名称的数组。

listTables

描述：

列出数据库中的所有表。

参数：

databaseName：数据库的名称。
pattern：用于过滤表名的模式。
isDropped：是否列出已删除的表。

返回值：

List<RequestResponses.TableInfo>：表的列表。