Fixed length binary columns in user defined table types fail when constructed

[daniellittledev]

Issue Summary

When using a user defined table type with a fixed length binary column the wrong constructor for SqlMetaData is used resulting in the following exception.

System.ArgumentException: 'The dbType Binary is invalid for this constructor.'

This line looks like it's causing the issue, which incorrectly assumes if it is a fixed length that it can safely use the two parameter constructor:

FSharp.Data.SqlClient/src/SqlClient.DesignTime/DesignTime.fs

Line 544 in 0bc5129

if typeInfo.IsFixedLength then

To Reproduce

1. Create a custom table type

CREATE TYPE [dbo].[CustomTableType] AS TABLE(
	[Value] [binary](16)
)

2. Use the type in a query

type StaticProvider =
    SqlCommandProvider<"
        Declare @Updates as CustomTableType = @Inputs;
    " , staticConnectionString>

use cmd = new StaticProvider(context.connection, transaction = context.transaction)
cmd.AsyncExecute(
    data.inputs
    |> List.map(fun x ->
        StaticProvider.CustomTableType( // <--- Error in constructor
            Value = x.value
        )
    )

Error

System.ArgumentException: 'The dbType Binary is invalid for this constructor.'

Expected behavior

There should not be an error in this case.

What you can do

• I am willing to contribute a PR with a unit test showcasing the issue
• I am willing to test the bug fix before next release

[smoothdeveloper]

Thanks for the issue report @daniellittledev.

In #362, a workaround was to use nvarchar(max) instead of a specified length, I'm not sure if it would work or if you can use that in meantime the bug get addressed.

I'll try to put this under test and fix the call to SqlMetaData constructor accordingly.

[suou-ryuu]

@smoothdeveloper I've submitted a PR with what I think may be the fix for this issue.
Please check it out when you have a minute: #418

[smoothdeveloper]

@suou-ryuu thanks a lot for the fix PR, with added test.

I'll take a moment to review and run the test locally, and issue a new release when possible.

@daniellittledev, if you happen to test the fix on your own and confirm in meantime, please let us know.

Thanks again all!

[suou-ryuu]

@smoothdeveloper Thanks for the quick reply.

I'll take a moment to review and run the test locally, and issue a new release when possible.

Superb. Looking forward to it :)

[suou-ryuu]

@smoothdeveloper Sorry to pester, but do you have an ETA for when you'll be able to confirm this fix and issue a new release? We currently need this as it's blocking progress on a few projects.

Thank you in advance

[smoothdeveloper]

@suou-ryuu there should be a 2.1.1 version with your PR changes upon validation from nuget.org.

[suou-ryuu]

@smoothdeveloper Fantastic. Thank you.
I see the 2.1.1 on nuget.org; I've tested it locally and it's all working as expected 😄
Thank you for handling so quickly

[smoothdeveloper]

@suou-ryuu thanks for confirming on your end and no problems.

Just so you know, once you've got the main library to build, you can generate the nuget package yourself: build NuGet -st

This allows you to drop a new version locally before a release is made.

@daniellittledev if you have a chance to try the new release and if it fixes this issue, we can close it?

Thanks again @suou-ryuu for contributing the fix.

[github-actions]

🤖 This is an automated response from Repo Assist.

It looks like this issue was fixed in version 2.1.1 (via PR #418 by @suou-ryuu — thank you for the fix!). The fix has been part of the released package since April 2022 and is included in the current latest version (2.1.3).

@daniellittledev — could you confirm whether the issue is resolved with 2.1.1 or later? If so, it would be great to close this issue.

For context, the fix changed the SqlMetaData constructor selection in DesignTime.fs so that binary/varbinary types (which are technically fixed-length but require the (name, dbType, maxLength) constructor overload) are handled separately from types that take the simple (name, dbType) constructor.

Generated by Repo Assist · ◷

To install this agentic workflow, run

gh aw add githubnext/agentics/workflows/repo-assist.md@346204513ecfa08b81566450d7d599556807389f