From 06e4d6b50c73276a9ad77f71b3f79649397858c5 Mon Sep 17 00:00:00 2001 From: Luke Sneeringer Date: Mon, 25 Sep 2017 13:28:00 -0700 Subject: [PATCH] Provide correct API for monitoring an LRO (database). (#4048) --- docs/spanner/database-usage.rst | 17 ++--------------- 1 file changed, 2 insertions(+), 15 deletions(-) diff --git a/docs/spanner/database-usage.rst b/docs/spanner/database-usage.rst index c2419a33e88b..b713ff991e84 100644 --- a/docs/spanner/database-usage.rst +++ b/docs/spanner/database-usage.rst @@ -96,26 +96,13 @@ Check on Current Database Operation The :meth:`~google.cloud.spanner.database.Database.create` and :meth:`~google.cloud.spanner.database.Database.update` methods of instance object trigger long-running operations on the server, and return instances -of the :class:`~google.cloud.spanner.database.Operation` class. - -You can check if a long-running operation has finished -by using its :meth:`~google.cloud.spanner.database.Operation.finished` -method: +conforming to the :class:`~.concurrent.futures.Future` class. .. code:: python >>> operation = instance.create() - >>> operation.finished() - True - -.. note:: + >>> operation.result() - Once an :class:`~google.cloud.spanner.instance.Operation` object - has returned :data:`True` from its - :meth:`~google.cloud.spanner.instance.Operation.finished` method, the - object should not be re-used. Subsequent calls to - :meth:`~google.cloud.spanner.instance.Operation.finished` - will result in an :exc`ValueError` being raised. Non-Admin Database Usage ========================