Skip to content

POCO serialization #284

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
cmettler wants to merge 9 commits into
base: main
Choose a base branch
from
Open

POCO serialization #284

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
92956bd
Add source-generated Arrow serialization library
Mar 11, 2026
ddc0fe0
Change test project target from net10.0 to net8.0
Mar 11, 2026
c513535
Fix solution folder nesting and remove net10.0 target
Mar 11, 2026
4f1fcd7
added license to readme and downgraded Microsoft.CodeAnalysis.CSharp
Mar 11, 2026
60e1735
removed Apache.Arrow.Tests.sln
Mar 11, 2026
922cb4a
Address PR review feedback
Jul 7, 2026
424d64e
Support .NET Framework and netstandard2.0 targets
Jul 7, 2026
7b3a5c8
Fix RC verification and integrate serialization docs
Jul 7, 2026
406ed84
Build docs prerequisite in Release configuration
Jul 7, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion Apache.Arrow.Tests.slnf
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,8 @@
"test\\Apache.Arrow.Flight.TestWeb\\Apache.Arrow.Flight.TestWeb.csproj",
"test\\Apache.Arrow.Tests\\Apache.Arrow.Tests.csproj",
"test\\Apache.Arrow.Scalars.Tests\\Apache.Arrow.Scalars.Tests.csproj",
"test\\Apache.Arrow.Operations.Tests\\Apache.Arrow.Operations.Tests.csproj"
"test\\Apache.Arrow.Operations.Tests\\Apache.Arrow.Operations.Tests.csproj",
"test\\Apache.Arrow.Serialization.Tests\\Apache.Arrow.Serialization.Tests.csproj"
]
}
}
42 changes: 42 additions & 0 deletions Apache.Arrow.sln
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,12 @@ Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Apache.Arrow.Operations", "
EndProject
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Apache.Arrow.Operations.Tests", "test\Apache.Arrow.Operations.Tests\Apache.Arrow.Operations.Tests.csproj", "{73EBE132-AE05-4C32-9525-515F4768156B}"
EndProject
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Apache.Arrow.Serialization", "src\Apache.Arrow.Serialization\Apache.Arrow.Serialization.csproj", "{E0C418BE-DD55-4FB1-973E-272B142BAA9E}"
EndProject
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Apache.Arrow.Serialization.Generator", "src\Apache.Arrow.Serialization.Generator\Apache.Arrow.Serialization.Generator.csproj", "{FD8B13D7-16F4-4DBF-BB25-13EA5131EE03}"
EndProject
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Apache.Arrow.Serialization.Tests", "test\Apache.Arrow.Serialization.Tests\Apache.Arrow.Serialization.Tests.csproj", "{3726633C-7093-40A1-8ABB-13A5CD64033A}"
EndProject
Global
GlobalSection(SolutionConfigurationPlatforms) = preSolution
Debug|Any CPU = Debug|Any CPU
Expand Down Expand Up @@ -264,6 +270,42 @@ Global
{73EBE132-AE05-4C32-9525-515F4768156B}.Release|x64.Build.0 = Release|Any CPU
{73EBE132-AE05-4C32-9525-515F4768156B}.Release|x86.ActiveCfg = Release|Any CPU
{73EBE132-AE05-4C32-9525-515F4768156B}.Release|x86.Build.0 = Release|Any CPU
{E0C418BE-DD55-4FB1-973E-272B142BAA9E}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
{E0C418BE-DD55-4FB1-973E-272B142BAA9E}.Debug|Any CPU.Build.0 = Debug|Any CPU
{E0C418BE-DD55-4FB1-973E-272B142BAA9E}.Debug|x64.ActiveCfg = Debug|Any CPU
{E0C418BE-DD55-4FB1-973E-272B142BAA9E}.Debug|x64.Build.0 = Debug|Any CPU
{E0C418BE-DD55-4FB1-973E-272B142BAA9E}.Debug|x86.ActiveCfg = Debug|Any CPU
{E0C418BE-DD55-4FB1-973E-272B142BAA9E}.Debug|x86.Build.0 = Debug|Any CPU
{E0C418BE-DD55-4FB1-973E-272B142BAA9E}.Release|Any CPU.ActiveCfg = Release|Any CPU
{E0C418BE-DD55-4FB1-973E-272B142BAA9E}.Release|Any CPU.Build.0 = Release|Any CPU
{E0C418BE-DD55-4FB1-973E-272B142BAA9E}.Release|x64.ActiveCfg = Release|Any CPU
{E0C418BE-DD55-4FB1-973E-272B142BAA9E}.Release|x64.Build.0 = Release|Any CPU
{E0C418BE-DD55-4FB1-973E-272B142BAA9E}.Release|x86.ActiveCfg = Release|Any CPU
{E0C418BE-DD55-4FB1-973E-272B142BAA9E}.Release|x86.Build.0 = Release|Any CPU
{FD8B13D7-16F4-4DBF-BB25-13EA5131EE03}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
{FD8B13D7-16F4-4DBF-BB25-13EA5131EE03}.Debug|Any CPU.Build.0 = Debug|Any CPU
{FD8B13D7-16F4-4DBF-BB25-13EA5131EE03}.Debug|x64.ActiveCfg = Debug|Any CPU
{FD8B13D7-16F4-4DBF-BB25-13EA5131EE03}.Debug|x64.Build.0 = Debug|Any CPU
{FD8B13D7-16F4-4DBF-BB25-13EA5131EE03}.Debug|x86.ActiveCfg = Debug|Any CPU
{FD8B13D7-16F4-4DBF-BB25-13EA5131EE03}.Debug|x86.Build.0 = Debug|Any CPU
{FD8B13D7-16F4-4DBF-BB25-13EA5131EE03}.Release|Any CPU.ActiveCfg = Release|Any CPU
{FD8B13D7-16F4-4DBF-BB25-13EA5131EE03}.Release|Any CPU.Build.0 = Release|Any CPU
{FD8B13D7-16F4-4DBF-BB25-13EA5131EE03}.Release|x64.ActiveCfg = Release|Any CPU
{FD8B13D7-16F4-4DBF-BB25-13EA5131EE03}.Release|x64.Build.0 = Release|Any CPU
{FD8B13D7-16F4-4DBF-BB25-13EA5131EE03}.Release|x86.ActiveCfg = Release|Any CPU
{FD8B13D7-16F4-4DBF-BB25-13EA5131EE03}.Release|x86.Build.0 = Release|Any CPU
{3726633C-7093-40A1-8ABB-13A5CD64033A}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
{3726633C-7093-40A1-8ABB-13A5CD64033A}.Debug|Any CPU.Build.0 = Debug|Any CPU
{3726633C-7093-40A1-8ABB-13A5CD64033A}.Debug|x64.ActiveCfg = Debug|Any CPU
{3726633C-7093-40A1-8ABB-13A5CD64033A}.Debug|x64.Build.0 = Debug|Any CPU
{3726633C-7093-40A1-8ABB-13A5CD64033A}.Debug|x86.ActiveCfg = Debug|Any CPU
{3726633C-7093-40A1-8ABB-13A5CD64033A}.Debug|x86.Build.0 = Debug|Any CPU
{3726633C-7093-40A1-8ABB-13A5CD64033A}.Release|Any CPU.ActiveCfg = Release|Any CPU
{3726633C-7093-40A1-8ABB-13A5CD64033A}.Release|Any CPU.Build.0 = Release|Any CPU
{3726633C-7093-40A1-8ABB-13A5CD64033A}.Release|x64.ActiveCfg = Release|Any CPU
{3726633C-7093-40A1-8ABB-13A5CD64033A}.Release|x64.Build.0 = Release|Any CPU
{3726633C-7093-40A1-8ABB-13A5CD64033A}.Release|x86.ActiveCfg = Release|Any CPU
{3726633C-7093-40A1-8ABB-13A5CD64033A}.Release|x86.Build.0 = Release|Any CPU
EndGlobalSection
GlobalSection(SolutionProperties) = preSolution
HideSolutionNode = FALSE
Expand Down
2 changes: 2 additions & 0 deletions Directory.Packages.props
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,8 @@
<PackageVersion Include="Grpc.Tools" Version="2.72.0" PrivateAssets="All" />
<PackageVersion Include="K4os.Compression.LZ4.Streams" Version="1.3.8" />
<PackageVersion Include="Microsoft.Bcl.AsyncInterfaces" Version="8.0.0" />
<PackageVersion Include="Microsoft.CodeAnalysis.Analyzers" Version="3.3.4" />
<PackageVersion Include="Microsoft.CodeAnalysis.CSharp" Version="4.11.0" />
<PackageVersion Include="Microsoft.NET.Test.Sdk" Version="18.7.0" />
<PackageVersion Include="Microsoft.SourceLink.GitHub" Version="10.0.103" />
<PackageVersion Include="pythonnet" Version="3.1.0" />
Expand Down
5 changes: 5 additions & 0 deletions ci/scripts/docs.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,11 @@ set -eux

source_dir=${1}

# Build the serialization library first so its source generator is available
# when docfx extracts metadata. docfx loads projects with Configuration=Release,
# so the analyzer project reference only resolves from the Release output.
dotnet build -c Release "${source_dir}/src/Apache.Arrow.Serialization/Apache.Arrow.Serialization.csproj"

pushd "${source_dir}/docs"

dotnet tool install -g docfx
Expand Down
16 changes: 16 additions & 0 deletions dev/release/verify_rc.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -173,6 +173,13 @@ test_binary_distribution() {

pushd nuget
for package in $(cd ../src && echo *); do
case "${package}" in
Apache.Arrow.Serialization.Generator)
# Not packable: the source generator ships inside the
# Apache.Arrow.Serialization package as a Roslyn analyzer.
continue
;;
esac
for package_type in nupkg snupkg; do
fetch_artifact "${package}.${VERSION}.${package_type}"
done
Expand All @@ -186,6 +193,15 @@ test_binary_distribution() {
reference_package "Apache.Arrow.Flight.AspNetCore" "Apache.Arrow.Flight.TestWeb"
reference_package "Apache.Arrow.Operations" "Apache.Arrow.Operations.Tests" "Apache.Arrow.Scalars.Tests"
reference_package "Apache.Arrow.Scalars" "Apache.Arrow.Scalars.Tests" "Apache.Arrow.Tests" "Apache.Arrow.Operations.Tests"
reference_package "Apache.Arrow.Serialization" "Apache.Arrow.Serialization.Tests"
# The source generator ships inside the Apache.Arrow.Serialization package
# as a Roslyn analyzer; drop the direct project reference so the packaged
# generator is exercised instead. The generator unit tests need the
# generator assembly as a compile-time reference, which the package's
# analyzer does not provide, so they only run against the source tree.
dotnet remove "test/Apache.Arrow.Serialization.Tests" \
reference "src/Apache.Arrow.Serialization.Generator/Apache.Arrow.Serialization.Generator.csproj"
rm test/Apache.Arrow.Serialization.Tests/DiagnosticTests.cs

# Move src directory to ensure we are only testing against built packages
mv src src.backup
Expand Down
7 changes: 7 additions & 0 deletions docs/docfx.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,13 @@
"_site/**",
"images/**"
]
},
{
"files": [
"README.md"
],
"src": "../src/Apache.Arrow.Serialization",
"dest": "serialization"
}
],
"resource": [
Expand Down
3 changes: 3 additions & 0 deletions docs/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,9 @@ An implementation of Arrow targeting .NET.
See our current [feature matrix](https://github.com/apache/arrow/blob/main/docs/source/status.rst)
for currently available features.

For source-generated POCO serialization (`[ArrowSerializable]`), see
[Apache.Arrow.Serialization](../src/Apache.Arrow.Serialization/README.md).

## Implementation

- Arrow specification 1.0.0. (Support for reading 0.11+.)
Expand Down
2 changes: 2 additions & 0 deletions docs/toc.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,8 @@
# under the License.

items:
- name: Serialization
href: ../src/Apache.Arrow.Serialization/README.md
- name: API Reference
type: Namespace
href: api/
Expand Down
17 changes: 17 additions & 0 deletions src/Apache.Arrow.Serialization.Generator/Apache.Arrow.Serialization.Generator.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
<Project Sdk="Microsoft.NET.Sdk">

<PropertyGroup>
<TargetFramework>netstandard2.0</TargetFramework>
<Nullable>enable</Nullable>
<EnforceExtendedAnalyzerRules>true</EnforceExtendedAnalyzerRules>
<IsRoslynComponent>true</IsRoslynComponent>
<IsPackable>false</IsPackable>
<NoWarn>RS2008</NoWarn>
</PropertyGroup>

<ItemGroup>
<PackageReference Include="Microsoft.CodeAnalysis.Analyzers" PrivateAssets="all" />
<PackageReference Include="Microsoft.CodeAnalysis.CSharp" PrivateAssets="all" />
</ItemGroup>

</Project>
Loading
Loading