[DOP-15764] - update docs

MobileTeleSystems · May 22, 2024 · 5072d1d · 5072d1d
1 parent 7610b0a
commit 5072d1d
Show file tree

Hide file tree

Showing 28 changed files with 88 additions and 66 deletions.
diff --git a/docs/connection/db_connection/clickhouse/execute.rst b/docs/connection/db_connection/clickhouse/execute.rst
@@ -20,7 +20,7 @@ Use ``Clickhouse.fetch``
 Use this method to perform some ``SELECT`` query which returns **small number or rows**, like reading
 Clickhouse config, or reading data from some reference table. Method returns Spark DataFrame.
 
-Method accepts :obj:`ClickhouseFetchOptions <onetl.connection.db_connection.clickhouse.options.ClickhouseFetchOptions>`.
+Method accepts :obj:`Clickhouse.FetchOptions <onetl.connection.db_connection.clickhouse.options.ClickhouseFetchOptions>`.
 
 Connection opened using this method should be then closed with ``connection.close()`` or ``with connection:``.
 
@@ -60,7 +60,7 @@ Use ``Clickhouse.execute``
 
 Use this method to execute DDL and DML operations. Each method call runs operation in a separated transaction, and then commits it.
 
-Method accepts :obj:`ClickhouseExecuteOptions <onetl.connection.db_connection.clickhouse.options.ClickhouseExecuteOptions>`.
+Method accepts :obj:`Clickhouse.ExecuteOptions <onetl.connection.db_connection.clickhouse.options.ClickhouseExecuteOptions>`.
 
 Connection opened using this method should be then closed with ``connection.close()`` or ``with connection:``.
 
@@ -114,10 +114,14 @@ Options
 .. currentmodule:: onetl.connection.db_connection.clickhouse.options
 
 .. autopydantic_model:: ClickhouseFetchOptions
-    :inherited-members: JDBCFetchOptions
+    :inherited-members: GenericOptions
     :member-order: bysource
+    :model-show-field-summary: false
+    :field-show-constraints: false
 
 
 .. autopydantic_model:: ClickhouseExecuteOptions
-    :inherited-members: JDBCExecuteOptions
+    :inherited-members: GenericOptions
     :member-order: bysource
+    :model-show-field-summary: false
+    :field-show-constraints: false
diff --git a/docs/connection/db_connection/clickhouse/read.rst b/docs/connection/db_connection/clickhouse/read.rst
@@ -88,5 +88,7 @@ Options
 .. currentmodule:: onetl.connection.db_connection.clickhouse.options
 
 .. autopydantic_model:: ClickhouseReadOptions
-    :inherited-members: JDBCReadOptions
+    :inherited-members: GenericOptions
     :member-order: bysource
+    :model-show-field-summary: false
+    :field-show-constraints: false
diff --git a/docs/connection/db_connection/clickhouse/sql.rst b/docs/connection/db_connection/clickhouse/sql.rst
@@ -73,7 +73,7 @@ Options
 .. currentmodule:: onetl.connection.db_connection.clickhouse.options
 
 .. autopydantic_model:: ClickhouseSQLOptions
-    :inherited-members: JDBCOptions
+    :inherited-members: GenericOptions
     :member-order: bysource
     :model-show-field-summary: false
     :field-show-constraints: false
diff --git a/docs/connection/db_connection/clickhouse/write.rst b/docs/connection/db_connection/clickhouse/write.rst
@@ -45,11 +45,12 @@ Examples
 Options
 -------
 
-Method above accepts  :obj:`JDBCWriteOptions <onetl.connection.db_connection.jdbc.options.JDBCWriteOptions>`
+Method above accepts  :obj:`ClickhouseWriteOptions <onetl.connection.db_connection.clickhouse.options.ClickhouseWriteOptions>`
 
-.. currentmodule:: onetl.connection.db_connection.jdbc_connection.options
+.. currentmodule:: onetl.connection.db_connection.clickhouse.options
 
-.. autopydantic_model:: JDBCWriteOptions
+.. autopydantic_model:: ClickhouseWriteOptions
+    :inherited-members: GenericOptions
     :member-order: bysource
     :model-show-field-summary: false
     :field-show-constraints: false
diff --git a/docs/connection/db_connection/greenplum/execute.rst b/docs/connection/db_connection/greenplum/execute.rst
@@ -20,7 +20,7 @@ Use ``Greenplum.fetch``
 Use this method to perform some ``SELECT`` query which returns **small number or rows**, like reading
 Greenplum config, or reading data from some reference table. Method returns Spark DataFrame.
 
-Method accepts :obj:`GreenplumFetchOptions <onetl.connection.db_connection.greenplum.options.GreenplumFetchOptions>`.
+Method accepts :obj:`Greenplum.FetchOptions <onetl.connection.db_connection.greenplum.options.GreenplumFetchOptions>`.
 
 Connection opened using this method should be then closed with ``connection.close()`` or ``with connection:``.
 
@@ -60,7 +60,7 @@ Use ``Greenplum.execute``
 
 Use this method to execute DDL and DML operations. Each method call runs operation in a separated transaction, and then commits it.
 
-Method accepts :obj:`GreenplumExecuteOptions <onetl.connection.db_connection.greenplum.options.GreenplumExecuteOptions>`.
+Method accepts :obj:`Greenplum.ExecuteOptions <onetl.connection.db_connection.greenplum.options.GreenplumExecuteOptions>`.
 
 Connection opened using this method should be then closed with ``connection.close()`` or ``with connection:``.
 
@@ -146,10 +146,14 @@ Options
 .. currentmodule:: onetl.connection.db_connection.greenplum.options
 
 .. autopydantic_model:: GreenplumFetchOptions
-    :inherited-members: JDBCFetchOptions
+    :inherited-members: GenericOptions
     :member-order: bysource
+    :model-show-field-summary: false
+    :field-show-constraints: false
 
 
 .. autopydantic_model:: GreenplumExecuteOptions
-    :inherited-members: JDBCExecuteOptions
+    :inherited-members: GenericOptions
     :member-order: bysource
+    :model-show-field-summary: false
+    :field-show-constraints: false
diff --git a/docs/connection/db_connection/mssql/execute.rst b/docs/connection/db_connection/mssql/execute.rst
@@ -20,7 +20,7 @@ Use ``MSSQL.fetch``
 Use this method to perform some ``SELECT`` query which returns **small number or rows**, like reading
 MSSQL config, or reading data from some reference table. Method returns Spark DataFrame.
 
-Method accepts :obj:`MSSQLFetchOptions <onetl.connection.db_connection.mssql.options.MSSQLFetchOptions>`.
+Method accepts :obj:`MSSQL.FetchOptions <onetl.connection.db_connection.mssql.options.MSSQLFetchOptions>`.
 
 Connection opened using this method should be then closed with ``connection.close()`` or ``with connection:``.
 
@@ -59,7 +59,7 @@ Use ``MSSQL.execute``
 
 Use this method to execute DDL and DML operations. Each method call runs operation in a separated transaction, and then commits it.
 
-Method accepts :obj:`MSSQLExecuteOptions <onetl.connection.db_connection.mssql.options.MSSQLExecuteOptions>`.
+Method accepts :obj:`MSSQL.ExecuteOptions <onetl.connection.db_connection.mssql.options.MSSQLExecuteOptions>`.
 
 Connection opened using this method should be then closed with ``connection.close()`` or ``with connection:``.
 
@@ -106,9 +106,13 @@ Options
 .. currentmodule:: onetl.connection.db_connection.mssql.options
 
 .. autopydantic_model:: MSSQLFetchOptions
-    :inherited-members: JDBCFetchOptions
+    :inherited-members: GenericOptions
     :member-order: bysource
+    :model-show-field-summary: false
+    :field-show-constraints: false
 
 .. autopydantic_model:: MSSQLExecuteOptions
-    :inherited-members: JDBCExecuteOptions
+    :inherited-members: GenericOptions
     :member-order: bysource
+    :model-show-field-summary: false
+    :field-show-constraints: false
diff --git a/docs/connection/db_connection/mssql/read.rst b/docs/connection/db_connection/mssql/read.rst
@@ -88,5 +88,7 @@ Options
 .. currentmodule:: onetl.connection.db_connection.mssql.options
 
 .. autopydantic_model:: MSSQLReadOptions
-    :inherited-members: JDBCReadOptions
+    :inherited-members: GenericOptions
     :member-order: bysource
+    :model-show-field-summary: false
+    :field-show-constraints: false
diff --git a/docs/connection/db_connection/mssql/sql.rst b/docs/connection/db_connection/mssql/sql.rst
@@ -73,7 +73,7 @@ Options
 .. currentmodule:: onetl.connection.db_connection.mssql.options
 
 .. autopydantic_model:: MSSQLSQLOptions
-    :inherited-members: JDBCOptions
+    :inherited-members: GenericOptions
     :member-order: bysource
     :model-show-field-summary: false
     :field-show-constraints: false
diff --git a/docs/connection/db_connection/mssql/write.rst b/docs/connection/db_connection/mssql/write.rst
@@ -40,11 +40,12 @@ Examples
 Options
 -------
 
-Method above accepts  :obj:`JDBCWriteOptions <onetl.connection.db_connection.jdbc.options.JDBCWriteOptions>`
+Method above accepts  :obj:`MSSQLWriteOptions <onetl.connection.db_connection.mssql.options.MSSQLWriteOptions>`
 
-.. currentmodule:: onetl.connection.db_connection.jdbc_connection.options
+.. currentmodule:: onetl.connection.db_connection.mssql.options
 
-.. autopydantic_model:: JDBCWriteOptions
+.. autopydantic_model:: MSSQLWriteOptions
+    :inherited-members: GenericOptions
     :member-order: bysource
     :model-show-field-summary: false
     :field-show-constraints: false
diff --git a/docs/connection/db_connection/mysql/execute.rst b/docs/connection/db_connection/mysql/execute.rst
@@ -20,7 +20,7 @@ Use ``MySQL.fetch``
 Use this method to perform some ``SELECT`` query which returns **small number or rows**, like reading
 MySQL config, or reading data from some reference table. Method returns Spark DataFrame.
 
-Method accepts :obj:`MySQLFetchOptions <onetl.connection.db_connection.mysql.options.MySQLFetchOptions>`.
+Method accepts :obj:`MySQL.FetchOptions <onetl.connection.db_connection.mysql.options.MySQLFetchOptions>`.
 
 Connection opened using this method should be then closed with ``connection.close()`` or ``with connection:``.
 
@@ -60,7 +60,7 @@ Use ``MySQL.execute``
 
 Use this method to execute DDL and DML operations. Each method call runs operation in a separated transaction, and then commits it.
 
-Method accepts :obj:`MySQLExecuteOptions <onetl.connection.db_connection.mysql.options.MySQLExecuteOptions>`.
+Method accepts :obj:`MySQL.ExecuteOptions <onetl.connection.db_connection.mysql.options.MySQLExecuteOptions>`.
 
 Connection opened using this method should be then closed with ``connection.close()`` or ``with connection:``.
 
@@ -107,10 +107,10 @@ Options
 .. currentmodule:: onetl.connection.db_connection.mysql.options
 
 .. autopydantic_model:: MySQLFetchOptions
-    :inherited-members: JDBCFetchOptions
+    :inherited-members: GenericOptions
     :member-order: bysource
 
 
 .. autopydantic_model:: MySQLExecuteOptions
-    :inherited-members: JDBCExecuteOptions
+    :inherited-members: GenericOptions
     :member-order: bysource
diff --git a/docs/connection/db_connection/mysql/read.rst b/docs/connection/db_connection/mysql/read.rst
@@ -90,5 +90,5 @@ Options
 .. currentmodule:: onetl.connection.db_connection.mysql.options
 
 .. autopydantic_model:: MySQLReadOptions
-    :inherited-members: JDBCReadOptions
+    :inherited-members: GenericOptions
     :member-order: bysource
diff --git a/docs/connection/db_connection/mysql/sql.rst b/docs/connection/db_connection/mysql/sql.rst
@@ -74,7 +74,7 @@ Options
 .. currentmodule:: onetl.connection.db_connection.mysql.options
 
 .. autopydantic_model:: MySQLSQLOptions
-    :inherited-members: JDBCOptions
+    :inherited-members: GenericOptions
     :member-order: bysource
     :model-show-field-summary: false
     :field-show-constraints: false
diff --git a/docs/connection/db_connection/mysql/write.rst b/docs/connection/db_connection/mysql/write.rst
@@ -44,11 +44,12 @@ Examples
 Options
 -------
 
-Method above accepts  :obj:`JDBCWriteOptions <onetl.connection.db_connection.jdbc.options.JDBCWriteOptions>`
+Method above accepts  :obj:`MySQLWriteOptions <onetl.connection.db_connection.mysql.options.MySQLWriteOptions>`
 
-.. currentmodule:: onetl.connection.db_connection.jdbc_connection.options
+.. currentmodule:: onetl.connection.db_connection.mysql.options
 
-.. autopydantic_model:: JDBCWriteOptions
+.. autopydantic_model:: MySQLWriteOptions
+    :inherited-members: GenericOptions
     :member-order: bysource
     :model-show-field-summary: false
     :field-show-constraints: false
diff --git a/docs/connection/db_connection/oracle/execute.rst b/docs/connection/db_connection/oracle/execute.rst
@@ -20,7 +20,7 @@ Use ``Oracle.fetch``
 Use this method to execute some ``SELECT`` query which returns **small number or rows**, like reading
 Oracle config, or reading data from some reference table. Method returns Spark DataFrame.
 
-Method accepts :obj:`OracleFetchOptions <onetl.connection.db_connection.oracle.options.OracleFetchOptions>`.
+Method accepts :obj:`Oracle.FetchOptions <onetl.connection.db_connection.oracle.options.OracleFetchOptions>`.
 
 Connection opened using this method should be then closed with ``connection.close()`` or ``with connection:``.
 
@@ -60,7 +60,7 @@ Use ``Oracle.execute``
 
 Use this method to execute DDL and DML operations. Each method call runs operation in a separated transaction, and then commits it.
 
-Method accepts :obj:`OracleExecuteOptions <onetl.connection.db_connection.oracle.options.OracleExecuteOptions>`.
+Method accepts :obj:`Oracle.ExecuteOptions <onetl.connection.db_connection.oracle.options.OracleExecuteOptions>`.
 
 Connection opened using this method should be then closed with ``connection.close()`` or ``with connection:``.
 
@@ -107,10 +107,10 @@ Options
 .. currentmodule:: onetl.connection.db_connection.oracle.options
 
 .. autopydantic_model:: OracleFetchOptions
-    :inherited-members: JDBCFetchOptions
+    :inherited-members: GenericOptions
     :member-order: bysource
 
 
 .. autopydantic_model:: OracleExecuteOptions
-    :inherited-members: JDBCExecuteOptions
+    :inherited-members: GenericOptions
     :member-order: bysource
diff --git a/docs/connection/db_connection/oracle/read.rst b/docs/connection/db_connection/oracle/read.rst
@@ -90,5 +90,5 @@ Options
 .. currentmodule:: onetl.connection.db_connection.oracle.options
 
 .. autopydantic_model:: OracleReadOptions
-    :inherited-members: JDBCReadOptions
+    :inherited-members: GenericOptions
     :member-order: bysource
diff --git a/docs/connection/db_connection/oracle/sql.rst b/docs/connection/db_connection/oracle/sql.rst
@@ -74,7 +74,7 @@ Options
 .. currentmodule:: onetl.connection.db_connection.oracle.options
 
 .. autopydantic_model:: OracleSQLOptions
-    :inherited-members: JDBCOptions
+    :inherited-members: GenericOptions
     :member-order: bysource
     :model-show-field-summary: false
     :field-show-constraints: false
diff --git a/docs/connection/db_connection/oracle/write.rst b/docs/connection/db_connection/oracle/write.rst
@@ -40,11 +40,12 @@ Examples
 Options
 -------
 
-Method above accepts  :obj:`JDBCWriteOptions <onetl.connection.db_connection.jdbc.options.JDBCWriteOptions>`
+Method above accepts  :obj:`OracleWriteOptions <onetl.connection.db_connection.oracle.options.OracleWriteOptions>`
 
-.. currentmodule:: onetl.connection.db_connection.jdbc_connection.options
+.. currentmodule:: onetl.connection.db_connection.oracle.options
 
-.. autopydantic_model:: JDBCWriteOptions
+.. autopydantic_model:: OracleWriteOptions
+    :inherited-members: GenericOptions
     :member-order: bysource
     :model-show-field-summary: false
     :field-show-constraints: false
diff --git a/docs/connection/db_connection/postgres/execute.rst b/docs/connection/db_connection/postgres/execute.rst
@@ -20,7 +20,7 @@ Use ``Postgres.fetch``
 Use this method to execute some ``SELECT`` query which returns **small number or rows**, like reading
 Postgres config, or reading data from some reference table. Method returns Spark DataFrame.
 
-Method accepts :obj:`PostgresFetchOptions <onetl.connection.db_connection.postgres.options.PostgresFetchOptions>`.
+Method accepts :obj:`Postgres.FetchOptions <onetl.connection.db_connection.postgres.options.PostgresFetchOptions>`.
 
 Connection opened using this method should be then closed with ``connection.close()`` or ``with connection:``.
 
@@ -58,7 +58,7 @@ Use ``Postgres.execute``
 
 Use this method to execute DDL and DML operations. Each method call runs operation in a separated transaction, and then commits it.
 
-Method accepts :obj:`PostgresExecuteOptions <onetl.connection.db_connection.postgres.options.PostgresExecuteOptions>`.
+Method accepts :obj:`Postgres.ExecuteOptions <onetl.connection.db_connection.postgres.options.PostgresExecuteOptions>`.
 
 Connection opened using this method should be then closed with ``connection.close()`` or ``with connection:``.
 
@@ -105,10 +105,10 @@ Options
 .. currentmodule:: onetl.connection.db_connection.postgres.options
 
 .. autopydantic_model:: PostgresFetchOptions
-    :inherited-members: JDBCFetchOptions
+    :inherited-members: GenericOptions
     :member-order: bysource
 
 
 .. autopydantic_model:: PostgresExecuteOptions
-    :inherited-members: JDBCExecuteOptions
+    :inherited-members: GenericOptions
     :member-order: bysource
diff --git a/docs/connection/db_connection/postgres/read.rst b/docs/connection/db_connection/postgres/read.rst
@@ -88,5 +88,5 @@ Options
 .. currentmodule:: onetl.connection.db_connection.postgres.options
 
 .. autopydantic_model:: PostgresReadOptions
-    :inherited-members: JDBCReadOptions
+    :inherited-members: GenericOptions
     :member-order: bysource
diff --git a/docs/connection/db_connection/postgres/sql.rst b/docs/connection/db_connection/postgres/sql.rst
@@ -73,7 +73,7 @@ Options
 .. currentmodule:: onetl.connection.db_connection.postgres.options
 
 .. autopydantic_model:: PostgresSQLOptions
-    :inherited-members: JDBCOptions
+    :inherited-members: GenericOptions
     :member-order: bysource
     :model-show-field-summary: false
     :field-show-constraints: false
diff --git a/docs/connection/db_connection/postgres/write.rst b/docs/connection/db_connection/postgres/write.rst
@@ -40,11 +40,12 @@ Examples
 Options
 -------
 
-Method above accepts  :obj:`JDBCWriteOptions <onetl.connection.db_connection.jdbc.options.JDBCWriteOptions>`
+Method above accepts  :obj:`PostgresWriteOptions <onetl.connection.db_connection.postgres.options.PostgresWriteOptions>`
 
-.. currentmodule:: onetl.connection.db_connection.jdbc_connection.options
+.. currentmodule:: onetl.connection.db_connection.postgres.options
 
-.. autopydantic_model:: JDBCWriteOptions
+.. autopydantic_model:: PostgresWriteOptions
+    :inherited-members: GenericOptions
     :member-order: bysource
     :model-show-field-summary: false
     :field-show-constraints: false
diff --git a/docs/connection/db_connection/teradata/execute.rst b/docs/connection/db_connection/teradata/execute.rst
@@ -20,7 +20,7 @@ Use ``Teradata.fetch``
 Use this method to execute some ``SELECT`` query which returns **small number or rows**, like reading
 Teradata config, or reading data from some reference table. Method returns Spark DataFrame.
 
-Method accepts :obj:`TeradataFetchOptions <onetl.connection.db_connection.teradata.options.TeradataFetchOptions>`.
+Method accepts :obj:`Teradata.FetchOptions <onetl.connection.db_connection.teradata.options.TeradataFetchOptions>`.
 
 Connection opened using this method should be then closed with ``connection.close()`` or ``with connection:``.
 
@@ -55,7 +55,7 @@ Use ``Teradata.execute``
 
 Use this method to execute DDL and DML operations. Each method call runs operation in a separated transaction, and then commits it.
 
-Method accepts :obj:`TeradataExecuteOptions <onetl.connection.db_connection.teradata.options.TeradataExecuteOptions>`.
+Method accepts :obj:`Teradata.ExecuteOptions <onetl.connection.db_connection.teradata.options.TeradataExecuteOptions>`.
 
 Connection opened using this method should be then closed with ``connection.close()`` or ``with connection:``.
 
@@ -104,10 +104,10 @@ Options
 .. currentmodule:: onetl.connection.db_connection.teradata.options
 
 .. autopydantic_model:: TeradataFetchOptions
-    :inherited-members: JDBCFetchOptions
+    :inherited-members: GenericOptions
     :member-order: bysource
 
 
 .. autopydantic_model:: TeradataExecuteOptions
-    :inherited-members: JDBCExecuteOptions
+    :inherited-members: GenericOptions
     :member-order: bysource
diff --git a/docs/connection/db_connection/teradata/read.rst b/docs/connection/db_connection/teradata/read.rst
@@ -118,5 +118,5 @@ Options
 .. currentmodule:: onetl.connection.db_connection.teradata.options
 
 .. autopydantic_model:: TeradataReadOptions
-    :inherited-members: JDBCReadOptions
+    :inherited-members: GenericOptions
     :member-order: bysource