Class DatabaseSessionService

Base class for session services. The service provides a set of methods for managing sessions and events.

Hierarchy (view full)

BaseSessionService
- DatabaseSessionService

Index

Constructors

Methods

createSession getSession updateSession listSessions deleteSession appendEvent updateSessionState

Constructors

constructor

new DatabaseSessionService(config): DatabaseSessionService
Parameters
- config: DatabaseSessionServiceConfig
Returns DatabaseSessionService
Overrides BaseSessionService.constructor
- Defined in packages/adk/src/sessions/database-session-service.ts:80

Methods

createSession

createSession(appName, userId, state?, sessionId?): Promise<Session>
Creates a new session.
Parameters
- appName: string
  The name of the app.
- userId: string
  The id of the user.
- Optionalstate: Record<string, any>
  The initial state of the session.
- OptionalsessionId: string
  The client-provided id of the session. If not provided, a generated ID will be used.
Returns Promise<Session>
The newly created session instance.
Overrides BaseSessionService.createSession
- Defined in packages/adk/src/sessions/database-session-service.ts:238

getSession

getSession(appName, userId, sessionId, config?): Promise<Session>
Gets a session.
Parameters
- appName: string
  The name of the app.
- userId: string
  The id of the user.
- sessionId: string
  The id of the session.
- Optionalconfig: GetSessionConfig
  Optional config for getting the session.
Returns Promise<Session>
The session or undefined if not found.
Overrides BaseSessionService.getSession
- Defined in packages/adk/src/sessions/database-session-service.ts:350

updateSession

updateSession(session): Promise<void>
Parameters
- session: Session
Returns Promise<void>
- Defined in packages/adk/src/sessions/database-session-service.ts:434

listSessions

listSessions(appName, userId): Promise<ListSessionsResponse>
Lists all the sessions.
Parameters
- appName: string
  The name of the app.
- userId: string
  The id of the user.
Returns Promise<ListSessionsResponse>
The response containing the list of sessions.
Overrides BaseSessionService.listSessions
- Defined in packages/adk/src/sessions/database-session-service.ts:449

deleteSession

deleteSession(appName, userId, sessionId): Promise<void>
Deletes a session.
Parameters
- appName: string
  The name of the app.
- userId: string
  The id of the user.
- sessionId: string
  The id of the session.
Returns Promise<void>
Overrides BaseSessionService.deleteSession
- Defined in packages/adk/src/sessions/database-session-service.ts:474

appendEvent

appendEvent(session, event): Promise<Event>
Appends an event to a session object.
Parameters
- session: Session
  The session to append the event to.
- event: Event
  The event to append.
Returns Promise<Event>
The appended event.
Overrides BaseSessionService.appendEvent
- Defined in packages/adk/src/sessions/database-session-service.ts:489

`Protected`updateSessionState

updateSessionState(session, event): void
Updates the session state based on the event. Overrides the base class method to work with plain object state.
Parameters
- session: Session
- event: Event
Returns void
Overrides BaseSessionService.updateSessionState
- Defined in packages/adk/src/sessions/database-session-service.ts:780