feat: Add Spanner location API

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

@@ -49,6 +49,7 @@
 
 from google.cloud.spanner_v1.services.spanner import pagers
 from google.cloud.spanner_v1.types import commit_response
+from google.cloud.spanner_v1.types import location
 from google.cloud.spanner_v1.types import mutation
 from google.cloud.spanner_v1.types import result_set
 from google.cloud.spanner_v1.types import spanner
@@ -477,10 +478,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

@@ -64,6 +64,7 @@
 
 from google.cloud.spanner_v1.services.spanner import pagers
 from google.cloud.spanner_v1.types import commit_response
+from google.cloud.spanner_v1.types import location
 from google.cloud.spanner_v1.types import mutation
 from google.cloud.spanner_v1.types import result_set
 from google.cloud.spanner_v1.types import spanner
@@ -922,10 +923,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

@@ -23,11 +23,21 @@
     KeyRange,
     KeySet,
 )
+from .location import (
+    CacheUpdate,
+    Group,
+    KeyRecipe,
+    Range,
+    RecipeList,
+    RoutingHint,
+    Tablet,
+)
 from .mutation import (
     Mutation,
 )
 from .query_plan import (
     PlanNode,
+    QueryAdvisorResult,
     QueryPlan,
 )
 from .result_set import (
@@ -80,8 +90,16 @@
     "CommitResponse",
     "KeyRange",
     "KeySet",
+    "CacheUpdate",
+    "Group",
+    "KeyRecipe",
+    "Range",
+    "RecipeList",
+    "RoutingHint",
+    "Tablet",
     "Mutation",
     "PlanNode",
+    "QueryAdvisorResult",
     "QueryPlan",
     "PartialResultSet",
     "ResultSet",