Skip to content

Dictionary (hstore, json, and jsonb) query support#3285

Open
yinzara wants to merge 1 commit intonpgsql:mainfrom
yinzara:feature/212
Open

Dictionary (hstore, json, and jsonb) query support#3285
yinzara wants to merge 1 commit intonpgsql:mainfrom
yinzara:feature/212

Conversation

@yinzara
Copy link

@yinzara yinzara commented Sep 19, 2024

This PR adds support for querying on hstore type columns which can map to either Dictionary<string, string> or ImmutableDictionary<string, string> in C# and for querying any other Dictionary<,> or ImmutableDictionary<,> for json and jsonb types.

See npgsql/doc#369 for full documentation.

Fixes #212

@yinzara yinzara force-pushed the feature/212 branch 2 times, most recently from 8f6dad8 to 49431a8 Compare September 19, 2024 19:21
Copy link
Member

@roji roji left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @yinzara, looks pretty good overall! See comments below.

@roji
Copy link
Member

roji commented Sep 22, 2024

I attempted Keys and Values and could never get it to work correctly.

If you translate Keys via akeys, that simply returns an array, so shouldn't be complicated (note that the provider will automatically call unnest on that array if you start composing arbitrary operators on it). If you translate via skeys which returns a set, things are definitely more complicated.

@yinzara yinzara force-pushed the feature/212 branch 21 times, most recently from df2adf1 to b4e4966 Compare October 4, 2024 07:15
@roji
Copy link
Member

roji commented Feb 20, 2025

@yinzara sorry this is taking so long to merge. In principle, as this is a new feature, it needs to go into 10 and not into 9; aside from a few exceptions, only bug fixes go into patch releases. So can you please rebase back on top of main? Re the preview SDK, it should be pretty easy to set up - you can use the dotnet-install scripts to download the specific version of the SDK specified in the project's global.json, and use that.

@yinzara yinzara changed the base branch from hotfix/9.0.4 to main February 20, 2025 17:05
@yinzara
Copy link
Author

yinzara commented Feb 20, 2025

I've rebased against main. Thank you! Happy to make any other changes you'd like.

SqlExpression? instance,
MethodInfo method,
IReadOnlyList<SqlExpression> arguments,
IDiagnosticsLogger<DbLoggerCategory.Query> logger)
Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Here I attempted to "return null quickly" as much as possible so that you did the least amount of operations before returning null. The logic below was what I found to be the best combination while still being readable and efficient.

/// any release. You should only use it directly in your code with extreme caution and knowing that
/// doing so can result in application failures when updating to a new Entity Framework Core release.
/// </summary>
public SqlExpression? Keys(SqlExpression instance)
Copy link
Author

@yinzara yinzara Feb 20, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I choose to make these methods public and not private so they could be used externally to this translator eventually (i.e. in some expression visitor translator for more complex translations). Honestly internal probably would have been enough but I didn't see that used in a lot of places.

All public methods accept arguments of either json/jsonb or hstore arguments and return the translation or null if the arguments are not json/jsonb/hstore.

Thoughts?

new NpgsqlDateTimeMemberTranslator(typeMappingSource, sqlExpressionFactory),
new NpgsqlJsonDomTranslator(typeMappingSource, sqlExpressionFactory, model),
new NpgsqlLTreeTranslator(typeMappingSource, sqlExpressionFactory, model),
new DictionaryTranslator(typeMappingSource, sqlExpressionFactory, model),
Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Needs to be before the JsonPocoTranslator as it needs to intercept methods on Dictionary types that are json types.

@yinzara yinzara force-pushed the feature/212 branch 2 times, most recently from 9bcdc30 to c76f04d Compare February 20, 2025 18:24
@yinzara
Copy link
Author

yinzara commented Feb 20, 2025

I have now verified that all tests are passing locally after the rebase to main and all unused code and formatting changes have been removed.
I believe this is ready for a final review and approval for testing in the build system.

@yinzara yinzara requested a review from roji February 20, 2025 18:44
@yinzara
Copy link
Author

yinzara commented Apr 4, 2025

Ping

@yinzara
Copy link
Author

yinzara commented May 9, 2025

I know this is kind of a big PR to review but I really feel like this could be a big .NET 10 feature. Queryable dictionaries of every type seems pretty helpful!

Any chance you could get back to it? @roji

@yinzara
Copy link
Author

yinzara commented Jun 9, 2025

@roji It has now been 10 months from my original submission. This feature is one that has been requested by users for more than 8 years and it is fully implemented. You had said you would get to this after the .NET 9 release which was now more than 6 months ago. This feature is fully implemented IMHO and ready for merge.

Can I please get a review?

@klinki
Copy link

klinki commented Sep 9, 2025

This is a great PR, I hope it will get into version 10 release. Especially mapping of Dictionary<string, string> is super useful.

@roji
Copy link
Member

roji commented Sep 9, 2025

@yinzara sorry that this hasn't received more attention in the previous months, I've simply been too busy (the PG provider has generally received very little attention). I admit this isn't on the top of my list generally, since hstore isn't exactly a widely-used/requested feature (the fact that something is open for X years isn't an indication that it's highly-needed, especially given it has received 6 votes total in all that time).

But in any case I'll do my best to devote some time to EFCore.PG in the coming weeks and try to get this merged for 10.

@roji roji force-pushed the main branch 9 times, most recently from 79fae3a to f894de9 Compare February 16, 2026 16:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Translate hstore access to SQL

4 participants

Comments