Hiperspace.SQL 2.4.2

There is a newer version of this package available.
See the version list below for details.
dotnet add package Hiperspace.SQL --version 2.4.2
                    
NuGet\Install-Package Hiperspace.SQL -Version 2.4.2
                    
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.4.2" />
                    
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="Hiperspace.SQL" Version="2.4.2" />
                    
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.4.2
                    
#r "nuget: Hiperspace.SQL, 2.4.2"
                    
#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.4.2
                    
#: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.4.2
                    
Install as a Cake Addin
#tool nuget:?package=Hiperspace.SQL&version=2.4.2
                    
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;

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 a 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 a n 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 was computed.  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.4.4 163 8/7/2025
2.4.2 90 7/28/2025
2.4.0 136 7/10/2025
2.3.8 125 7/1/2025
2.3.4 139 6/5/2025
2.2.2 149 5/5/2025
2.2.1 212 4/14/2025
2.2.0 96 3/29/2025
2.1.9 219 3/5/2025
2.1.6 116 2/15/2025
2.0.0 72 1/14/2025
1.0.5 120 11/15/2024
1.0.2 109 11/1/2024
1.0.1 157 10/18/2024

https://www.cepheis.com/hiperspace/20250728
## Overview

This release changes the way the horizons are selected for domain subspaces to allow for streamlines application of constrains.  Horizons performed two roles within hyperspace. To apply constraints that apply to a model and to filter content that should not be visible to a community of users:

* Constraint horizon include mandatory fields and referential integrity.  They are configurable (*optional*) so that a separate definitions are not needed for logging error.  traditional best-practice is to catch any validation or reference constraint errors and log the source message (*normally JSON or XML text*) to a seperate store for investingation by 3rd line support.  With Hiperspace there are two options: use the same schema, but a separate hiperspace that does not apply constraints, or hide the stored until the referenced element is available.
* Visibility horizons *hide* data from retrieval - the best example is the **Deleted** pattern that *appears* to remove data from the subspace, but still available to historical versions before the *delete*

Typically, the choice of which constraints to apply is driven by the `ContextLabel` for seperate domains (e.g. independent price verification, or approval)  or using `UserLabel` to apply permission using role-based access control.  The internal `Horizon[]?` array has been changed to an overridable property that can be customized for the domain.

### SubSpaceParameters
This structure enabled all SubSpace properties to be set in the construction of a domain `SubSpace`, and available to the construction of each `SetSpace` for domain elements.

```
/// <summary>
/// Represents the traits of a subspace, including filters, versioning, and security labels.
/// </summary>
/// <remarks>
/// Provides a generic initialisation of the subspace when dynamically Instantiated.   
/// </remarks>
public struct SubSpaceParameters
{
   /// <summary>
   /// The HiperSpace that provides storage services to this SubSpace
   /// </summary>
   public HiperSpace Space;
   /// <summary>
   /// Horizon filters for the subspace <see cref="Horizon" />
   /// </summary>
   public Horizon[]? Horizon;
   /// <summary>
   /// The version of the subspace, used to determine if the subspace is up to date
   /// </summary>
   public DateTime? AsAt;
   /// <summary>
   /// The delta from which the subspace was created, used to determine if the subspace is up to date
   /// </summary>
   public DateTime? DeltaFrom;
   /// <summary>
   /// Label applied to the subspace for security verification in Horizon filters
   /// </summary>
   public string? ContextLabel;
   /// <summary>
   /// Label applied to the subspace for fine grained access control
   /// </summary>
   public IPrincipal? UserLabel;
   /// <summary>
   /// Was the subspace opened by a remote client, and need to have Horizon security re-applied
   /// </summary>
   public bool RemoteLabel;
}
```

The primary motive for this change is to support `Hiperspace.DB` streaming aggregation, which takes the `ContextLabel` from configuration and used `AsAt` parameters for *time-travel/temporal* views to calculate a Cube *delta* for the *facts* that have changed in the last few seconds.

### MetaModelException
Hiperspace uses the rule that #id aliases can never change once they have been opened with a durable Hiperspace.  This release add an explanatory exception to guide the resolution of any incompatible changes.  Consider the examples of `Quantity : Int32 #5` that need to change to a Decimal but triggers a `MetaModelException` of changed to `Quantity : Decimal #5`.  This can be accomplished with `{ Quantity_V1 : Int32 #5, Quantity_V2 : Decimal #6 } [Quantity = Quantity_V2 = null ?  Quantity_V1 :  Quantity_V2]` for compatible access with both versions, or `Quantity : Decimal #6` after a data migration update.

## HiLang
The Private Space Language parser has been updated to generate the additional `SubSpaceParameters` constructor.

The code generator has also been updated to order view extensions to avoid the need order specific coding, and add a validation rule that elements that provide `HiperEdge` view must also provide `Edge` view.

The [TOGAF Sample](https://github.com/channell/Hiperspace/blob/master/examples/TOGAF/TOGAF.hilang) now includes *bi-directional Edges* in the patterm
```
/* another Edge that inherits from Edge and can be viewed as an Edge */
view Edge_ : Edge = Edge();

"Pair of edges between nodes"
view Edges
   = Edge  (From = From, To = To, Name = Name, TypeName = FromTypeName),
     Edge_ (From = To, To = From, Name = Name, TypeName = ToTypeName)
(
   From            : Node      #2,
   To              : Node      #3,
   FromTypeName    : String    #4,
   ToTypeName      : String    #5
)
{
   Name        : String    #6,
};

entity Togaf.Business.Driver : Togaf.General.Base
   = Node        ( SKey = SKey, Name = Name, TypeName = "AF-Driver"),    
     Edges       ( From = this, To = MotivatedBy, FromTypeName = "AF-Driver-Organization", ToTypeName = "AF-Organization-Driver") #76
{
   MotivatedBy     : Togaf.Organization #5
}
```
The *Togaf Business Driver* provides an directed *Edge* to *Togaf Organization* that it is *Motivated By* **and**  directed *Edge* from  *Togaf Organization*  to *Togaf Business Driver*.

## RockSpace
The [Hiperspace.Rocks](Hiperspace.Rocks) driver has been updated to raise ` MetaModelException` if an incompatible change has been made to the schema model.

[Hiperspace.Rocks](Hiperspace.Rocks) has also been updated to [RocksDB](https://rocksdb.org/) version 10.