Skip to content

Commit 8004eb2

Browse files
mgravellmgravell
committed
unify attributesJson over jsonAttributes, and add [StringSyntax] appropriately
1 parent 65efb51 commit 8004eb2

File tree

7 files changed

+22
-13
lines changed

7 files changed

+22
-13
lines changed

‎src/StackExchange.Redis/Interfaces/IDatabase.VectorSets.cs‎

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -153,15 +153,18 @@ bool VectorSetAdd(
153153
/// </summary>
154154
/// <param name="key">The key of the vectorset.</param>
155155
/// <param name="member">The member name.</param>
156-
/// <param name="jsonAttributes">The attributes to set as a JSON string.</param>
156+
/// <param name="attributesJson">The attributes to set as a JSON string.</param>
157157
/// <param name="flags">The flags to use for this operation.</param>
158158
/// <returns>True if successful.</returns>
159159
/// <remarks><seealso href="https://redis.io/commands/vsetattr"/></remarks>
160160
[Experimental(Experiments.VectorSets, UrlFormat = Experiments.UrlFormat)]
161161
bool VectorSetSetAttributesJson(
162162
RedisKey key,
163163
RedisValue member,
164-
string jsonAttributes,
164+
#if NET7_0_OR_GREATER
165+
[StringSyntax(StringSyntaxAttribute.Json)]
166+
#endif
167+
string attributesJson,
165168
CommandFlags flags = CommandFlags.None);
166169

167170
/// <summary>

‎src/StackExchange.Redis/Interfaces/IDatabaseAsync.VectorSets.cs‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,10 @@ Task<bool> VectorSetAddAsync(
8080
Task<bool> VectorSetSetAttributesJsonAsync(
8181
RedisKey key,
8282
RedisValue member,
83-
string jsonAttributes,
83+
#if NET7_0_OR_GREATER
84+
[StringSyntax(StringSyntaxAttribute.Json)]
85+
#endif
86+
string attributesJson,
8487
CommandFlags flags = CommandFlags.None);
8588

8689
/// <inheritdoc cref="IDatabase.VectorSetSimilaritySearch(RedisKey, VectorSetSimilaritySearchRequest, CommandFlags)"/>

‎src/StackExchange.Redis/KeyspaceIsolation/KeyPrefixed.VectorSets.cs‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -48,8 +48,8 @@ public Task<RedisValue[]> VectorSetRandomMembersAsync(RedisKey key, long count,
4848
public Task<bool> VectorSetRemoveAsync(RedisKey key, RedisValue member, CommandFlags flags = CommandFlags.None) =>
4949
Inner.VectorSetRemoveAsync(ToInner(key), member, flags);
5050

51-
public Task<bool> VectorSetSetAttributesJsonAsync(RedisKey key, RedisValue member, string jsonAttributes, CommandFlags flags = CommandFlags.None) =>
52-
Inner.VectorSetSetAttributesJsonAsync(ToInner(key), member, jsonAttributes, flags);
51+
public Task<bool> VectorSetSetAttributesJsonAsync(RedisKey key, RedisValue member, string attributesJson, CommandFlags flags = CommandFlags.None) =>
52+
Inner.VectorSetSetAttributesJsonAsync(ToInner(key), member, attributesJson, flags);
5353

5454
public Task<Lease<VectorSetSimilaritySearchResult>?> VectorSetSimilaritySearchAsync(
5555
RedisKey key,

‎src/StackExchange.Redis/KeyspaceIsolation/KeyPrefixedDatabase.VectorSets.cs‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -45,8 +45,8 @@ public RedisValue[] VectorSetRandomMembers(RedisKey key, long count, CommandFlag
4545
public bool VectorSetRemove(RedisKey key, RedisValue member, CommandFlags flags = CommandFlags.None) =>
4646
Inner.VectorSetRemove(ToInner(key), member, flags);
4747

48-
public bool VectorSetSetAttributesJson(RedisKey key, RedisValue member, string jsonAttributes, CommandFlags flags = CommandFlags.None) =>
49-
Inner.VectorSetSetAttributesJson(ToInner(key), member, jsonAttributes, flags);
48+
public bool VectorSetSetAttributesJson(RedisKey key, RedisValue member, string attributesJson, CommandFlags flags = CommandFlags.None) =>
49+
Inner.VectorSetSetAttributesJson(ToInner(key), member, attributesJson, flags);
5050

5151
public Lease<VectorSetSimilaritySearchResult>? VectorSetSimilaritySearch(
5252
RedisKey key,

‎src/StackExchange.Redis/PublicAPI/PublicAPI.Unshipped.txt‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@
4444
[SER001]StackExchange.Redis.IDatabase.VectorSetRandomMember(StackExchange.Redis.RedisKey key, StackExchange.Redis.CommandFlags flags = StackExchange.Redis.CommandFlags.None) -> StackExchange.Redis.RedisValue
4545
[SER001]StackExchange.Redis.IDatabase.VectorSetRandomMembers(StackExchange.Redis.RedisKey key, long count, StackExchange.Redis.CommandFlags flags = StackExchange.Redis.CommandFlags.None) -> StackExchange.Redis.RedisValue[]!
4646
[SER001]StackExchange.Redis.IDatabase.VectorSetRemove(StackExchange.Redis.RedisKey key, StackExchange.Redis.RedisValue member, StackExchange.Redis.CommandFlags flags = StackExchange.Redis.CommandFlags.None) -> bool
47-
[SER001]StackExchange.Redis.IDatabase.VectorSetSetAttributesJson(StackExchange.Redis.RedisKey key, StackExchange.Redis.RedisValue member, string! jsonAttributes, StackExchange.Redis.CommandFlags flags = StackExchange.Redis.CommandFlags.None) -> bool
47+
[SER001]StackExchange.Redis.IDatabase.VectorSetSetAttributesJson(StackExchange.Redis.RedisKey key, StackExchange.Redis.RedisValue member, string! attributesJson, StackExchange.Redis.CommandFlags flags = StackExchange.Redis.CommandFlags.None) -> bool
4848
[SER001]StackExchange.Redis.IDatabase.VectorSetSimilaritySearch(StackExchange.Redis.RedisKey key, StackExchange.Redis.VectorSetSimilaritySearchRequest! query, StackExchange.Redis.CommandFlags flags = StackExchange.Redis.CommandFlags.None) -> StackExchange.Redis.Lease<StackExchange.Redis.VectorSetSimilaritySearchResult>?
4949
[SER001]StackExchange.Redis.IDatabaseAsync.VectorSetContainsAsync(StackExchange.Redis.RedisKey key, StackExchange.Redis.RedisValue member, StackExchange.Redis.CommandFlags flags = StackExchange.Redis.CommandFlags.None) -> System.Threading.Tasks.Task<bool>!
5050
[SER001]StackExchange.Redis.IDatabaseAsync.VectorSetDimensionAsync(StackExchange.Redis.RedisKey key, StackExchange.Redis.CommandFlags flags = StackExchange.Redis.CommandFlags.None) -> System.Threading.Tasks.Task<int>!
@@ -57,7 +57,7 @@
5757
[SER001]StackExchange.Redis.IDatabaseAsync.VectorSetRandomMemberAsync(StackExchange.Redis.RedisKey key, StackExchange.Redis.CommandFlags flags = StackExchange.Redis.CommandFlags.None) -> System.Threading.Tasks.Task<StackExchange.Redis.RedisValue>!
5858
[SER001]StackExchange.Redis.IDatabaseAsync.VectorSetRandomMembersAsync(StackExchange.Redis.RedisKey key, long count, StackExchange.Redis.CommandFlags flags = StackExchange.Redis.CommandFlags.None) -> System.Threading.Tasks.Task<StackExchange.Redis.RedisValue[]!>!
5959
[SER001]StackExchange.Redis.IDatabaseAsync.VectorSetRemoveAsync(StackExchange.Redis.RedisKey key, StackExchange.Redis.RedisValue member, StackExchange.Redis.CommandFlags flags = StackExchange.Redis.CommandFlags.None) -> System.Threading.Tasks.Task<bool>!
60-
[SER001]StackExchange.Redis.IDatabaseAsync.VectorSetSetAttributesJsonAsync(StackExchange.Redis.RedisKey key, StackExchange.Redis.RedisValue member, string! jsonAttributes, StackExchange.Redis.CommandFlags flags = StackExchange.Redis.CommandFlags.None) -> System.Threading.Tasks.Task<bool>!
60+
[SER001]StackExchange.Redis.IDatabaseAsync.VectorSetSetAttributesJsonAsync(StackExchange.Redis.RedisKey key, StackExchange.Redis.RedisValue member, string! attributesJson, StackExchange.Redis.CommandFlags flags = StackExchange.Redis.CommandFlags.None) -> System.Threading.Tasks.Task<bool>!
6161
[SER001]StackExchange.Redis.IDatabaseAsync.VectorSetSimilaritySearchAsync(StackExchange.Redis.RedisKey key, StackExchange.Redis.VectorSetSimilaritySearchRequest! query, StackExchange.Redis.CommandFlags flags = StackExchange.Redis.CommandFlags.None) -> System.Threading.Tasks.Task<StackExchange.Redis.Lease<StackExchange.Redis.VectorSetSimilaritySearchResult>?>!
6262
[SER001]StackExchange.Redis.VectorSetInfo
6363
[SER001]StackExchange.Redis.VectorSetInfo.Dimension.get -> int

‎src/StackExchange.Redis/RedisDatabase.VectorSets.cs‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -81,9 +81,9 @@ public bool VectorSetRemove(RedisKey key, RedisValue member, CommandFlags flags
8181
return ExecuteSync(msg, ResultProcessor.Boolean);
8282
}
8383

84-
public bool VectorSetSetAttributesJson(RedisKey key, RedisValue member, string jsonAttributes, CommandFlags flags = CommandFlags.None)
84+
public bool VectorSetSetAttributesJson(RedisKey key, RedisValue member, string attributesJson, CommandFlags flags = CommandFlags.None)
8585
{
86-
var msg = Message.Create(Database, flags, RedisCommand.VSETATTR, key, member, jsonAttributes);
86+
var msg = Message.Create(Database, flags, RedisCommand.VSETATTR, key, member, attributesJson);
8787
return ExecuteSync(msg, ResultProcessor.Boolean);
8888
}
8989

@@ -173,9 +173,9 @@ public Task<bool> VectorSetRemoveAsync(RedisKey key, RedisValue member, CommandF
173173
return ExecuteAsync(msg, ResultProcessor.Boolean);
174174
}
175175

176-
public Task<bool> VectorSetSetAttributesJsonAsync(RedisKey key, RedisValue member, string jsonAttributes, CommandFlags flags = CommandFlags.None)
176+
public Task<bool> VectorSetSetAttributesJsonAsync(RedisKey key, RedisValue member, string attributesJson, CommandFlags flags = CommandFlags.None)
177177
{
178-
var msg = Message.Create(Database, flags, RedisCommand.VSETATTR, key, member, jsonAttributes);
178+
var msg = Message.Create(Database, flags, RedisCommand.VSETATTR, key, member, attributesJson);
179179
return ExecuteAsync(msg, ResultProcessor.Boolean);
180180
}
181181

‎src/StackExchange.Redis/VectorSetSimilaritySearchResult.cs‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,9 @@ public readonly struct VectorSetSimilaritySearchResult(RedisValue member, double
2222
/// <summary>
2323
/// The JSON attributes associated with the member when WITHATTRIBS is used, null otherwise.
2424
/// </summary>
25+
#if NET7_0_OR_GREATER
26+
[StringSyntax(StringSyntaxAttribute.Json)]
27+
#endif
2528
public string? AttributesJson { get; } = attributesJson;
2629

2730
/// <inheritdoc/>

0 commit comments

Comments
 (0)