Skip to content
This repository was archived by the owner on Mar 31, 2026. It is now read-only.

Commit 507a4ec

Browse files
committed
docs: document logger param
1 parent b2bf238 commit 507a4ec

2 files changed

Lines changed: 12 additions & 0 deletions

File tree

google/cloud/spanner_v1/database.py

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -96,6 +96,12 @@ class Database(object):
9696
:param pool: (Optional) session pool to be used by database. If not
9797
passed, the database will construct an instance of
9898
:class:`~google.cloud.spanner_v1.pool.BurstyPool`.
99+
100+
:type logger: `logging.Logger`
101+
:param logger: (Optional) a custom logger that is used if `log_commit_stats`
102+
is `True` to log commit statistics. If not passed, a logger
103+
will be created when needed that will log the commit statistics
104+
to stdout.
99105
"""
100106

101107
_spanner_api = None

google/cloud/spanner_v1/instance.py

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -371,6 +371,12 @@ def database(self, database_id, ddl_statements=(), pool=None, logger=None):
371371
:class:`~google.cloud.spanner_v1.pool.AbstractSessionPool`.
372372
:param pool: (Optional) session pool to be used by database.
373373
374+
:type logger: `logging.Logger`
375+
:param logger: (Optional) a custom logger that is used if `log_commit_stats`
376+
is `True` to log commit statistics. If not passed, a logger
377+
will be created when needed that will log the commit statistics
378+
to stdout.
379+
374380
:rtype: :class:`~google.cloud.spanner_v1.database.Database`
375381
:returns: a database owned by this instance.
376382
"""

0 commit comments

Comments
 (0)