apacheGH-39204: [FlightRPC] Stabilize Flight SQL

Update documentation, protobufs, and class documentation to remove experimental tags from Flight and Flight SQL documentation.
Bit-Quill · May 14, 2024 · 33924b9 · 33924b9
1 parent e411e0e
commit 33924b9
Show file tree

Hide file tree

Showing 19 changed files with 12 additions and 75 deletions.
diff --git a/cpp/src/arrow/flight/client.h b/cpp/src/arrow/flight/client.h
@@ -15,8 +15,7 @@
 // specific language governing permissions and limitations
 // under the License.
 
-/// \brief Implementation of Flight RPC client. API should be
-/// considered experimental for now
+/// \brief Implementation of Flight RPC client.
 
 #pragma once
 
@@ -177,7 +176,6 @@ class ARROW_FLIGHT_EXPORT FlightMetadataReader {
 };
 
 /// \brief Client class for Arrow Flight RPC services.
-/// API experimental for now
 class ARROW_FLIGHT_EXPORT FlightClient {
  public:
   ~FlightClient();
@@ -275,8 +273,6 @@ class ARROW_FLIGHT_EXPORT FlightClient {
   /// \param[in] options Per-RPC options
   /// \param[in] descriptor the dataset request
   /// \param[in] listener Callbacks for response and RPC completion
-  ///
-  /// This API is EXPERIMENTAL.
   void GetFlightInfoAsync(const FlightCallOptions& options,
                           const FlightDescriptor& descriptor,
                           std::shared_ptr<AsyncListener<FlightInfo>> listener);
@@ -288,8 +284,6 @@ class ARROW_FLIGHT_EXPORT FlightClient {
   /// \brief Asynchronous GetFlightInfo returning a Future.
   /// \param[in] options Per-RPC options
   /// \param[in] descriptor the dataset request
-  ///
-  /// This API is EXPERIMENTAL.
   arrow::Future<FlightInfo> GetFlightInfoAsync(const FlightCallOptions& options,
                                                const FlightDescriptor& descriptor);
   arrow::Future<FlightInfo> GetFlightInfoAsync(const FlightDescriptor& descriptor) {

diff --git a/cpp/src/arrow/flight/cookie_internal.cc b/cpp/src/arrow/flight/cookie_internal.cc
@@ -15,8 +15,7 @@
 // specific language governing permissions and limitations
 // under the License.
 
-// Interfaces for defining middleware for Flight clients. Currently
-// experimental.
+// Interfaces for defining middleware for Flight clients.
 
 #include "arrow/flight/cookie_internal.h"
 #include "arrow/flight/client.h"

diff --git a/cpp/src/arrow/flight/middleware.h b/cpp/src/arrow/flight/middleware.h
@@ -16,7 +16,7 @@
 // under the License.
 
 // Interfaces for defining middleware for Flight clients and
-// servers. Currently experimental.
+// servers.
 
 #pragma once
 

diff --git a/cpp/src/arrow/flight/server.h b/cpp/src/arrow/flight/server.h
@@ -15,8 +15,7 @@
 // specific language governing permissions and limitations
 // under the License.
 
-// Interfaces to use for defining Flight RPC servers. API should be considered
-// experimental for now
+// Interfaces to use for defining Flight RPC servers.
 
 #pragma once
 

diff --git a/cpp/src/arrow/flight/server_middleware.h b/cpp/src/arrow/flight/server_middleware.h
@@ -15,8 +15,7 @@
 // specific language governing permissions and limitations
 // under the License.
 
-// Interfaces for defining middleware for Flight servers. Currently
-// experimental.
+// Interfaces for defining middleware for Flight servers.
 
 #pragma once
 

diff --git a/cpp/src/arrow/flight/sql/server.cc b/cpp/src/arrow/flight/sql/server.cc
@@ -15,8 +15,7 @@
 // specific language governing permissions and limitations
 // under the License.
 
-// Interfaces to use for defining Flight RPC servers. API should be considered
-// experimental for now
+// Interfaces to use for defining Flight RPC servers.
 
 // Platform-specific defines
 #include "arrow/flight/platform.h"

diff --git a/cpp/src/arrow/flight/sql/server.h b/cpp/src/arrow/flight/sql/server.h
@@ -15,8 +15,7 @@
 // specific language governing permissions and limitations
 // under the License.
 
-// Interfaces to use for defining Flight RPC servers. API should be considered
-// experimental for now
+// Interfaces to use for defining Flight RPC servers.
 
 #pragma once
 

diff --git a/cpp/src/arrow/flight/sql/server_session_middleware.h b/cpp/src/arrow/flight/sql/server_session_middleware.h
@@ -16,7 +16,6 @@
 // under the License.
 
 // Middleware for handling Flight SQL Sessions including session cookie handling.
-// Currently experimental.
 
 #pragma once
 

diff --git a/cpp/src/arrow/flight/transport.h b/cpp/src/arrow/flight/transport.h
@@ -19,8 +19,6 @@
 /// Internal (but not private) interface for implementing
 /// alternate network transports in Flight.
 ///
-/// \warning EXPERIMENTAL. Subject to change.
-///
 /// To implement a transport, implement ServerTransport and
 /// ClientTransport, and register the desired URI schemes with
 /// TransportRegistry. Flight takes care of most of the per-RPC
@@ -248,8 +246,6 @@ TransportRegistry* GetDefaultTransportRegistry();
 /// Transport implementations may subclass this to store their own
 /// state, and stash an instance in a user-supplied AsyncListener via
 /// ClientTransport::GetAsyncRpc and ClientTransport::SetAsyncRpc.
-///
-/// This API is EXPERIMENTAL.
 class ARROW_FLIGHT_EXPORT AsyncRpc {
  public:
   virtual ~AsyncRpc() = default;

diff --git a/cpp/src/arrow/flight/types.h b/cpp/src/arrow/flight/types.h
@@ -15,7 +15,7 @@
 // specific language governing permissions and limitations
 // under the License.
 
-// Data structure for Flight RPC. API should be considered experimental for now
+// Data structure for Flight RPC.
 
 #pragma once
 
@@ -1115,8 +1115,6 @@ std::string ToString(TransportStatusCode code);
 ///   instead of trying to translate to Arrow Status.
 ///
 /// Currently, only attached to the Status passed to AsyncListener::OnFinish.
-///
-/// This API is EXPERIMENTAL.
 class ARROW_FLIGHT_EXPORT TransportStatusDetail : public StatusDetail {
  public:
   constexpr static const char* kTypeId = "flight::TransportStatusDetail";

diff --git a/cpp/src/arrow/flight/types_async.h b/cpp/src/arrow/flight/types_async.h
@@ -31,8 +31,6 @@ namespace arrow::flight {
 /// @{
 
 /// \brief Non-templated state for an async RPC.
-///
-/// This API is EXPERIMENTAL.
 class ARROW_FLIGHT_EXPORT AsyncListenerBase {
  public:
   AsyncListenerBase();
@@ -57,8 +55,6 @@ class ARROW_FLIGHT_EXPORT AsyncListenerBase {
 /// A single listener may not be used for multiple concurrent RPC
 /// calls.  The application MUST hold the listener alive until
 /// OnFinish() is called and has finished.
-///
-/// This API is EXPERIMENTAL.
 template <typename T>
 class ARROW_FLIGHT_EXPORT AsyncListener : public AsyncListenerBase {
  public:

diff --git a/docs/source/cpp/api/flightsql.rst b/docs/source/cpp/api/flightsql.rst
@@ -22,8 +22,6 @@
 Arrow Flight SQL
 ================
 
-.. note:: Flight SQL is currently experimental and APIs are subject to change.
-
 Common Types
 ============
 

diff --git a/docs/source/format/FlightSql.rst b/docs/source/format/FlightSql.rst
@@ -32,9 +32,6 @@ with any database that supports the necessary endpoints. Flight SQL
 clients wrap the underlying Flight client to provide methods for the
 new RPC methods described here.
 
-.. warning:: Flight SQL is **experimental** and changes to the
-             protocol may still be made.
-
 RPC Methods
 ===========
 

diff --git a/docs/source/java/overview.rst b/docs/source/java/overview.rst
@@ -54,10 +54,10 @@ but some modules are JNI bindings to the C++ library.
      - (Experimental) A library for converting JDBC data to Arrow data.
      - Native
    * - flight-core
-     - (Experimental) An RPC mechanism for transferring ValueVectors.
+     - An RPC mechanism for transferring ValueVectors.
      - Native
    * - flight-sql
-     - (Experimental) Contains utility classes to expose Flight SQL semantics for clients and servers over Arrow Flight.
+     - Contains utility classes to expose Flight SQL semantics for clients and servers over Arrow Flight.
      - Native
    * - flight-integration-tests
      - Integration tests for Flight RPC.