Hiperspace.SQL
2.5.2
Prefix Reserved
See the version list below for details.
dotnet add package Hiperspace.SQL --version 2.5.2
NuGet\Install-Package Hiperspace.SQL -Version 2.5.2
<PackageReference Include="Hiperspace.SQL" Version="2.5.2" />
<PackageVersion Include="Hiperspace.SQL" Version="2.5.2" />
<PackageReference Include="Hiperspace.SQL" />
paket add Hiperspace.SQL --version 2.5.2
#r "nuget: Hiperspace.SQL, 2.5.2"
#:package Hiperspace.SQL@2.5.2
#addin nuget:?package=Hiperspace.SQL&version=2.5.2
#tool nuget:?package=Hiperspace.SQL&version=2.5.2
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 | Versions 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. |
-
net8.0
- FSharp.Core (>= 9.0.303)
- FsLexYacc (>= 11.3.0)
- FsLexYacc.Runtime (>= 11.3.0)
- HiLang (>= 2.5.2)
- Hiperspace (>= 2.5.2)
- Microsoft.Bcl.HashCode (>= 6.0.0)
- Microsoft.CodeAnalysis (>= 4.14.0)
- Microsoft.CodeAnalysis.Analyzers (>= 4.14.0)
- Microsoft.CodeAnalysis.CSharp (>= 4.14.0)
- Parquet.Net (>= 5.2.0)
- protobuf-net.Core (>= 3.2.56)
- System.CodeDom (>= 9.0.10)
- System.Text.Json (>= 9.0.10)
-
net9.0
- FSharp.Core (>= 9.0.303)
- FsLexYacc (>= 11.3.0)
- FsLexYacc.Runtime (>= 11.3.0)
- HiLang (>= 2.5.2)
- Hiperspace (>= 2.5.2)
- Microsoft.Bcl.HashCode (>= 6.0.0)
- Microsoft.CodeAnalysis (>= 4.14.0)
- Microsoft.CodeAnalysis.Analyzers (>= 4.14.0)
- Microsoft.CodeAnalysis.CSharp (>= 4.14.0)
- Parquet.Net (>= 5.2.0)
- protobuf-net.Core (>= 3.2.56)
- System.CodeDom (>= 9.0.10)
- System.Text.Json (>= 9.0.10)
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.21 | 373 | 12/10/2025 |
| 2.5.18 | 650 | 12/3/2025 |
| 2.5.8 | 155 | 11/15/2025 |
| 2.5.2 | 181 | 11/6/2025 |
| 2.5.0 | 171 | 10/20/2025 |
| 2.4.6 | 179 | 9/23/2025 |
| 2.4.4 | 255 | 8/7/2025 |
| 2.4.2 | 144 | 7/28/2025 |
| 2.4.0 | 175 | 7/10/2025 |
| 2.3.8 | 165 | 7/1/2025 |
| 2.3.4 | 166 | 6/5/2025 |
| 2.2.2 | 183 | 5/5/2025 |
| 2.2.1 | 235 | 4/14/2025 |
| 2.2.0 | 118 | 3/29/2025 |
| 2.1.9 | 252 | 3/5/2025 |
| 2.1.6 | 149 | 2/15/2025 |
| 2.0.0 | 121 | 1/14/2025 |
| 1.0.5 | 141 | 11/15/2024 |
| 1.0.2 | 143 | 11/1/2024 |
| 1.0.1 | 181 | 10/18/2024 |
https://www.cepheis.com/hiperspace/20251106
## Overview
This release builds on the functionality provided by **message** to execute queries on a remote **Hiperspace.DB** and return the full set of *elements* back to a client without the need to return every intermediate object necessary. The prime example is the **Hiperspace.DB** opening page, which displays a summary bar-graphs of the number of **nodes** and **edges** in each database, and validates that *changes* to the (compiled) schema for databases does not change the definition of an already stored *element set.*
The *graph-view* functionality of **Hiperspace.DB** uses `HiperEdge` functions to recursively search (*in parallel*) all `Node` types that satisfy the view criteria and display as a navigable [SVG](https://en.wikipedia.org/wiki/SVG) graph of connections. These capabilities use the [`GraphFunctions`](https://github.com/channell/Hiperspace/blob/master/src/Hiperspace/Graph/GraphFunctions.cs) to search Nodes using message-keys *sent* to teh server and message-value *provided* on completion together with rendering information for `Node` *shapes* and *color*.
To support these use-cases, a couple of enhancements have been added to [Hiperspace](Hiperspace) and [HiLang](HiLang) to better support the functions.
### SubSpace
`IServiceProvider` is an interface on the .NET Platform to inject *Services* into components ([IoC](https://en.wikipedia.org/wiki/Inversion_of_control)) at runtime. A ServiceProvider property has been added to `SubSpace` to enable messages to enlist functionality when a message is received, and a parameter added to `SubSpaceParameters` for *domain space* construction.
`FindPaths` and `FindPathsAsync` functions now have *domain-specific* implementations that use a ***message*** to transmit the call through to a server where the parallel recursive search can be efficiently executed close the data, using many of the cores of the server.
### Node
The `Node` element has been extended to include additional functions that provide `HiperEdge` search for related nodes across transitive edges
|Name| Description |
|-|-|-|-|-|
| HiperEdges|Treat the TypeName parameter as a HiperEdge and find all matching|
| HiperEdgesAsync|as above, but non-blocking (especially for Blazor web clients)|
```
/// <summary>
/// Treat the Edges of TypeName as a HiperEdge and find all transitive paths for that type
/// </summary>
/// <param name="TypeName">The Edge type name</param>
/// <param name="length">the maximum length of the path</param>
/// <param name="targets">only return HiperEdges that end with a Node of the type matching one of these types</param>
/// <returns>The full set of HiperEdges for this path</returns>
public HashSet<HiperEdge> HiperEdges(string TypeName, int? length = null, HashSet<string>? targets = null)
/// <summary>
/// Create an inline HiperName from TypeNames and find all transitive paths for that type
/// </summary>
/// <param name="HiperName">The name of the HiperEdge being infered from the Edge TyopeNames</param>
/// <param name="TypeNames">the set of Edge TypeNames that make up this HiperEdge</param>
/// <param name="length">the maximum length of the path</param>
/// <param name="targets">only return HiperEdges that end with a Node of the type matching one of these types</param>
/// <returns>The full set of HiperEdges for this path</returns>
public HashSet<HiperEdge> HiperEdges(string HiperName, IEnumerable<string> TypeNames, int? length = null, HashSet<string>? targets = null)
/// <summary>
/// Treat the Edges of TypeName as a HiperEdge and find all transitive paths for that type
/// </summary>
/// <param name="TypeName">the name given to this transitative hiperedge</param>
/// <param name="rules">the set of meta edges (start-node type, end-node type, edge type) rules that define the transitative path</param>
/// <param name="length">the maximum length of the path</param>
/// <param name="targets">only return HiperEdges that end with a Node of the type matching one of these types</param>
/// <returns>The full set of HiperEdges for this path</returns>
public HashSet<HiperEdge> HiperEdges(string TypeName, HashSet<Rule> rules, int? length = null, HashSet<string>? targets = null)
/// <summary>
/// Treat the Edges of TypeName as a HiperEdge and find all transitive paths for that type
/// </summary>
/// <param name="TypeName">The Edge type name</param>
/// <param name="length">the maximum length of the path</param>
/// <param name="targets">only return HiperEdges that end with a Node of the type matching one of these types</param>
/// <returns>The full set of HiperEdges for this path</returns>
public async Task<HashSet<Graph.HiperEdge>> HiperEdgesAsync(string TypeName, int? length = null, HashSet<string>? targets = null, CancellationToken cancellationToken = default)
/// <summary>
/// Create an inline HiperName from TypeNames and find all transitive paths for that type
/// </summary>
/// <param name="HiperName">The name of the HiperEdge being infered from the Edge TyopeNames</param>
/// <param name="TypeNames">the set of Edge TypeNames that make up this HiperEdge</param>
/// <param name="length">the maximum length of the path</param>
/// <param name="targets">only return HiperEdges that end with a Node of the type matching one of these types</param>
/// <returns>The full set of HiperEdges for this path</returns>
public async Task<HashSet<HiperEdge>> HiperEdgesAsync(string HiperName, IEnumerable<string> TypeNames, int? length = null, HashSet<string>? targets = null, CancellationToken cancellationToken = default)
/// <summary>
/// Treat the Edges of TypeName as a HiperEdge and find all transitive paths for that type
/// </summary>
/// <param name="TypeName">the name given to this transitative hiperedge</param>
/// <param name="rules">the set of meta edges (start-node type, end-node type, edge type) rules that define the transitative path</param>
/// <param name="length">the maximum length of the path</param>
/// <param name="targets">only return HiperEdges that end with a Node of the type matching one of these types</param>
/// <returns>The full set of HiperEdges for this path</returns>
public async Task<HashSet<Graph.HiperEdge>> HiperEdgesAsync(string TypeName, HashSet<Rule> rules, int? length = null, HashSet<string>? targets = null, CancellationToken cancellationToken = default)
```
The [Test cases](https://github.com/channell/Hiperspace/blob/master/examples/CousinProblem/Test.cs) demonstrate the use of these functions to provide *server-side* search for relations. The first example treats "Child" as a transitive `HiperEdge`, while the second infers an "Ancestors" `HiperEdge` from either *Mother* or *Father*.
```
var descendants = node.HiperEdges("Child");
var ancestors = node.HiperEdges("Ancestors", new[] {"Mother", "Father" });
```