Skip to content

Commit

Permalink
Updated documentation (#483)
Browse files Browse the repository at this point in the history
  • Loading branch information
ckunki authored Mar 17, 2023
1 parent 6534cd1 commit 38ed8a6
Show file tree
Hide file tree
Showing 12 changed files with 167 additions and 36 deletions.
4 changes: 4 additions & 0 deletions .gitattributes
Original file line number Diff line number Diff line change
@@ -1 +1,5 @@
*.sh text eol=lf
doc/changes/changelog.md linguist-generated=true
.github/workflows/broken_links_checker.yml linguist-generated=true
.github/workflows/project-keeper.sh linguist-generated=true
.github/workflows/project-keeper-verify.yml linguist-generated=true
7 changes: 5 additions & 2 deletions .github/workflows/broken_links_checker.yml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

52 changes: 52 additions & 0 deletions .github/workflows/project-keeper-verify.yml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

18 changes: 18 additions & 0 deletions .github/workflows/project-keeper.sh

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

12 changes: 11 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -19,4 +19,14 @@ dependency-reduced-pom.xml
local
Scripts
.dbeaver*
**/*.log
**/*.log
.directory
venv/
pom.xml.versionsBackup
~*
*.lock
*.bak
*.orig
*.old
*.md.html
*.flattened-pom.xml
8 changes: 8 additions & 0 deletions .project-keeper.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
version: 6.0.2
linkReplacements:
excludes:
- "E-PK-CORE-18: Outdated content: '.github/workflows/project-keeper-verify.yml'"
- regex: "(?s)E-PK-CORE-62: The project's README.md does not contain a valid badges block.*"
- "E-PK-CORE-61: The project's README.md does not reference the dependencies.md file.' Please add a link like '[Dependencies](dependencies.md)' to the README.md."
- "E-PK-CORE-50: This project does not have a dependencies.md file."

17 changes: 17 additions & 0 deletions .vscode/settings.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
{
"editor.formatOnSave": true,
"editor.codeActionsOnSave": {
"source.organizeImports": true,
"source.generate.finalModifiers": true,
"source.fixAll": true
},
"java.codeGeneration.useBlocks": true,
"java.saveActions.organizeImports": true,
"java.sources.organizeImports.starThreshold": 3,
"java.sources.organizeImports.staticStarThreshold": 3,
"java.test.config": {
"vmArgs": [
"-Djava.util.logging.config.file=src/test/resources/logging.properties"
]
}
}
3 changes: 2 additions & 1 deletion doc/changes/changelog.md

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

11 changes: 5 additions & 6 deletions doc/changes/changes_4.0.3.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,17 +13,17 @@
## Documentation

* #317: Worked on reducing redundancy between user_guid.md and docs.exasol.com
* #354: Added datatypes mapping info to the postgres documentation.
* #355: Updated general deployment guide.
* #354: Added datatypes mapping info to the postgres documentation.
* #355: Updated general deployment guide.
* #359: Replaced links to products with links to dialect in the README's feature list.
* #369: Added supported data types list to Oracle dialect.

## Dependency updates

<details>
<summary>Click to expand</summary>
* Added `org.junit.jupiter:junit-jupiter:5.6.2`

* Added `org.junit.jupiter:junit-jupiter:5.6.2`
* Updated `com.exasol:virtual-schema-common-jdbc` from 5.0.2 to 5.0.4
* Updated `com.exasol:exasol-testcontainers` from 2.0.3 to 2.1.0
* Updated `mysql:mysql-connector-java` from 8.0.20 to 8.0.21
Expand All @@ -32,7 +32,6 @@
* Removed `org.junit.jupiter:junit-jupiter-engine`
* Removed `org.junit.platform:junit-platform-runner`
* Removed `org.mockito.mockito-core`
* Excluded `com.fasterxml.jackson.core:jackson-databind` from `org.apache.hbase:hbase-server` to remove vulnerabilities:
https://ossindex.sonatype.org/component/pkg:maven/com.fasterxml.jackson.core/[email protected]
* Excluded `com.fasterxml.jackson.core:jackson-databind` from `org.apache.hbase:hbase-server` to remove vulnerabilities.

</details>
11 changes: 11 additions & 0 deletions doc/changes/changes_6.0.2.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# Virtual Schemas 6.0.2, released 2023-03-17

Code name: Documentation Update

## Summary

This release adds information to the Exasol dialect in the list of supported dialects.

## Documentation

* #482: Improved list of supported dialects
57 changes: 31 additions & 26 deletions doc/user-guide/dialects.md
Original file line number Diff line number Diff line change
@@ -1,31 +1,36 @@
# Supported Dialects

Dialect name | OEM | Type | Repository | Latest release |
------------------------------------------|-----------|-----------|-------------------------------------------------------------------|----------------------------------------------------|
[Athena][athena-dialect-doc] | AWS | document | [Athena Virtual Schema][athena-vs-repository] | [Latest release][athena-vs-releases] |
[Aurora][aurora-dialect-doc] | AWS | JDBC | [Virtual Schemas][virtual-schemas-repository] | [Latest release][virtual-schemas-releases] |
[Azure Blob Storage document files][azure-blob-storage-vs-doc] | Microsoft | document | [Azure Blob Storage document files Virtual Schema][azure-blob-storage-vs-repository] | [Latest release][azure-blob-storage-vs-releases] |
[Azure Data Lake Storage Gen2 document files][azure-data-lake-storage-gen2-vs-doc] | Microsoft | document | [Azure Data Lake Storage Gen2 document files Virtual Schema][azure-data-lake-storage-gen2-vs-repository] | [Latest release][azure-data-lake-storage-gen2-vs-releases] |
[BucketFS document files][bucketfs-vs-doc] | Exasol | document | [BucketFS document files Virtual Schema][bucketfs-vs-repository] | [Latest release][bucketfs-vs-releases] |
[DB2][db2-dialect-doc] | IBM | JDBC | [DB2 Virtual Schemas][db2-virtual-schema-repository] | [Latest release][db2-virtual-schema-releases] |
[Dynamo DB][dynamodb-vs-doc] | AWS | document | [Dynamo DB Virtual Schema][dynamodb-vs-repository] | [Latest release][dynamodb-vs-releases] |
[ElasticSearch][elasticsearch-dialect-doc] | | JDBC | [ElasticSearch][elasticsearch-repository] | [Latest release][elasticsearch-releases] |
[Exasol][exasol-dialect-doc] | Exasol | JDBC | [Exasol Virtual Schema][exasol-vs-repository] | [Latest release][exasol-vs-releases] |
[Google Big Query][bigquery-dialect-doc] | Google | JDBC | [Big Query Virtual Schema][bigquery-virtual-schema-repository] | [Latest release][bigquery-virtual-schema-releases] |
[Google Cloud Storage document files][google-cloud-storage-vs-doc] | Google | document | [Google Cloud Storage document files Virtual Schema][google-cloud-storage-vs-repository] | [Latest release][google-cloud-storage-vs-releases] |
[HANA][hana-dialect-doc] | SAP | JDBC | [Hana Virtual Schemas][hana-vs-repository] | [Latest release][hana-vs-releases] |
[Hive][hive-dialect-doc] | Apache | JDBC | [Hive Virtual Schemas][hive-vs-repository] | [Latest release][hive-vs-releases] |
[Impala][impala-dialect-doc] | Apache | JDBC | [Impala Virtual Schema][impala-vs-repository] | [Latest release][impala-vs-releases] |
[MySQL][mysql-dialect-doc] | | JDBC | [MySQL Virtual Schema][mysql-vs-repository] | [Latest release][mysql-vs-releases] |
[Oracle][oracle-dialect-doc] | Oracle | JDBC | [Oracle Virtual Schema][oracle-vs-repository] | [Latest release][oracle-vs-releases] |
[PostgreSQL][pg-dialect-doc] | | JDBC | [PostgreSQL Virtual Schema][pg-vs-repository] | [Latest release][pg-vs-releases] |
[Redshift][redshift-dialect-doc] | AWS | JDBC | [Redshift Virtual Schema][redshift-vs-repository] | [Latest release][redshift-vs-releases] |
[S3 document files][s3-vs-doc] | AWS | document | [S3 document files Virtual Schema][s3-vs-repository] | [Latest release][s3-vs-releases] |
[SQL Server][sql-server-dialect-doc] | Microsoft | JDBC | [SQL Server Virtual Schema][sqlserver-vs-repository] | [Latest release][sqlserver-vs-releases] |
[Sybase ASE][sybase-dialect-doc] | Sybase | JDBC | [Sybase Virtual Schema][sybase-vs-repository] | [Latest release][sybase-vs-releases] |
Generic | Exasol | (generic) | [Virtual Schemas][virtual-schemas-repository] | [Latest release][virtual-schemas-releases] |
Generic JDBC-capable RDBMS | Exasol | JDBC | [Generic JDBC-capable RDBMS][jdbc-vs-repository] | [Latest release][jdbc-vs-releases] |
[Generic Document Files][document-vs-doc] | Exasol | document | [Generic Document Files][document-vs-repository] | [Latest release][document-vs-releases] |
| Dialect name | OEM | Type | Repository | Latest release |
|------------------------------------------------------------------------------------|-----------|-----------|----------------------------------------------------------------------------------------------------------|------------------------------------------------------------|
| [Athena][athena-dialect-doc] | AWS | document | [Athena Virtual Schema][athena-vs-repository] | [Latest release][athena-vs-releases] |
| [Aurora][aurora-dialect-doc] | AWS | JDBC | [Virtual Schemas][virtual-schemas-repository] | [Latest release][virtual-schemas-releases] |
| [Azure Blob Storage document files][azure-blob-storage-vs-doc] | Microsoft | document | [Azure Blob Storage document files Virtual Schema][azure-blob-storage-vs-repository] | [Latest release][azure-blob-storage-vs-releases] |
| [Azure Data Lake Storage Gen2 document files][azure-data-lake-storage-gen2-vs-doc] | Microsoft | document | [Azure Data Lake Storage Gen2 document files Virtual Schema][azure-data-lake-storage-gen2-vs-repository] | [Latest release][azure-data-lake-storage-gen2-vs-releases] |
| [BucketFS document files][bucketfs-vs-doc] | Exasol | document | [BucketFS document files Virtual Schema][bucketfs-vs-repository] | [Latest release][bucketfs-vs-releases] |
| [DB2][db2-dialect-doc] | IBM | JDBC | [DB2 Virtual Schemas][db2-virtual-schema-repository] | [Latest release][db2-virtual-schema-releases] |
| [Dynamo DB][dynamodb-vs-doc] | AWS | document | [Dynamo DB Virtual Schema][dynamodb-vs-repository] | [Latest release][dynamodb-vs-releases] |
| [ElasticSearch][elasticsearch-dialect-doc] | | JDBC | [ElasticSearch][elasticsearch-repository] | [Latest release][elasticsearch-releases] |
| [Exasol][exasol-dialect-doc] | Exasol | JDBC *) | [Exasol Virtual Schema][exasol-vs-repository] | [Latest release][exasol-vs-releases] |
| [Google Big Query][bigquery-dialect-doc] | Google | JDBC | [Big Query Virtual Schema][bigquery-virtual-schema-repository] | [Latest release][bigquery-virtual-schema-releases] |
| [Google Cloud Storage document files][google-cloud-storage-vs-doc] | Google | document | [Google Cloud Storage document files Virtual Schema][google-cloud-storage-vs-repository] | [Latest release][google-cloud-storage-vs-releases] |
| [HANA][hana-dialect-doc] | SAP | JDBC | [Hana Virtual Schemas][hana-vs-repository] | [Latest release][hana-vs-releases] |
| [Hive][hive-dialect-doc] | Apache | JDBC | [Hive Virtual Schemas][hive-vs-repository] | [Latest release][hive-vs-releases] |
| [Impala][impala-dialect-doc] | Apache | JDBC | [Impala Virtual Schema][impala-vs-repository] | [Latest release][impala-vs-releases] |
| [MySQL][mysql-dialect-doc] | | JDBC | [MySQL Virtual Schema][mysql-vs-repository] | [Latest release][mysql-vs-releases] |
| [Oracle][oracle-dialect-doc] | Oracle | JDBC | [Oracle Virtual Schema][oracle-vs-repository] | [Latest release][oracle-vs-releases] |
| [PostgreSQL][pg-dialect-doc] | | JDBC | [PostgreSQL Virtual Schema][pg-vs-repository] | [Latest release][pg-vs-releases] |
| [Redshift][redshift-dialect-doc] | AWS | JDBC | [Redshift Virtual Schema][redshift-vs-repository] | [Latest release][redshift-vs-releases] |
| [S3 document files][s3-vs-doc] | AWS | document | [S3 document files Virtual Schema][s3-vs-repository] | [Latest release][s3-vs-releases] |
| [SQL Server][sql-server-dialect-doc] | Microsoft | JDBC | [SQL Server Virtual Schema][sqlserver-vs-repository] | [Latest release][sqlserver-vs-releases] |
| [Sybase ASE][sybase-dialect-doc] | Sybase | JDBC | [Sybase Virtual Schema][sybase-vs-repository] | [Latest release][sybase-vs-releases] |
| Generic | Exasol | (generic) | [Virtual Schemas][virtual-schemas-repository] | [Latest release][virtual-schemas-releases] |
| Generic JDBC-capable RDBMS | Exasol | JDBC | [Generic JDBC-capable RDBMS][jdbc-vs-repository] | [Latest release][jdbc-vs-releases] |
| [Generic Document Files][document-vs-doc] | Exasol | document | [Generic Document Files][document-vs-repository] | [Latest release][document-vs-releases] |

\*) The Virtual Schema for Exasol databases supports three connection variants in total:
* Import from JDBC
* Using EXA Import
* Using `IS_LOCAL`

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].

Expand Down
3 changes: 3 additions & 0 deletions release_config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
release-platforms:
- GitHub
language: Generic

0 comments on commit 38ed8a6

Please sign in to comment.