Hiperspace 2.4.0

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

Hiperspace

Hiperspace is an Object technology that uses a key-addressable store to expand an application data-model beyond the limits of memory that can be directly referenced in main memory.

Elements are not duplicated or changing to match database shapes.
Elements are serialized directly using Protocol Buffers to and from key/value structure for storage in memory stores including CXL expanded and pooled memory, shared cache , local SSD or key-value durable databases.
Elements that are not currently being used are released from main memory, and transparently (and quickly) reloaded when referenced. Memory stores allows petabytes of data to be addressed.

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 (3)

Showing the top 3 NuGet packages that depend on Hiperspace:

Package Downloads
Hiperspace.Rocks

HiperSpace RocksDB adaptor

Hiperspace.Heap

Hiperspace heap store for session, edge and testing purposes

Hiperspace.SQL

Package Description

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
2.5.35 23 2/27/2026
2.5.33 139 2/14/2026
2.5.32 145 1/30/2026
2.5.29 1,428 1/17/2026
2.5.28 3,106 12/31/2025
2.5.26 4,182 12/21/2025
2.5.21 6,349 12/10/2025
2.5.18 8,384 12/3/2025
2.5.13 7,899 11/24/2025
2.5.8 7,878 11/15/2025
2.5.2 7,915 11/6/2025
2.5.1 7,861 10/23/2025
2.5.0 7,902 10/20/2025
2.4.6 7,918 9/23/2025
2.4.4 7,965 8/7/2025
2.4.2 7,853 7/28/2025
2.4.0 7,903 7/10/2025
2.3.8 7,905 7/1/2025
2.3.7 7,892 6/18/2025
2.3.3 7,918 6/5/2025
Loading failed

## Overview

**Hiperspace** is uses [protobuf](https://protobuf.dev/) wire-format to serialise **elements** in the domain **SubSpace**
for peristence is a *key/value* *(primarilly [RocksDB](https://rocksdb.org/))* with *minimal* transformation, and no padding.

The schema can evolve without the need to alter an historically, using two rules:
* #id numeric aliases for {entities, segments, aspects, keys, values, indexes} are never reused
* The datatype of {keys, values} are never changed (*other than by renaming items*)


### MetaModel

The `MetaModel` contains a list of all the *Element* types stored within a Hiperspace and the data types of each *key*
and *value*.  The `MetaModel` is eternal - additional *Element* are added as tyhe schema changes, but never removed, to ensure that
older build can still read the data that they understand.

When a **Hiperspace** is opened, the domain `MetaModel` is compared with the `MetaModel` stored in the **Hiperspace** to ensure the
above rules have not been compromised.  All read and write after open uses the wire-format directly without transformation from store
through to client application (including browser web-assembly).

### MetaMap

To support range access, the bytes in wire-format for keys are reordered to place message lengths at the end of the `byte[]`
for each key.  This is especially important for *segments* (*where the parent knows only the `owner` part of the key, and *indexes*).

The `MetaMap` is an ordered array of #id and mapping of *key/value* #id to the element #id of references.  The `MetaMap` is coded
in the domain assembly.  This release adds the capability to remove key references without the need to crerate a new element type, by
regenerating the `MetaMap` from the `MetaModel` stored in **Hiperspace**.


### Change

This release changes the method signatures {`KeyPath`, `IndexPath`} to support a MetaMap built at load-time, and
adds additional abstract methods to the `Hiperspace` to load and merge `MetaModel`.

The `MetaModelException` exception type has been added to provide detailed diagnostics, if the `MetaModel` is not compatible.