MySQL extension with MariaDB connector docs#11608
Merged
clintropolis merged 5 commits intoapache:masterfrom Aug 19, 2021
Merged
MySQL extension with MariaDB connector docs#11608clintropolis merged 5 commits intoapache:masterfrom
clintropolis merged 5 commits intoapache:masterfrom
Conversation
techdocsmith
requested changes
Aug 17, 2021
Contributor
techdocsmith
left a comment
techdocsmith
left a comment
There was a problem hiding this comment.
some typos & style changes.
| This module can be used side to side with other lookup module like the global cached lookup module. | ||
|
|
||
| To use this extension please make sure to [include](../../development/extensions.md#loading-extensions) `druid-lookups-cached-single` as an extension. | ||
| To use this extension please make sure to [include](../extensions.md#loading-extensions) `druid-lookups-cached-single` as an extension. |
Contributor
There was a problem hiding this comment.
Suggested change
| To use this extension please make sure to [include](../extensions.md#loading-extensions) `druid-lookups-cached-single` as an extension. | |
| To use this extension [include](../extensions.md#loading-extensions) `druid-lookups-cached-single` as an extension. |
Member
Author
There was a problem hiding this comment.
should this be something like
... include
druid-lookups-cached-singlein the extension load list.
so it isn't
this extension ... as an extension.
?
| > For Postgres, the connector JAR is already included. | ||
| > For MySQL, you can get it from https://dev.mysql.com/downloads/connector/j/. | ||
| > Copy or symlink the downloaded file inside the folder `extensions/druid-lookups-cached-single` under the distribution root directory. | ||
| > See the MySQL extension documentation for instructions on how to obtain for [MySQL](./mysql.md#installing-the-mysql-connector-library) or [MariaDB](./mysql.md#alternative-installing-the-mariadb-connector-library) connector libraries. |
Contributor
There was a problem hiding this comment.
Suggested change
| > See the MySQL extension documentation for instructions on how to obtain for [MySQL](./mysql.md#installing-the-mysql-connector-library) or [MariaDB](./mysql.md#alternative-installing-the-mariadb-connector-library) connector libraries. | |
| > See the MySQL extension documentation for instructions to obtain [MySQL](./mysql.md#installing-the-mysql-connector-library) or [MariaDB](./mysql.md#alternative-installing-the-mariadb-connector-library) connector libraries. |
| > Lookups are an [experimental](../experimental.md) feature. | ||
|
|
||
| To use this Apache Druid extension, make sure to [include](../../development/extensions.md#loading-extensions) `druid-lookups-cached-global` as an extension. | ||
| To use this Apache Druid extension, make sure to [include](../extensions.md#loading-extensions) `druid-lookups-cached-global` as an extension. |
Contributor
There was a problem hiding this comment.
Suggested change
| To use this Apache Druid extension, make sure to [include](../extensions.md#loading-extensions) `druid-lookups-cached-global` as an extension. | |
| To use this Apache Druid extension, [include](../extensions.md#loading-extensions) `druid-lookups-cached-global` as an extension. |
| > If using JDBC, you will need to add your database's client JAR files to the extension's directory. | ||
| > For Postgres, the connector JAR is already included. | ||
| > For MySQL, you can get it from https://dev.mysql.com/downloads/connector/j/. | ||
| > See the MySQL extension documentation for instructions on how to obtain for [MySQL](./mysql.md#installing-the-mysql-connector-library) or [MariaDB](./mysql.md#alternative-installing-the-mariadb-connector-library) connector libraries. |
Contributor
There was a problem hiding this comment.
Suggested change
| > See the MySQL extension documentation for instructions on how to obtain for [MySQL](./mysql.md#installing-the-mysql-connector-library) or [MariaDB](./mysql.md#alternative-installing-the-mariadb-connector-library) connector libraries. | |
| > See the MySQL extension documentation for instructions to obtain [MySQL](./mysql.md#installing-the-mysql-connector-library) or [MariaDB](./mysql.md#alternative-installing-the-mariadb-connector-library) connector libraries. |
| To use this Apache Druid extension, make sure to [include](../../development/extensions.md#loading-extensions) `mysql-metadata-storage` as an extension. | ||
|
|
||
| > The MySQL extension requires the MySQL Connector/J library which is not included in the Druid distribution. | ||
| > The MySQL extension requires the MySQL Connector/J library or MariaDB Connector/J library, neither of which is not included in the Druid distribution. |
Contributor
There was a problem hiding this comment.
Suggested change
| > The MySQL extension requires the MySQL Connector/J library or MariaDB Connector/J library, neither of which is not included in the Druid distribution. | |
| > The MySQL extension requires the MySQL Connector/J library or MariaDB Connector/J library, neither of which are included in the Druid distribution. |
Double negative. Looks like neither are included.
| THis extension also supports using the MariaDB connector jar, though it is also not included in the Druid distribution and must be installed separately like the MySQL connector. | ||
|
|
||
| - Download from the MariaDB site: https://mariadb.com/downloads/connector | ||
| - Maven Central: https://repo1.maven.org/maven2/org/mariadb/jdbc/mariadb-java-client/2.7.3/mariadb-java-client-2.7.3.jar |
Contributor
There was a problem hiding this comment.
Suggested change
| - Maven Central: https://repo1.maven.org/maven2/org/mariadb/jdbc/mariadb-java-client/2.7.3/mariadb-java-client-2.7.3.jar | |
| - Download from Maven Central: https://repo1.maven.org/maven2/org/mariadb/jdbc/mariadb-java-client/2.7.3/mariadb-java-client-2.7.3.jar |
| - Download from the MariaDB site: https://mariadb.com/downloads/connector | ||
| - Maven Central: https://repo1.maven.org/maven2/org/mariadb/jdbc/mariadb-java-client/2.7.3/mariadb-java-client-2.7.3.jar | ||
|
|
||
| This should fetch a JAR file named similar to 'maria-java-client-x.x.x.jar'. |
Contributor
There was a problem hiding this comment.
Suggested change
| This should fetch a JAR file named similar to 'maria-java-client-x.x.x.jar'. | |
| This fetches the MariaDB connector JAR file with a name like 'maria-java-client-x.x.x.jar'. |
|
|
||
| Copy or symlink this file to `extensions/mysql-metadata-storage` under the distribution root directory. | ||
|
|
||
| In Druid properties, `druid.metadata.mysql.driver.driverClassName=org.mariadb.jdbc.Driver` must be set, which will instruct the `mysql-metadata-storage` extension to use the MariaDB connector library instead of MySQL. Depending on the MariaDB client library version, it will support both `jdbc:mysql:` and `jdbc:mariadb:` connection URIs, though the parameters to configure the connection vary between implementations, so be sure to [check the documentation](https://mariadb.com/kb/en/about-mariadb-connector-j/#connection-strings) for details. |
Contributor
There was a problem hiding this comment.
Suggested change
| In Druid properties, `druid.metadata.mysql.driver.driverClassName=org.mariadb.jdbc.Driver` must be set, which will instruct the `mysql-metadata-storage` extension to use the MariaDB connector library instead of MySQL. Depending on the MariaDB client library version, it will support both `jdbc:mysql:` and `jdbc:mariadb:` connection URIs, though the parameters to configure the connection vary between implementations, so be sure to [check the documentation](https://mariadb.com/kb/en/about-mariadb-connector-j/#connection-strings) for details. | |
| To configure the `mysql-metadata-storage` extension to use the MariaDB connector library instead of MySQL, set the following in the Druid properties: `druid.metadata.mysql.driver.driverClassName=org.mariadb.jdbc.Driver` | |
| Depending on the MariaDB client library version, the connector supports both `jdbc:mysql:` and `jdbc:mariadb:` connection URIs. However, the parameters to configure the connection vary between implementations, so be sure to [check the documentation](https://mariadb.com/kb/en/about-mariadb-connector-j/#connection-strings) for details. |
| [http://dev.mysql.com/downloads/mysql/](http://dev.mysql.com/downloads/mysql/) | ||
| [http://dev.mysql.com/downloads/mysql/](http://dev.mysql.com/downloads/mysql/). | ||
|
|
||
| This extension should also function correctly using MariaDB server, https://mariadb.org/download/, substituting for MariaDB in the following instructions where appropriate. |
Contributor
There was a problem hiding this comment.
Suggested change
| This extension should also function correctly using MariaDB server, https://mariadb.org/download/, substituting for MariaDB in the following instructions where appropriate. | |
| This extension should also supports MariaDB server, https://mariadb.org/download/, substituting for MariaDB in the following instructions where appropriate. |
| druid.metadata.storage.connector.password=diurd | ||
| ``` | ||
|
|
||
| If using MariaDB, `druid.metadata.mysql.driver.driverClassName=org.mariadb.jdbc.Driver` must also be set. |
Contributor
There was a problem hiding this comment.
Suggested change
| If using MariaDB, `druid.metadata.mysql.driver.driverClassName=org.mariadb.jdbc.Driver` must also be set. | |
| If using MariaDB, set `druid.metadata.mysql.driver.driverClassName=org.mariadb.jdbc.Driver`. |
Member
Author
|
hmm, we need to figure out how to make the code coverage bot ignore log statements I think... |
Member
Author
|
skipping CI since changes are basically doc only, and those jobs are passing |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Follow-up to #11402, adding docs for using MySQL extension with MariaDB connector library. Also, a log statement so Druid reports which driver class it is attempting to use.