[ci skip] publishing updated documentation...

transferwise · Jul 25, 2023 · 04ad475 · 04ad475
1 parent 4b88d0a
commit 04ad475
Show file tree

Hide file tree

Showing 5 changed files with 56 additions and 23 deletions.
diff --git a/_sources/connectors/taps/mysql.rst.txt b/_sources/connectors/taps/mysql.rst.txt
@@ -187,12 +187,20 @@ Example YAML for ``tap-mysql``:
         - table_name: "table_three"
           replication_method: "LOG_BASED"
           sync_start_from:                   # Optional, applies for then first sync and fast sync
-            column: "column_name"            # column name to be picked for partial sync with incremental or timestamp value
-            value: "start_value"             # The first sync always starts from column >= value
+            column: "column_name"            # Column name to be picked for partial sync with incremental or timestamp value
+            static_value: "start_value"      # A static value which the first sync always starts from column >= static_value
+            drop_target_table: true          # Optional, drops target table before syncing. default value is false
+
+        - table_name: "table_four"
+          replication_method: "LOG_BASED"
+          sync_start_from:                   # Optional, applies for then first sync and fast sync
+            column: "column_name"            # Column name to be picked for partial sync with incremental or timestamp value
+            dynamic_value: "A SELECT query   # It can be a valid mysql SELECT query which returns only one row with one column and first sync always starts from column >= dynamic_value
             drop_target_table: true          # Optional, drops target table before syncing. default value is false
 
     # You can add as many schemas as you need...
     # Uncomment this if you want replicate tables from multiple schemas
     #- source_schema: "another_schema_in_mysql" 
     #  target_schema: "another
+    # static and dynamic values can not be defined together for a table and only one of them can be used.
 
diff --git a/_sources/connectors/taps/postgres.rst.txt b/_sources/connectors/taps/postgres.rst.txt
@@ -200,14 +200,23 @@ Example YAML for ``tap-postgres``:
           - table_name: "table_two"
             replication_method: "LOG_BASED"     # Important! Log based must be enabled in MySQL
 
-           - table_name: "table_three"
-             replication_method: "LOG_BASED"
-             sync_start_from:                   # Optional, applies for then first sync and fast sync
-               column: "column_name"            # column name to be picked for partial sync with inremental or timestamp value
-               value: "start_value"             # The first sync always starts from column >= value
-               drop_target_table: true          # Optional, drops target table before syncing. default value is false
+          - table_name: "table_three"
+            replication_method: "LOG_BASED"
+            sync_start_from:                   # Optional, applies for then first sync and fast sync
+              column: "column_name"            # column name to be picked for partial sync with inremental or timestamp value
+              static_value: "start_value"      # A static value which the first sync always starts from column >= static_value
+              drop_target_table: true          # Optional, drops target table before syncing. default value is false
+
+          - table_name: "table_four"
+            replication_method: "LOG_BASED"
+            sync_start_from:                   # Optional, applies for then first sync and fast sync
+              column: "column_name"            # Column name to be picked for partial sync with incremental or timestamp value
+              dynamic_value: "A SELECT query   # It can be a valid PG SELECT query which returns only one row with one column and first sync always starts from column >= dynamic_value
+              drop_target_table: true          # Optional, drops target table before syncing. default value is false
 
       # You can add as many schemas as you need...
       # Uncomment this if you want replicate tables from multiple schemas
       #- source_schema: "another_schema_in_postgres" 
       #  target_schema: "another
+      # static and dynamic values can not be defined together for a table and only one of them can be used.
+
diff --git a/connectors/taps/mysql.html b/connectors/taps/mysql.html
@@ -306,14 +306,22 @@ <h2>Configuring what to replicate<a class="headerlink" href="#configuring-what-t
 <span class="w">      </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">table_name</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;table_three&quot;</span>
 <span class="w">        </span><span class="nt">replication_method</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;LOG_BASED&quot;</span>
 <span class="w">        </span><span class="nt">sync_start_from</span><span class="p">:</span><span class="w">                   </span><span class="c1"># Optional, applies for then first sync and fast sync</span>
-<span class="w">          </span><span class="nt">column</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;column_name&quot;</span><span class="w">            </span><span class="c1"># column name to be picked for partial sync with incremental or timestamp value</span>
-<span class="w">          </span><span class="nt">value</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;start_value&quot;</span><span class="w">             </span><span class="c1"># The first sync always starts from column &gt;= value</span>
+<span class="w">          </span><span class="nt">column</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;column_name&quot;</span><span class="w">            </span><span class="c1"># Column name to be picked for partial sync with incremental or timestamp value</span>
+<span class="w">          </span><span class="nt">static_value</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;start_value&quot;</span><span class="w">      </span><span class="c1"># A static value which the first sync always starts from column &gt;= static_value</span>
 <span class="w">          </span><span class="nt">drop_target_table</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">true</span><span class="w">          </span><span class="c1"># Optional, drops target table before syncing. default value is false</span>
 
-<span class="w">  </span><span class="c1"># You can add as many schemas as you need...</span>
-<span class="w">  </span><span class="c1"># Uncomment this if you want replicate tables from multiple schemas</span>
-<span class="w">  </span><span class="c1">#- source_schema: &quot;another_schema_in_mysql&quot;</span>
+<span class="w">      </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">table_name</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;table_four&quot;</span>
+<span class="w">        </span><span class="nt">replication_method</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;LOG_BASED&quot;</span>
+<span class="w">        </span><span class="nt">sync_start_from</span><span class="p">:</span><span class="w">                   </span><span class="c1"># Optional, applies for then first sync and fast sync</span>
+<span class="w">          </span><span class="nt">column</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;column_name&quot;</span><span class="w">            </span><span class="c1"># Column name to be picked for partial sync with incremental or timestamp value</span>
+<span class="w">          </span><span class="nt">dynamic_value</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;A</span><span class="nv"> </span><span class="s">SELECT</span><span class="nv"> </span><span class="s">query</span><span class="nv">   </span><span class="s">#</span><span class="nv"> </span><span class="s">It</span><span class="nv"> </span><span class="s">can</span><span class="nv"> </span><span class="s">be</span><span class="nv"> </span><span class="s">a</span><span class="nv"> </span><span class="s">valid</span><span class="nv"> </span><span class="s">mysql</span><span class="nv"> </span><span class="s">SELECT</span><span class="nv"> </span><span class="s">query</span><span class="nv"> </span><span class="s">which</span><span class="nv"> </span><span class="s">returns</span><span class="nv"> </span><span class="s">only</span><span class="nv"> </span><span class="s">one</span><span class="nv"> </span><span class="s">row</span><span class="nv"> </span><span class="s">with</span><span class="nv"> </span><span class="s">one</span><span class="nv"> </span><span class="s">column</span><span class="nv"> </span><span class="s">and</span><span class="nv"> </span><span class="s">first</span><span class="nv"> </span><span class="s">sync</span><span class="nv"> </span><span class="s">always</span><span class="nv"> </span><span class="s">starts</span><span class="nv"> </span><span class="s">from</span><span class="nv"> </span><span class="s">column</span><span class="nv"> </span><span class="s">&gt;=</span><span class="nv"> </span><span class="s">dynamic_value</span>
+<span class="w">          </span><span class="s">drop_target_table:</span><span class="nv"> </span><span class="s">true</span><span class="nv">          </span><span class="s">#</span><span class="nv"> </span><span class="s">Optional,</span><span class="nv"> </span><span class="s">drops</span><span class="nv"> </span><span class="s">target</span><span class="nv"> </span><span class="s">table</span><span class="nv"> </span><span class="s">before</span><span class="nv"> </span><span class="s">syncing.</span><span class="nv"> </span><span class="s">default</span><span class="nv"> </span><span class="s">value</span><span class="nv"> </span><span class="s">is</span><span class="nv"> </span><span class="s">false</span>
+
+<span class="w">  </span><span class="s">#</span><span class="nv"> </span><span class="s">You</span><span class="nv"> </span><span class="s">can</span><span class="nv"> </span><span class="s">add</span><span class="nv"> </span><span class="s">as</span><span class="nv"> </span><span class="s">many</span><span class="nv"> </span><span class="s">schemas</span><span class="nv"> </span><span class="s">as</span><span class="nv"> </span><span class="s">you</span><span class="nv"> </span><span class="s">need...</span>
+<span class="w">  </span><span class="s">#</span><span class="nv"> </span><span class="s">Uncomment</span><span class="nv"> </span><span class="s">this</span><span class="nv"> </span><span class="s">if</span><span class="nv"> </span><span class="s">you</span><span class="nv"> </span><span class="s">want</span><span class="nv"> </span><span class="s">replicate</span><span class="nv"> </span><span class="s">tables</span><span class="nv"> </span><span class="s">from</span><span class="nv"> </span><span class="s">multiple</span><span class="nv"> </span><span class="s">schemas</span>
+<span class="w">  </span><span class="s">#-</span><span class="nv"> </span><span class="s">source_schema:</span><span class="nv"> </span><span class="s">&quot;</span><span class="l l-Scalar l-Scalar-Plain">another_schema_in_mysql&quot;</span>
 <span class="w">  </span><span class="c1">#  target_schema: &quot;another</span>
+<span class="w">  </span><span class="c1"># static and dynamic values can not be defined together for a table and only one of them can be used.</span>
 </pre></div>
 </div>
 </section>

diff --git a/connectors/taps/postgres.html b/connectors/taps/postgres.html
@@ -311,17 +311,25 @@ <h2>Configuring what to replicate<a class="headerlink" href="#configuring-what-t
 <span class="w">      </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">table_name</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;table_two&quot;</span>
 <span class="w">        </span><span class="nt">replication_method</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;LOG_BASED&quot;</span><span class="w">     </span><span class="c1"># Important! Log based must be enabled in MySQL</span>
 
-<span class="w">      </span><span class="w w-Error"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">table_name</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;table_three&quot;</span>
-<span class="w">         </span><span class="nt">replication_method</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;LOG_BASED&quot;</span>
-<span class="w">         </span><span class="nt">sync_start_from</span><span class="p">:</span><span class="w">                   </span><span class="c1"># Optional, applies for then first sync and fast sync</span>
-<span class="w">           </span><span class="nt">column</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;column_name&quot;</span><span class="w">            </span><span class="c1"># column name to be picked for partial sync with inremental or timestamp value</span>
-<span class="w">           </span><span class="nt">value</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;start_value&quot;</span><span class="w">             </span><span class="c1"># The first sync always starts from column &gt;= value</span>
-<span class="w">           </span><span class="nt">drop_target_table</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">true</span><span class="w">          </span><span class="c1"># Optional, drops target table before syncing. default value is false</span>
+<span class="w">      </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">table_name</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;table_three&quot;</span>
+<span class="w">        </span><span class="nt">replication_method</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;LOG_BASED&quot;</span>
+<span class="w">        </span><span class="nt">sync_start_from</span><span class="p">:</span><span class="w">                   </span><span class="c1"># Optional, applies for then first sync and fast sync</span>
+<span class="w">          </span><span class="nt">column</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;column_name&quot;</span><span class="w">            </span><span class="c1"># column name to be picked for partial sync with inremental or timestamp value</span>
+<span class="w">          </span><span class="nt">static_value</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;start_value&quot;</span><span class="w">      </span><span class="c1"># A static value which the first sync always starts from column &gt;= static_value</span>
+<span class="w">          </span><span class="nt">drop_target_table</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">true</span><span class="w">          </span><span class="c1"># Optional, drops target table before syncing. default value is false</span>
 
-<span class="w">  </span><span class="c1"># You can add as many schemas as you need...</span>
-<span class="w">  </span><span class="c1"># Uncomment this if you want replicate tables from multiple schemas</span>
-<span class="w">  </span><span class="c1">#- source_schema: &quot;another_schema_in_postgres&quot;</span>
+<span class="w">      </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">table_name</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;table_four&quot;</span>
+<span class="w">        </span><span class="nt">replication_method</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;LOG_BASED&quot;</span>
+<span class="w">        </span><span class="nt">sync_start_from</span><span class="p">:</span><span class="w">                   </span><span class="c1"># Optional, applies for then first sync and fast sync</span>
+<span class="w">          </span><span class="nt">column</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;column_name&quot;</span><span class="w">            </span><span class="c1"># Column name to be picked for partial sync with incremental or timestamp value</span>
+<span class="w">          </span><span class="nt">dynamic_value</span><span class="p">:</span><span class="w"> </span><span class="s">&quot;A</span><span class="nv"> </span><span class="s">SELECT</span><span class="nv"> </span><span class="s">query</span><span class="nv">   </span><span class="s">#</span><span class="nv"> </span><span class="s">It</span><span class="nv"> </span><span class="s">can</span><span class="nv"> </span><span class="s">be</span><span class="nv"> </span><span class="s">a</span><span class="nv"> </span><span class="s">valid</span><span class="nv"> </span><span class="s">PG</span><span class="nv"> </span><span class="s">SELECT</span><span class="nv"> </span><span class="s">query</span><span class="nv"> </span><span class="s">which</span><span class="nv"> </span><span class="s">returns</span><span class="nv"> </span><span class="s">only</span><span class="nv"> </span><span class="s">one</span><span class="nv"> </span><span class="s">row</span><span class="nv"> </span><span class="s">with</span><span class="nv"> </span><span class="s">one</span><span class="nv"> </span><span class="s">column</span><span class="nv"> </span><span class="s">and</span><span class="nv"> </span><span class="s">first</span><span class="nv"> </span><span class="s">sync</span><span class="nv"> </span><span class="s">always</span><span class="nv"> </span><span class="s">starts</span><span class="nv"> </span><span class="s">from</span><span class="nv"> </span><span class="s">column</span><span class="nv"> </span><span class="s">&gt;=</span><span class="nv"> </span><span class="s">dynamic_value</span>
+<span class="w">          </span><span class="s">drop_target_table:</span><span class="nv"> </span><span class="s">true</span><span class="nv">          </span><span class="s">#</span><span class="nv"> </span><span class="s">Optional,</span><span class="nv"> </span><span class="s">drops</span><span class="nv"> </span><span class="s">target</span><span class="nv"> </span><span class="s">table</span><span class="nv"> </span><span class="s">before</span><span class="nv"> </span><span class="s">syncing.</span><span class="nv"> </span><span class="s">default</span><span class="nv"> </span><span class="s">value</span><span class="nv"> </span><span class="s">is</span><span class="nv"> </span><span class="s">false</span>
+
+<span class="w">  </span><span class="s">#</span><span class="nv"> </span><span class="s">You</span><span class="nv"> </span><span class="s">can</span><span class="nv"> </span><span class="s">add</span><span class="nv"> </span><span class="s">as</span><span class="nv"> </span><span class="s">many</span><span class="nv"> </span><span class="s">schemas</span><span class="nv"> </span><span class="s">as</span><span class="nv"> </span><span class="s">you</span><span class="nv"> </span><span class="s">need...</span>
+<span class="w">  </span><span class="s">#</span><span class="nv"> </span><span class="s">Uncomment</span><span class="nv"> </span><span class="s">this</span><span class="nv"> </span><span class="s">if</span><span class="nv"> </span><span class="s">you</span><span class="nv"> </span><span class="s">want</span><span class="nv"> </span><span class="s">replicate</span><span class="nv"> </span><span class="s">tables</span><span class="nv"> </span><span class="s">from</span><span class="nv"> </span><span class="s">multiple</span><span class="nv"> </span><span class="s">schemas</span>
+<span class="w">  </span><span class="s">#-</span><span class="nv"> </span><span class="s">source_schema:</span><span class="nv"> </span><span class="s">&quot;</span><span class="l l-Scalar l-Scalar-Plain">another_schema_in_postgres&quot;</span>
 <span class="w">  </span><span class="c1">#  target_schema: &quot;another</span>
+<span class="w">  </span><span class="c1"># static and dynamic values can not be defined together for a table and only one of them can be used.</span>
 </pre></div>
 </div>
 </section>

diff --git a/searchindex.js b/searchindex.js