Connecting to the Hyperspace Server

The following describes how to create a local instance of the Hyperspace client, which will enable you to connect to the database through the Hyperspace API. Hyperspace provides you with a username, password and the address of the cloud machine to which you will connect using the Hyperspace API.

To create a local instance of the Hyperspace client –

Copy the following code snippet to enable a connection to the database through the Hyperspace API.

Python

hyperspace_client = hyperspace.HyperspaceClientApi(host=host_address,
                                                   username=username,
                                                   password=password)

Java

import io.hyperspace.client.HyperspaceClient;
HyperspaceClient hyperspaceClient = new HyperspaceClient(host, username, password);

JavaScript

const hs = require('hyperspace-js')
const hyperspaceClient = new hs.HyperspaceClient(host_address, username, password); 

• Replace host_address with the address of the Hyperspace cloud machine that you will access. This will be provided to you by Hyperspace.

• Replace username and password with the user name and password provided to you by Hyperspace.

To check that the client is live, run the following command -

Python

print(hyperspace_client.collections_info())

Java

Object info = hyperspaceClient.collectionsInfo(); 
System.out.println(new Gson().toJson(info));

JavaScript

const { data } = await hyperspaceClient.info();
console.log(data);

A status message similar to the following should appear –

{'collections': {'qa_collection': {'creation_time': '2025-06-10T11:30:14Z', 'size': 29607}}}

If no status message appears, contact support for assistance.