SnowflakeIDGenerator 1.2.2023.201

.NET Standard 1.3 This package targets .NET Standard 1.3. The package is compatible with this framework or higher. .NET Framework 2.0 This package targets .NET Framework 2.0. The package is compatible with this framework or higher.
Additional Details

While not critical, these versions contain a bug that, when using a custom epoch, the epoch being used is not saved to the generated code.
This does NOT affect in any way the generated codes, nor it affect the Snowflake objects when parsing. However, when generating the Id as a Snowflake object, the epoch being used is not saved. Please update to the latest version.

There is a newer version of this package available.
See the version list below for details. 
dotnet add package SnowflakeIDGenerator --version 1.2.2023.201                

                    
                

            
NuGet\Install-Package SnowflakeIDGenerator -Version 1.2.2023.201
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="SnowflakeIDGenerator" Version="1.2.2023.201" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
paket add SnowflakeIDGenerator --version 1.2.2023.201                

                    
                

            
#r "nuget: SnowflakeIDGenerator, 1.2.2023.201"
#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. 
// Install SnowflakeIDGenerator as a Cake Addin
#addin nuget:?package=SnowflakeIDGenerator&version=1.2.2023.201

// Install SnowflakeIDGenerator as a Cake Tool
#tool nuget:?package=SnowflakeIDGenerator&version=1.2.2023.201

Snowflake Id Generator

Generate unique identifiers based on Twitter's Snowflake ID.

Parse a Snowflake to get information about it's creation.

Nuget Build status Quality Gate Status Lines of Code Coverage

Usage

Generate

  1. Instantiate class SnowflakeIDGenerator
SnowflakeIDGenerator gen = new SnowflakeIDGenerator(machineId);

where machineId is the number of the system currently trying to get an id

Starting on version 1.1.2023 you can instruct the generator to use a custom date as epoch from which the timestamps are derived for the current date.

SnowflakeIDGenerator gen = new SnowflakeIDGenerator(machineId, CustomEpoch);
  1. Now you have 3 options:
    1. Call GetSnowflake to get a Snowflake object
    2. Call GetCode to get an Id in number (ulong) format
    3. Call GetCodeString to get an Id in string format

Additionally, the SnowflakeIDGenerator class methods can be used as static. IE.: GetCode(machineId) or GetCodeString(machineId)

Parse

Parse a Snowflake either from a string or a number (ulong).

string s = "06975580616378931208";
ulong n = 6975580821430984519ul;
Snowflake fromString = Snowflake.Parse(s);
var utcDateTimeFromString = fromString.UtcDateTime; // 13/9/2022 22:26:58
var timestampFromString = fromString.Timestamp;     // 1663108018965
var machineIdFromString = fromString.MachineId;     // 477
var sequenceFromString = fromString.Sequence;       // 2056

Snowflake fromNumber = Snowflake.Parse(n);
var utcDateTimeFromNumber = fromNumber.UtcDateTime; // 13/9/2022 22:27:47
var timestampFromNumber = fromNumber.Timestamp;     // 1663108067853
var machineIdFromNumber = fromNumber.MachineId;     // 701
var sequenceFromNumber = fromNumber.Sequence;       // 3911

Additionally, starting on version 1.2.2023 you can cast a string or a number (ulong) directly into a Snowflake

string s = "06975580616378931208";
ulong n = 6975580821430984519ul;
Snowflake fromString = (Snowflake)s;
var utcDateTimeFromString = fromString.UtcDateTime; // 13/9/2022 22:26:58
var timestampFromString = fromString.Timestamp;     // 1663108018965
var machineIdFromString = fromString.MachineId;     // 477
var sequenceFromString = fromString.Sequence;       // 2056

Snowflake fromNumber = (Snowflake)n;
var utcDateTimeFromNumber = fromNumber.UtcDateTime; // 13/9/2022 22:27:47
var timestampFromNumber = fromNumber.Timestamp;     // 1663108067853
var machineIdFromNumber = fromNumber.MachineId;     // 701
var sequenceFromNumber = fromNumber.Sequence;       // 3911
Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 was computed.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  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. 
.NET Core netcoreapp1.0 was computed.  netcoreapp1.1 was computed.  netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard1.3 is compatible.  netstandard1.4 was computed.  netstandard1.5 was computed.  netstandard1.6 was computed.  netstandard2.0 is compatible.  netstandard2.1 was computed. 
.NET Framework net20 is compatible.  net35 is compatible.  net40 is compatible.  net403 was computed.  net45 was computed.  net451 was computed.  net452 was computed.  net46 was computed.  net461 was computed.  net462 was computed.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen30 was computed.  tizen40 was computed.  tizen60 was computed. 
Universal Windows Platform uap was computed.  uap10.0 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

  • .NETFramework 2.0

    • No dependencies.

  • .NETFramework 3.5

    • No dependencies.

  • .NETFramework 4.0

    • No dependencies.

  • .NETStandard 1.3

  • .NETStandard 2.0

    • No dependencies.

NuGet packages (1)

Showing the top 1 NuGet packages that depend on SnowflakeIDGenerator:

Package Downloads
SnowflakeIDGenerator.DependencyInjection

Extends package SnowflakeIDGenerator to help in configuring the snowflakeId generator using dependency injection

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
1.5.2024.306 883 11/1/2024
1.4.2024.131 2,619 5/10/2024
1.3.2023.287 328 10/14/2023
1.2.2023.201 915 7/20/2023 1.2.2023.201 is deprecated.
1.1.2023.147 180 5/27/2023 1.1.2023.147 is deprecated.
1.0.2023.145 159 5/25/2023
1.0.2022.283 471 10/10/2022
1.0.2022.268 502 9/25/2022
1.0.2022.261 452 9/18/2022
1.0.2022.257 463 9/14/2022
1.0.2022.256 614 9/13/2022

# Changelog

## 1.2.2023
- Added ability to change and rebase epoch to an already generated code
- Added implicit casting from Snowflake to string and ulong
- Added explicit casting to Snowflake from string and ulong

## 1.1.2023
- Added ability to use a custom epoch

## 1.0.2023
- Throw exception if time moves backwards

## 1.0.2022
- Initial version