Updated documentation (#475)

exasol · Aug 29, 2022 · 182a8a1 · 182a8a1
1 parent 00d29ea
commit 182a8a1
Show file tree

Hide file tree

Showing 2 changed files with 92 additions and 93 deletions.
diff --git a/README.md b/README.md
@@ -1,4 +1,4 @@
-# Virtual Schemas 
+# Virtual Schemas
 
 <img alt="virtual-schemas logo" src="doc/images/virtual-schemas_128x128.png" style="float:left; padding:0px 10px 10px 10px;"/>
 
@@ -75,31 +75,12 @@ in all your `CREATE JAVA ADAPTER SCRIPT` statements. The old entry point was rem
 
 ## Supported Data Sources
 
-| Data Source                                       |
-|---------------------------------------------------|
-| [IBM DB2][db2-dialect-doc]                        |
-| [Exasol][exasol-dialect-doc]                      |
-| [Generic JDBC-capable RDBMS][generic-dialect-doc] |
-| [MySQL][mysql-dialect-doc]                        |
-| [Oracle][oracle-dialect-doc]                      |
-| [PostgreSQL][postgresql-dialect-doc]              |
-| [Amazon AWS Redshift][redshift-dialect-doc]       |
-| [Amazon AWS Redshift Spectrum][redshift-spectrum] |
-| [SAP HANA][sap-hana-dialect-doc]                  |
-| [Microsoft SQLServer][sql-server-dialect-doc]     |
-| [Sybase][sybase-dialect-doc]                      |
-| [Google Big Query][big-query-dialect-doc]         |
-| [AWS Aurora][aurora-dialect-doc]                  |
-| [Amazon AWS Athena][athena-dialect-doc]           |
-| [ElasticSearch][elasticsearch-dialect-doc]        |
-| [Apache Impala][impala-dialect-doc]               |
-| [Apache Hive][hive-dialect-doc]                   |
-| [Document Files][virtual-schema-common-document-files] |
+See [List of Supported Dialects](doc/user-guide/dialects.md).
 
 ## Limitations
 
 * The Virtual Schema adapter takes about 1s to start.
-That means that queries that involve tables from Virtual Schema will take at least 1s. 
+That means that queries that involve tables from Virtual Schema will take at least 1s.
 
 ## Customer Support
 
@@ -111,7 +92,6 @@ This is an open source project officially supported by Exasol. Please contact ou
 
 ## Information for Users
 
-* [List of Supported Dialects](doc/user-guide/dialects.md)
 * [User Guide](https://docs.exasol.com/database_concepts/virtual_schemas.htm)
 * [Virtual Schema's Properties Reference](https://docs.exasol.com/database_concepts/virtual_schema/adapter_properties.htm)
 * [Remote Logging](https://docs.exasol.com/database_concepts/virtual_schema/logging.htm)
@@ -123,26 +103,8 @@ Additional resources:
 * [Changelog](doc/changes/changelog.md)
 * [Virtual Schema Privileges](https://docs.exasol.com/database_concepts/virtual_schema/virtual_schema_privilege.htm)
 
-## Information for Developers 
+## Information for Developers
 
 * Find all developers information in [Virtual Schema Common JDBC repository][developers-information].
 
-[athena-dialect-doc]: https://github.com/exasol/athena-virtual-schema/blob/main/doc/user_guide/athena_user_guide.md
-[aurora-dialect-doc]: doc/dialects/aurora.md
-[big-query-dialect-doc]: https://github.com/exasol/bigquery-virtual-schema/blob/main/doc/user_guide/bigquery_user_guide.md
-[db2-dialect-doc]: https://github.com/exasol/db2-virtual-schema/blob/main/doc/user_guide/db2_user_guide.md
-[exasol-dialect-doc]: https://github.com/exasol/exasol-virtual-schema/blob/main/doc/dialects/exasol.md
-[hive-dialect-doc]: https://github.com/exasol/hive-virtual-schema/blob/main/doc/user_guide/hive_user_guide.md
-[impala-dialect-doc]: https://github.com/exasol/impala-virtual-schema/blob/main/doc/user_guide/impala_user_guide.md
-[mysql-dialect-doc]: https://github.com/exasol/mysql-virtual-schema/blob/main/doc/user_guide/mysql_user_guide.md
-[oracle-dialect-doc]: https://github.com/exasol/oracle-virtual-schema/blob/main/doc/user_guide/oracle_user_guide.md
-[postgresql-dialect-doc]: https://github.com/exasol/postgresql-virtual-schema/blob/main/doc/dialects/postgresql.md
-[redshift-dialect-doc]: https://github.com/exasol/redshift-virtual-schema/blob/main/doc/user_guide/redshift_user_guide.md
-[sap-hana-dialect-doc]: https://github.com/exasol/hana-virtual-schema/blob/main/doc/user_guide/user_guide.md
-[sql-server-dialect-doc]: https://github.com/exasol/sqlserver-virtual-schema/blob/main/doc/user_guide/sqlserver_user_guide.md
-[sybase-dialect-doc]: https://github.com/exasol/sybase-virtual-schema/blob/main/doc/user_guide/sybase_user_guide.md
-[elasticsearch-dialect-doc]: https://github.com/exasol/elasticsearch-virtual-schema/blob/main/doc/dialects/elasticsearch_sql_user_guide.md
-[redshift-spectrum]: https://docs.aws.amazon.com/redshift/latest/dg/c-using-spectrum.html
-[generic-dialect-doc]: https://github.com/exasol/generic-virtual-schema
-
 [developers-information]: https://github.com/exasol/virtual-schema-common-jdbc#information-for-developers
diff --git a/doc/user-guide/dialects.md b/doc/user-guide/dialects.md
@@ -1,67 +1,104 @@
 # Supported Dialects
 
-Dialect name                        | Repository                                                        | Latest release                                      |
-------------------------------------|-------------------------------------------------------------------|-----------------------------------------------------|
-[Athena][athena-dialect-doc]        |  [Athena Virtual Schema][athena-virtual-schema-repository]        | [Latest release][athena-virtual-schema-releases]    |
-[Aurora][aurora-dialect-doc]        |  [Virtual Schemas][virtual-schemas-repository]                    | [Latest release][virtual-schemas-releases]          |
-[Big Query][big-query-dialect-doc]  |  [Big Query Virtual Schema][bigquery-virtual-schema-repository]   | [Latest release][bigquery-virtual-schema-releases]  |
-[DB2][db2-dialect-doc]              |  [DB2 Virtual Schemas][db2-virtual-schema-repository]             | [Latest release][db2-virtual-schema-releases]       |
-[Exasol][exasol-dialect-doc]        |  [Exasol Virtual Schema][exasol-virtual-schema-repository]        | [Latest release][exasol-virtual-schema-releases]    |
-[Hive][hive-dialect-doc]            |  [Hive Virtual Schemas][hive-virtual-schema-repository]           | [Latest release][hive-virtual-schema-releases]      |
-[Impala][impala-dialect-doc]        |  [Impala Virtual Schema][impala-virtual-schema-repository]        | [Latest release][impala-virtual-schema-releases]    |
-[MySQL][mysql-dialect-doc]          |  [MySQL Virtual Schema][mysql-virtual-schema-repository]          | [Latest release][mysql-virtual-schema-releases]     |
-[Oracle][oracle-dialect-doc]        |  [Oracle Virtual Schema][oracle-virtual-schema-repository]        | [Latest release][oracle-virtual-schema-releases]    |
-[PostgreSQL][postgresql-dialect-doc]|  [PostgreSQL Virtual Schema][pg-virtual-schema-repository]        | [Latest release][pg-virtual-schema-releases]        |
-[Redshift][redshift-dialect-doc]    |  [Redshift Virtual Schema][redshift-virtual-schema-repository]    | [Latest release][redshift-virtual-schema-releases]  |
-[SAP HANA][sap-hana-dialect-doc]    |  [Hana Virtual Schemas][hana-virtual-schema-repository]           | [Latest release][hana-virtual-schema-releases]      |
-[SQL Server][sql-server-dialect-doc]|  [SQL Server Virtual Schema][sqlserver-virtual-schema-repository] | [Latest release][sqlserver-virtual-schema-releases] |
-[Sybase ASE][sybase-dialect-doc]    |  [Sybase Virtual Schema][sybase-virtual-schema-repository]        | [Latest release][sybase-virtual-schema-releases]    |
-Generic                             |  [Virtual Schemas][virtual-schemas-repository]                    | [Latest release][virtual-schemas-releases]          |
+Dialect name                              | OEM       | Repository                                                        | Latest release                                     |
+------------------------------------------|-----------|-------------------------------------------------------------------|----------------------------------------------------|
+[Athena][athena-dialect-doc]              | AWS       | [Athena Virtual Schema][athena-vs-repository]			 | [Latest release][athena-vs-releases]    |
+[Aurora][aurora-dialect-doc]              | AWS       | [Virtual Schemas][virtual-schemas-repository]                    | [Latest release][virtual-schemas-releases]          |
+[DB2][db2-dialect-doc]                    | IBM       | [DB2 Virtual Schemas][db2-virtual-schema-repository]             | [Latest release][db2-virtual-schema-releases]       |
+[ElasticSearch][elasticsearch-dialect-doc] |          | [ElasticSearch][elasticsearch-repository] 			 | [Latest release][elasticsearch-releases]         |
+[Exasol][exasol-dialect-doc]              | Exasol    | [Exasol Virtual Schema][exasol-vs-repository]        		 | [Latest release][exasol-vs-releases]    |
+[Google Big Query][bigquery-dialect-doc]  | Google    | [Big Query Virtual Schema][bigquery-virtual-schema-repository]   | [Latest release][bigquery-virtual-schema-releases]  |
+[HANA][hana-dialect-doc]                  | SAP       | [Hana Virtual Schemas][hana-vs-repository]                       | [Latest release][hana-vs-releases]      |
+[Hive][hive-dialect-doc]                  | Apache    | [Hive Virtual Schemas][hive-vs-repository]                       | [Latest release][hive-vs-releases]      |
+[Impala][impala-dialect-doc]              | Apache    | [Impala Virtual Schema][impala-vs-repository]        		 | [Latest release][impala-vs-releases]    |
+[MySQL][mysql-dialect-doc]                |           | [MySQL Virtual Schema][mysql-vs-repository]          		 | [Latest release][mysql-vs-releases]     |
+[Oracle][oracle-dialect-doc]              | Oracle    | [Oracle Virtual Schema][oracle-vs-repository]        		 | [Latest release][oracle-vs-releases]    |
+[PostgreSQL][pg-dialect-doc]              |           | [PostgreSQL Virtual Schema][pg-vs-repository]        		 | [Latest release][pg-vs-releases]        |
+[Redshift][redshift-dialect-doc]          | AWS       | [Redshift Virtual Schema][redshift-vs-repository]    		 | [Latest release][redshift-vs-releases]  |
+[SQL Server][sql-server-dialect-doc]      | Microsoft | [SQL Server Virtual Schema][sqlserver-vs-repository] 		 | [Latest release][sqlserver-vs-releases] |
+[Sybase ASE][sybase-dialect-doc]          | Sybase    | [Sybase Virtual Schema][sybase-vs-repository]        		 | [Latest release][sybase-vs-releases]    |
+Generic                                   | Exasol    | [Virtual Schemas][virtual-schemas-repository]                    | [Latest release][virtual-schemas-releases]          |
+Generic JDBC-capable RDBMS                | Exasol    | [Generic JDBC-capable RDBMS][jdbc-vs-repository]              	 | [Latest release][jdbc-vs-releases]                                  |
+[Generic Document Files][document-vs-doc] | Exasol    | [Generic Document Files][document-vs-repository] 	      	 | [Latest release][document-vs-releases] 				       |
 
 If your database is not part of that list but provides a JDBC driver, try to use the Generic driver.
-You can also [develop a custom dialect][developing-dialect].  
+You can also [develop a custom dialect][developing-dialect].
+
+[aurora-dialect-doc]: https://github.com/exasol/virtual-schemas/blob/main/doc/dialects/aurora.md
 
 [athena-dialect-doc]: https://github.com/exasol/athena-virtual-schema/blob/main/doc/user_guide/athena_user_guide.md
-[aurora-dialect-doc]: ../dialects/aurora.md
-[big-query-dialect-doc]: https://github.com/exasol/bigquery-virtual-schema/blob/main/doc/user_guide/bigquery_user_guide.md
+[athena-vs-releases]: https://github.com/exasol/athena-virtual-schema/releases
+[athena-vs-repository]: https://github.com/exasol/athena-virtual-schema
+
+[bigquery-dialect-doc]: https://github.com/exasol/bigquery-virtual-schema/blob/main/doc/user_guide/bigquery_user_guide.md
+[bigquery-virtual-schema-releases]: https://github.com/exasol/bigquery-virtual-schema/releases
+[bigquery-virtual-schema-repository]: https://github.com/exasol/bigquery-virtual-schema
+
 [db2-dialect-doc]: https://github.com/exasol/db2-virtual-schema/blob/main/doc/user_guide/db2_user_guide.md
+[db2-virtual-schema-releases]: https://github.com/exasol/db2-virtual-schema/releases
+[db2-virtual-schema-repository]: https://github.com/exasol/db2-virtual-schema
+
+[elasticsearch-dialect-doc]: https://github.com/exasol/elasticsearch-virtual-schema/blob/main/doc/user_guide/elasticsearch_sql_user_guide.md
+[elasticsearch-releases]: https://github.com/exasol/elasticsearch-virtual-schema/releases
+[elasticsearch-repository]: https://github.com/exasol/elasticsearch-virtual-schema
+
 [exasol-dialect-doc]: https://github.com/exasol/exasol-virtual-schema/blob/master/doc/dialects/exasol.md
+[exasol-vs-releases]: https://github.com/exasol/exasol-virtual-schema/releases
+[exasol-vs-repository]: https://github.com/exasol/exasol-virtual-schema
+
 [hive-dialect-doc]: https://github.com/exasol/hive-virtual-schema/blob/main/doc/user_guide/hive_user_guide.md
+[hive-vs-releases]: https://github.com/exasol/hive-virtual-schema/releases
+[hive-vs-repository]: https://github.com/exasol/hive-virtual-schema
+
 [impala-dialect-doc]: https://github.com/exasol/impala-virtual-schema/blob/main/doc/user_guide/impala_user_guide.md
+[impala-vs-releases]: https://github.com/exasol/impala-virtual-schema/releases
+[impala-vs-repository]: https://github.com/exasol/impala-virtual-schema
+
 [mysql-dialect-doc]: https://github.com/exasol/mysql-virtual-schema/blob/main/doc/user_guide/mysql_user_guide.md
+[mysql-vs-releases]: https://github.com/exasol/mysql-virtual-schema/releases
+[mysql-vs-repository]: https://github.com/exasol/mysql-virtual-schema
+
 [oracle-dialect-doc]: https://github.com/exasol/oracle-virtual-schema/blob/main/doc/user_guide/oracle_user_guide.md
-[postgresql-dialect-doc]: https://github.com/exasol/postgresql-virtual-schema/blob/main/doc/user_guide/postgresql_user_guide.md
+[oracle-vs-releases]: https://github.com/exasol/oracle-virtual-schema/releases
+[oracle-vs-repository]: https://github.com/exasol/oracle-virtual-schema
+
+[pg-vs-releases]: https://github.com/exasol/postgresql-virtual-schema/releases
+[pg-vs-repository]: https://github.com/exasol/postgresql-virtual-schema
+[pg-dialect-doc]: https://github.com/exasol/postgresql-virtual-schema/blob/main/doc/user_guide/postgresql_user_guide.md
+
 [redshift-dialect-doc]: https://github.com/exasol/redshift-virtual-schema/blob/main/doc/user_guide/redshift_user_guide.md
-[sap-hana-dialect-doc]:  https://github.com/exasol/hana-virtual-schema/blob/main/doc/user_guide/user_guide.md
+[redshift-vs-releases]: https://github.com/exasol/redshift-virtual-schema/releases
+[redshift-vs-repository]: https://github.com/exasol/redshift-virtual-schema
+
+[hana-dialect-doc]:  https://github.com/exasol/hana-virtual-schema/blob/main/doc/user_guide/user_guide.md
+[hana-vs-releases]: https://github.com/exasol/hana-virtual-schema/releases
+[hana-vs-repository]: https://github.com/exasol/hana-virtual-schema
+
 [sql-server-dialect-doc]: https://github.com/exasol/sqlserver-virtual-schema/blob/main/doc/user_guide/sqlserver_user_guide.md
+[sqlserver-vs-releases]: https://github.com/exasol/sqlserver-virtual-schema/releases
+[sqlserver-vs-repository]: https://github.com/exasol/sqlserver-virtual-schema
+
 [sybase-dialect-doc]: https://github.com/exasol/sybase-virtual-schema/blob/main/doc/user_guide/sybase_user_guide.md
-[virtual-schemas-repository]: https://github.com/exasol/virtual-schemas
+[sybase-vs-releases]: https://github.com/exasol/sybase-virtual-schema/releases
+[sybase-vs-repository]: https://github.com/exasol/sybase-virtual-schema
+
+
+
+<!-- no [virtual-schemas-dialect-doc] -->
 [virtual-schemas-releases]: https://github.com/exasol/virtual-schemas/releases
-[athena-virtual-schema-repository]: https://github.com/exasol/athena-virtual-schema
-[athena-virtual-schema-releases]: https://github.com/exasol/athena-virtual-schema/releases
-[bigquery-virtual-schema-repository]: https://github.com/exasol/bigquery-virtual-schema
-[bigquery-virtual-schema-releases]: https://github.com/exasol/bigquery-virtual-schema/releases
-[db2-virtual-schema-repository]: https://github.com/exasol/db2-virtual-schema
-[db2-virtual-schema-releases]: https://github.com/exasol/db2-virtual-schema/releases
-[exasol-virtual-schema-repository]: https://github.com/exasol/exasol-virtual-schema
-[exasol-virtual-schema-releases]: https://github.com/exasol/exasol-virtual-schema/releases
-[hana-virtual-schema-repository]: https://github.com/exasol/hana-virtual-schema
-[hana-virtual-schema-releases]: https://github.com/exasol/hana-virtual-schema/releases
-[sqlserver-virtual-schema-repository]: https://github.com/exasol/sqlserver-virtual-schema
-[sqlserver-virtual-schema-releases]: https://github.com/exasol/sqlserver-virtual-schema/releases
-[sybase-virtual-schema-repository]: https://github.com/exasol/sybase-virtual-schema
-[sybase-virtual-schema-releases]: https://github.com/exasol/sybase-virtual-schema/releases
-[hive-virtual-schema-repository]: https://github.com/exasol/hive-virtual-schema
-[hive-virtual-schema-releases]: https://github.com/exasol/hive-virtual-schema/releases
-[impala-virtual-schema-repository]: https://github.com/exasol/impala-virtual-schema
-[impala-virtual-schema-releases]: https://github.com/exasol/impala-virtual-schema/releases
-[mysql-virtual-schema-repository]: https://github.com/exasol/mysql-virtual-schema
-[mysql-virtual-schema-releases]: https://github.com/exasol/mysql-virtual-schema/releases
-[oracle-virtual-schema-repository]: https://github.com/exasol/oracle-virtual-schema
-[oracle-virtual-schema-releases]: https://github.com/exasol/oracle-virtual-schema/releases
-[pg-virtual-schema-repository]: https://github.com/exasol/postgresql-virtual-schema
-[pg-virtual-schema-releases]: https://github.com/exasol/postgresql-virtual-schema/releases
-[redshift-virtual-schema-repository]: https://github.com/exasol/redshift-virtual-schema
-[redshift-virtual-schema-releases]: https://github.com/exasol/redshift-virtual-schema/releases
-
-[developing-dialect]: https://github.com/exasol/virtual-schema-common-jdbc/blob/main/doc/development/developing_a_dialect.md
+[virtual-schemas-repository]: https://github.com/exasol/virtual-schemas
+
+<!-- no [jdbc-dialect-doc], no user guide -->
+[jdbc-vs-releases]: https://github.com/exasol/virtual-schema-common-jdbc/releases
+[jdbc-vs-repository]: https://github.com/exasol/virtual-schema-common-jdbc
+
+<!-- no [jdbc-dialect-doc], no user guide -->
+[jdbc-vs-releases]: https://github.com/exasol/virtual-schema-common-jdbc/releases
+[jdbc-vs-repository]: https://github.com/exasol/virtual-schema-common-jdbc
+
+[document-vs-doc]: https://github.com/exasol/virtual-schema-common-document-files/blob/main/doc/user_guide/user_guide.md
+[document-vs-releases]: https://github.com/exasol/virtual-schema-common-document-files/releases
+[document-vs-repository]: https://github.com/exasol/virtual-schema-common-document-files
+
+[developing-dialect]: https://github.com/exasol/virtual-schema-common-jdbc/blob/main/doc/development/developing_a_dialect.md
+