Installation

SoftClient4ES supports multiple installation methods depending on your use case.

REPL Client (CLI)

The interactive SQL client for ad-hoc queries and exploration.

Linux / macOS:

curl -fsSL https://raw.githubusercontent.com/SOFTNETWORK-APP/SoftClient4ES/main/scripts/install.sh | bash

Windows (PowerShell):

irm https://raw.githubusercontent.com/SOFTNETWORK-APP/SoftClient4ES/main/scripts/install.ps1 | iex

Usage:

# Connect with defaults
softclient4es --host localhost --port 9200

# With authentication
softclient4es --host es.example.com --port 9200 --user elastic --password secret

# With SSL
softclient4es --host es.example.com --port 9243 --ssl

Scala Library (SBT)

Add the appropriate dependencies for your ES version:

resolvers += "Softnetwork" at "https://softnetwork.jfrog.io/artifactory/releases/"

Client Library Matrix

Elasticsearch	Artifact	Scala	JDK
6.x	`softclient4es6-jest-client`	2.12, 2.13	8+
6.x	`softclient4es6-rest-client`	2.12, 2.13	8+
7.x	`softclient4es7-rest-client`	2.12, 2.13	8+
8.x	`softclient4es8-java-client`	2.12, 2.13	8+
9.x	`softclient4es9-java-client`	2.13 only	17+

// Choose your Elasticsearch version
libraryDependencies += "app.softnetwork.elastic" %% "softclient4es8-java-client" % "0.19.2"

// Community extensions for materialized views (optional)
libraryDependencies += "app.softnetwork.elastic" %% "softclient4es-community-extensions" % "0.1.4"

JDBC Driver

Download the self-contained fat JAR for your Elasticsearch version:

Elasticsearch Version	Artifact
ES 6.x	`softclient4es6-jdbc-driver-0.1.4.jar`
ES 7.x	`softclient4es7-jdbc-driver-0.1.4.jar`
ES 8.x	`softclient4es8-jdbc-driver-0.1.4.jar`
ES 9.x	`softclient4es9-jdbc-driver-0.1.4.jar`

Connection details:

JDBC URL:      jdbc:elastic://localhost:9200
Driver class:  app.softnetwork.elastic.jdbc.ElasticDriver

The JDBC driver JARs are Scala-version-independent (no _2.12 or _2.13 suffix) and include all required dependencies.

Maven

<dependency>
  <groupId>app.softnetwork.elastic</groupId>
  <artifactId>softclient4es8-jdbc-driver</artifactId>
  <version>0.1.4</version>
</dependency>

Gradle

implementation 'app.softnetwork.elastic:softclient4es8-jdbc-driver:0.1.4'

sbt

libraryDependencies += "app.softnetwork.elastic" % "softclient4es8-jdbc-driver" % "0.1.4"

See the JDBC Integration Guide for BI tool setup instructions.

Arrow Flight SQL Server (Docker)

Run the Arrow Flight SQL server as a Docker container:

docker run -p 32010:32010 \
  -e ES_HOST=elasticsearch \
  -e ES_PORT=9200 \
  -e ES_USER=elastic \
  -e ES_PASSWORD=changeme \
  softnetwork/softclient4es8-arrow-flight-sql:latest

See the Arrow Flight SQL Guide for details.