From f1499f593a1d44d68cf2412bf70a05c48350bfc8 Mon Sep 17 00:00:00 2001
From: molsionmo <52347588+molsionmo@users.noreply.github.com>
Date: Wed, 9 Nov 2022 21:23:34 +0800
Subject: [PATCH] [docs][oracle] Add new introduced config options from
 incremental snapshot framework  (#1718)

Co-authored-by: Leonard Xu <xbjtdcq@gmail.com>
---
 docs/content/connectors/oracle-cdc.md | 48 +++++++++++++++++++++++++--
 1 file changed, 46 insertions(+), 2 deletions(-)

diff --git a/docs/content/connectors/oracle-cdc.md b/docs/content/connectors/oracle-cdc.md
index 7de47344b..cfe0e4323 100644
--- a/docs/content/connectors/oracle-cdc.md
+++ b/docs/content/connectors/oracle-cdc.md
@@ -169,6 +169,7 @@ Overall, the steps for configuring CDB database is quite similar to non-CDB data
      GRANT SELECT ANY TRANSACTION TO flinkuser CONTAINER=ALL;
      GRANT LOGMINING TO flinkuser CONTAINER=ALL;
      GRANT CREATE TABLE TO flinkuser CONTAINER=ALL;
+     -- need not to execute if set scan.incremental.snapshot.enabled=true(default)
      GRANT LOCK ANY TABLE TO flinkuser CONTAINER=ALL;
      GRANT CREATE SEQUENCE TO flinkuser CONTAINER=ALL;
 
@@ -303,6 +304,39 @@ Connector Options
            and "latest-offset". 
            Please see <a href="#startup-reading-position">Startup Reading Position</a> section for more detailed information.</td>
     </tr> 
+    <tr>
+          <td>scan.incremental.snapshot.enabled</td>
+          <td>optional</td>
+          <td style="word-wrap: break-word;">true</td>
+          <td>Boolean</td>
+          <td>Incremental snapshot is a new mechanism to read snapshot of a table. Compared to the old snapshot mechanism,
+              the incremental snapshot has many advantages, including:
+                (1) source can be parallel during snapshot reading, 
+                (2) source can perform checkpoints in the chunk granularity during snapshot reading, 
+                (3) source doesn't need to acquire ROW SHARE MODE lock before snapshot reading.
+          </td>
+    </tr>
+    <tr>
+          <td>scan.incremental.snapshot.chunk.size</td>
+          <td>optional</td>
+          <td style="word-wrap: break-word;">8096</td>
+          <td>Integer</td>
+          <td>The chunk size (number of rows) of table snapshot, captured tables are split into multiple chunks when read the snapshot of table.</td>
+    </tr>
+    <tr>
+          <td>scan.snapshot.fetch.size</td>
+          <td>optional</td>
+          <td style="word-wrap: break-word;">1024</td>
+          <td>Integer</td>
+          <td>The maximum fetch size for per poll when read table snapshot.</td>
+    </tr>
+    <tr>
+          <td>connect.max-retries</td>
+          <td>optional</td>
+          <td style="word-wrap: break-word;">3</td>
+          <td>Integer</td>
+          <td>The max retry times that the connector should retry to build MySQL database server connection.</td>
+    </tr>
     <tr>
       <td>chunk-meta.group.size</td>
       <td>optional</td>
@@ -335,6 +369,13 @@ Connector Options
               The table chunks would use evenly calculation optimization when the data distribution is even, and the query for splitting would happen when it is uneven. 
               The distribution factor could be calculated by (MAX(id) - MIN(id) + 1) / rowCount.</td>
     </tr>
+    <tr>
+          <td>connection.pool.size</td>
+          <td>optional</td>
+          <td style="word-wrap: break-word;">20</td>
+          <td>Integer</td>
+          <td>The connection pool size.</td>
+    </tr>
     <tr>
       <td>debezium.*</td>
       <td>optional</td>
@@ -418,7 +459,9 @@ CREATE TABLE products (
     'password' = 'flinkpw',
     'database-name' = 'XE',
     'schema-name' = 'inventory',
-    'table-name' = 'products'
+    'table-name' = 'products',
+    'debezium.log.mining.strategy' = 'online_catalog',
+    'debezium.log.mining.continuous.mine' = 'true'
 );
 ```
 
@@ -569,7 +612,8 @@ Data Type Mapping
         VARCHAR2(n)<br>
         CLOB<br>
         NCLOB<br>
-        XMLType
+        XMLType<br>
+        SYS.XMLTYPE
       </td>
       <td>STRING</td>
     </tr>