Merge pull request #488 from ydb-platform/remove_experimental

Remove experimental warn from query service
ydb-platform · Sep 19, 2024 · ce03ac6 · ce03ac6
2 parents 67dfc17 + e1c83d5
commit ce03ac6
Show file tree

Hide file tree

Showing 7 changed files with 25 additions and 81 deletions.
diff --git a/ydb/aio/query/pool.py b/ydb/aio/query/pool.py
@@ -28,7 +28,6 @@ def __init__(self, driver: common_utils.SupportedDriverType, size: int = 100):
         :param size: Size of session pool
         """
 
-        logger.warning("QuerySessionPool is an experimental API, which could be changed.")
         self._driver = driver
         self._size = size
         self._should_stop = asyncio.Event()
@@ -44,9 +43,7 @@ async def _create_new_session(self):
         return session
 
     async def acquire(self) -> QuerySession:
-        """WARNING: This API is experimental and could be changed.
-
-        Acquire a session from Session Pool.
+        """Acquire a session from Session Pool.
 
         :return A QuerySession object.
         """
@@ -86,28 +83,20 @@ async def acquire(self) -> QuerySession:
         return session
 
     async def release(self, session: QuerySession) -> None:
-        """WARNING: This API is experimental and could be changed.
-
-        Release a session back to Session Pool.
-        """
+        """Release a session back to Session Pool."""
 
         self._queue.put_nowait(session)
         logger.debug("Session returned to queue: %s", session._state.session_id)
 
     def checkout(self) -> "SimpleQuerySessionCheckoutAsync":
-        """WARNING: This API is experimental and could be changed.
-
-        Return a Session context manager, that acquires session on enter and releases session on exit.
-        """
+        """Return a Session context manager, that acquires session on enter and releases session on exit."""
 
         return SimpleQuerySessionCheckoutAsync(self)
 
     async def retry_operation_async(
         self, callee: Callable, retry_settings: Optional[RetrySettings] = None, *args, **kwargs
     ):
-        """WARNING: This API is experimental and could be changed.
-
-        Special interface to execute a bunch of commands with session in a safe, retriable way.
+        """Special interface to execute a bunch of commands with session in a safe, retriable way.
 
         :param callee: A function, that works with session.
         :param retry_settings: RetrySettings object.
@@ -131,9 +120,7 @@ async def execute_with_retries(
         *args,
         **kwargs,
     ) -> List[convert.ResultSet]:
-        """WARNING: This API is experimental and could be changed.
-
-        Special interface to execute a one-shot queries in a safe, retriable way.
+        """Special interface to execute a one-shot queries in a safe, retriable way.
         Note: this method loads all data from stream before return, do not use this
         method with huge read queries.
 

diff --git a/ydb/aio/query/session.py b/ydb/aio/query/session.py
@@ -64,9 +64,7 @@ async def _check_session_status_loop(self) -> None:
                 self._state._change_state(QuerySessionStateEnum.CLOSED)
 
     async def delete(self, settings: Optional[BaseRequestSettings] = None) -> None:
-        """WARNING: This API is experimental and could be changed.
-
-        Deletes a Session of Query Service on server side and releases resources.
+        """Deletes a Session of Query Service on server side and releases resources.
 
         :return: None
         """
@@ -78,9 +76,7 @@ async def delete(self, settings: Optional[BaseRequestSettings] = None) -> None:
         self._stream.cancel()
 
     async def create(self, settings: Optional[BaseRequestSettings] = None) -> "QuerySession":
-        """WARNING: This API is experimental and could be changed.
-
-        Creates a Session of Query Service on server side and attaches it.
+        """Creates a Session of Query Service on server side and attaches it.
 
         :return: QuerySession object.
         """
@@ -113,9 +109,7 @@ async def execute(
         concurrent_result_sets: bool = False,
         settings: Optional[BaseRequestSettings] = None,
     ) -> AsyncResponseContextIterator:
-        """WARNING: This API is experimental and could be changed.
-
-        Sends a query to Query Service
+        """Sends a query to Query Service
 
         :param query: (YQL or SQL text) to be executed.
         :param syntax: Syntax of the query, which is a one from the following choises:

diff --git a/ydb/aio/query/transaction.py b/ydb/aio/query/transaction.py
@@ -48,9 +48,7 @@ async def _ensure_prev_stream_finished(self) -> None:
             self._prev_stream = None
 
     async def begin(self, settings: Optional[BaseRequestSettings] = None) -> "QueryTxContext":
-        """WARNING: This API is experimental and could be changed.
-
-        Explicitly begins a transaction
+        """Explicitly begins a transaction
 
         :param settings: An additional request settings BaseRequestSettings;
 
@@ -60,9 +58,7 @@ async def begin(self, settings: Optional[BaseRequestSettings] = None) -> "QueryT
         return self
 
     async def commit(self, settings: Optional[BaseRequestSettings] = None) -> None:
-        """WARNING: This API is experimental and could be changed.
-
-        Calls commit on a transaction if it is open otherwise is no-op. If transaction execution
+        """Calls commit on a transaction if it is open otherwise is no-op. If transaction execution
         failed then this method raises PreconditionFailed.
 
         :param settings: An additional request settings BaseRequestSettings;
@@ -81,9 +77,7 @@ async def commit(self, settings: Optional[BaseRequestSettings] = None) -> None:
         await self._commit_call(settings)
 
     async def rollback(self, settings: Optional[BaseRequestSettings] = None) -> None:
-        """WARNING: This API is experimental and could be changed.
-
-        Calls rollback on a transaction if it is open otherwise is no-op. If transaction execution
+        """Calls rollback on a transaction if it is open otherwise is no-op. If transaction execution
         failed then this method raises PreconditionFailed.
 
         :param settings: An additional request settings BaseRequestSettings;
@@ -111,9 +105,7 @@ async def execute(
         concurrent_result_sets: Optional[bool] = False,
         settings: Optional[BaseRequestSettings] = None,
     ) -> AsyncResponseContextIterator:
-        """WARNING: This API is experimental and could be changed.
-
-        Sends a query to Query Service
+        """Sends a query to Query Service
 
         :param query: (YQL or SQL text) to be executed.
         :param parameters: dict with parameters and YDB types;

diff --git a/ydb/query/__init__.py b/ydb/query/__init__.py
@@ -35,7 +35,6 @@
 
 class QueryClientSync:
     def __init__(self, driver: common_utils.SupportedDriverType, query_client_settings: QueryClientSettings = None):
-        logger.warning("QueryClientSync is an experimental API, which could be changed.")
         self._driver = driver
         self._settings = query_client_settings
 

diff --git a/ydb/query/pool.py b/ydb/query/pool.py
@@ -33,7 +33,6 @@ def __init__(self, driver: common_utils.SupportedDriverType, size: int = 100):
         :param size: Max size of Session Pool.
         """
 
-        logger.warning("QuerySessionPool is an experimental API, which could be changed.")
         self._driver = driver
         self._queue = queue.Queue()
         self._current_size = 0
@@ -48,9 +47,7 @@ def _create_new_session(self, timeout: Optional[float]):
         return session
 
     def acquire(self, timeout: Optional[float] = None) -> QuerySession:
-        """WARNING: This API is experimental and could be changed.
-
-        Acquire a session from Session Pool.
+        """Acquire a session from Session Pool.
 
         :param timeout: A timeout to wait in seconds.
 
@@ -102,28 +99,21 @@ def acquire(self, timeout: Optional[float] = None) -> QuerySession:
                 self._lock.release()
 
     def release(self, session: QuerySession) -> None:
-        """WARNING: This API is experimental and could be changed.
-
-        Release a session back to Session Pool.
-        """
+        """Release a session back to Session Pool."""
 
         self._queue.put_nowait(session)
         logger.debug("Session returned to queue: %s", session._state.session_id)
 
     def checkout(self, timeout: Optional[float] = None) -> "SimpleQuerySessionCheckout":
-        """WARNING: This API is experimental and could be changed.
-
-        Return a Session context manager, that acquires session on enter and releases session on exit.
+        """Return a Session context manager, that acquires session on enter and releases session on exit.
 
         :param timeout: A timeout to wait in seconds.
         """
 
         return SimpleQuerySessionCheckout(self, timeout)
 
     def retry_operation_sync(self, callee: Callable, retry_settings: Optional[RetrySettings] = None, *args, **kwargs):
-        """WARNING: This API is experimental and could be changed.
-
-        Special interface to execute a bunch of commands with session in a safe, retriable way.
+        """Special interface to execute a bunch of commands with session in a safe, retriable way.
 
         :param callee: A function, that works with session.
         :param retry_settings: RetrySettings object.
@@ -147,9 +137,7 @@ def execute_with_retries(
         *args,
         **kwargs,
     ) -> List[convert.ResultSet]:
-        """WARNING: This API is experimental and could be changed.
-
-        Special interface to execute a one-shot queries in a safe, retriable way.
+        """Special interface to execute a one-shot queries in a safe, retriable way.
         Note: this method loads all data from stream before return, do not use this
         method with huge read queries.
 

diff --git a/ydb/query/session.py b/ydb/query/session.py
@@ -235,9 +235,7 @@ def _check_session_status_loop(self, status_stream: _utilities.SyncResponseItera
                 self._state._change_state(QuerySessionStateEnum.CLOSED)
 
     def delete(self, settings: Optional[BaseRequestSettings] = None) -> None:
-        """WARNING: This API is experimental and could be changed.
-
-        Deletes a Session of Query Service on server side and releases resources.
+        """Deletes a Session of Query Service on server side and releases resources.
 
         :return: None
         """
@@ -249,9 +247,7 @@ def delete(self, settings: Optional[BaseRequestSettings] = None) -> None:
         self._stream.cancel()
 
     def create(self, settings: Optional[BaseRequestSettings] = None) -> "QuerySession":
-        """WARNING: This API is experimental and could be changed.
-
-        Creates a Session of Query Service on server side and attaches it.
+        """Creates a Session of Query Service on server side and attaches it.
 
         :return: QuerySession object.
         """
@@ -266,9 +262,7 @@ def create(self, settings: Optional[BaseRequestSettings] = None) -> "QuerySessio
         return self
 
     def transaction(self, tx_mode: Optional[base.BaseQueryTxMode] = None) -> QueryTxContext:
-        """WARNING: This API is experimental and could be changed.
-
-        Creates a transaction context manager with specified transaction mode.
+        """Creates a transaction context manager with specified transaction mode.
 
         :param tx_mode: Transaction mode, which is a one from the following choises:
          1) QuerySerializableReadWrite() which is default mode;
@@ -299,9 +293,7 @@ def execute(
         concurrent_result_sets: bool = False,
         settings: Optional[BaseRequestSettings] = None,
     ) -> base.SyncResponseContextIterator:
-        """WARNING: This API is experimental and could be changed.
-
-        Sends a query to Query Service
+        """Sends a query to Query Service
 
         :param query: (YQL or SQL text) to be executed.
         :param syntax: Syntax of the query, which is a one from the following choises:

diff --git a/ydb/query/transaction.py b/ydb/query/transaction.py
@@ -327,9 +327,7 @@ def _ensure_prev_stream_finished(self) -> None:
             self._prev_stream = None
 
     def begin(self, settings: Optional[BaseRequestSettings] = None) -> "QueryTxContext":
-        """WARNING: This API is experimental and could be changed.
-
-        Explicitly begins a transaction
+        """Explicitly begins a transaction
 
         :param settings: An additional request settings BaseRequestSettings;
 
@@ -340,9 +338,7 @@ def begin(self, settings: Optional[BaseRequestSettings] = None) -> "QueryTxConte
         return self
 
     def commit(self, settings: Optional[BaseRequestSettings] = None) -> None:
-        """WARNING: This API is experimental and could be changed.
-
-        Calls commit on a transaction if it is open otherwise is no-op. If transaction execution
+        """Calls commit on a transaction if it is open otherwise is no-op. If transaction execution
         failed then this method raises PreconditionFailed.
 
         :param settings: An additional request settings BaseRequestSettings;
@@ -361,9 +357,7 @@ def commit(self, settings: Optional[BaseRequestSettings] = None) -> None:
         self._commit_call(settings)
 
     def rollback(self, settings: Optional[BaseRequestSettings] = None) -> None:
-        """WARNING: This API is experimental and could be changed.
-
-        Calls rollback on a transaction if it is open otherwise is no-op. If transaction execution
+        """Calls rollback on a transaction if it is open otherwise is no-op. If transaction execution
         failed then this method raises PreconditionFailed.
 
         :param settings: An additional request settings BaseRequestSettings;
@@ -391,9 +385,7 @@ def execute(
         concurrent_result_sets: Optional[bool] = False,
         settings: Optional[BaseRequestSettings] = None,
     ) -> base.SyncResponseContextIterator:
-        """WARNING: This API is experimental and could be changed.
-
-        Sends a query to Query Service
+        """Sends a query to Query Service
 
         :param query: (YQL or SQL text) to be executed.
         :param parameters: dict with parameters and YDB types;