ARROW-15452: [FlightRPC][Java] JDBC driver for Flight SQL

cpp/src/arrow/flight/sql/column_metadata.cc

@@ -42,6 +42,7 @@ bool StringToBoolean(const std::string& string_value) {
 const char* ColumnMetadata::kCatalogName = "ARROW:FLIGHT:SQL:CATALOG_NAME";
 const char* ColumnMetadata::kSchemaName = "ARROW:FLIGHT:SQL:SCHEMA_NAME";
 const char* ColumnMetadata::kTableName = "ARROW:FLIGHT:SQL:TABLE_NAME";
+const char* ColumnMetadata::kTypeName = "ARROW:FLIGHT:SQL:TYPE_NAME";
 const char* ColumnMetadata::kPrecision = "ARROW:FLIGHT:SQL:PRECISION";
 const char* ColumnMetadata::kScale = "ARROW:FLIGHT:SQL:SCALE";
 const char* ColumnMetadata::kIsAutoIncrement = "ARROW:FLIGHT:SQL:IS_AUTO_INCREMENT";
@@ -65,6 +66,10 @@ arrow::Result<std::string> ColumnMetadata::GetTableName() const {
   return metadata_map_->Get(kTableName);
 }
 
+arrow::Result<std::string> ColumnMetadata::GetTypeName() const {
+  return metadata_map_->Get(kTypeName);
+}
+
 arrow::Result<int32_t> ColumnMetadata::GetPrecision() const {
   std::string precision_string;
   ARROW_ASSIGN_OR_RAISE(precision_string, metadata_map_->Get(kPrecision));
@@ -130,6 +135,12 @@ ColumnMetadata::ColumnMetadataBuilder& ColumnMetadata::ColumnMetadataBuilder::Ta
   return *this;
 }
 
+ColumnMetadata::ColumnMetadataBuilder& ColumnMetadata::ColumnMetadataBuilder::TypeName(
+    std::string& type_name) {
+  metadata_map_->Append(ColumnMetadata::kTypeName, type_name);
+  return *this;
+}
+
 ColumnMetadata::ColumnMetadataBuilder& ColumnMetadata::ColumnMetadataBuilder::Precision(
     int32_t precision) {
   metadata_map_->Append(ColumnMetadata::kPrecision, std::to_string(precision));

cpp/src/arrow/flight/sql/column_metadata.h

@@ -46,6 +46,9 @@ class ColumnMetadata {
   static const char* kTableName;
   /// \brief Constant variable to hold the value of the key that
   ///        will be used in the KeyValueMetadata class.
+  static const char* kTypeName;
+  /// \brief Constant variable to hold the value of the key that
+  ///        will be used in the KeyValueMetadata class.
   static const char* kPrecision;
   /// \brief Constant variable to hold the value of the key that
   ///        will be used in the KeyValueMetadata class.
@@ -78,6 +81,10 @@ class ColumnMetadata {
   /// \return The table name.
   arrow::Result<std::string> GetTableName() const;
 
+  /// \brief  Return the type name set in the KeyValueMetadata.
+  /// \return The type name.
+  arrow::Result<std::string> GetTypeName() const;
+
   /// \brief  Return the precision set in the KeyValueMetadata.
   /// \return The precision.
   arrow::Result<int32_t> GetPrecision() const;
@@ -117,15 +124,20 @@ class ColumnMetadata {
     ColumnMetadataBuilder& CatalogName(std::string& catalog_name);
 
     /// \brief Set the schema_name in the KeyValueMetadata object.
-    /// \param[in] schema_name The schema_name.
+    /// \param[in] schema_name  The schema_name.
     /// \return                 A ColumnMetadataBuilder.
     ColumnMetadataBuilder& SchemaName(std::string& schema_name);
 
     /// \brief Set the table name in the KeyValueMetadata object.
-    /// \param[in] table_name The table name.
+    /// \param[in] table_name   The table name.
     /// \return                 A ColumnMetadataBuilder.
     ColumnMetadataBuilder& TableName(std::string& table_name);
 
+    /// \brief Set the type name in the KeyValueMetadata object.
+    /// \param[in] type_name    The type name.
+    /// \return                 A ColumnMetadataBuilder.
+    ColumnMetadataBuilder& TypeName(std::string& type_name);
+
     /// \brief Set the precision in the KeyValueMetadata object.
     /// \param[in] precision    The precision.
     /// \return                 A ColumnMetadataBuilder.
@@ -138,22 +150,22 @@ class ColumnMetadata {
 
     /// \brief Set the IsAutoIncrement in the KeyValueMetadata object.
     /// \param[in] is_auto_increment  The IsAutoIncrement.
-    /// \return                     A ColumnMetadataBuilder.
+    /// \return                       A ColumnMetadataBuilder.
     ColumnMetadataBuilder& IsAutoIncrement(bool is_auto_increment);
 
     /// \brief Set the IsCaseSensitive in the KeyValueMetadata object.
     /// \param[in] is_case_sensitive The IsCaseSensitive.
-    /// \return                    A ColumnMetadataBuilder.
+    /// \return                      A ColumnMetadataBuilder.
     ColumnMetadataBuilder& IsCaseSensitive(bool is_case_sensitive);
 
     /// \brief Set the IsReadOnly in the KeyValueMetadata object.
     /// \param[in] is_read_only   The IsReadOnly.
-    /// \return                 A ColumnMetadataBuilder.
+    /// \return                   A ColumnMetadataBuilder.
     ColumnMetadataBuilder& IsReadOnly(bool is_read_only);
 
     /// \brief Set the IsSearchable in the KeyValueMetadata object.
     /// \param[in] is_searchable The IsSearchable.
-    /// \return                 A ColumnMetadataBuilder.
+    /// \return                  A ColumnMetadataBuilder.
     ColumnMetadataBuilder& IsSearchable(bool is_searchable);
 
     ColumnMetadata Build() const;

format/FlightSql.proto

@@ -1118,6 +1118,7 @@ message CommandGetDbSchemas {
  *  - ARROW:FLIGHT:SQL:CATALOG_NAME      - Table's catalog name
  *  - ARROW:FLIGHT:SQL:DB_SCHEMA_NAME    - Database schema name
  *  - ARROW:FLIGHT:SQL:TABLE_NAME        - Table name
+ *  - ARROW:FLIGHT:SQL:TYPE_NAME         - Type name
  *  - ARROW:FLIGHT:SQL:PRECISION         - Column precision/size
  *  - ARROW:FLIGHT:SQL:SCALE             - Column scale/decimal digits if applicable
  *  - ARROW:FLIGHT:SQL:IS_AUTO_INCREMENT - "1" indicates if the column is auto incremented, "0" otherwise.
@@ -1457,6 +1458,7 @@ message ActionClosePreparedStatementRequest {
  *    - ARROW:FLIGHT:SQL:CATALOG_NAME      - Table's catalog name
  *    - ARROW:FLIGHT:SQL:DB_SCHEMA_NAME    - Database schema name
  *    - ARROW:FLIGHT:SQL:TABLE_NAME        - Table name
+ *    - ARROW:FLIGHT:SQL:TYPE_NAME         - Type name
  *    - ARROW:FLIGHT:SQL:PRECISION         - Column precision/size
  *    - ARROW:FLIGHT:SQL:SCALE             - Column scale/decimal digits if applicable
  *    - ARROW:FLIGHT:SQL:IS_AUTO_INCREMENT - "1" indicates if the column is auto incremented, "0" otherwise.
@@ -1491,6 +1493,7 @@ message TicketStatementQuery {
  *    - ARROW:FLIGHT:SQL:CATALOG_NAME      - Table's catalog name
  *    - ARROW:FLIGHT:SQL:DB_SCHEMA_NAME    - Database schema name
  *    - ARROW:FLIGHT:SQL:TABLE_NAME        - Table name
+ *    - ARROW:FLIGHT:SQL:TYPE_NAME         - Type name
  *    - ARROW:FLIGHT:SQL:PRECISION         - Column precision/size
  *    - ARROW:FLIGHT:SQL:SCALE             - Column scale/decimal digits if applicable
  *    - ARROW:FLIGHT:SQL:IS_AUTO_INCREMENT - "1" indicates if the column is auto incremented, "0" otherwise.

java/flight/flight-jdbc-driver/jdbc-spotbugs-exclude.xml

@@ -0,0 +1,40 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!-- 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. -->
+
+<FindBugsFilter>
+    <!--  These elements are supposed to be mutable  -->
+    <Match>
+        <Package name="~org\.apache\.arrow\.driver\.jdbc\.accessor\.impl.*"/>
+        <Bug pattern="EI_EXPOSE_REP2"/>
+    </Match>
+    <Match>
+        <Class name="org.apache.arrow.driver.jdbc.client.ArrowFlightSqlClientHandler"/>
+        <Bug pattern="EI_EXPOSE_REP2"/>
+    </Match>
+    <Match>
+        <Class name="org.apache.arrow.driver.jdbc.utils.ConnectionWrapper"/>
+        <Bug pattern="EI_EXPOSE_REP2"/>
+    </Match>
+    <Match>
+        <Class name="org.apache.arrow.driver.jdbc.ArrowFlightJdbcDataSource"/>
+        <Bug pattern="EI_EXPOSE_REP2"/>
+    </Match>
+    <Match>
+        <Class name="org.apache.arrow.driver.jdbc.ArrowFlightJdbcCursor"/>
+        <Bug pattern="EI_EXPOSE_REP2"/>
+    </Match>
+
+    <Match>
+        <Class name="org.apache.arrow.driver.jdbc.ArrowFlightJdbcDataSource"/>
+        <Bug pattern="EI_EXPOSE_REP"/>
+    </Match>
+</FindBugsFilter>