FromQueryAsync does not allow TableNamePrefix to be set

[BryanCrotaz]

Describe the bug

QueryAsync allows TableNamePrefix but FromQueryAsync does not.

Expected Behavior

Expected TableNamePrefix to be public on QueryOperationConfig class

Current Behavior

TableNamePrefix is not present on QueryOperationConfig class

Reproduction Steps

await dynamoContext
			.FromQueryAsync<TModel>(new QueryOperationConfig
			{
				IndexName = indexName,
				TableNamePrefix = stackName
			})

Possible Solution

Add the property

Additional Information/Context

No response

AWS .NET SDK and/or Package version used

AWSSDK.DynamoDBv2 3.7.103.8

Targeted .NET Platform

.Net 6

Operating System and version

Lambda

[ashishdhingra]

This appears to be a feature request since it is not breaking any functionality. Need to investigate on why the support for TableNamePrefix is missing in FromQueryAsync.

[BryanCrotaz]

It breaks deployment via cloud formation where you want to have a dev, staging and production stack. Message ID: ***@***.***>

[ashishdhingra]

@BryanCrotaz Good afternoon. I'm unsure if you have tried to use the overloaded version of FromQueryAsync(QueryOperationConfig, DynamoDBOperationConfig) where you could provide TableNamePrefix in DynamoDBOperationConfig, but the following code works:

using Amazon.DynamoDBv2;
using Amazon.DynamoDBv2.DataModel;
using Amazon.DynamoDBv2.DocumentModel;
using System;
using System.Collections.Generic;
using System.Threading.Tasks;

namespace DynamoDBTest
{
    class Program
    {
        private static AmazonDynamoDBClient client = new AmazonDynamoDBClient();

        static void Main(string[] args)
        {
            DynamoDBContext context = new DynamoDBContext(client);
            Task.WaitAll(TestTableNamePrefix(context));
        }

        private static async Task TestTableNamePrefix(DynamoDBContext context)
        {
            try
            {
                int bookID = 1001; // Some unique value.
                DigitalBook myBook = new DigitalBook
                {
                    Id = bookID,
                    Title = "object persistence-AWS SDK for.NET SDK-Book 1001",
                    ISBN = "111-1111111001",
                    BookAuthors = new List<string> { "Author 1", "Author 2" },
                    ImageUrl = "http://localhost/test.jpg"
                };

                // Save the book.
                await context.SaveAsync(
                    myBook,
                    new DynamoDBOperationConfig()
                    {
                        TableNamePrefix = "test_"
                    }
                );
                var search = context.FromQueryAsync<DigitalBook>(
                    new QueryOperationConfig()
                    {
                        IndexName = "Id-ISBN-index",
                        Filter = new QueryFilter("Id", QueryOperator.Equal, 1001)
                    },
                    new DynamoDBOperationConfig()
                    {
                        TableNamePrefix = "test_"
                    }
                );
                Console.WriteLine("items retrieved");

                var searchResponse = search.GetRemainingAsync().Result;
                searchResponse.ForEach((s) =>
                {
                    Console.WriteLine(s.Title);
                });
            }
            catch(Exception e)
            { Console.WriteLine(e.Message); }
        }
    }

    [DynamoDBTable("ProductCatalog")]
    public class Book
    {
        [DynamoDBHashKey] //Partition key
        public int Id
        {
            get; set;
        }
        [DynamoDBProperty("title")]
        public virtual string Title
        {
            get; set;
        }
        [DynamoDBProperty]
        public string ISBN
        {
            get; set;
        }
        [DynamoDBProperty("Authors")] //String Set datatype
        public List<string> BookAuthors
        {
            get; set;
        }
    }

    [DynamoDBTable("DigitalProductCatalog")]
    public class DigitalBook : Book
    {
        public override string Title
        {
            get;set;
        }

        [DynamoDBProperty]
        public string ImageUrl
        {
            get; set;
        }
    }
}

For above code, I have a DynamoDB table named "test_DigitalProductCatalog". Hence, I'm setting TableNamePrefix as test_ in above code.

Thanks,
Ashish

[BryanCrotaz]

I haven’t tried it but that basically confirms this is a bug if you have to use a more complex workaround. Bryan Crotaz

[ashishdhingra]

I haven’t tried it but that basically confirms this is a bug if you have to use a more complex workaround. Bryan Crotaz

@BryanCrotaz Upon investigating further, looks like QueryAsync(object, DynamoDBOperationConfig) also supports specifying TableNamePrefix in DynamoDBOperationConfig. Hence, overloaded FromQueryAsync(QueryOperationConfig, DynamoDBOperationConfig) is not a complex workaround, but is designed on the lines of existing method that works for your scenario.

Please refer https://docs.aws.amazon.com/sdkfornet/v3/apidocs/items/DynamoDBv2/TDynamoDBContext.html for more details.

Hence, this is neither a bug or a feature request, rather a guidance issue.

Thanks,
Ashish

[github-actions[bot]]

Hello! Reopening this discussion to make it searchable.