Introduction

About this document

This is the complete User Manual for Sparksee graph database which covers all the technical details relating to Sparksee, so it should be the go-to document for any doubts regarding this graph database. It has been divided into the following chapters & sections:

• Introduction

  This chapter includes notation convention, license details and support information.

• Graph Database

  This is an introductory chapter providing general graph database concepts and specific Sparksee graph database definitions.

• Installation

  This chapter explains how to install Sparksee in order to use is it as an embedded database in applications.

• API

  In this chapter developers learn how to use Sparksee APIs, with explanations and examples of all the functionalities.

• Configuration

  This chapter explains how to configure Sparksee, including how to monitorize the system, help with the deployment of applications and memory tuning.

• Scripting

  Information on the use of scripts to create a graph schema and loading data into the graph is available in this chapter.

• High availability

  This chapter explains every detail of this functionality that allows using Sparksee replicated.

• Maintenance and monitoring

  This chapter covers specific information about how to use Sparksee tools to monitorize and maintain the DB.

• Third-party tools

  This chapter reveals some tricks for using the Blueprints interface, and links to other third-party APIs.

This document is addressed to architects and developers.

The Sparksee manual is not intended to be followed as a tutorial document: examples are solely created to help understand the concepts explained. Every chapter may be consulted independently of the others, so the reader may hop directly to the chapter and section of interest.

Check other support documents for different approaches to learning how to use Sparksee graph database.

Notation

Please consider the following notation convention assumed for this document:

• This is a Java code-block example:

  [Java]

  // Java code-block

• This is a C# code-block example:

  [C#]

  // C# code-block

• This is a C++ code-block example:

  [C++]

  // C++ code-block

• This is a Python code-block example:

  [Python]

  # Python code-block

• This is an Objective-C code-block example:

  [Objective-C]

  // Objective-C code-block

• This is the notation to refer a method from a class:

  ret class#method(type1 arg1, ...)

  Where:

  • ret is the return type of the method
  • class is the name of the class
  • method is the name of the method itself
  • type1 and arg1 are the type and name of the first argument respectively. When there is more than one argument, a comma-separated list of pair type-argument is given.

  The notation may be simplified by leaving out some parts of the full signature.

License

Sparksee is distributed under a proprietary license considering the following variables:

• Size of the graph

  The license recognizes XSMALL (up to 1M objects in a single graph), SMALL (up to 10M objects), MEDIUM (up to 100M objects), LARGE (up to 1B objects) or VERY LARGE (more than 1B objects) graphs.

• Number of concurrent sessions

  1 session for the free trial or UNLIMITED for the rest of licenses.

• HA functionality

  This can be enabled or disabled.

Sparsity Technologies offers the following license agreements for Sparksee:

• Free license

  Sparksee is free to use, in its XSMALL size, for non-commercial purposes. Download Sparksee from the download section of our website.

• Free commercial license

  Sparksee is free to use, in XSMALL size, for commercial purposes, but recognition is requested. Please contact us.

• Development license

  Sparsity Technologies may offer development licenses for any size free of charge to qualified companies. Please check if you are qualified by requesting your development license.

• Research license

  Sparsity encourages research by offering free licenses to PhD students, academics and other university staff, for non-commercial purposes. Please check if you are qualified by requesting your research license.

• Commercial license

  Sparksee Commercial license allows the software, implemented with Sparksee, to be used commercially with options for SME or Corporate. Check Sparksee price list for commercial purposes.

• Startup license

  This is a special license for those companies inside Sparksee’s partnership program. It includes a free development license (see conditions above) and a special commercial license. Please read the conditions and benefits of the Sparksee Partnership program.

Support

Sparksee technical support is offered online through the website in the documentation and support sections.

Documentation section

All the written information about Sparksee is available in this section. A developer will find the following relevant documents:

• Starting Guide

  Quick guide to building graphs with Sparksee. Includes sources of the examples ready to compile & run.

• User Manual

  What you are reading now is the complete manual for Sparksee. It should be the go-to document for everything regarding Sparksee.

• HA manual

  Separate manual for quick access to SparkseeHA’s information.

• Reference guides

  Reference programming guides for each Sparksee’s supported languages. They can be consulted online or offline (inside the Sparksee download).

In addition Sparksee documentation includes a brochure, presentations, tutorials and webinars, which are addressed to other stakeholders, such as CTOs and decision makers.

Support section

Our contact information can be found in the Developers page of the Sparsity Technologies web site.