Uploading Data

Data can be uploaded in batches or as single documents.

Uploading a Single Document

To upload a document into a Collection –

Hyperspace documents must be of type dictionary.

Use the following to upload a a batch of documents –

Use the following to upload a single document –

hyperspace_client.add_document(document, collection_name)

Python

document = {"title": "star wars", 
            "genres": ["Action","Adventure","Sc-ifi"],
            "embedded_description" = [0.01,0.003,...]}
              
hyperspace_client.add_document(document, collection_name)              

Java

Document document = new Document();
document.putAdditionalProperty("title", "star wars");
document.putAdditionalProperty("genres", ["Action","Adventure","Sc-ifi"]);
document.putAdditionalProperty("embedded_description", [0.01,0.003,...])

hyperspaceClient.updateDocument(collectionName, doc, true, false);

JavaScript

const document = {"title": "star wars", 
                "genres": ["Action","Adventure","Sc-ifi"],
                "embedded_description" = [0.01,0.003,...]};
              
hyperspaceClient.addDocument(document, collection_name);

Where –

• document – Contains the data to be uploaded in the structure specified in the data schema configuration file.

• collection_name – Specifies the name of the Collection into which to load the document.

Uploading a Batch of Documents

Data can be uploaded in batches by conversion of the documents to a document object before uploading. The basic data point object for the Hyperspace database is a structure of python dictionaries.

To upload a batch of documents into a Collection –

We recommend that you upload data to a Collection in batches of many documents each, which has the structure specified in the data schema configuration file.

The following code snippet builds a list of documents in a temporary variable named batch and then uploads each batch using –

Python

hyperspace_client.add_batch(batch, collection_name)

Java

hyperspaceClient.addBatch(batch, collectionName);

JavaScript

hyperspaceClient.addBatch(batch, collectionName);

The following example builds batches of 250 random documents for Hybrid Search. Each time it creates a random document, it loads it into a batch and then uploads the batch. Once a batch reaches 250 documents, it's uploaded to the Hyperspace Collection. Replace the yellow highlighted line below with code that retrieves the next document to be uploaded.

Copy the following code snippet -

Python

BATCH_SIZE = 250
batch = []

for i, data_point in enumerate(documents):
   batch.append(data_point)
   if (i+1) % BATCH_SIZE == 0:
      response = hyperspace_client.add_batch(batch, collection_name)
      print(i + 1, response)
      batch.clear()
if batch:
  response = hyperspace_client.add_batch(batch, collection_name)
  hyperspace_client.commit(collection_name)

Java

import java.util.ArrayList;
final int batchSize = 250;

for (int i= 0; index < documents.size(); i++) {
    batch.add(documents.get(i));
    if ((i+ 1) % batchSize == 0) {
          List<DataPoint> batchCopy = new ArrayList<>(batch);
          futures.add(hyperspaceClient.addBatch(batchCopy, collectionName));
          batch.clear();
      }    
}

if (!batch.isEmpty()) {
    futures.add(hyperspaceClient.addBatch(new ArrayList<>(batch), collectionName));
}
CompletableFuture.allOf(futures.toArray(new CompletableFuture[0])).join();
hyperspaceClient.commit(collectionName).join();

JavaScript

const batchSize = 250;
let batch = [];

documents.forEach((dataPoint, index) => {
    batch.push(dataPoint);
    if ((index + 1) % batchSize === 0) {
        await hyperspaceClient.addBatch(batch, collectionName);
        batch = [];
    }
});

if (batch.length > 0) {
    await hyperspaceClient.addBatch(collectionName, documents)
};
hyperspaceClient.commit(collectionName);

In the above example, Hyperspace will assign the each document with a random id. If you want to manually assign id , each document must include an id type field, as explained in Database schema config file. The id must be of type keyword/string.

At the moment, it is not possible to upload additional documents after commit. This will be changed in next versions.