forked from apache/arrow-adbc
-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(csharp/src/Drivers/Apache): add connect and query timeout options (
apache#2312) Adds options for command and query timeout | Property | Description | Default | | :--- | :--- | :--- | | `adbc.spark.connect_timeout_ms` | Sets the timeout (in milliseconds) to open a new session. Values can be 0 (infinite) or greater than zero. | `30000` | | `adbc.apache.statement.query_timeout_s` | Sets the maximum time (in seconds) for a query to complete. Values can be 0 (infinite) or greater than zero. | `60` | --------- Co-authored-by: Aman Goyal <[email protected]> Co-authored-by: David Coe <[email protected]>
- Loading branch information
3 people
authored
Dec 4, 2024
1 parent
08ac053
commit 845f9c2
Showing
23 changed files
with
1,098 additions
and
353 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,29 @@ | ||
| /* | ||
| * Licensed to the Apache Software Foundation (ASF) under one or more | ||
| * contributor license agreements. See the NOTICE file distributed with | ||
| * this work for additional information regarding copyright ownership. | ||
| * The ASF licenses this file to You under the Apache License, Version 2.0 | ||
| * (the "License"); you may not use this file except in compliance with | ||
| * the License. You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
|
|
||
| namespace Apache.Arrow.Adbc.Drivers.Apache | ||
| { | ||
| /// <summary> | ||
| /// Options common to all Apache drivers. | ||
| /// </summary> | ||
| public class ApacheParameters | ||
| { | ||
| public const string PollTimeMilliseconds = "adbc.apache.statement.polltime_ms"; | ||
| public const string BatchSize = "adbc.apache.statement.batch_size"; | ||
| public const string QueryTimeoutSeconds = "adbc.apache.statement.query_timeout_s"; | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,141 @@ | ||
| /* | ||
| * Licensed to the Apache Software Foundation (ASF) under one or more | ||
| * contributor license agreements. See the NOTICE file distributed with | ||
| * this work for additional information regarding copyright ownership. | ||
| * The ASF licenses this file to You under the Apache License, Version 2.0 | ||
| * (the "License"); you may not use this file except in compliance with | ||
| * the License. You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
|
|
||
| using System; | ||
| using System.Threading; | ||
|
|
||
| namespace Apache.Arrow.Adbc.Drivers.Apache | ||
| { | ||
| internal class ApacheUtility | ||
| { | ||
| internal const int QueryTimeoutSecondsDefault = 60; | ||
|
|
||
| public enum TimeUnit | ||
| { | ||
| Seconds, | ||
| Milliseconds | ||
| } | ||
|
|
||
| public static CancellationToken GetCancellationToken(int timeout, TimeUnit timeUnit) | ||
| { | ||
| TimeSpan span; | ||
|
|
||
| if (timeout == 0 || timeout == int.MaxValue) | ||
| { | ||
| // the max TimeSpan for CancellationTokenSource is int.MaxValue in milliseconds (not TimeSpan.MaxValue) | ||
| // no matter what the unit is | ||
| span = TimeSpan.FromMilliseconds(int.MaxValue); | ||
| } | ||
| else | ||
| { | ||
| if (timeUnit == TimeUnit.Seconds) | ||
| { | ||
| span = TimeSpan.FromSeconds(timeout); | ||
| } | ||
| else | ||
| { | ||
| span = TimeSpan.FromMilliseconds(timeout); | ||
| } | ||
| } | ||
|
|
||
| return GetCancellationToken(span); | ||
| } | ||
|
|
||
| private static CancellationToken GetCancellationToken(TimeSpan timeSpan) | ||
| { | ||
| var cts = new CancellationTokenSource(timeSpan); | ||
| return cts.Token; | ||
| } | ||
|
|
||
| public static bool QueryTimeoutIsValid(string key, string value, out int queryTimeoutSeconds) | ||
| { | ||
| if (!string.IsNullOrEmpty(value) && int.TryParse(value, out int queryTimeout) && (queryTimeout >= 0)) | ||
| { | ||
| queryTimeoutSeconds = queryTimeout; | ||
| return true; | ||
| } | ||
| else | ||
| { | ||
| throw new ArgumentOutOfRangeException(key, value, $"The value '{value}' for option '{key}' is invalid. Must be a numeric value of 0 (infinite) or greater."); | ||
| } | ||
| } | ||
|
|
||
| public static bool ContainsException<T>(Exception exception, out T? containedException) where T : Exception | ||
| { | ||
| if (exception is AggregateException aggregateException) | ||
| { | ||
| foreach (Exception? ex in aggregateException.InnerExceptions) | ||
| { | ||
| if (ex is T ce) | ||
| { | ||
| containedException = ce; | ||
| return true; | ||
| } | ||
| } | ||
| } | ||
|
|
||
| Exception? e = exception; | ||
| while (e != null) | ||
| { | ||
| if (e is T ce) | ||
| { | ||
| containedException = ce; | ||
| return true; | ||
| } | ||
| e = e.InnerException; | ||
| } | ||
|
|
||
| containedException = null; | ||
| return false; | ||
| } | ||
|
|
||
| public static bool ContainsException(Exception exception, Type? exceptionType, out Exception? containedException) | ||
| { | ||
| if (exception == null || exceptionType == null) | ||
| { | ||
| containedException = null; | ||
| return false; | ||
| } | ||
|
|
||
| if (exception is AggregateException aggregateException) | ||
| { | ||
| foreach (Exception? ex in aggregateException.InnerExceptions) | ||
| { | ||
| if (exceptionType.IsInstanceOfType(ex)) | ||
| { | ||
| containedException = ex; | ||
| return true; | ||
| } | ||
| } | ||
| } | ||
|
|
||
| Exception? e = exception; | ||
| while (e != null) | ||
| { | ||
| if (exceptionType.IsInstanceOfType(e)) | ||
| { | ||
| containedException = e; | ||
| return true; | ||
| } | ||
| e = e.InnerException; | ||
| } | ||
|
|
||
| containedException = null; | ||
| return false; | ||
| } | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.