Add sample application for ScalarDB Cluster .NET Client SDK #77

Dima-X · 2025-03-28T07:55:01Z

Description

This PR adds sample application for ScalarDB Cluster .NET Client SDK.
This is a .NET version of https://github.com/scalar-labs/scalardb-samples/tree/main/scalardb-sample

Related issues and/or PRs

https://github.com/scalar-labs/docs-internal-scalardb/pull/1051

Changes made

sample added to dotnet/scalardb-cluster-sample
Visual Studio specific exceptions were added to .gitignore

Checklist

I have commented my code, particularly in hard-to-understand areas.
I have updated the documentation to reflect the changes.
Any remaining open issues linked to this PR are documented and up-to-date (Jira, GitHub, etc.).
Tests (unit, integration, etc.) have been added for the changes.
My changes generate no new warnings.
Any dependent changes in other PRs have been merged and published.

Additional notes (optional)

komamitsu · 2025-03-31T04:26:19Z

dotnet/scalardb-cluster-sample/Commands/LoadInitialDataCommand.cs

+        loadInitialDataCommand.SetHandler(async () =>
+        {
+            using var sample = new Sample();
+            await sample.CreateTables();


The existing sample applications don't create tables within the applications, as table creation is handled by the Schema Loader tool. I think this sample application should follow the same approach.

I think forcing .NET developers to install Java just to use the Schema Loader tool is not good; that’s why tables are created within the sample application.

You have a point. Maybe it's a trade off between the consistency with other sample applications and the convenience of this one. I don't have a strong opinion on it, so I'll leave the decision to @feeblefakie and @brfrn169.

@Dima-X Can you make it configurable?
So, users can create tables through this (default) or create tables through the schema-loader.

@feeblefakie Tables already can be created both ways. Tables and namespaces are created only if they don’t exist already, so there’s no problem applying the schema with the schema-loader and then using this sample app.

IMO, table schema migration is basically conducted outside applications in production environments. So I think the tables for the sample application should be explicitly created as much as possible. On the other hand, I understand that it's might be not easy for .NET developers to use the Schema Loader or equivalent. How about adding a new command CreateTablesCommand instead of implicitly creating the tables in LoadInitialDataCommand?

@komamitsu

How about adding a new command CreateTablesCommand instead of implicitly creating the tables in LoadInitialDataCommand?

I thought about doing it as a separate command at first, but you always have to run LoadInitialDataCommand exactly after CreateTablesCommand, so I think it’s more logical for them to be a single command.

it’s more logical for them to be a single command.

This depends on whether Scalar wants to provide a sample application that always implicitly creates the tables. I'll wait for feedback from other members.

Per discussion with @feeblefakie and @brfrn169, we decided to use a Docker image that runs the Schema Loader tool after we make it public. So, let's go with the current PR as is.

komamitsu · 2025-03-31T04:37:48Z

dotnet/scalardb-cluster-sample/Sample.cs

+                );
+
+            if (customer is not null)
+                return;


If the target record exist and credit_total has been modified from the initial value, I think it should be reset to the initial value after LoadInitialData finishes. How about updating or deleting and re-inserting it if it exists?

I don’t think that the existing Java sample application is doing it.

I see. That's fair enough.

Torch3333

LGTM, thank you!

komamitsu

LGTM! 👍

brfrn169

LGTM! Thank you!

feeblefakie · 2025-04-02T06:26:56Z

dotnet/scalardb-cluster-sample/Commands/GetCustomerInfoCommand.cs

@@ -0,0 +1,31 @@
+using System.CommandLine;


As for the location, let's put them into scalardb-dotnet-samples instead of scalardb-samples/dotnet.

@feeblefakie
Created public scalardb-dotnet-samples repository.
Will move this sample there after there are no more questions and requests about the sample. Or is it better to move it right now and set all of you as reviewers again?

Oh, I'm sorry, I made a mistake.
I meant the scalardb-dotnet-samples folder in the scalardb-samples repo.
My bad.

@feeblefakie
Moved to scalardb-dotnet-samples

komamitsu · 2025-04-04T06:23:36Z

@feeblefakie @brfrn169 @Torch3333 I added a small fix to throw the last exception when the retry is over 18e99de and b0438af. PTAL just in case.

kota2and3kan

Thank you for creating the new sample application!
It's a minor thing, but I have questions about an error that I faced in my local environment.
Please take a look when you have time! 🙇‍♂️

kota2and3kan · 2025-04-04T07:01:51Z

scalardb-dotnet-samples/scalardb-cluster-sample/ScalarDbClusterSample.csproj

+    <PropertyGroup>
+        <OutputType>Exe</OutputType>
+        <TargetFramework>net8.0</TargetFramework>
+        <ImplicitUsings>enable</ImplicitUsings>
+        <Nullable>enable</Nullable>
+    </PropertyGroup>


I have one question. I guess it's related to .NET itself. It's not related to this sample application. However, I'm not familiar with .NET, so I want to ask this question here.

When I tried this sample application in my local environment, I faced the following error.

Error

$ dotnet run LoadInitialData /home/ubuntu/tmp/scalardb-samples/scalardb-dotnet-samples/scalardb-cluster-sql-sample/ScalarDbClusterSqlSample.csproj : error NU1101: Unable to find package Microsoft.NETCore.App.Host.ubuntu.22.04-x64. No packages exist with this id in source(s): nuget.org The build failed. Fix the build errors and run again.

Environment information

$ dotnet --info .NET SDK: Version: 8.0.114 Commit: 54ac9c88f1 Workload version: 8.0.100-manifests.2d3000a2 Runtime Environment: OS Name: ubuntu OS Version: 22.04 OS Platform: Linux RID: ubuntu.22.04-x64 Base Path: /usr/lib/dotnet/sdk/8.0.114/ .NET workloads installed: Workload version: 8.0.100-manifests.2d3000a2 There are no installed workloads to display. Host: Version: 8.0.10 Architecture: x64 Commit: 81cabf2857 .NET SDKs installed: 8.0.114 [/usr/lib/dotnet/sdk] .NET runtimes installed: Microsoft.AspNetCore.App 8.0.14 [/usr/lib/dotnet/shared/Microsoft.AspNetCore.App] Microsoft.NETCore.App 8.0.14 [/usr/lib/dotnet/shared/Microsoft.NETCore.App] Other architectures found: None Environment variables: DOTNET_ROOT [/home/ubuntu/.dotnet] global.json file: /home/ubuntu/tmp/scalardb-samples/scalardb-dotnet-samples/scalardb-cluster-sql-sample/global.json Learn more: https://aka.ms/dotnet/info Download .NET: https://aka.ms/dotnet/download

Regarding the above error, I found one issue.
dotnet/sdk#40676 (comment)

And, according to the above issue comment, I fixed the sample app (ScalarDbClusterSqlSample.csproj file) as follows (added <RuntimeIdentifier>linux-x64</RuntimeIdentifier>):

Suggested change

<PropertyGroup>

<OutputType>Exe</OutputType>

<TargetFramework>net8.0</TargetFramework>

<ImplicitUsings>enable</ImplicitUsings>

<Nullable>enable</Nullable>

</PropertyGroup>

<PropertyGroup>

<OutputType>Exe</OutputType>

<TargetFramework>net8.0</TargetFramework>

<ImplicitUsings>enable</ImplicitUsings>

<Nullable>enable</Nullable>

<RuntimeIdentifier>linux-x64</RuntimeIdentifier>

</PropertyGroup>

After that, I was able to run the sample application in my local environment.

Question 1

It seems that the error above is related to a specific environment (Ubuntu 22.04 + .NET 8.0?). In other words, this error is likely not a general issue with the sample application itself.

Is my understanding correct?

Question 2

As I mentioned in Q1, this error appears to be environment-specific. Therefore, I believe we may not need to make any changes to the sample application itself.

However, it might be beneficial to address this error if we can find a general solution to prevent it.

This is because there is a possibility that some users might run this sample application in an Ubuntu 22.04 + .NET 8.0 environment.

Do you have any ideas on how to resolve this error in a general way?

I apologize, but I am not very familiar with .NET. Therefore, I would like to ask you here.

@kota2and3kan

Is my understanding correct?

Yes, I think it is. In fact, it seems that that specific environment is Ubuntu 22.04 + .NET 7.0 (or older) + .NET 8.0 (or newer), as it seems that removing all installed .NET versions and then only installing .NET 8.0 fixes the problem.

Do you have any ideas on how to resolve this error in a general way?

Technically, you can set runtime identifiers for all OS's this sample needs to support: <RuntimeIdentifiers>win-x64;win-arm64;win-x86;osx-arm64;linux-x64;linux-arm64</RuntimeIdentifiers>.

But because it’s a problem with .NET/Ubuntu itself and not sample-specific, I don’t think it’s a good idea to “fix” the sample. Maybe it’s better just to add a note to the guides about this error.

@Dima-X
Thank you for your answer!

Is my understanding correct?

Yes, I think it is. In fact, it seems that that specific environment is Ubuntu 22.04 + .NET 7.0 (or older) + .NET 8.0 (or newer), as it seems that removing all installed .NET versions and then only installing .NET 8.0 fixes the problem.

I see. I understood. I will try the workaround removing all installed .NET versions and then only installing .NET 8.0. Thank you!

Do you have any ideas on how to resolve this error in a general way?

Technically, you can set runtime identifiers for all OS's this sample needs to support: <RuntimeIdentifiers>win-x64;win-arm64;win-x86;osx-arm64;linux-x64;linux-arm64</RuntimeIdentifiers>.

I see. Thank you for the configuration sample!

But because it’s a problem with .NET/Ubuntu itself and not sample-specific, I don’t think it’s a good idea to “fix” the sample. Maybe it’s better just to add a note to the guides about this error.

I agree with you. I think we should add a note about this issue on the documentation side. I will consider it and create a PR on the document side.

kota2and3kan

LGTM! Thank you!

kota2and3kan · 2025-04-06T23:43:13Z

scalardb-dotnet-samples/scalardb-cluster-sample/ScalarDbClusterSample.csproj

+    <PropertyGroup>
+        <OutputType>Exe</OutputType>
+        <TargetFramework>net8.0</TargetFramework>
+        <ImplicitUsings>enable</ImplicitUsings>
+        <Nullable>enable</Nullable>
+    </PropertyGroup>


@Dima-X
Thank you for your answer!

Is my understanding correct?

Yes, I think it is. In fact, it seems that that specific environment is Ubuntu 22.04 + .NET 7.0 (or older) + .NET 8.0 (or newer), as it seems that removing all installed .NET versions and then only installing .NET 8.0 fixes the problem.

I see. I understood. I will try the workaround removing all installed .NET versions and then only installing .NET 8.0. Thank you!

Do you have any ideas on how to resolve this error in a general way?

Technically, you can set runtime identifiers for all OS's this sample needs to support: <RuntimeIdentifiers>win-x64;win-arm64;win-x86;osx-arm64;linux-x64;linux-arm64</RuntimeIdentifiers>.

I see. Thank you for the configuration sample!

But because it’s a problem with .NET/Ubuntu itself and not sample-specific, I don’t think it’s a good idea to “fix” the sample. Maybe it’s better just to add a note to the guides about this error.

I agree with you. I think we should add a note about this issue on the documentation side. I will consider it and create a PR on the document side.

kota2and3kan · 2025-04-07T02:22:13Z

FYI: Regarding the comment #77 (comment), we (@brfrn169 , @komamitsu , and I) discussed and decided to create another PR to add a note to all documents after all related PRs are merged. I will do it later.

feeblefakie

LGTM! Thank you!

feeblefakie · 2025-04-08T03:02:31Z

cc: @josh-wong

Dima-X added 2 commits March 28, 2025 16:37

Add sample application for ScalarDB Cluster .NET Client SDK

9cb62d4

Add new line to the end of json files

636f1b1

Dima-X self-assigned this Mar 28, 2025

Dima-X requested review from a team, Torch3333, brfrn169, feeblefakie and komamitsu and removed request for a team March 28, 2025 08:03

komamitsu reviewed Mar 31, 2025

View reviewed changes

Torch3333 approved these changes Mar 31, 2025

View reviewed changes

Dima-X requested a review from komamitsu March 31, 2025 07:37

komamitsu approved these changes Apr 1, 2025

View reviewed changes

brfrn169 requested a review from kota2and3kan April 2, 2025 01:47

brfrn169 approved these changes Apr 2, 2025

View reviewed changes

feeblefakie reviewed Apr 2, 2025

View reviewed changes

Move to scalardb-dotnet-samples

76512b5

Dima-X mentioned this pull request Apr 3, 2025

Add sample application for ScalarDB Cluster .NET Client SDK (SQL) #78

Merged

6 tasks

brfrn169 requested a review from feeblefakie April 4, 2025 00:45

Dima-X mentioned this pull request Apr 4, 2025

Add sample application for ScalarDB Cluster .NET Client SDK (LINQ) #79

Merged

6 tasks

Throw the last exception in case of retry over

18e99de

Fix wrong exception type

b0438af

kota2and3kan reviewed Apr 4, 2025

View reviewed changes

kota2and3kan approved these changes Apr 6, 2025

View reviewed changes

feeblefakie approved these changes Apr 8, 2025

View reviewed changes

feeblefakie merged commit 977434e into main Apr 8, 2025
32 checks passed

feeblefakie deleted the add-dotnet-scalardb-cluster-sample branch April 8, 2025 03:02

Add sample application for ScalarDB Cluster .NET Client SDK #77

Add sample application for ScalarDB Cluster .NET Client SDK #77

Uh oh!

Conversation

Dima-X commented Mar 28, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Related issues and/or PRs

Changes made

Checklist

Additional notes (optional)

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Torch3333 left a comment

Choose a reason for hiding this comment

Uh oh!

komamitsu left a comment

Choose a reason for hiding this comment

Uh oh!

brfrn169 left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Dima-X Apr 3, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

komamitsu commented Apr 4, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

kota2and3kan left a comment

Choose a reason for hiding this comment

Uh oh!

kota2and3kan Apr 4, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Question 1

Question 2

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

kota2and3kan left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

kota2and3kan commented Apr 7, 2025

Uh oh!

feeblefakie left a comment

Choose a reason for hiding this comment

Dima-X commented Mar 28, 2025 •

edited

Loading

Dima-X Apr 3, 2025 •

edited

Loading

komamitsu commented Apr 4, 2025 •

edited

Loading

kota2and3kan Apr 4, 2025 •

edited

Loading