Unified 1.0.6

.NET Standard 2.0
Install-Package Unified -Version 1.0.6
dotnet add package Unified --version 1.0.6
<PackageReference Include="Unified" Version="1.0.6" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Unified --version 1.0.6
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: Unified, 1.0.6"
#r directive can be used in F# Interactive, C# scripting and .NET Interactive. Copy this into the interactive tool or source code of the script to reference the package.
// Install Unified as a Cake Addin
#addin nuget:?package=Unified&version=1.0.6

// Install Unified as a Cake Tool
#tool nuget:?package=Unified&version=1.0.6
The NuGet Team does not provide support for this client. Please contact its maintainers for support.

Unified Id - the identity of your data.

Pull Requests Welcome Build Quality Gate Status NuGet

Why

What is Unified Id? If GUID is too heavy for your application but you need a random global Id that can be used as a string or long basic type, you are in right place.

What are the main advantages?

Feature Unified GUID
Size 8 byte (13 as string) 16 byte (36 as string)
Partitioning Build-in No, external can be added
Collisions 0.00000001% in 10B IDs 50% in 2.7e18 IDs
Cast implicit(string, ulong, long) explicit(byte[], Parse/ToString)
Generate Build-in(byte[], string, GUID) No, only random NewGuid
Null/Empty-handling Friendly as Empty Exception

Getting started

Install the NuGet package and write the following code:

using Unified;

class Program
{
    static void Main()
    {
        var id = UnifiedId.NewId(); // AFHUTVDSGUGVQ
    }
}

You have created your first Unified Id!

Want to use it as a string? string id = UnifiedId.NewId(); or long? long id = UnifiedId.NewId();

UnifiedId could be used as DDD ValueObject in your entities.

using Unified;

class User
{
    public UnifiedId UserId { set; get; }
}

class Program
{
    static void Main()
    {
        var user = new User
        {
            UserId = UnifiedId.NewId();
        };

        var settings = new JsonSerializerSettings // Could be added to global settings.
        { 
            Converters = new List<JsonConverter> 
            { 
                new UnifiedIdConverter() 
            }
        };
        var json = JsonConvert.SerializeObject(user, settings); // { "UserId": "AFHUTVDSGUGVQ" }
    }
}

How it works

using Unified;

class Program
{
    static void Main()
    {
        var guid = Guid.NewGuid();
        var id = UnifiedId.FromGuid(guid);
        var fnv = id.ToUInt64();
        Console.WriteLine($"{guid} => {fnv} => {id}");
        // 8dd02ad1-62cc-4015-9502-49658ba240ae => 15834445116674749764 => DNFPVU1LD2DA4
    }
}

Unified Id generates 64bit FNV-1a Id's based on GUID and converts it to HEX32 to use as string.

Algorithm

HEX32 is reversible, so you can convert it back from string to UInt64. ulong number = UnifiedId.Parse("DNFPVU1LD2DA4");

Why FNV-1a 64bit? because it has the best space randomization in the case of GUID conversion, below is space representation.

FNV-1a

Default method of generation is GUID based using method var id = UnifiedId.NewId();.

This value could be used as string converted in HEX32 consisting of two parts.

[KEY][UNIFIED_ID] KEY - Partition/Shard Key and UNIFIED_ID as Row Unified Key together used as the global identity.

You can also generate this Id as a one-way hash using the following sources:

  • UnifiedId FromGuid(Guid id)
  • UnifiedId FromBytes(byte[] bytes)
  • UnifiedId FromString(string text)
  • UnifiedId FromInt64(long number)
  • UnifiedId FromUInt64(ulong number)

Do you need sequential Id? var id = new UnifiedId(DateTime.UtcNow.Ticks)

Want to save partitioned data? It's easy...

using Unified;
using System;

class Program
{
    static void Main()
    {
        // Let's emulate the partitioned database.
        var db = new Dictionary<string, List<UnifiedId>>();

        // We will use 10M records, just to execute it fast.
        var all = 10000000; 
        for (var i = 0; i <= all; i++)
        {
            // Generate random Id.
            var id = UnifiedId.NewId();

            // Get it's partition key. Number of partitions could be customized, default 16K.
            var partition = id.PartitionKey();

            // Initialize partitions in your DB.
            if (!db.ContainsKey(partition))
            {
                db.Add(partition, new List<UnifiedId>());
            }

            // Add values to partitions.
            db[partition].Add(id);
        }
    }
}

Result:

DB Count             : 16384
Each item contain    : 610 elements +/-5%

We recommend using Unified Id for data sets size up to 10 billion Ids. More will increase the chance of collision.

© 2021 Serhii Seletskyi. All rights reserved.

Product Versions
.NET net5.0 net5.0-windows net6.0 net6.0-android net6.0-ios net6.0-maccatalyst net6.0-macos net6.0-tvos net6.0-windows
.NET Core netcoreapp2.0 netcoreapp2.1 netcoreapp2.2 netcoreapp3.0 netcoreapp3.1
.NET Standard netstandard2.0 netstandard2.1
.NET Framework net461 net462 net463 net47 net471 net472 net48
MonoAndroid monoandroid
MonoMac monomac
MonoTouch monotouch
Tizen tizen40 tizen60
Xamarin.iOS xamarinios
Xamarin.Mac xamarinmac
Xamarin.TVOS xamarintvos
Xamarin.WatchOS xamarinwatchos
Compatible target framework(s)
Additional computed target framework(s)
Learn more about Target Frameworks and .NET Standard.
  • .NETStandard 2.0

    • No dependencies.

NuGet packages (1)

Showing the top 1 NuGet packages that depend on Unified:

Package Downloads
Unified.Json

Unified.Json is JsonConverter for UnifiedId to use it as ValueObject.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
1.0.6 6,476 11/26/2021
1.0.5 1,367 11/26/2021
1.0.4 1,805 11/26/2021
1.0.3 165,527 9/24/2020
1.0.2 252 9/24/2020
1.0.1 352 9/21/2020
1.0.0 258 9/21/2020

Performance improvements