DataSourceClientProxy (DatasourceX 1.7.1-RELEASE API)

java.lang.Object
- com.dtstack.dtcenter.loader.client.sql.DataSourceClientProxy<T>

所有已实现的接口:: IClient<T>

public class DataSourceClientProxy<T>
extends Object
implements IClient<T>

构造器概要

构造器
构造器和说明

DataSourceClientProxy(IClient targetClient)

构造器
构造器和说明
`DataSourceClientProxy(IClient targetClient)`

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`Boolean`	`createDatabase(ISourceDTO source, String dbName, String comment)` 创建数据库
`List<Map<String,Object>>`	`executeQuery(ISourceDTO source, SqlQueryDTO queryDTO)` 执行查询
`Boolean`	`executeSqlWithoutResultSet(ISourceDTO source, SqlQueryDTO queryDTO)` 执行查询，无需结果集
`List<String>`	`getAllDatabases(ISourceDTO source, SqlQueryDTO queryDTO)` 获取所有的 DB
`List<String>`	`getCatalogs(ISourceDTO source)` 获取数据源/数据库目录列表，目前presto使用，后续pgSql等可以实现该方法用于获取所有库
`List<String>`	`getColumnClassInfo(ISourceDTO source, SqlQueryDTO queryDTO)` 返回字段 Java 类的标准名称字段名若不填则默认全部
`List<ColumnMetaDTO>`	`getColumnMetaData(ISourceDTO source, SqlQueryDTO queryDTO)` 获取表字段属性字段名若不填则默认全部, 是否过滤分区字段不填默认不过滤
`List<ColumnMetaDTO>`	`getColumnMetaDataWithSql(ISourceDTO source, SqlQueryDTO queryDTO)` 根据自定义sql获取表字段属性
`Connection`	`getCon(ISourceDTO source)` 获取连接
`Connection`	`getCon(ISourceDTO source, String taskParams)` 获取连接
`String`	`getCreateTableSql(ISourceDTO source, SqlQueryDTO queryDTO)` 获取建表语句
`String`	`getCurrentDatabase(ISourceDTO source)` 获取当前使用的数据库
`IDownloader`	`getDownloader(ISourceDTO source, SqlQueryDTO queryDTO)` 获取对应的downloader
`IDownloader`	`getDownloader(ISourceDTO source, String sql, Integer pageSize)` 根据执行 sql 下载数据
`List<ColumnMetaDTO>`	`getFlinkColumnMetaData(ISourceDTO source, SqlQueryDTO queryDTO)` 获取flinkSql字段名称
`List<ColumnMetaDTO>`	`getPartitionColumn(ISourceDTO source, SqlQueryDTO queryDTO)` 获取分区字段
`List<List<Object>>`	`getPreview(ISourceDTO source, SqlQueryDTO queryDTO)` 获取预览数据
`List<String>`	`getRootDatabases(ISourceDTO source, SqlQueryDTO queryDTO)` 获取所有的db，此方法目的为获取所有的 database，为了解决一些遗留问题。
`Table`	`getTable(ISourceDTO source, SqlQueryDTO queryDTO)` 获取表信息
`List<String>`	`getTableList(ISourceDTO source, SqlQueryDTO queryDTO)` 返回所有的表字段名称是否视图表，默认不过滤
`List<String>`	`getTableListBySchema(ISourceDTO source, SqlQueryDTO queryDTO)` 根据schema/db获取表
`String`	`getTableMetaComment(ISourceDTO source, SqlQueryDTO queryDTO)` 获取表注释
`String`	`getVersion(ISourceDTO source)` 获取当前数据源的版本
`Boolean`	`isDatabaseExists(ISourceDTO source, String dbName)` 判断数据库是否存在
`Boolean`	`isTableExistsInDatabase(ISourceDTO source, String tableName, String dbName)` 判断该数据库中是否存在该表
`List<String>`	`listFileNames(ISourceDTO sourceDTO, String path, Boolean includeDir, Boolean recursive, Integer maxNum, String regexStr)` 列出指定路径下的文件
`Boolean`	`testCon(ISourceDTO source)` 校验连接

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 构造器详细资料
  - DataSourceClientProxy
```
public DataSourceClientProxy(IClient targetClient)
```
- 方法详细资料
  - getCon
```
public Connection getCon(ISourceDTO source)
```
    从接口复制的说明: IClient
    
    获取连接
    
    指定者:
    
    getCon 在接口中 IClient<T>
    
    参数:
    
    source - 数据源信息
    
    返回:
  - getCon
```
public Connection getCon(ISourceDTO source,
                         String taskParams)
```
    从接口复制的说明: IClient
    
    获取连接
    
    指定者:
    
    getCon 在接口中 IClient<T>
    
    参数:
    
    source - 数据源信息
    
    taskParams - 任务环境变量
    
    返回:
  - testCon
```
public Boolean testCon(ISourceDTO source)
```
    从接口复制的说明: IClient
    
    校验连接
    
    指定者:
    
    testCon 在接口中 IClient<T>
    
    返回:
  - executeQuery
```
public List<Map<String,Object>> executeQuery(ISourceDTO source,
                                             SqlQueryDTO queryDTO)
```
    从接口复制的说明: IClient
    
    执行查询
    
    指定者:
    
    executeQuery 在接口中 IClient<T>
    
    queryDTO - 必填项 sql
    
    返回:
  - executeSqlWithoutResultSet
```
public Boolean executeSqlWithoutResultSet(ISourceDTO source,
                                          SqlQueryDTO queryDTO)
```
    从接口复制的说明: IClient
    
    执行查询，无需结果集
    
    指定者:
    
    executeSqlWithoutResultSet 在接口中 IClient<T>
    
    queryDTO - 必填项 sql
    
    返回:
  - getTableList
```
public List<String> getTableList(ISourceDTO source,
                                 SqlQueryDTO queryDTO)
```
    从接口复制的说明: IClient
    
    返回所有的表字段名称是否视图表，默认不过滤
    
    指定者:
    
    getTableList 在接口中 IClient<T>
    
    返回:
  - getTableListBySchema
```
public List<String> getTableListBySchema(ISourceDTO source,
                                         SqlQueryDTO queryDTO)
```
    从接口复制的说明: IClient
    
    根据schema/db获取表
    
    指定者:
    
    getTableListBySchema 在接口中 IClient<T>
    
    返回:
  - getColumnClassInfo
```
public List<String> getColumnClassInfo(ISourceDTO source,
                                       SqlQueryDTO queryDTO)
```
    从接口复制的说明: IClient
    
    返回字段 Java 类的标准名称字段名若不填则默认全部
    
    指定者:
    
    getColumnClassInfo 在接口中 IClient<T>
    
    queryDTO - 必填项表名
    
    返回:
  - getColumnMetaData
```
public List<ColumnMetaDTO> getColumnMetaData(ISourceDTO source,
                                             SqlQueryDTO queryDTO)
```
    从接口复制的说明: IClient
    
    获取表字段属性字段名若不填则默认全部, 是否过滤分区字段不填默认不过滤
    
    指定者:
    
    getColumnMetaData 在接口中 IClient<T>
    
    queryDTO - 必填项表名
    
    返回:
  - getColumnMetaDataWithSql
```
public List<ColumnMetaDTO> getColumnMetaDataWithSql(ISourceDTO source,
                                                    SqlQueryDTO queryDTO)
```
    从接口复制的说明: IClient
    
    根据自定义sql获取表字段属性
    
    指定者:
    
    getColumnMetaDataWithSql 在接口中 IClient<T>
    
    queryDTO - 必填项 sql
    
    返回:
  - getFlinkColumnMetaData
```
public List<ColumnMetaDTO> getFlinkColumnMetaData(ISourceDTO source,
                                                  SqlQueryDTO queryDTO)
```
    从接口复制的说明: IClient
    
    获取flinkSql字段名称
    
    指定者:
    
    getFlinkColumnMetaData 在接口中 IClient<T>
    
    返回:
  - getTableMetaComment
```
public String getTableMetaComment(ISourceDTO source,
                                  SqlQueryDTO queryDTO)
```
    从接口复制的说明: IClient
    
    获取表注释
    
    指定者:
    
    getTableMetaComment 在接口中 IClient<T>
    
    返回:
  - getPreview
```
public List<List<Object>> getPreview(ISourceDTO source,
                                     SqlQueryDTO queryDTO)
```
    从接口复制的说明: IClient
    
    获取预览数据
    
    指定者:
    
    getPreview 在接口中 IClient<T>
    
    返回:
  - getDownloader
```
public IDownloader getDownloader(ISourceDTO source,
                                 SqlQueryDTO queryDTO)
```
    从接口复制的说明: IClient
    
    获取对应的downloader
    
    指定者:
    
    getDownloader 在接口中 IClient<T>
    
    返回:
  - getDownloader
```
public IDownloader getDownloader(ISourceDTO source,
                                 String sql,
                                 Integer pageSize)
                          throws Exception
```
    从接口复制的说明: IClient
    
    根据执行 sql 下载数据
    
    指定者:
    
    getDownloader 在接口中 IClient<T>
    
    参数:
    
    source - 数据源信息
    
    sql - 执行 sql
    
    pageSize - 每页的数量
    
    返回:
    
    数据下载 downloader
    
    抛出:
    
    Exception - 异常
  - getAllDatabases
```
public List<String> getAllDatabases(ISourceDTO source,
                                    SqlQueryDTO queryDTO)
```
    从接口复制的说明: IClient
    
    获取所有的 DB
    
    指定者:
    
    getAllDatabases 在接口中 IClient<T>
    
    返回:
  - getRootDatabases
```
public List<String> getRootDatabases(ISourceDTO source,
                                     SqlQueryDTO queryDTO)
```
    从接口复制的说明: IClient
    
    获取所有的db，此方法目的为获取所有的 database，为了解决一些遗留问题。例如 oracle 12 后支持 cdb 模式，此时 oracle 可以包含多个 pdb，每个 pdb 下面可以有多个 schema，但是getAllDatabases 返回的是 schema 列表
    
    指定者:
    
    getRootDatabases 在接口中 IClient<T>
    
    参数:
    
    source - 数据源信息
    
    queryDTO - 查询信息
    
    返回:
    
    db 列表
    
    另请参阅:
    
    该方法对于有 database 概念的数据源返回的是 database，否则返回 schema
  - getCreateTableSql
```
public String getCreateTableSql(ISourceDTO source,
                                SqlQueryDTO queryDTO)
```
    从接口复制的说明: IClient
    
    获取建表语句
    
    指定者:
    
    getCreateTableSql 在接口中 IClient<T>
    
    返回:
  - getPartitionColumn
```
public List<ColumnMetaDTO> getPartitionColumn(ISourceDTO source,
                                              SqlQueryDTO queryDTO)
```
    从接口复制的说明: IClient
    
    获取分区字段
    
    指定者:
    
    getPartitionColumn 在接口中 IClient<T>
    
    返回:
  - getTable
```
public Table getTable(ISourceDTO source,
                      SqlQueryDTO queryDTO)
```
    从接口复制的说明: IClient
    
    获取表信息
    
    指定者:
    
    getTable 在接口中 IClient<T>
    
    返回:
  - getCurrentDatabase
```
public String getCurrentDatabase(ISourceDTO source)
```
    从接口复制的说明: IClient
    
    获取当前使用的数据库
    
    指定者:
    
    getCurrentDatabase 在接口中 IClient<T>
    
    参数:
    
    source - 数据源信息
    
    返回:
    
    当前使用的数据库
  - createDatabase
```
public Boolean createDatabase(ISourceDTO source,
                              String dbName,
                              String comment)
```
    从接口复制的说明: IClient
    
    创建数据库
    
    指定者:
    
    createDatabase 在接口中 IClient<T>
    
    参数:
    
    source - 数据源信息
    
    dbName - 需要创建的数据库
    
    comment - 库注释信息
    
    返回:
    
    创建结果
  - isDatabaseExists
```
public Boolean isDatabaseExists(ISourceDTO source,
                                String dbName)
```
    从接口复制的说明: IClient
    
    判断数据库是否存在
    
    指定者:
    
    isDatabaseExists 在接口中 IClient<T>
    
    参数:
    
    source - 数据源信息
    
    dbName - 数据库名称
    
    返回:
    
    判断结果
  - isTableExistsInDatabase
```
public Boolean isTableExistsInDatabase(ISourceDTO source,
                                       String tableName,
                                       String dbName)
```
    从接口复制的说明: IClient
    
    判断该数据库中是否存在该表
    
    指定者:
    
    isTableExistsInDatabase 在接口中 IClient<T>
    
    参数:
    
    source - 数据源信息
    
    tableName - 表名
    
    dbName - 库名
    
    返回:
    
    判断结果
  - getCatalogs
```
public List<String> getCatalogs(ISourceDTO source)
```
    从接口复制的说明: IClient
    
    获取数据源/数据库目录列表，目前presto使用，后续pgSql等可以实现该方法用于获取所有库
    
    指定者:
    
    getCatalogs 在接口中 IClient<T>
    
    返回:
    
    数据源目录
  - getVersion
```
public String getVersion(ISourceDTO source)
```
    从接口复制的说明: IClient
    
    获取当前数据源的版本
    
    指定者:
    
    getVersion 在接口中 IClient<T>
    
    参数:
    
    source - 数据源信息
    
    返回:
    
    数据源版本
  - listFileNames
```
public List<String> listFileNames(ISourceDTO sourceDTO,
                                  String path,
                                  Boolean includeDir,
                                  Boolean recursive,
                                  Integer maxNum,
                                  String regexStr)
```
    从接口复制的说明: IClient
    
    列出指定路径下的文件
    
    指定者:
    
    listFileNames 在接口中 IClient<T>
    
    参数:
    
    sourceDTO - 数据源信息
    
    path - 路径
    
    includeDir - 是否包含文件夹
    
    recursive - 是否递归
    
    maxNum - 最大返回条数
    
    regexStr - 正则匹配
    
    返回:
    
    文件集合

类 DataSourceClientProxy<T>

构造器概要

方法概要

从类继承的方法 java.lang.Object

构造器详细资料

DataSourceClientProxy

方法详细资料

getCon

getCon

testCon

executeQuery

executeSqlWithoutResultSet

getTableList

getTableListBySchema

getColumnClassInfo

getColumnMetaData

getColumnMetaDataWithSql

getFlinkColumnMetaData

getTableMetaComment

getPreview

getDownloader

getDownloader

getAllDatabases

getRootDatabases

getCreateTableSql

getPartitionColumn

getTable

getCurrentDatabase

createDatabase

isDatabaseExists

isTableExistsInDatabase

getCatalogs

getVersion

listFileNames