Skip to content

Commit

Permalink
[DOP-15764] - update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
maxim-lixakov committed May 22, 2024
1 parent 5072d1d commit c18a04b
Show file tree
Hide file tree
Showing 15 changed files with 15 additions and 15 deletions.
2 changes: 1 addition & 1 deletion docs/connection/db_connection/clickhouse/read.rst
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ Supported DBReader features
* * ✅︎ :ref:`incremental-batch-strategy`
* ❌ ``hint`` (is not supported by Clickhouse)
* ❌ ``df_schema``
* ✅︎ ``options`` (see :obj:`ClickhouseReadOptions <onetl.connection.db_connection.clickhouse.options.ClickhouseReadOptions>`)
* ✅︎ ``options`` (see :obj:`Clickhouse.ReadOptions <onetl.connection.db_connection.clickhouse.options.ClickhouseReadOptions>`)

Examples
--------
Expand Down
2 changes: 1 addition & 1 deletion docs/connection/db_connection/clickhouse/write.rst
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ Examples
Options
-------

Method above accepts :obj:`ClickhouseWriteOptions <onetl.connection.db_connection.clickhouse.options.ClickhouseWriteOptions>`
Method above accepts :obj:`Clickhouse.WriteOptions <onetl.connection.db_connection.clickhouse.options.ClickhouseWriteOptions>`

.. currentmodule:: onetl.connection.db_connection.clickhouse.options

Expand Down
2 changes: 1 addition & 1 deletion docs/connection/db_connection/greenplum/read.rst
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ Supported DBReader features
* * ✅︎ :ref:`incremental-batch-strategy`
* ❌ ``hint`` (is not supported by Greenplum)
* ❌ ``df_schema``
* ✅︎ ``options`` (see :obj:`GreenplumReadOptions <onetl.connection.db_connection.greenplum.options.GreenplumReadOptions>`)
* ✅︎ ``options`` (see :obj:`Greenplum.ReadOptions <onetl.connection.db_connection.greenplum.options.GreenplumReadOptions>`)

.. warning::

Expand Down
2 changes: 1 addition & 1 deletion docs/connection/db_connection/kafka/read.rst
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Supported DBReader features
* * ❌ :ref:`incremental-batch-strategy`
* ❌ ``hint`` (is not supported by Kafka)
* ❌ ``df_schema`` (see note below)
* ✅︎ ``options`` (see :obj:`KafkaReadOptions <onetl.connection.db_connection.kafka.options.KafkaReadOptions>`)
* ✅︎ ``options`` (see :obj:`Kafka.ReadOptions <onetl.connection.db_connection.kafka.options.KafkaReadOptions>`)

Dataframe schema
----------------
Expand Down
2 changes: 1 addition & 1 deletion docs/connection/db_connection/mongodb/read.rst
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ Supported DBReader features
* * Note that ``expression`` field of HWM can only be a field name, not a custom expression
* ✅︎ ``hint`` (see `official documentation <https://www.mongodb.com/docs/v5.0/reference/operator/meta/hint/>`_)
* ✅︎ ``df_schema`` (mandatory)
* ✅︎ ``options`` (see :obj:`MongoDBReadOptions <onetl.connection.db_connection.mongodb.options.MongoDBReadOptions>`)
* ✅︎ ``options`` (see :obj:`MongoDB.ReadOptions <onetl.connection.db_connection.mongodb.options.MongoDBReadOptions>`)

Examples
--------
Expand Down
2 changes: 1 addition & 1 deletion docs/connection/db_connection/mongodb/write.rst
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ Examples
Write options
-------------

Method above accepts :obj:`JDBCWriteOptions <onetl.connection.db_connection.mongodb.options.MongoDBWriteOptions>`
Method above accepts :obj:`MongoDB.WriteOptions <onetl.connection.db_connection.mongodb.options.MongoDBWriteOptions>`

.. currentmodule:: onetl.connection.db_connection.mongodb.options

Expand Down
2 changes: 1 addition & 1 deletion docs/connection/db_connection/mssql/read.rst
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ Supported DBReader features
* * ✅︎ :ref:`incremental-batch-strategy`
* ❌ ``hint`` (MSSQL does support hints, but DBReader not, at least for now)
* ❌ ``df_schema``
* ✅︎ ``options`` (see :obj:`MSSQLReadOptions <onetl.connection.db_connection.mssql.options.MSSQLReadOptions>`)
* ✅︎ ``options`` (see :obj:`MSSQL.ReadOptions <onetl.connection.db_connection.mssql.options.MSSQLReadOptions>`)

Examples
--------
Expand Down
2 changes: 1 addition & 1 deletion docs/connection/db_connection/mssql/write.rst
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ Examples
Options
-------

Method above accepts :obj:`MSSQLWriteOptions <onetl.connection.db_connection.mssql.options.MSSQLWriteOptions>`
Method above accepts :obj:`MSSQL.WriteOptions <onetl.connection.db_connection.mssql.options.MSSQLWriteOptions>`

.. currentmodule:: onetl.connection.db_connection.mssql.options

Expand Down
2 changes: 1 addition & 1 deletion docs/connection/db_connection/mysql/read.rst
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ Supported DBReader features
* * ✅︎ :ref:`incremental-batch-strategy`
* ✅︎ ``hint`` (see `official documentation <https://dev.mysql.com/doc/refman/en/optimizer-hints.html>`_)
* ❌ ``df_schema``
* ✅︎ ``options`` (see :obj:`MySQLReadOptions <onetl.connection.db_connection.mysql.options.MySQLReadOptions>`)
* ✅︎ ``options`` (see :obj:`MySQL.ReadOptions <onetl.connection.db_connection.mysql.options.MySQLReadOptions>`)

Examples
--------
Expand Down
2 changes: 1 addition & 1 deletion docs/connection/db_connection/mysql/write.rst
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ Examples
Options
-------

Method above accepts :obj:`MySQLWriteOptions <onetl.connection.db_connection.mysql.options.MySQLWriteOptions>`
Method above accepts :obj:`MySQL.WriteOptions <onetl.connection.db_connection.mysql.options.MySQLWriteOptions>`

.. currentmodule:: onetl.connection.db_connection.mysql.options

Expand Down
2 changes: 1 addition & 1 deletion docs/connection/db_connection/oracle/read.rst
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ Supported DBReader features
* * ✅︎ :ref:`incremental-batch-strategy`
* ✅︎ ``hint`` (see `official documentation <https://docs.oracle.com/cd/B10500_01/server.920/a96533/hintsref.htm>`_)
* ❌ ``df_schema``
* ✅︎ ``options`` (see :obj:`OracleReadOptions <onetl.connection.db_connection.oracle.options.OracleReadOptions>`)
* ✅︎ ``options`` (see :obj:`Oracle.ReadOptions <onetl.connection.db_connection.oracle.options.OracleReadOptions>`)

Examples
--------
Expand Down
2 changes: 1 addition & 1 deletion docs/connection/db_connection/postgres/read.rst
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ Supported DBReader features
* * ✅︎ :ref:`incremental-batch-strategy`
* ❌ ``hint`` (is not supported by Postgres)
* ❌ ``df_schema``
* ✅︎ ``options`` (see :obj:`PostgresReadOptions <onetl.connection.db_connection.postgres.options.PostgresReadOptions>`)
* ✅︎ ``options`` (see :obj:`Postgres.ReadOptions <onetl.connection.db_connection.postgres.options.PostgresReadOptions>`)

Examples
--------
Expand Down
2 changes: 1 addition & 1 deletion docs/connection/db_connection/postgres/write.rst
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ Examples
Options
-------

Method above accepts :obj:`PostgresWriteOptions <onetl.connection.db_connection.postgres.options.PostgresWriteOptions>`
Method above accepts :obj:`Postgres.WriteOptions <onetl.connection.db_connection.postgres.options.PostgresWriteOptions>`

.. currentmodule:: onetl.connection.db_connection.postgres.options

Expand Down
2 changes: 1 addition & 1 deletion docs/connection/db_connection/teradata/read.rst
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Supported DBReader features
* * ✅︎ :ref:`incremental-batch-strategy`
* ❌ ``hint`` (is not supported by Teradata)
* ❌ ``df_schema``
* ✅︎ ``options`` (see :obj:`TeradataReadOptions <onetl.connection.db_connection.teradata.options.TeradataReadOptions>`)
* ✅︎ ``options`` (see :obj:`Teradata.ReadOptions <onetl.connection.db_connection.teradata.options.TeradataReadOptions>`)

Examples
--------
Expand Down
2 changes: 1 addition & 1 deletion docs/connection/db_connection/teradata/write.rst
Original file line number Diff line number Diff line change
Expand Up @@ -110,7 +110,7 @@ Choosing one of the modes can alter connector behavior. For example:
Options
-------

Method above accepts :obj:`TeradataWriteOptions <onetl.connection.db_connection.teradata.options.TeradataWriteOptions>`
Method above accepts :obj:`Teradata.WriteOptions <onetl.connection.db_connection.teradata.options.TeradataWriteOptions>`

.. currentmodule:: onetl.connection.db_connection.teradata.options

Expand Down

0 comments on commit c18a04b

Please sign in to comment.