feat(csharp/src/Drivers/BigQuery): add override for excluding table c…

…onstraints (#1512) - Adds a new parameter value to exclude the additional calls to obtain table constraints - Fixes some common nits about spacing --------- Co-authored-by: David Coe <[email protected]>
apache · Feb 5, 2024 · 3828e0b · 3828e0b
1 parent b1947bf
commit 3828e0b
Show file tree

Hide file tree

Showing 12 changed files with 61 additions and 18 deletions.
diff --git a/csharp/src/Client/AdbcColumn.cs b/csharp/src/Client/AdbcColumn.cs
@@ -59,7 +59,7 @@ public AdbcColumn(string name, Type dataType, IArrowType arrowType, bool nullabl
             this.DataType = dataType;
             this.ArrowType = arrowType;
 
-            if(precision.HasValue && scale.HasValue)
+            if (precision.HasValue && scale.HasValue)
             {
                 this.NumericScale = scale.Value;
                 this.NumericPrecision = precision.Value;

diff --git a/csharp/src/Client/AdbcCommand.cs b/csharp/src/Client/AdbcCommand.cs
@@ -42,10 +42,10 @@ public sealed class AdbcCommand : DbCommand
         /// <exception cref="ArgumentNullException"></exception>
         public AdbcCommand(AdbcStatement adbcStatement, AdbcConnection adbcConnection) : base()
         {
-            if(adbcStatement == null)
+            if (adbcStatement == null)
                 throw new ArgumentNullException(nameof(adbcStatement));
 
-            if(adbcConnection == null)
+            if (adbcConnection == null)
                 throw new ArgumentNullException(nameof(adbcConnection));
 
             this.adbcStatement = adbcStatement;
@@ -183,7 +183,7 @@ protected override DbDataReader ExecuteDbDataReader(CommandBehavior behavior)
 
         protected override void Dispose(bool disposing)
         {
-            if(disposing)
+            if (disposing)
             {
                 // TODO: ensure not in the middle of pulling
                 this.adbcStatement?.Dispose();

diff --git a/csharp/src/Client/AdbcDataReader.cs b/csharp/src/Client/AdbcDataReader.cs
@@ -217,7 +217,7 @@ public override object GetValue(int ordinal)
             if (value == null)
                 return null;
 
-            if(value is SqlDecimal dValue)
+            if (value is SqlDecimal dValue)
             {
                 if (this.DecimalBehavior == DecimalBehavior.UseSqlDecimal)
                 {
@@ -317,7 +317,7 @@ public ReadOnlyCollection<AdbcColumn> GetAdbcColumnSchema()
                 {
                     Type t = SchemaConverter.ConvertArrowType(f, this.DecimalBehavior);
 
-                    if(f.HasMetadata &&
+                    if (f.HasMetadata &&
                        f.Metadata.ContainsKey("precision") &&
                        f.Metadata.ContainsKey("scale"))
                     {
@@ -361,7 +361,7 @@ private ValueTask<RecordBatch> ReadNextRecordBatchAsync(CancellationToken cancel
 
             RecordBatch recordBatch = this.adbcQueryResult.Stream.ReadNextRecordBatchAsync(cancellationToken).Result;
 
-            if( recordBatch != null )
+            if (recordBatch != null)
             {
                 this.TotalBatches += 1;
             }

diff --git a/csharp/src/Client/SchemaConverter.cs b/csharp/src/Client/SchemaConverter.cs
@@ -34,7 +34,7 @@ internal class SchemaConverter
         /// <exception cref="ArgumentNullException"></exception>
         public static DataTable ConvertArrowSchema(Schema schema, AdbcStatement adbcStatement, DecimalBehavior decimalBehavior)
         {
-            if(schema == null)
+            if (schema == null)
                 throw new ArgumentNullException(nameof(schema));
 
             if (adbcStatement == null)

diff --git a/csharp/src/Drivers/BigQuery/BigQueryConnection.cs b/csharp/src/Drivers/BigQuery/BigQueryConnection.cs
@@ -427,15 +427,29 @@ private StructArray GetTableSchemas(
 
             if (result != null)
             {
+                bool includeConstraints = true;
+
+                if (this.properties.TryGetValue(BigQueryParameters.IncludeConstraintsWithGetObjects, out string includeConstraintsValue))
+                {
+                    bool.TryParse(includeConstraintsValue, out includeConstraints);
+                }
+
                 foreach (BigQueryRow row in result)
                 {
                     tableNameBuilder.Append(GetValue(row["table_name"]));
                     tableTypeBuilder.Append(GetValue(row["table_type"]));
                     nullBitmapBuffer.Append(true);
                     length++;
 
-                    tableConstraintsValues.Add(GetConstraintSchema(
-                        depth, catalog, dbSchema, GetValue(row["table_name"]), columnNamePattern));
+                    if (includeConstraints)
+                    {
+                        tableConstraintsValues.Add(GetConstraintSchema(
+                            depth, catalog, dbSchema, GetValue(row["table_name"]), columnNamePattern));
+                    }
+                    else
+                    {
+                        tableConstraintsValues.Add(null);
+                    }
 
                     if (depth == GetObjectsDepth.Tables)
                     {

diff --git a/csharp/src/Drivers/BigQuery/BigQueryParameters.cs b/csharp/src/Drivers/BigQuery/BigQueryParameters.cs
@@ -33,6 +33,7 @@ public class BigQueryParameters
         public const string UseLegacySQL = "adbc.bigquery.use_legacy_sql";
         public const string LargeDecimalsAsString = "adbc.bigquery.large_decimals_as_string";
         public const string Scopes = "adbc.bigquery.scopes";
+        public const string IncludeConstraintsWithGetObjects = "adbc.bigquery.include_constraints_getobjects";
     }
 
     /// <summary>

diff --git a/csharp/src/Drivers/BigQuery/BigQueryStatement.cs b/csharp/src/Drivers/BigQuery/BigQueryStatement.cs
@@ -199,14 +199,14 @@ static IArrowReader ReadChunk(BigQueryReadClient readClient, string streamName)
 
                     string[] segments = destinationTable.Split('.');
 
-                    if(segments.Length != 3)
+                    if (segments.Length != 3)
                         throw new InvalidOperationException($"{BigQueryParameters.LargeResultsDestinationTable} cannot be parsed");
 
                     projectId = segments[0];
                     datasetId = segments[1];
                     tableId = segments[2];
 
-                    if(string.IsNullOrEmpty(projectId.Trim()) || string.IsNullOrEmpty(datasetId.Trim()) || string.IsNullOrEmpty(tableId.Trim()))
+                    if (string.IsNullOrEmpty(projectId.Trim()) || string.IsNullOrEmpty(datasetId.Trim()) || string.IsNullOrEmpty(tableId.Trim()))
                         throw new InvalidOperationException($"{BigQueryParameters.LargeResultsDestinationTable} contains invalid values");
 
                     options.DestinationTable = new TableReference()

diff --git a/csharp/src/Drivers/BigQuery/readme.md b/csharp/src/Drivers/BigQuery/readme.md
@@ -32,6 +32,8 @@ The ADBC driver passes the configured credentials to BigQuery, but you may need
 
 ## Parameters
 
+The following parameters can be used to configure the driver behavior. The parameters are case sensitive.
+
 **adbc.bigquery.allow_large_results**<br>
 &nbsp;&nbsp;&nbsp;&nbsp;Sets the [AllowLargeResults](https://cloud.google.com/dotnet/docs/reference/Google.Cloud.BigQuery.V2/latest/Google.Cloud.BigQuery.V2.QueryOptions#Google_Cloud_BigQuery_V2_QueryOptions_AllowLargeResults) value of the QueryOptions to `true` if configured; otherwise, the default is `false`.
 
@@ -49,9 +51,11 @@ https://cloud.google.com/dotnet/docs/reference/Google.Cloud.BigQuery.V2/latest/G
 **adbc.bigquery.auth_json_credential**<br>
 &nbsp;&nbsp;&nbsp;&nbsp;Required if using `service` authentication. This value is passed to the [GoogleCredential.FromJson](https://cloud.google.com/dotnet/docs/reference/Google.Apis/latest/Google.Apis.Auth.OAuth2.GoogleCredential#Google_Apis_Auth_OAuth2_GoogleCredential_FromJson_System_String) method.
 
-**adbc.bigquery.large_results_destination_table**<br>
-&nbsp;&nbsp;&nbsp;&nbsp;Sets the [DestinationTable](https://cloud.google.com/dotnet/docs/reference/Google.Cloud.BigQuery.V2/latest/Google.Cloud.BigQuery.V2.QueryOptions#Google_Cloud_BigQuery_V2_QueryOptions_DestinationTable) value of the QueryOptions if configured. Expects the format to be `{projectId}.{datasetId}.{tableId}` to set the corresponding values in the [TableReference](https://github.com/googleapis/google-api-dotnet-client/blob/6c415c73788b848711e47c6dd33c2f93c76faf97/Src/Generated/Google.Apis.Bigquery.v2/Google.Apis.Bigquery.v2.cs#L9348) class.
+**adbc.bigquery.include_constraints_getobjects**<br>
+&nbsp;&nbsp;&nbsp;&nbsp;Optional. Some callers do not need the constraint details when they get the table information and can improve the speed of obtaining the results. Setting this value to `"false"` will not include the constraint details. The default value is `"true"`.
 
+**adbc.bigquery.large_results_destination_table**<br>
+&nbsp;&nbsp;&nbsp;&nbsp;Optional. Sets the [DestinationTable](https://cloud.google.com/dotnet/docs/reference/Google.Cloud.BigQuery.V2/latest/Google.Cloud.BigQuery.V2.QueryOptions#Google_Cloud_BigQuery_V2_QueryOptions_DestinationTable) value of the QueryOptions if configured. Expects the format to be `{projectId}.{datasetId}.{tableId}` to set the corresponding values in the [TableReference](https://github.com/googleapis/google-api-dotnet-client/blob/6c415c73788b848711e47c6dd33c2f93c76faf97/Src/Generated/Google.Apis.Bigquery.v2/Google.Apis.Bigquery.v2.cs#L9348) class.
 
 **adbc.bigquery.project_id**<br>
 &nbsp;&nbsp;&nbsp;&nbsp;The [Project ID](https://cloud.google.com/resource-manager/docs/creating-managing-projects) used for accessing BigQuery.

diff --git a/csharp/src/Drivers/Interop/Snowflake/SnowflakeDriverLoader.cs b/csharp/src/Drivers/Interop/Snowflake/SnowflakeDriverLoader.cs
@@ -34,7 +34,7 @@ public static AdbcDriver LoadDriver()
         {
             string file = "libadbc_driver_snowflake.dll";
 
-            if(File.Exists(file))
+            if (File.Exists(file))
             {
                 // get the full path because some .NET versions need it
                 file = Path.GetFullPath(file);

diff --git a/csharp/test/Drivers/BigQuery/BigQueryTestConfiguration.cs b/csharp/test/Drivers/BigQuery/BigQueryTestConfiguration.cs
@@ -27,6 +27,7 @@ internal class BigQueryTestConfiguration : TestConfiguration
         public BigQueryTestConfiguration()
         {
             AllowLargeResults = false;
+            IncludeTableConstraints = true;
         }
 
         [JsonPropertyName("projectId")]
@@ -52,5 +53,8 @@ public BigQueryTestConfiguration()
 
         [JsonPropertyName("largeResultsDestinationTable")]
         public string LargeResultsDestinationTable { get; set; }
+
+        [JsonPropertyName("includeTableConstraints")]
+        public bool IncludeTableConstraints { get; set; }
     }
 }
diff --git a/csharp/test/Drivers/BigQuery/BigQueryTestingUtils.cs b/csharp/test/Drivers/BigQuery/BigQueryTestingUtils.cs
@@ -74,12 +74,14 @@ internal static Dictionary<string,string> GetBigQueryParameters(BigQueryTestConf
                 parameters.Add(BigQueryParameters.Scopes, testConfiguration.Scopes);
             }
 
-            if(testConfiguration.AllowLargeResults)
+            if (testConfiguration.AllowLargeResults)
             {
                 parameters.Add(BigQueryParameters.AllowLargeResults, testConfiguration.AllowLargeResults.ToString());
             }
 
-            if(!string.IsNullOrEmpty(testConfiguration.LargeResultsDestinationTable))
+            parameters.Add(BigQueryParameters.IncludeConstraintsWithGetObjects, testConfiguration.IncludeTableConstraints.ToString());
+
+            if (!string.IsNullOrEmpty(testConfiguration.LargeResultsDestinationTable))
             {
                 parameters.Add(BigQueryParameters.LargeResultsDestinationTable, testConfiguration.LargeResultsDestinationTable);
             }

diff --git a/csharp/test/Drivers/BigQuery/ClientTests.cs b/csharp/test/Drivers/BigQuery/ClientTests.cs
@@ -100,6 +100,22 @@ public void VerifyTypesAndValues()
             }
         }
 
+        [SkippableFact]
+        public void VerifySchemaTablesWithNoConstraints()
+        {
+            using (Adbc.Client.AdbcConnection adbcConnection = GetAdbcConnection(includeTableConstraints: false))
+            {
+                adbcConnection.Open();
+
+                string schema = "Tables";
+
+                var tables = adbcConnection.GetSchema(schema);
+
+                Assert.True(tables.Rows.Count > 0, $"No tables were found in the schema '{schema}'");
+            }
+        }
+
+
         [SkippableFact]
         public void VerifySchemaTables()
         {
@@ -166,8 +182,10 @@ public void VerifySchemaTables()
             }
         }
 
-        private Adbc.Client.AdbcConnection GetAdbcConnection()
+        private Adbc.Client.AdbcConnection GetAdbcConnection(bool includeTableConstraints = true)
         {
+            _testConfiguration.IncludeTableConstraints = includeTableConstraints;
+
             return new Adbc.Client.AdbcConnection(
                 new BigQueryDriver(),
                 BigQueryTestingUtils.GetBigQueryParameters(_testConfiguration),