🦉 Updates from OwlBot post-processor

See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md

Author: gcf-owl-bot[bot]

docs/_templates/layout.html

@@ -20,8 +20,8 @@
           {% endblock %}
 
           <div class="body" role="main">
-          	<div class="admonition" id="python2-eol"> 
-          	 As of January 1, 2020 this library no longer supports Python 2 on the latest released version. 
+          	<div class="admonition" id="python2-eol">
+          	 As of January 1, 2020 this library no longer supports Python 2 on the latest released version.
           	 Library versions released prior to that date will continue to be available. For more information please
           	 visit <a href="https://cloud.google.com/python/docs/python2-sunset/">Python 2 support on Google Cloud</a>.
           	</div>

docs/conf.py

@@ -1,19 +1,20 @@
 # -*- coding: utf-8 -*-
-# Copyright 2024 Google LLC
+# Copyright 2025 Google LLC
 #
 # Licensed 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
+#     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.
 #
-# google-cloud-spanner documentation build configuration file
+#
+# google-cloud-spanner-admin-database documentation build configuration file
 #
 # This file is execfile()d with the current directory set to its
 # containing dir.
@@ -42,7 +43,7 @@
 # -- General configuration ------------------------------------------------
 
 # If your documentation needs a minimal Sphinx version, state it here.
-needs_sphinx = "1.5.5"
+needs_sphinx = "4.5.0"
 
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
@@ -80,8 +81,8 @@
 root_doc = "index"
 
 # General information about the project.
-project = "google-cloud-spanner"
-copyright = "2019, Google"
+project = "google-cloud-spanner-admin-database"
+copyright = "2025, Google, LLC"
 author = "Google APIs"
 
 # The version info for the project you're documenting, acts as replacement for
@@ -154,9 +155,9 @@
 # further.  For a list of options available for each theme, see the
 # documentation.
 html_theme_options = {
-    "description": "Google Cloud Client Libraries for google-cloud-spanner",
+    "description": "Google Cloud Client Libraries for google-cloud-spanner-admin-database",
     "github_user": "googleapis",
-    "github_repo": "python-spanner",
+    "github_repo": "google-cloud-python",
     "github_banner": True,
     "font_family": "'Roboto', Georgia, sans",
     "head_font_family": "'Roboto', Georgia, serif",
@@ -248,7 +249,7 @@
 # html_search_scorer = 'scorer.js'
 
 # Output file base name for HTML help builder.
-htmlhelp_basename = "google-cloud-spanner-doc"
+htmlhelp_basename = "google-cloud-spanner-admin-database-doc"
 
 # -- Options for warnings ------------------------------------------------------
 
@@ -266,13 +267,13 @@
 
 latex_elements = {
     # The paper size ('letterpaper' or 'a4paper').
-    #'papersize': 'letterpaper',
+    # 'papersize': 'letterpaper',
     # The font size ('10pt', '11pt' or '12pt').
-    #'pointsize': '10pt',
+    # 'pointsize': '10pt',
     # Additional stuff for the LaTeX preamble.
-    #'preamble': '',
+    # 'preamble': '',
     # Latex figure (float) alignment
-    #'figure_align': 'htbp',
+    # 'figure_align': 'htbp',
 }
 
 # Grouping the document tree into LaTeX files. List of tuples
@@ -281,8 +282,8 @@
 latex_documents = [
     (
         root_doc,
-        "google-cloud-spanner.tex",
-        "google-cloud-spanner Documentation",
+        "google-cloud-spanner-admin-database.tex",
+        "google-cloud-spanner-admin-database Documentation",
         author,
         "manual",
     )
@@ -316,8 +317,8 @@
 man_pages = [
     (
         root_doc,
-        "google-cloud-spanner",
-        "google-cloud-spanner Documentation",
+        "google-cloud-spanner-admin-database",
+        "google-cloud-spanner-admin-database Documentation",
         [author],
         1,
     )
@@ -335,11 +336,11 @@
 texinfo_documents = [
     (
         root_doc,
-        "google-cloud-spanner",
-        "google-cloud-spanner Documentation",
+        "google-cloud-spanner-admin-database",
+        "google-cloud-spanner-admin-database Documentation",
         author,
-        "google-cloud-spanner",
-        "google-cloud-spanner Library",
+        "google-cloud-spanner-admin-database",
+        "google-cloud-spanner-admin-database Library",
         "APIs",
     )
 ]

google/cloud/spanner_v1/services/spanner/async_client.py

@@ -477,10 +477,11 @@ async def sample_batch_create_sessions():
                 should not be set.
             session_count (:class:`int`):
                 Required. The number of sessions to be created in this
-                batch call. The API can return fewer than the requested
-                number of sessions. If a specific number of sessions are
-                desired, the client can make additional calls to
-                ``BatchCreateSessions`` (adjusting
+                batch call. At least one session is created. The API can
+                return fewer than the requested number of sessions. If a
+                specific number of sessions are desired, the client can
+                make additional calls to ``BatchCreateSessions``
+                (adjusting
                 [session_count][google.spanner.v1.BatchCreateSessionsRequest.session_count]
                 as necessary).
 

google/cloud/spanner_v1/services/spanner/client.py

@@ -922,10 +922,11 @@ def sample_batch_create_sessions():
                 should not be set.
             session_count (int):
                 Required. The number of sessions to be created in this
-                batch call. The API can return fewer than the requested
-                number of sessions. If a specific number of sessions are
-                desired, the client can make additional calls to
-                ``BatchCreateSessions`` (adjusting
+                batch call. At least one session is created. The API can
+                return fewer than the requested number of sessions. If a
+                specific number of sessions are desired, the client can
+                make additional calls to ``BatchCreateSessions``
+                (adjusting
                 [session_count][google.spanner.v1.BatchCreateSessionsRequest.session_count]
                 as necessary).
 

google/cloud/spanner_v1/types/__init__.py

@@ -28,6 +28,7 @@
 )
 from .query_plan import (
     PlanNode,
+    QueryAdvisorResult,
     QueryPlan,
 )
 from .result_set import (
@@ -82,6 +83,7 @@
     "KeySet",
     "Mutation",
     "PlanNode",
+    "QueryAdvisorResult",
     "QueryPlan",
     "PartialResultSet",
     "ResultSet",

google/cloud/spanner_v1/types/mutation.py

@@ -21,6 +21,7 @@
 
 from google.cloud.spanner_v1.types import keys
 from google.protobuf import struct_pb2  # type: ignore
+from google.protobuf import timestamp_pb2  # type: ignore
 
 
 __protobuf__ = proto.module(
@@ -89,6 +90,14 @@ class Mutation(proto.Message):
             Delete rows from a table. Succeeds whether or
             not the named rows were present.
 
+            This field is a member of `oneof`_ ``operation``.
+        send (google.cloud.spanner_v1.types.Mutation.Send):
+            Send a message to a queue.
+
+            This field is a member of `oneof`_ ``operation``.
+        ack (google.cloud.spanner_v1.types.Mutation.Ack):
+            Ack a message from a queue.
+
             This field is a member of `oneof`_ ``operation``.
     """
 
@@ -166,6 +175,79 @@ class Delete(proto.Message):
             message=keys.KeySet,
         )
 
+    class Send(proto.Message):
+        r"""Arguments to [send][google.spanner.v1.Mutation.send] operations.
+
+        Attributes:
+            queue (str):
+                Required. The queue to which the message will
+                be sent.
+            key (google.protobuf.struct_pb2.ListValue):
+                Required. The primary key of the message to
+                be sent.
+            deliver_time (google.protobuf.timestamp_pb2.Timestamp):
+                The time at which Spanner will begin attempting to deliver
+                the message. If ``deliver_time`` is not set, Spanner will
+                deliver the message immediately. If ``deliver_time`` is in
+                the past, Spanner will replace it with a value closer to the
+                current time.
+            payload (google.protobuf.struct_pb2.Value):
+                The payload of the message.
+        """
+
+        queue: str = proto.Field(
+            proto.STRING,
+            number=1,
+        )
+        key: struct_pb2.ListValue = proto.Field(
+            proto.MESSAGE,
+            number=2,
+            message=struct_pb2.ListValue,
+        )
+        deliver_time: timestamp_pb2.Timestamp = proto.Field(
+            proto.MESSAGE,
+            number=3,
+            message=timestamp_pb2.Timestamp,
+        )
+        payload: struct_pb2.Value = proto.Field(
+            proto.MESSAGE,
+            number=4,
+            message=struct_pb2.Value,
+        )
+
+    class Ack(proto.Message):
+        r"""Arguments to [ack][google.spanner.v1.Mutation.ack] operations.
+
+        Attributes:
+            queue (str):
+                Required. The queue where the message to be
+                acked is stored.
+            key (google.protobuf.struct_pb2.ListValue):
+                Required. The primary key of the message to
+                be acked.
+            ignore_not_found (bool):
+                By default, an attempt to ack a message that does not exist
+                will fail with a ``NOT_FOUND`` error. With
+                ``ignore_not_found`` set to true, the ack will succeed even
+                if the message does not exist. This is useful for
+                unconditionally acking a message, even if it is missing or
+                has already been acked.
+        """
+
+        queue: str = proto.Field(
+            proto.STRING,
+            number=1,
+        )
+        key: struct_pb2.ListValue = proto.Field(
+            proto.MESSAGE,
+            number=2,
+            message=struct_pb2.ListValue,
+        )
+        ignore_not_found: bool = proto.Field(
+            proto.BOOL,
+            number=3,
+        )
+
     insert: Write = proto.Field(
         proto.MESSAGE,
         number=1,
@@ -196,6 +278,18 @@ class Delete(proto.Message):
         oneof="operation",
         message=Delete,
     )
+    send: Send = proto.Field(
+        proto.MESSAGE,
+        number=6,
+        oneof="operation",
+        message=Send,
+    )
+    ack: Ack = proto.Field(
+        proto.MESSAGE,
+        number=7,
+        oneof="operation",
+        message=Ack,
+    )
 
 
 __all__ = tuple(sorted(__protobuf__.manifest))

google/cloud/spanner_v1/types/query_plan.py

@@ -26,6 +26,7 @@
     package="google.spanner.v1",
     manifest={
         "PlanNode",
+        "QueryAdvisorResult",
         "QueryPlan",
     },
 )
@@ -198,6 +199,49 @@ class ShortRepresentation(proto.Message):
     )
 
 
+class QueryAdvisorResult(proto.Message):
+    r"""Output of query advisor analysis.
+
+    Attributes:
+        index_advice (MutableSequence[google.cloud.spanner_v1.types.QueryAdvisorResult.IndexAdvice]):
+            Optional. Index Recommendation for a query.
+            This is an optional field and the recommendation
+            will only be available when the recommendation
+            guarantees significant improvement in query
+            performance.
+    """
+
+    class IndexAdvice(proto.Message):
+        r"""Recommendation to add new indexes to run queries more
+        efficiently.
+
+        Attributes:
+            ddl (MutableSequence[str]):
+                Optional. DDL statements to add new indexes
+                that will improve the query.
+            improvement_factor (float):
+                Optional. Estimated latency improvement
+                factor. For example if the query currently takes
+                500 ms to run and the estimated latency with new
+                indexes is 100 ms this field will be 5.
+        """
+
+        ddl: MutableSequence[str] = proto.RepeatedField(
+            proto.STRING,
+            number=1,
+        )
+        improvement_factor: float = proto.Field(
+            proto.DOUBLE,
+            number=2,
+        )
+
+    index_advice: MutableSequence[IndexAdvice] = proto.RepeatedField(
+        proto.MESSAGE,
+        number=1,
+        message=IndexAdvice,
+    )
+
+
 class QueryPlan(proto.Message):
     r"""Contains an ordered list of nodes appearing in the query
     plan.
@@ -208,13 +252,22 @@ class QueryPlan(proto.Message):
             pre-order starting with the plan root. Each
             [PlanNode][google.spanner.v1.PlanNode]'s ``id`` corresponds
             to its index in ``plan_nodes``.
+        query_advice (google.cloud.spanner_v1.types.QueryAdvisorResult):
+            Optional. The advise/recommendations for a
+            query. Currently this field will be serving
+            index recommendations for a query.
     """
 
     plan_nodes: MutableSequence["PlanNode"] = proto.RepeatedField(
         proto.MESSAGE,
         number=1,
         message="PlanNode",
     )
+    query_advice: "QueryAdvisorResult" = proto.Field(
+        proto.MESSAGE,
+        number=2,
+        message="QueryAdvisorResult",
+    )
 
 
 __all__ = tuple(sorted(__protobuf__.manifest))