AvroSchemaGenerator 2.5.2-Alpha.1
See the version list below for details.
dotnet add package AvroSchemaGenerator --version 2.5.2-Alpha.1
NuGet\Install-Package AvroSchemaGenerator -Version 2.5.2-Alpha.1
<PackageReference Include="AvroSchemaGenerator" Version="2.5.2-Alpha.1" />
paket add AvroSchemaGenerator --version 2.5.2-Alpha.1
#r "nuget: AvroSchemaGenerator, 2.5.2-Alpha.1"
// Install AvroSchemaGenerator as a Cake Addin
#addin nuget:?package=AvroSchemaGenerator&version=2.5.2-Alpha.1&prerelease
// Install AvroSchemaGenerator as a Cake Tool
#tool nuget:?package=AvroSchemaGenerator&version=2.5.2-Alpha.1&prerelease
AvroSchemaGenerator
Use to generate Avro Schema with support for RECURSIVE SCHEMA
Getting Started
Install the NuGet package AvroSchemaGenerator and copy/paste the code below
using AvroSchemaGenerator;
public class Course
{
public string Level { get; set; }
public int Year { get; set; }
public string State { get; set; }
public string Gender { get; set; }
}
var avroSchema = typeof(Course).GetSchema();
By default, AvroSchemaGenerator
generates schema with optional fields. The code below is an example of how to mark fields as required
using System.ComponentModel;
using System.ComponentModel.DataAnnotations;
using AvroSchemaGenerator;
public class Course
{
[Required]
public string Level { get; set; }
[Required]
public int Year { get; set; }
[Required]
public string State { get; set; }
[Required]
public string Gender { get; set; }
}
var avroSchema = typeof(Course).GetSchema();
You can assign a default value as well
using System.ComponentModel;
using System.ComponentModel.DataAnnotations;
using AvroSchemaGenerator;
public class Course
{
[DefaultValue("200")]
[Required]
public string Level { get; set; }
[Required]
public int Year { get; set; }
[DefaultValue("Closed")]
public string State { get; set; }
public string Gender { get; set; }
}
var avroSchema = typeof(Course).GetSchema();
Aliases
[Aliases("OldCourse")]
public class Course
{
[Aliases("Level")]
public string NewLevel { get; set; }
}
Logical Types
public class MessageTimeKind
{
[LogicalType(LogicalTypeKind.TimeMicrosecond)]
public TimeSpan TimeMicros { get; set; }
[LogicalType(LogicalTypeKind.TimeMillisecond)]
public TimeSpan TimeMillis { get; set; }
}
public class MessageTimestampKind
{
[LogicalType(LogicalTypeKind.TimestampMicrosecond)]
public DateTime StampMicros { get; set; }
[LogicalType(LogicalTypeKind.TimestampMillisecond)]
public DateTime StampMillis { get; set; }
}
public class MessageDateKind
{
[LogicalType(LogicalTypeKind.Date)]
public DateTime CreatedTime { get; set; }
public AvroDecimal Size { get; set; }
public string DayOfWeek { get; set; }
}
NOTE
- Don't use same declaring type as dictionary value
- Don't use same declaring type as list argument
- Dictionary key must be a string type
Product | Versions Compatible and additional computed target framework versions. |
---|---|
.NET | net5.0 is compatible. net5.0-windows was computed. net6.0 is compatible. 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. |
-
net5.0
- Nuke.Components (>= 6.0.1)
- System.ComponentModel.Annotations (>= 5.0.0)
- System.Text.Json (>= 6.0.1)
-
net6.0
- Nuke.Components (>= 6.0.1)
- System.ComponentModel.Annotations (>= 5.0.0)
- System.Text.Json (>= 6.0.1)
NuGet packages (3)
Showing the top 3 NuGet packages that depend on AvroSchemaGenerator:
Package | Downloads |
---|---|
Pulsar.Client
.NET client library for Apache Pulsar |
|
Pulsar.Client.Otel
OpenTelemetry plugin for Pulsar.Client |
|
SharpPulsar
SharpPulsar is Apache Pulsar Client built using Akka.net |
GitHub repositories
This package is not used by any popular GitHub repositories.
Version | Downloads | Last updated |
---|---|---|
2.10.0 | 558 | 12/16/2023 |
2.9.2 | 124,112 | 7/10/2023 |
2.9.1 | 1,398 | 3/19/2023 |
2.9.0 | 459 | 2/4/2023 |
2.9.0-rc.39 | 125 | 2/3/2023 |
2.9.0-rc.15 | 136 | 1/9/2023 |
2.9.0-rc.6 | 120 | 1/9/2023 |
2.8.1 | 86,307 | 1/9/2023 |
2.8.0 | 334 | 12/24/2022 |
2.8.0-rc.22 | 119 | 12/24/2022 |
2.8.0-rc.21 | 115 | 12/24/2022 |
2.8.0-rc.13 | 116 | 12/24/2022 |
2.8.0-rc.6 | 116 | 12/24/2022 |
2.7.0 | 72,830 | 7/20/2022 |
2.7.0-rc.139 | 139 | 7/20/2022 |
2.7.0-rc.138 | 129 | 7/20/2022 |
2.6.0 | 165,385 | 2/20/2022 |
2.6.0-rc.136 | 151 | 7/19/2022 |
2.5.2-alpha.2 | 162 | 1/16/2022 |
2.5.2-Alpha.1 | 156 | 1/16/2022 |
2.5.1 | 321 | 1/13/2022 |
2.5.0 | 426 | 12/26/2021 |
2.4.1 | 1,220 | 10/27/2021 |
2.4.0 | 46,808 | 9/28/2021 |
2.4.0-beta | 240 | 9/28/2021 |
2.3.3 | 904 | 9/15/2021 |
2.3.3-beta | 273 | 9/15/2021 |
2.3.2 | 345 | 9/15/2021 |
2.3.1-beta | 257 | 9/15/2021 |
2.3.0 | 390 | 9/15/2021 |
2.2.0 | 716 | 9/13/2021 |
2.2.0-beta.17 | 198 | 9/13/2021 |
2.1.0 | 734 | 9/11/2021 |
2.1.0-beta.16 | 220 | 9/13/2021 |
2.1.0-beta.15 | 268 | 9/11/2021 |
2.0.0 | 754 | 9/10/2021 |
2.0.0-beta.14 | 210 | 9/9/2021 |
1.9.0 | 50,204 | 4/14/2021 |
1.9.0-beta.13 | 231 | 9/9/2021 |
1.9.0-beta.12 | 199 | 4/14/2021 |
1.9.0-beta.11 | 182 | 4/14/2021 |
1.9.0-beta.10 | 189 | 4/13/2021 |
1.9.0-beta.9 | 181 | 4/13/2021 |
1.9.0-beta.5 | 169 | 4/13/2021 |
1.9.0-beta.3 | 175 | 4/13/2021 |
1.9.0-beta.2 | 219 | 4/11/2021 |
1.8.0 | 121,462 | 12/10/2020 |
1.7.0 | 594 | 11/4/2020 |
1.6.0 | 56,240 | 6/26/2020 |
1.5.4 | 484 | 6/21/2020 |
1.5.3 | 6,043 | 5/27/2020 |
1.5.2 | 4,659 | 5/13/2020 |
1.5.1 | 1,155 | 5/13/2020 |
1.5.0 | 477 | 5/13/2020 |
1.4.1 | 513 | 5/11/2020 |
1.4.0 | 487 | 5/11/2020 |
1.3.0 | 1,439 | 4/30/2020 |
1.2.0 | 516 | 4/28/2020 |
1.1.0 | 802 | 4/27/2020 |
1.0.0 | 491 | 4/27/2020 |
0.1.2 | 1,505 | 4/14/2020 |
0.1.1 | 481 | 4/14/2020 |
0.1.0 | 1,217 | 4/11/2020 |
• Improved CI
Full changelog at https://github.com/eaba/AvroSchemaGenerator/blob/alpha/CHANGELOG.md