Hiperspace.SQL
2.3.8
dotnet add package Hiperspace.SQL --version 2.3.8
NuGet\Install-Package Hiperspace.SQL -Version 2.3.8
<PackageReference Include="Hiperspace.SQL" Version="2.3.8" />
<PackageVersion Include="Hiperspace.SQL" Version="2.3.8" />
<PackageReference Include="Hiperspace.SQL" />
paket add Hiperspace.SQL --version 2.3.8
#r "nuget: Hiperspace.SQL, 2.3.8"
#addin nuget:?package=Hiperspace.SQL&version=2.3.8
#tool nuget:?package=Hiperspace.SQL&version=2.3.8
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.300)
- FsLexYacc (>= 11.3.0)
- FsLexYacc.Runtime (>= 11.3.0)
- HiLang (>= 2.3.7)
- Hiperspace (>= 2.3.8)
- 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.1.1)
- protobuf-net.Core (>= 3.2.52)
- System.CodeDom (>= 9.0.6)
- System.Numerics.Tensors (>= 9.0.5)
- System.Text.Json (>= 9.0.6)
-
net9.0
- FSharp.Core (>= 9.0.300)
- FsLexYacc (>= 11.3.0)
- FsLexYacc.Runtime (>= 11.3.0)
- HiLang (>= 2.3.7)
- Hiperspace (>= 2.3.8)
- 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.1.1)
- protobuf-net.Core (>= 3.2.52)
- System.CodeDom (>= 9.0.6)
- System.Numerics.Tensors (>= 9.0.5)
- System.Text.Json (>= 9.0.6)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.
## Overview
This release adds the **@CubeExtent** property for post-aggregation calcualted properties of *HiperCubes*.
For the Cube fact
```
@DeltaIndex, CubeFact
segment Account.Transaction : Versioned
(
"when the transaction was authorised"
At : DateTime
)
{
"average amount"
@CubeMeasure(Aggregate.Average)
Amount : Decimal
};
```
Amount is transformed in observations
| Properrty | Name| Expression |
|-|-|-|
| @CubeMeasure(Aggregate.AverageTotal) | Amount_Sum||
| @CubeExtent | Amount|Amount2_Sum / this.Facts|
### CubeExtent language support
The `CubeExtent` property has been added to the **HiLang** schema language to support complex aggregation of quantitative observations for {*PFE*, *RWA*, etc} aggregation without the ned for additional support in the `Hiperspace.DB` aggregation service