Skip to content

Commit

Permalink
Draft of installation and upgrading content.
Browse files Browse the repository at this point in the history
  • Loading branch information
Serdaro committed Nov 7, 2022
1 parent 4558580 commit 27a12cf
Show file tree
Hide file tree
Showing 4 changed files with 77 additions and 1 deletion.
5 changes: 4 additions & 1 deletion docs/modules/ROOT/nav.adoc
Original file line number Diff line number Diff line change
@@ -1 +1,4 @@
* xref:index.adoc[]

* xref:install.adoc[]
* xref:upgrade.adoc[]
* xref:security.adoc[]
66 changes: 66 additions & 0 deletions docs/modules/ROOT/pages/install.adoc
Original file line number Diff line number Diff line change
@@ -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+"]
----
<dependency>
<groupId>com.hazelcast</groupId>
<artifactId>hazelcast-jdbc</artifactId>
<version>{full-version}/version>
</dependency>
----
--
Snapshot Versions::
+
--
You can always download the latest development build by adding the snapshot repository:
[source,xml]
----
<repository>
<id>snapshot-repository</id>
<name>Maven2 Snapshot Repository</name>
<url>https://oss.sonatype.org/content/repositories/snapshots</url>
</repository>
----
And the dependency:
[source,xml]
----
<dependency>
<groupId>com.hazelcast</groupId>
<artifactId>hazelcast-jdbc</artifactId>
<version>5.3-SNAPSHOT</version>
</dependency>
----
--
====

2 changes: 2 additions & 0 deletions docs/modules/ROOT/pages/security.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
= Hazelcast JDBC Driver
:description:
5 changes: 5 additions & 0 deletions docs/modules/ROOT/pages/upgrade.adoc
Original file line number Diff line number Diff line change
@@ -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.

0 comments on commit 27a12cf

Please sign in to comment.