# Oracle Reader

OracleReader 插件用于从Oracle读取数据

## 配置样例

配置一个从Oracle数据库同步抽取数据到本地的作业:

=== "job/oracle2stream.json"

`json --8<-- "jobs/oraclereader.json" `

## 参数说明

配置项    | 是否必须 | 默认值 | 描述                                                                                                     |
:-------- | :------: | ------ | -------------------------------------------------------------------------------------------------------- |
jdbcUrl   |    是    | 无     | 对端数据库的JDBC连接信息，jdbcUrl按照RDBMS官方规范，并可以填写连接[附件控制信息][1]                      |
username  |    是    | 无     | 数据源的用户名                                                                                           |
password  |    否    | 无     | 数据源指定用户名的密码                                                                                   |
table     |    是    | 无     | 所选取的需要同步的表名,使用JSON数据格式，当配置为多张表时，用户自己需保证多张表是同一表结构              |
column    |    是    | 无     | 所配置的表中需要同步的列名集合，详细描述见 [rdbmsreader](../rdbmsreader)                                 |
splitPk   |    否    | 无     | 使用splitPk代表的字段进行数据分片，Addax因此会启动并发任务进行数据同步，这样可以大大提供数据同步的效能   |
autoPk    |    否    | false  | 是否自动猜测分片主键，3.2.6 版本引入                                                                   |
where     |    否    | 无     | 针对表的筛选条件                                                                                         |
querySql  |    否    | 无     | 使用自定义的SQL而不是指定表来获取数据，当配置了这一项之后，Addax系统就会忽略 table，`column`这些配置项 |
fetchSize |    否    | 1024   | 定义了插件和数据库服务器端每次批量数据获取条数，调高该值可能导致 Addax 出现OOM                           |
session   |    否    | 无     | 针对本地连接,修改会话配置,详见下文                                                                       |

[1]: http://www.oracle.com/technetwork/database/enterprise-edition/documentation/index.html

### session

控制写入数据的时间格式，时区等的配置，如果表中有时间字段，配置该值以明确告知写入 oracle 的时间格式。通常配置的参数为：NLS_DATE_FORMAT,`NLS_TIME_FORMAT`。其配置的值为 json 格式，例如：

```json {

"session": [
"alter session set NLS_DATE_FORMAT='yyyy-mm-dd hh24:mi:ss'", "alter session set NLS_TIMESTAMP_FORMAT='yyyy-mm-dd hh24:mi:ss'", "alter session set NLS_TIMESTAMP_TZ_FORMAT='yyyy-mm-dd hh24:mi:ss'", "alter session set TIME_ZONE='Asia/Chongqing'"

]

}

注意 "`是 `" 的转义字符串

## 对 GEOMETRY 类型的支持

从 Addax 4.0.13 开始，实验性的支持 Oracle GEOMETRY 类型，该插件会把该类型的数据转为 JSON 数组字符串。

假定你有这样的的表和数据

`sql --8<-- "assets/sql/oracle_geom.sql `

读取表该的数据的最后输出结果类似如下：

` --8<-- "assets/output/oracle_geom_reader.txt `

注意：该数据类型目前还处于实验支持阶段，作者对次数据类型的理解并不深刻，也未经过全面的测试，请勿直接在生产环境使用。

## 类型转换

Addax 内部类型 | Oracle 数据类型                                                                                    |
-------------- |------------------------------------------------------------------------------------------------|
Long           | NUMBER, INTEGER, INT, SMALLINT                                                                 |
Double         | NUMERIC, DECIMAL, FLOAT, DOUBLE PRECISION, REAL                                                |
String         | LONG ,CHAR, NCHAR, VARCHAR, VARCHAR2, NVARCHAR2, CLOB, NCLOB, CHARACTER, STRUCT                |
String         | CHARACTER VARYING, CHAR VARYING, NATIONAL CHARACTER, NATIONAL CHAR, NATIONAL CHARACTER VARYING |
String         | NATIONAL CHAR VARYING, NCHAR VARYING                                                           |
Date           | TIMESTAMP, DATE                                                                                |
Boolean        | bit, bool                                                                                      |
Bytes          | BLOB, BFILE, RAW, LONG RAW                                                                     |

请注意: 除上述罗列字段类型外，其他类型均不支持

### 数据库编码问题

OracleReader底层使用JDBC进行数据抽取，JDBC天然适配各类编码，并在底层进行了编码转换。因此OracleReader不需用户指定编码，可以自动获取编码并转码。

对于Oracle底层写入编码和其设定的编码不一致的混乱情况，OracleReader对此无法识别，对此也无法提供解决方案，对于这类情况，导出有可能为乱码。