Skip to content

Commit

Permalink
[misc] documentation improvement
Browse files Browse the repository at this point in the history
  • Loading branch information
rusher committed Nov 16, 2015
1 parent 7c913ab commit 226ce60
Show file tree
Hide file tree
Showing 4 changed files with 6 additions and 5 deletions.
2 changes: 1 addition & 1 deletion documentation/About-MariaDB-Connector-J.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ Using maven :

## Requirements

* Java 7 (until April 2015) or 8
* Java 7 or 8 (Last compatible version with java 6 is [1.1.9](https://downloads.mariadb.org/connector-java/1.1.9/))
* com.sun.JNA is used by some library functions and a jar is available at
https://github.com/twall/jna
** only needed when connecting to the server with unix sockets or windows
Expand Down
5 changes: 3 additions & 2 deletions documentation/Developers-Guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,14 +25,14 @@ Before downloading source, fork the project to your own repository, and use your
# Run local test

Before any submission :
Run the test locally : by default, you need to have a MySQL/MariaDB server on localhost:3306 with a database named "test" and a user root without password.
Run the test locally : by default, you need to have a MySQL/MariaDB server on localhost:3306 with a database named "testj" and a user root without password.
so you can run

mvn test

You can change those parameter by adding -DdbUrl parameter. like :

mvn test -DdbUrl=jdbc:mariadb://127.0.0.1:3306/test?user=root&password=*****
mvn test -DdbUrl=jdbc:mariadb://127.0.0.1:3306/testj?user=root&password=*****

You can launch a specific test by adding -Dfile

Expand Down Expand Up @@ -60,6 +60,7 @@ server :
* MariaDB 10.0
* MariaDB 10.1
* MySQL 5.6
* MySQL 5.7

max_allowed_packet :
* 1M
Expand Down
2 changes: 1 addition & 1 deletion documentation/Failover-and-high-availability.md
Original file line number Diff line number Diff line change
Expand Up @@ -150,7 +150,7 @@ Each parameter corresponds to a specific use case:
|failoverLoopRetries|When searching silently for a valid host, maximum number of connection attempts.<br/>This differ from "retriesAllDown" parameter, because this silent search is for example used after a disconnection of a slave connection when using the master connection.<br/>*Default: 120. Since 1.2.0*|
|validConnectionTimeout|With multiple hosts, after this time in seconds has elapsed it’s verified that the connections haven’t been lost.<br/>When 0, no verification will be done.<br/>*Default:120 seconds. Since 1.2.0*|
|loadBalanceBlacklistTimeout|When a connection fails, this host will be blacklisted during the "loadBalanceBlacklistTimeout" amount of time.<br/>When connecting to a host, the driver will try to connect to a host in the list of not blacklisted hosts and after that only on blacklisted ones if none has been found before that.<br/>This blacklist is shared inside the classloader.<br/>*Default: 50 seconds. Since 1.2.0*|
|assureReadOnly|If true, in high availability, and switching to a read-only host, assure that this host is in read-only mode by setting session read-only.<br/>Default to false.<br/>*Default: 50 seconds. Since 1.3.0*|
|assureReadOnly|If true, in high availability, and switching to a read-only host, assure that this host is in read-only mode by setting session read-only.<br/>*Default to false.<br/> Since 1.3.0*|



Expand Down
2 changes: 1 addition & 1 deletion documentation/Use-MariaDB-Connector-j-driver.md
Original file line number Diff line number Diff line change
Expand Up @@ -134,7 +134,7 @@ eliminates concerns about SELECT privileges on the

### Optional JDBC classes
Following optional interfaces are implemented by the
org.mariadb.jdbc.MySQLDataSource class : javax.sql.DataSource,
org.mariadb.jdbc.MariaDbDataSource class : javax.sql.DataSource,
javax.sql.ConnectionPoolDataSource, javax.sql.XADataSource

## Usage examples
Expand Down

0 comments on commit 226ce60

Please sign in to comment.