Skip to content
SoftClient4ES Logo SoftClient4ES

Quick Start

Get started with SoftClient4ES in minutes. Choose your preferred method.

Option 1: Install the REPL Client

Linux / macOS:

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

Windows (PowerShell):

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

Connect to your cluster:

Terminal window
softclient4es --host localhost --port 9200

Option 2: SBT Dependency (Scala)

Add to your build.sbt:

// Core SQL engine
libraryDependencies += "app.softnetwork.elastic" %% "softclient4es8-java-client" % "0.19.2"

Resolvers:

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

Your First Queries

Once connected, try these SQL commands:

-- Show existing indexes
SHOW TABLES;


-- Create a table
CREATE TABLE demo (
  id KEYWORD,
  name TEXT,
  age INTEGER,
  PRIMARY KEY (id)
);


-- Insert data
INSERT INTO demo (id, name, age) VALUES ('1', 'Alice', 30);
INSERT INTO demo (id, name, age) VALUES ('2', 'Bob', 25);


-- Query
SELECT * FROM demo WHERE age > 20 ORDER BY name;


-- Describe the schema
DESCRIBE TABLE demo;


-- Clean up
DROP TABLE demo;

Next Steps