diff --git a/docs/modules/ROOT/nav.adoc b/docs/modules/ROOT/nav.adoc index f74eadc..75d5dc8 100644 --- a/docs/modules/ROOT/nav.adoc +++ b/docs/modules/ROOT/nav.adoc @@ -1 +1,4 @@ -* xref:index.adoc[] \ No newline at end of file + +* xref:install.adoc[] +* xref:upgrade.adoc[] +* xref:security.adoc[] \ No newline at end of file diff --git a/docs/modules/ROOT/pages/install.adoc b/docs/modules/ROOT/pages/install.adoc new file mode 100644 index 0000000..9e7099f --- /dev/null +++ b/docs/modules/ROOT/pages/install.adoc @@ -0,0 +1,66 @@ += Installing the Hazelcast JDBC Driver + +You can install the Hazelcast JDBC driver using one of the following: + +* Downloading the binary +* Maven + +== Binary + +You can download the driver's JAR file manually from the https://github.com/hazelcast/hazelcast-jdbc/releases[releases page] to be used +as a library in your projects. + +Once downloaded, you can either: + +* put the JAR file to the directory as required by the database administration tool and frameworks you use or, +* set the classpath pointing to the directory containing the JAR file. + +Regardless of which option you use to download, the implementation class of the driver (`com.hazelcast.jdbc.Driver`) automatically registers itself. + +== Maven + +You can download the Hazelcast JDBC driver using Maven by adding the following to the `pom.xml` of your project. + +[tabs] +==== +Stable Versions:: ++ +-- +[source,xml,subs="attributes+"] +---- + + com.hazelcast + hazelcast-jdbc + {full-version}/version> + +---- +-- + +Snapshot Versions:: ++ +-- + +You can always download the latest development build by adding the snapshot repository: + +[source,xml] +---- + + snapshot-repository + Maven2 Snapshot Repository + https://oss.sonatype.org/content/repositories/snapshots + +---- + +And the dependency: + +[source,xml] +---- + + com.hazelcast + hazelcast-jdbc + 5.3-SNAPSHOT + +---- +-- +==== + diff --git a/docs/modules/ROOT/pages/security.adoc b/docs/modules/ROOT/pages/security.adoc new file mode 100644 index 0000000..2ada08c --- /dev/null +++ b/docs/modules/ROOT/pages/security.adoc @@ -0,0 +1,2 @@ += Hazelcast JDBC Driver +:description: \ No newline at end of file diff --git a/docs/modules/ROOT/pages/upgrade.adoc b/docs/modules/ROOT/pages/upgrade.adoc new file mode 100644 index 0000000..f295cb6 --- /dev/null +++ b/docs/modules/ROOT/pages/upgrade.adoc @@ -0,0 +1,5 @@ += Upgrading the Hazelcast JDBC Driver + +To upgrade to the latest version, reinstall the Hazelcast JDBC Driver after each new release. + +See xref:install.adoc[Installing the Hazelcast JDBC Driver] to see the installation options. \ No newline at end of file