Skip to content

EventStoreDetailsResponse

API reference for EventStoreDetailsResponse

@delta-base/server


Detailed event store information including usage statistics and settings. Extends the basic EventStore interface with additional details.

createdAt: string

ISO timestamp of when the event store was created

EventStoreInfo.createdAt


optional description: string

Optional description of the event store’s purpose or contents

EventStoreInfo.description


id: string

Unique identifier for the event store

EventStoreInfo.id


name: string

Display name of the event store

EventStoreInfo.name


optional region: string

Optional cloud region where the event store is located

EventStoreInfo.region


optional settings: object

Configuration settings for the event store

maxStreamSizeBytes: number

Maximum size in bytes allowed per event stream

retentionPeriodDays: number

Number of days events are retained before automatic deletion


optional statistics: object

Usage statistics for the event store

databaseSizeBytes: number

Storage size in bytes used by the event store

optional newestEventTimestamp: string

ISO timestamp of the newest event in the store, if available

optional oldestEventTimestamp: string

ISO timestamp of the oldest event in the store, if available

totalEvents: number

Total number of events stored

totalStreams: number

Total number of event streams stored


status: "active" | "suspended" | "deleted"

Current status of the event store

EventStoreInfo.status


updatedAt: string

ISO timestamp of when the event store was last updated

EventStoreInfo.updatedAt