Skip to content

Commit f830ce0

Browse files
g-despotmpartipilo
authored andcommitted
Revert dataTimeout renaming
1 parent f54ef96 commit f830ce0

File tree

6 files changed

+30
-30
lines changed

6 files changed

+30
-30
lines changed

docs/CLIENT_INIT.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ var client = await Connect.Local(
5757
hostname: "localhost",
5858
defaultTimeout: TimeSpan.FromSeconds(30),
5959
initTimeout: TimeSpan.FromSeconds(5),
60-
insertTimeout: TimeSpan.FromSeconds(60),
60+
dataTimeout: TimeSpan.FromSeconds(60),
6161
queryTimeout: TimeSpan.FromSeconds(120)
6262
);
6363
```
@@ -213,7 +213,7 @@ The client supports four timeout categories:
213213

214214
1. **DefaultTimeout**: Applied to all operations (fallback timeout) - **Default: 30 seconds**
215215
2. **InitTimeout**: Applied to initialization operations (GetMeta, Live, IsReady) - **Default: 2 seconds**
216-
3. **InsertTimeout**: Applied to data operations (Insert, Delete, Update, Reference management) - **Default: 120 seconds**
216+
3. **DataTimeout**: Applied to data operations (Insert, Delete, Update, Reference management) - **Default: 120 seconds**
217217
4. **QueryTimeout**: Applied to query/search operations (FetchObjects, NearText, BM25, Hybrid, Aggregate) and generative operations (Generate.*) - **Default: 60 seconds**
218218

219219
### Basic Timeout Configuration
@@ -234,7 +234,7 @@ var client = await new WeaviateClientBuilder()
234234
.WithRestEndpoint("localhost")
235235
.WithDefaultTimeout(TimeSpan.FromSeconds(30)) // Fallback timeout
236236
.WithInitTimeout(TimeSpan.FromSeconds(5)) // Fast init timeout
237-
.WithInsertTimeout(TimeSpan.FromSeconds(60)) // Longer for writes
237+
.WithDataTimeout(TimeSpan.FromSeconds(60)) // Longer for writes
238238
.WithQueryTimeout(TimeSpan.FromSeconds(120)) // Longest for searches
239239
.BuildAsync();
240240
```
@@ -243,7 +243,7 @@ var client = await new WeaviateClientBuilder()
243243

244244
- **InitTimeout (2s)**: Initialization operations are quick health checks. A very short timeout quickly detects network connectivity issues during client startup without blocking for long.
245245

246-
- **InsertTimeout (120s)**: Write operations (inserts, deletes, updates, references) may take longer due to indexing and consistency guarantees. The 120-second default allows time for moderate-to-large batch operations.
246+
- **DataTimeout (120s)**: Write operations (inserts, deletes, updates, references) may take longer due to indexing and consistency guarantees. The 120-second default allows time for moderate-to-large batch operations.
247247

248248
- **QueryTimeout (60s)**: Search and retrieval operations (queries, aggregations, generative operations) can be computationally intensive, especially with complex filters, reranking, large result sets, or LLM processing. The 60-second default balances responsiveness with allowing complex queries and generative operations to complete.
249249

@@ -375,7 +375,7 @@ class Program
375375
)
376376
.WithDefaultTimeout(TimeSpan.FromSeconds(30))
377377
.WithInitTimeout(TimeSpan.FromSeconds(5))
378-
.WithInsertTimeout(TimeSpan.FromSeconds(60))
378+
.WithDataTimeout(TimeSpan.FromSeconds(60))
379379
.WithQueryTimeout(TimeSpan.FromSeconds(120))
380380
.WithRetryPolicy(new RetryPolicy(maxRetries: 3))
381381
.BuildAsync();
@@ -426,7 +426,7 @@ var client = await new WeaviateClientBuilder()
426426
.Local(hostname: "localhost")
427427
.WithDefaultTimeout(TimeSpan.FromSeconds(30))
428428
.WithInitTimeout(TimeSpan.FromSeconds(10))
429-
.WithInsertTimeout(TimeSpan.FromSeconds(60))
429+
.WithDataTimeout(TimeSpan.FromSeconds(60))
430430
.WithQueryTimeout(TimeSpan.FromSeconds(120))
431431
.BuildAsync();
432432
```
@@ -450,7 +450,7 @@ var client = await new WeaviateClientBuilder()
450450
.WithHeader("X-API-Key", "secret-key")
451451
.WithDefaultTimeout(TimeSpan.FromSeconds(30))
452452
.WithInitTimeout(TimeSpan.FromSeconds(5))
453-
.WithInsertTimeout(TimeSpan.FromSeconds(90))
453+
.WithDataTimeout(TimeSpan.FromSeconds(90))
454454
.WithQueryTimeout(TimeSpan.FromSeconds(180))
455455
.BuildAsync();
456456
```

src/Weaviate.Client/ConnectionHelpers.cs

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -19,12 +19,12 @@ public static Task<WeaviateClient> Local(
1919
HttpMessageHandler? httpMessageHandler = null,
2020
TimeSpan? defaultTimeout = null,
2121
TimeSpan? initTimeout = null,
22-
TimeSpan? insertTimeout = null,
22+
TimeSpan? dataTimeout = null,
2323
TimeSpan? queryTimeout = null
2424
) =>
2525
WeaviateClientBuilder
2626
.Local(credentials, hostname, restPort, grpcPort, useSsl, headers, httpMessageHandler)
27-
.ApplyTimeouts(defaultTimeout, initTimeout, insertTimeout, queryTimeout)
27+
.ApplyTimeouts(defaultTimeout, initTimeout, dataTimeout, queryTimeout)
2828
.BuildAsync();
2929

3030
/// <summary>
@@ -40,12 +40,12 @@ public static Task<WeaviateClient> Local(
4040
HttpMessageHandler? httpMessageHandler = null,
4141
TimeSpan? defaultTimeout = null,
4242
TimeSpan? initTimeout = null,
43-
TimeSpan? insertTimeout = null,
43+
TimeSpan? dataTimeout = null,
4444
TimeSpan? queryTimeout = null
4545
) =>
4646
WeaviateClientBuilder
4747
.Local(credentials, hostname, restPort, grpcPort, useSsl, headers, httpMessageHandler)
48-
.ApplyTimeouts(defaultTimeout, initTimeout, insertTimeout, queryTimeout)
48+
.ApplyTimeouts(defaultTimeout, initTimeout, dataTimeout, queryTimeout)
4949
.BuildAsync();
5050

5151
/// <summary>
@@ -58,12 +58,12 @@ public static Task<WeaviateClient> Cloud(
5858
HttpMessageHandler? httpMessageHandler = null,
5959
TimeSpan? defaultTimeout = null,
6060
TimeSpan? initTimeout = null,
61-
TimeSpan? insertTimeout = null,
61+
TimeSpan? dataTimeout = null,
6262
TimeSpan? queryTimeout = null
6363
) =>
6464
WeaviateClientBuilder
6565
.Cloud(restEndpoint, apiKey, headers, httpMessageHandler)
66-
.ApplyTimeouts(defaultTimeout, initTimeout, insertTimeout, queryTimeout)
66+
.ApplyTimeouts(defaultTimeout, initTimeout, dataTimeout, queryTimeout)
6767
.BuildAsync();
6868

6969
/// <summary>
@@ -74,7 +74,7 @@ public static Task<WeaviateClient> FromEnvironment(
7474
string prefix = "WEAVIATE_",
7575
TimeSpan? defaultTimeout = null,
7676
TimeSpan? initTimeout = null,
77-
TimeSpan? insertTimeout = null,
77+
TimeSpan? dataTimeout = null,
7878
TimeSpan? queryTimeout = null
7979
)
8080
{
@@ -114,7 +114,7 @@ public static Task<WeaviateClient> FromEnvironment(
114114
}
115115

116116
return builder
117-
.ApplyTimeouts(defaultTimeout, initTimeout, insertTimeout, queryTimeout)
117+
.ApplyTimeouts(defaultTimeout, initTimeout, dataTimeout, queryTimeout)
118118
.BuildAsync();
119119
}
120120
}

src/Weaviate.Client/DataClient.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,12 +21,12 @@ internal DataClient(CollectionClient collectionClient)
2121

2222
/// <summary>
2323
/// Creates a cancellation token with data-specific timeout configuration.
24-
/// Uses InsertTimeout if configured, falls back to DefaultTimeout, then to WeaviateDefaults.InsertTimeout.
24+
/// Uses DataTimeout if configured, falls back to DefaultTimeout, then to WeaviateDefaults.DataTimeout.
2525
/// </summary>
2626
private CancellationToken CreateTimeoutCancellationToken(CancellationToken userToken = default)
2727
{
2828
var effectiveTimeout =
29-
_client.InsertTimeout ?? _client.DefaultTimeout ?? WeaviateDefaults.InsertTimeout;
29+
_client.DataTimeout ?? _client.DefaultTimeout ?? WeaviateDefaults.DataTimeout;
3030
return TimeoutHelper.GetCancellationToken(effectiveTimeout, userToken);
3131
}
3232

src/Weaviate.Client/TimeoutHelper.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ internal static CancellationToken GetCancellationToken(
3434
/// <summary>
3535
/// Creates a CancellationToken from a configuration timeout, falling back to a default timeout if needed.
3636
/// </summary>
37-
/// <param name="configTimeout">The specific timeout from configuration (e.g., InsertTimeout, QueryTimeout).</param>
37+
/// <param name="configTimeout">The specific timeout from configuration (e.g., DataTimeout, QueryTimeout).</param>
3838
/// <param name="defaultTimeout">The default timeout to use if configTimeout is null.</param>
3939
/// <param name="providedToken">An optional cancellation token to link with the timeout token.</param>
4040
/// <returns>A CancellationToken that will be cancelled after the effective timeout expires.</returns>

src/Weaviate.Client/WeaviateClient.cs

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -26,9 +26,9 @@ public static class WeaviateDefaults
2626

2727
/// <summary>
2828
/// Default timeout for data operations (Insert, Delete, Update, Reference management). Default is 120 seconds.
29-
/// This can be overridden per client via ClientConfiguration.WithInsertTimeout().
29+
/// This can be overridden per client via ClientConfiguration.WithDataTimeout().
3030
/// </summary>
31-
public static TimeSpan InsertTimeout { get; set; } = TimeSpan.FromSeconds(120);
31+
public static TimeSpan DataTimeout { get; set; } = TimeSpan.FromSeconds(120);
3232

3333
/// <summary>
3434
/// Default timeout for query/search operations (FetchObjects, NearText, BM25, Hybrid, etc.). Default is 60 seconds.
@@ -112,7 +112,7 @@ public sealed record ClientConfiguration(
112112
ICredentials? Credentials = null,
113113
TimeSpan? DefaultTimeout = null,
114114
TimeSpan? InitTimeout = null,
115-
TimeSpan? InsertTimeout = null,
115+
TimeSpan? DataTimeout = null,
116116
TimeSpan? QueryTimeout = null,
117117
RetryPolicy? RetryPolicy = null,
118118
DelegatingHandler[]? CustomHandlers = null
@@ -464,7 +464,7 @@ static bool IsWeaviateDomain(string url)
464464

465465
public TimeSpan? DefaultTimeout => Configuration.DefaultTimeout;
466466
public TimeSpan? InitTimeout => Configuration.InitTimeout;
467-
public TimeSpan? InsertTimeout => Configuration.InsertTimeout;
467+
public TimeSpan? DataTimeout => Configuration.DataTimeout;
468468
public TimeSpan? QueryTimeout => Configuration.QueryTimeout;
469469

470470
/// <summary>

src/Weaviate.Client/WeaviateClientBuilder.cs

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ public partial class WeaviateClientBuilder
1818
private HttpMessageHandler? _httpMessageHandler = null;
1919
private TimeSpan? _defaultTimeout = null;
2020
private TimeSpan? _initTimeout = null;
21-
private TimeSpan? _insertTimeout = null;
21+
private TimeSpan? _dataTimeout = null;
2222
private TimeSpan? _queryTimeout = null;
2323
private RetryPolicy? _retryPolicy = null;
2424
private readonly List<DelegatingHandler> _customHandlers = new();
@@ -189,9 +189,9 @@ public WeaviateClientBuilder WithInitTimeout(TimeSpan timeout)
189189
/// <summary>
190190
/// Sets the timeout for data operations.
191191
/// </summary>
192-
public WeaviateClientBuilder WithInsertTimeout(TimeSpan timeout)
192+
public WeaviateClientBuilder WithDataTimeout(TimeSpan timeout)
193193
{
194-
_insertTimeout = timeout;
194+
_dataTimeout = timeout;
195195
return this;
196196
}
197197

@@ -210,16 +210,16 @@ public WeaviateClientBuilder WithQueryTimeout(TimeSpan timeout)
210210
public WeaviateClientBuilder ApplyTimeouts(
211211
TimeSpan? defaultTimeout = null,
212212
TimeSpan? initTimeout = null,
213-
TimeSpan? insertTimeout = null,
213+
TimeSpan? dataTimeout = null,
214214
TimeSpan? queryTimeout = null
215215
)
216216
{
217217
if (defaultTimeout.HasValue)
218218
WithDefaultTimeout(defaultTimeout.Value);
219219
if (initTimeout.HasValue)
220220
WithInitTimeout(initTimeout.Value);
221-
if (insertTimeout.HasValue)
222-
WithInsertTimeout(insertTimeout.Value);
221+
if (dataTimeout.HasValue)
222+
WithDataTimeout(dataTimeout.Value);
223223
if (queryTimeout.HasValue)
224224
WithQueryTimeout(queryTimeout.Value);
225225
return this;
@@ -278,7 +278,7 @@ public async Task<WeaviateClient> BuildAsync()
278278
_credentials,
279279
_defaultTimeout,
280280
_initTimeout,
281-
_insertTimeout,
281+
_dataTimeout,
282282
_queryTimeout,
283283
_retryPolicy,
284284
_customHandlers.Count > 0 ? _customHandlers.ToArray() : null
@@ -311,7 +311,7 @@ public WeaviateClient Build()
311311
_credentials,
312312
_defaultTimeout,
313313
_initTimeout,
314-
_insertTimeout,
314+
_dataTimeout,
315315
_queryTimeout,
316316
_retryPolicy,
317317
_customHandlers.Count > 0 ? _customHandlers.ToArray() : null

0 commit comments

Comments
 (0)