From d60a68649f85f1edfbd8f11673bb280813c2b771 Mon Sep 17 00:00:00 2001
From: Hengfeng Li <hengfeng@google.com>
Date: Wed, 19 May 2021 20:37:29 +1000
Subject: [PATCH] fix(spanner): mark SessionPoolConfig.MaxBurst deprecated
 (#4115)

---
 spanner/session.go | 8 ++++++++
 1 file changed, 8 insertions(+)

diff --git a/spanner/session.go b/spanner/session.go
index c29f9be32de7..5692fd3ffce9 100644
--- a/spanner/session.go
+++ b/spanner/session.go
@@ -411,6 +411,14 @@ type SessionPoolConfig struct {
 
 	// MaxBurst is the maximum number of concurrent session creation requests.
 	//
+	// Deprecated: MaxBurst exists for historical compatibility and should not
+	// be used. MaxBurst was used to limit the number of sessions that the
+	// session pool could create within a time frame. This was an early safety
+	// valve to prevent a client from overwhelming the backend if a large number
+	// of sessions was suddenly needed. The session pool would then pause the
+	// creation of sessions for a while. Such a pause is no longer needed and
+	// the implementation has been removed from the pool.
+	//
 	// Defaults to 10.
 	MaxBurst uint64