Skip to content

Commit

Permalink
Merge pull request #2 from Serdaro/install-upgrade
Browse files Browse the repository at this point in the history
Draft of installation and upgrading content.
  • Loading branch information
Serdaro authored Dec 18, 2022
2 parents 4558580 + 4927c20 commit 02f3321
Show file tree
Hide file tree
Showing 6 changed files with 103 additions and 1 deletion.
9 changes: 8 additions & 1 deletion docs/modules/ROOT/nav.adoc
Original file line number Diff line number Diff line change
@@ -1 +1,8 @@
* xref:index.adoc[]

* xref:install.adoc[]
* xref:upgrade.adoc[]
* xref:security.adoc[]
. Release Notes
* xref:release-notes:releases.adoc[Releases]
** xref:release-notes:5-2-0.adoc[5.2.0]
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>
----
--
====

6 changes: 6 additions & 0 deletions docs/modules/ROOT/pages/security.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
= Securing the Connection

You can use TLS/SSL to secure the communication between the JDBC driver and the cluster.
TLS/SSL must be enabled and configured both on the driver and cluster sides.

See xref:configuration.adoc#ssl-prop[TLS/SSL Properties] for the descriptions of the JDBC driver configuration elements, and xref:hazelcast:security:tls-ssl.adoc[TLS/SSL for Members] to configure the cluster side.
7 changes: 7 additions & 0 deletions docs/modules/ROOT/pages/upgrade.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
= Upgrading the Hazelcast JDBC Driver

To upgrade to the latest version, reinstall the Hazelcast JDBC Driver after each new release.

For a Maven project, see xref:install.adoc#maven[how to install using Maven].

If you are using the driver for some UI tools to connect to a database such as Tableau or DBeaver, see xref:install.adoc#binary[how to install by downloading the JAR file manually].
13 changes: 13 additions & 0 deletions docs/modules/release-notes/pages/5-2-0.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
= 5.2.0 Release Notes

== New Features

* Added support of resubmitting queries after member failures.
https://github.com/hazelcast/hazelcast-jdbc/pull/185[#185]
* Added support of basic database metadata.
https://github.com/hazelcast/hazelcast-jdbc/pull/170[#170]

== Fixes

* Fixed an issue where queries resulted in nulls for some fields.
https://github.com/hazelcast/hazelcast-jdbc/pull/184[#184]
3 changes: 3 additions & 0 deletions docs/modules/release-notes/pages/releases.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
= Hazelcast JDBC Driver {page-component-version}.X Releases

* xref:5-2-0.adoc[5.2.0]

0 comments on commit 02f3321

Please sign in to comment.