Skip to content

Commit

Permalink
Updated the README files.
Browse files Browse the repository at this point in the history
  • Loading branch information
fjssilva committed Feb 11, 2022
1 parent 6976d9d commit 192a4d6
Show file tree
Hide file tree
Showing 2 changed files with 26 additions and 0 deletions.
5 changes: 5 additions & 0 deletions README
Original file line number Diff line number Diff line change
Expand Up @@ -26,3 +26,8 @@ Notice:
Maven repository and add it to the CLASSPATH, or use Maven's automatic
dependency resolution features by adding a dependency to "GroupId: mysql"
and "ArtifactId: mysql-connector-java" to your project's pom.xml file.
- To use OCI AIM authentication, you will need to add the external library
oci-java-sdk-common, which you can download manually from the official Maven
repository and add it to the CLASSPATH, or use Maven's automatic dependency
resolution features by adding a dependency to "GroupId: com.oracle.oci.sdk"
and "ArtifactId: oci-java-sdk-common" to your project's pom.xml file.
21 changes: 21 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,11 @@ MySQL Connector/J is free for usage under the terms of the specified licensing a

MySQL Connector/J can be installed from pre-compiled packages that can be downloaded from the [Connector/J download page](https://dev.mysql.com/downloads/connector/j/). Installing Connector/J only requires obtaining the corresponding JAR file from the downloaded bundle or installer and including it in the application's CLASSPATH.

According to how you use Connector/J, you may also need to install the following third-party libraries on your system for it to work:
* Protocol Buffers (protobuf-java) is required for using X DevAPI
* Oracle Cloud Infrastructure SDK for Java (oci-java-sdk) is required to support OCI AIM authentication
* Simple Logging Facade API (slf4j-api) is required for using the logging capabilities provided by the default implementation of org.slf4j.Logger.Slf4JLogger by Connector/J

### As a Maven Dependency

Alternatively, Connector/J can be obtained automatically via [Maven's dependency management](https://search.maven.org/search?q=g:mysql%20AND%20a:mysql-connector-java) by adding the following configuration in the application's Project Object Model (POM) file:
Expand All @@ -34,6 +39,22 @@ Alternatively, Connector/J can be obtained automatically via [Maven's dependency
</dependency>
```

Connector/J's own Project Object Model (POM) file specifies a transitive dependency to Protocol Buffers (protobuf-java) since it is required for using X DevAPI. However, if you do not use the X DevAPI features, you may also want to add a dependency exclusion to avoid linking the unneeded sub-library. For example:

```xml
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<version>8.0.29</version>
<exclusions>
<exclusion>
<groupId>com.google.protobuf</groupId>
<artifactId>protobuf-java</artifactId>
</exclusion>
</exclusions>
</dependency>
```

### Build From Source

This driver can also be complied and installed from the source available in this repository. Please refer to the Connector/J documentation for [detailed instructions](https://dev.mysql.com/doc/connector-j/8.0/en/connector-j-installing-source.html) on how to do it.
Expand Down

0 comments on commit 192a4d6

Please sign in to comment.