Hiperspace.SQL 2.5.26

Prefix Reserved
.NET 8.0 This package targets .NET 8.0. The package is compatible with this framework or higher. 
dotnet add package Hiperspace.SQL --version 2.5.26
                    


                    

                
NuGet\Install-Package Hiperspace.SQL -Version 2.5.26
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package. 
<PackageReference Include="Hiperspace.SQL" Version="2.5.26" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
<PackageVersion Include="Hiperspace.SQL" Version="2.5.26" />
                    


                            Directory.Packages.props
                        

                    

                
<PackageReference Include="Hiperspace.SQL" />
                    


                            Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package. 
paket add Hiperspace.SQL --version 2.5.26
                    


                    

                
#r "nuget: Hiperspace.SQL, 2.5.26"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package. 
#:package Hiperspace.SQL@2.5.26
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package. 
#addin nuget:?package=Hiperspace.SQL&version=2.5.26
                    


                            Install as a Cake Addin
                        

                    

                
#tool nuget:?package=Hiperspace.SQL&version=2.5.26
                    


                            Install as a Cake Tool

Hiperspace.SQL

Hiperspace.SQL is a full SQL query engine for Hiperspace, supporting the full range of joins, aggregations, and subqueries.

Hiperspace.SQL provides the same query functionality as a .NET client can use with LINQ queries, but without the need to write code in C#/F#

Hiperspace fully supports point-in-time "time travel" queries that are not possible with Python Data-Frames or DuckDB

Features

  • Hiperspace.SQL is not limited to queries of columns within a table, but supports the full navigation of properties of Hiperspace elements
  • Where a column is a complex object, it is returned as a JSON object
  • Executing a batch of SQL statements return columnar data frames (dictionary of column-name and array of values)
  • Explain SQL returns the execution plan, detailing the SetSpaces accessed and keys used for search (Key, Index, Scan)
  • The Parquet method returns a Parquet file that can be used with any Apache Parquet library, or added to DuckDB OLAP store

Data Dictionary

SCHEMA_TABLE

Column Name Data Type Description
TABLE_NAME string The name of the table
TABLE_TYPE string The type of the table in SCHEMA_PROPERTY

SCHEMA_COLUMN

Column Name Data Type Description
TABLE_NAME string The name of the table
COLUMN_NAME string The name of the column
COLUMN_TYPE string The type of the table in SCHEMA_PROPERTY

SCHEMA_PROPERTY

Column Name Data Type Description
TYPE_NAME string The Type Name
PROPERTY_NAME string The name of each property
PROPERTY_TYPE string reference to SCHEMA_PROPERTY.TYPE_NAME

Examples

Simple query

SELECT p.Name, p.Gender FROM Persons as p WHERE p.Name = 'Lucy'

Query parameters

SELECT p.Name, p.Gender FROM Persons as p WHERE p.Name = :name

Query batches

SELECT p.Name, p.Gender FROM Persons as p WHERE p.Name = :name;
SELECT Name as name, Father as father from   Persons ;

Joins

SELECT  p.Name, f.Name as Father, f.Father as GrandFather
FROM    Persons as p 
join    Persons as f on p.Father.Name = f.Name
WHERE   p.Name = :name

Aggregates

select  p.Father.Name, count(p.Name) as Children
from    Persons as p
group by p.Father.Name as f
having count(*) > 1;

Like expressions

select  p.Father.Name, count(p.Name) as Children
from    Persons as p
where   Name like 'L%' and Name like '%y' or (Name like '%u%' and Name like '_uc_')
group by p.Father.Name as f
having count(*) > 1;

Null handling

select  p.Name, p.Father.Name
from    Persons as p
where   Name is not null

in query

SELECT p.Name, p.Gender 
FROM Persons as p 
WHERE p.Gender in (select p2.Gender from Persons as p2 where p2.Name = 'Lucy')

union

SELECT p.Name, p.Gender 
FROM Persons as p 
WHERE p.Name in ('Lucy', 'Mark')
union 
SELECT p.Name, p.Gender 
FROM Persons as p 
WHERE p.Name in ('Eve', 'Mary')

inline view

SELECT p.Name, p.Gender 
FROM Persons as p 
join (select p2.Gender from Persons as p2 where p2.Name = 'Lucy') as p3 on p.Gender = p3.Gender

dictionary query

select * from SCHEMA_TABLES;
select * from SCHEMA_COLUMNS;
select * from SCHEMA_PROPERTIES;

Hierarchy query

select  p.Name as Parent, c.Name as Child
from    Persons as p, p.MotherChild as c
where   p.Name = :name;

is equivalent to

select  p.Name as Parent, c.Name as Child
from    Persons as p JOIN Persons as c ON p.Name = c.Mother.Name
where   p.Name = :name;

since MotherChild is a set (of person) with each Person element, and any set can be joined with another set. In this case there is an implicit join between the set MotherChild and the Person p.

Graph

The Cousins example includes the property AllRelatives = allrelation(this) which uses the Cousins.Helper.AllRelations function to return the set of HiperEdge for all graph nodes that can be recursively found in Hiperspace for each person.

The following query finds all the relations for a person

select  p.Name as Person, 
        r.To.Name as Relation, 
        r.TypeName as Relationship,
        r.Length as Length,
        r.Width as Width
from    Persons as p,
        p.AllRelatives as r
where   p.Name = :name;

NB : There is no need to use a JOIN clause as p.AllRelatives includes the implicit join to Person.

the ability to navigate graph relationships is a unique feature of Hiperspace.SQL

API

The Hiperspace.SQL API can be called from any language that supports DOTNET interop, including Python (using pythonnet). Access via the Hiperspace.SQL.Engine object that is constructed with reference to any domain space.

Explain

Provides a detailed breakdown of the query execution plan

member engine.Explain (source, parameters : IDictionary<string,obj>) : string array =

Execute

Executes the SQL queries and returns an array of Data Frames

member engine.Execute (source , parameters : IDictionary<string,obj>) : IDictionary<string, obj array> array  =

Parquet

Executes the SQL queries will an array of filenames (one for each statement) and returns the filenames after writing the results to the Apache Parquet files.

member this.Parquet (source, fileNames, parameters : IDictionary<string,obj>): string array =
Product Compatible and additional computed target framework versions.
.NET net8.0 is compatible.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed.  net9.0 is compatible.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed.  net10.0 is compatible.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
2.5.26 76 12/21/2025
2.5.21 409 12/10/2025
2.5.18 656 12/3/2025
2.5.8 163 11/15/2025
2.5.2 191 11/6/2025
2.5.0 176 10/20/2025
2.4.6 183 9/23/2025
2.4.4 263 8/7/2025
2.4.2 150 7/28/2025
2.4.0 181 7/10/2025
2.3.8 172 7/1/2025
2.3.4 176 6/5/2025
2.2.2 191 5/5/2025
2.2.1 241 4/14/2025
2.2.0 127 3/29/2025
2.1.9 256 3/5/2025
2.1.6 155 2/15/2025
2.0.0 127 1/14/2025
1.0.5 145 11/15/2024
1.0.2 145 11/1/2024
1.0.1 188 10/18/2024

https://www.cepheis.com/hiperspace/20251221
# Overview
Change method signatures for Path functions to use Route instead of RouteMap for remote calls.

Add Session2 to Subspace to support time-travel sessions over a graph space to support partial refresh of GPU cache for GPU parallel search of Graph methods without the need for recursive cycle detection.


-----

## Sequence support
Sequence numbers are a relational database feature that has largely been replaced been replaced by [UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier) (*especially v7*) since they do not require a sequence source and can be allocated within a client, but they still have a use as an alternate key especially with [GPGPU](https://en.wikipedia.org/wiki/General-purpose_computing_on_graphics_processing_units) that need primitive points, *but do not wish to use the expense of mapping UUID to int128 values that may not be supported by the device*

**Hiperspace** implements *sequences* as unsigned 64-bit integers (*1 to 18,446,744,073,709,551,616*), and can be stored for any *element* key value

### Hiperspace

Added `UseSequenceAsync()` for driver implementation, together with proxy methods in {`BrowserSpace, FailoverSpace, GenerationSpace, PartitionSpace, SessionSpace`}

### Hiperspace.Heap
Implemented  `UseSequenceAsync()` in `Hiperspace.Heap` and added additional driver `CacheHeapSpace` for use by caches that do not require history to be maintained for elements. **CacheHeapSpace** should *only* be used by *caches* since it lacks the ability to reconcile concurrent changes through version inspection.

`LatestSpace` is replaced by `CacheHeapSpace` and will be removed in a future release.

### Hiperspace.Rocks
Implemented UseSequenceAsync()` in `Hiperspace.Rocks` and added additional driver `CacheRockSpace` for use by caches that do not require history to be maintained for elements. **CacheRockSpace** should *only* be used by *caches* since it lacks the ability to reconcile concurrent changes through version inspection.

The underlying RocksDB driver has been updated.

### SubSpace
`SubSpace` forwards the `UseSequenceAsync()` function to the underlying driver

### SetSpace
Added two functions to get a sequence counter from the driver:
* `GetSequenceAsync<TEntity>(TEntity? element)` to get the current sequence number associated with the domain key
* `UseSequenceAsync<TEntity>(TEntity? element)` to get a new  sequence number for the with the domain key

**NB** While the main use of Sequence numbers is to provide an alternate (*GPGPU friendly*) sequence number for a `Node`, it can be applied to any key value.
```
// get an order number that is unique within all orders
var orderNo = await space.Orders.UseSequenceAsync (new Order { });

// get a line number within the owning Order {1,2,3..}
var lineNo = await space.Lines.UseSequenceAsync (new Line { Order = order });
```

-----

### HiLang

Added code generation for the SubSpace methods.

-----

## OnInitialized
Addition of `virtual void OnInitialized()` function to SubSpace to allow domian subspaces to perform additional initialization after the Domain Space has been created by a generic container (e.g. **Hiperspace.DB**)