feat(ndb): New sample for named-database support in Cloud NDB (GoogleCloudPlatform#10637)

rwhogg · web-flow · commit 2cd3b9328e97 · 2023-10-16T17:50:53.000+02:00
diff --git a/datastore/cloud-ndb/named_db.py b/datastore/cloud-ndb/named_db.py
@@ -0,0 +1,25 @@
+# Copyright 2023 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
+#
+# 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.
+
+
+def create_named_db_client():
+    # [START datastore_ndb_named_db]
+    import os
+
+    from google.cloud import ndb
+
+    database = os.environ.get("DATASTORE_DATABASE", "prod-database")
+    client = ndb.Client(database=database)
+    # [END datastore_ndb_named_db]
+    return client
diff --git a/datastore/cloud-ndb/named_db_test.py b/datastore/cloud-ndb/named_db_test.py
@@ -0,0 +1,23 @@
+# Copyright 2023 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
+#
+# 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.
+
+import os
+
+from named_db import create_named_db_client
+
+
+def test_named_db():
+    os.environ["DATASTORE_DATABASE"] = "test"
+    client = create_named_db_client()
+    assert client.database == "test"
diff --git a/testing/test-env.tmpl.sh b/testing/test-env.tmpl.sh
@@ -113,3 +113,6 @@ export CONNECTOR=
 # Dialogflow examples.
 export SMART_REPLY_MODEL=
 export SMART_REPLY_ALLOWLIST=
+
+# Datastore/Firestore
+export DATASTORE_DATABASE=
