Class used to manage connections to Spanner.
**You don't need to use this class directly, connections will be handled for you.**
{EventEmitter}
Inheritance
EventEmitter > SessionPoolPackage
@google-cloud/spannerConstructors
(constructor)(database, options)
constructor(database: Database, options?: SessionPoolOptions);
Constructs a new instance of the SessionPool
class
Parameters | |
---|---|
Name | Description |
database |
Database
The DB instance. |
options |
SessionPoolOptions
Configuration options. |
Properties
_acquires
_acquires: PQueue;
_evictHandle
_evictHandle: NodeJS.Timer;
_inventory
_inventory: SessionInventory;
_numInProcessPrepare
_numInProcessPrepare: number;
_onClose
_onClose: Promise<void>;
_pending
_pending: number;
_pendingPrepare
_pendingPrepare: number;
_pingHandle
_pingHandle: NodeJS.Timer;
_requests
_requests: PQueue;
_traces
_traces: Map<string, trace.StackFrame[]>;
_waiters
_waiters: Waiters;
available
get available(): number;
Total number of available sessions. {number}
borrowed
get borrowed(): number;
Total number of borrowed sessions. {number}
currentWriteFraction
get currentWriteFraction(): number;
Current fraction of write-prepared sessions in the pool. {number}
database
database: Database;
isFull
get isFull(): boolean;
Flag to determine if Pool is full. {boolean}
isOpen
isOpen: boolean;
numReadWaiters
get numReadWaiters(): number;
Current number of waiters for a read-only session. {number}
numWriteWaiters
get numWriteWaiters(): number;
Current number of waiters for a read/write session. {number}
options
options: SessionPoolOptions;
pendingPrepare
get pendingPrepare(): number;
Number of sessions currently being prepared for a read/write transaction before being released into the pool. This number does not include the number of sessions being prepared for a read/write transaction that have already been checked out of the pool. {number}
reads
get reads(): number;
Total number of read sessions. {number}
size
get size(): number;
Total size of pool. {number}
totalPending
get totalPending(): number;
Number of sessions being created or prepared for a read/write transaction. {number}
totalWaiters
get totalWaiters(): number;
Sum of read and write waiters. {number}
writes
get writes(): number;
Total number of write sessions. {number}
Methods
_acquire(type)
_acquire(type: types): Promise<Session>;
Attempts to borrow a session from the pool.
Parameter | |
---|---|
Name | Description |
type |
types
The desired type to borrow. |
Returns | |
---|---|
Type | Description |
Promise<Session> | {Promise
|
_borrow(session)
_borrow(session: Session): void;
Moves a session into the borrowed group.
Parameter | |
---|---|
Name | Description |
session |
Session
The session object. |
Returns | |
---|---|
Type | Description |
void |
_borrowFrom(type)
_borrowFrom(type: types): Session;
Borrows the first session from specific group. This method may only be called if the inventory actually contains a session of the desired type.
Parameter | |
---|---|
Name | Description |
type |
types
The desired session type. {Session} |
Returns | |
---|---|
Type | Description |
Session |
_borrowNextAvailableSession(type)
_borrowNextAvailableSession(type: types): Session;
Grabs the next available session.
Parameter | |
---|---|
Name | Description |
type |
types
The desired session type. |
Returns | |
---|---|
Type | Description |
Session | {Promise
|
_createSession(type)
_createSession(type: types): Promise<void>;
Attempts to create a single session of a certain type.
Parameter | |
---|---|
Name | Description |
type |
types
The desired type to create. |
Returns | |
---|---|
Type | Description |
Promise<void> | {Promise} |
_createSessions({ reads, writes, })
_createSessions({ reads, writes, }: CreateSessionsOptions): Promise<void>;
Batch creates sessions and prepares any necessary transactions.
Parameter | |
---|---|
Name | Description |
{ reads, writes, } |
CreateSessionsOptions
|
Returns | |
---|---|
Type | Description |
Promise<void> | {Promise} SessionPool#createError |
_destroy(session)
_destroy(session: Session): Promise<void>;
Attempts to delete a session, optionally creating a new one of the same type if the pool is still open and we're under the configured min value.
SessionPool#error
Parameter | |
---|---|
Name | Description |
session |
Session
The session to delete. |
Returns | |
---|---|
Type | Description |
Promise<void> | {Promise} |
_evictIdleSessions()
_evictIdleSessions(): void;
Deletes idle sessions that exceed the maxIdle configuration.
Returns | |
---|---|
Type | Description |
void |
_fill()
_fill(): Promise<void>;
Fills the pool with the minimum number of sessions.
{Promise}
Returns | |
---|---|
Type | Description |
Promise<void> |
_getIdleSessions()
_getIdleSessions(): Session[];
Retrieves a list of all the idle sessions.
Returns | |
---|---|
Type | Description |
Session[] | {Session[]} |
_getLeaks()
_getLeaks(): string[];
Returns stack traces for sessions that have not been released.
{string[]}
Returns | |
---|---|
Type | Description |
string[] |
_getSession(type, startTime)
_getSession(type: types, startTime: number): Promise<Session>;
Attempts to get a session of a specific type. If the type is unavailable it may try to use a different type.
Parameters | |
---|---|
Name | Description |
type |
types
The desired session type. |
startTime |
number
Timestamp to use when determining timeouts. |
Returns | |
---|---|
Type | Description |
Promise<Session> | {Promise
|
_hasSessionUsableFor(type)
_hasSessionUsableFor(type: types): boolean;
Returns true if the pool has a session that is usable for the specified type, i.e. if a read-only session is requested, it returns true if the pool has a read-only or a read/write session. If a read/write session is requested, the method only returns true if the pool has a read/write session available.
Parameter | |
---|---|
Name | Description |
type |
types
The type of session. |
Returns | |
---|---|
Type | Description |
boolean |
_isValidSession(session)
_isValidSession(session: Session): boolean;
Checks to see whether or not session is expired.
Parameter | |
---|---|
Name | Description |
session |
Session
The session to check. |
Returns | |
---|---|
Type | Description |
boolean | {boolean} |
_ping(session)
_ping(session: Session): Promise<void>;
Pings an individual session.
Parameter | |
---|---|
Name | Description |
session |
Session
The session to ping. |
Returns | |
---|---|
Type | Description |
Promise<void> | {Promise} |
_pingIdleSessions()
_pingIdleSessions(): Promise<void>;
Makes a keep alive request to all the idle sessions.
Returns | |
---|---|
Type | Description |
Promise<void> | {Promise} |
_prepareTransaction(session)
_prepareTransaction(session: Session): Promise<void>;
Creates a transaction for a session.
Parameter | |
---|---|
Name | Description |
session |
Session
The session object. |
Returns | |
---|---|
Type | Description |
Promise<void> | {Promise} |
_release(session)
_release(session: Session): void;
Releases a session back into the pool.
SessionPool#available SessionPool#readonly-available SessionPool#readwrite-available
Parameter | |
---|---|
Name | Description |
session |
Session
The session object. |
Returns | |
---|---|
Type | Description |
void |
_startHouseKeeping()
_startHouseKeeping(): void;
Starts housekeeping (pinging/evicting) of idle sessions.
Returns | |
---|---|
Type | Description |
void |
_stopHouseKeeping()
_stopHouseKeeping(): void;
Stops housekeeping.
Returns | |
---|---|
Type | Description |
void |
close(callback)
close(callback: SessionPoolCloseCallback): void;
Closes and the pool.
SessionPool#close
Parameter | |
---|---|
Name | Description |
callback |
SessionPoolCloseCallback
The callback function. |
Returns | |
---|---|
Type | Description |
void |
formatTrace(frames)
static formatTrace(frames: trace.StackFrame[]): string;
Formats stack trace objects into Node-like stack trace.
Parameter | |
---|---|
Name | Description |
frames |
trace.StackFrame[]
|
Returns | |
---|---|
Type | Description |
string |
getReadSession(callback)
getReadSession(callback: GetReadSessionCallback): void;
Retrieve a read session.
Parameter | |
---|---|
Name | Description |
callback |
GetReadSessionCallback
The callback function. |
Returns | |
---|---|
Type | Description |
void |
getWriteSession(callback)
getWriteSession(callback: GetWriteSessionCallback): void;
Retrieve a read/write session.
Parameter | |
---|---|
Name | Description |
callback |
GetWriteSessionCallback
The callback function. |
Returns | |
---|---|
Type | Description |
void |
open()
open(): void;
Opens the pool, filling it to the configured number of read and write sessions.
SessionPool#open {Promise}
Returns | |
---|---|
Type | Description |
void |
release(session)
release(session: Session): void;
Releases session back into the pool. If the session is a write session it will also prepare a new transaction before releasing it.
Parameter | |
---|---|
Name | Description |
session |
Session
The session to release. |
Returns | |
---|---|
Type | Description |
void |