chronicle

package module

Go to main page

Versions in this module

v0

v0.11.1

Oct 20, 2026

v0.11.0

Oct 15, 2026

v0.10.0

Oct 13, 2026

v0.9.1

Oct 10, 2026

v0.9.0

Oct 7, 2026

v0.8.0

Oct 6, 2026

v0.7.0

Oct 6, 2026

v0.6.0

Oct 6, 2026

v0.5.0

Oct 6, 2026

Changes in this version

type ClientOption

+ func WithGRPCStatsHandler(handler stats.Handler) ClientOption

v0.4.0

Oct 6, 2026

v0.3.0

Oct 6, 2026

v0.2.0

Oct 6, 2026

Changes in this version

type ClientOption

+ func WithLoadBalancer(balancer LoadBalancer) ClientOption

+ func WithOnConnected(hook ConnectionHook) ClientOption

+ func WithOnDisconnected(hook ConnectionHook) ClientOption

+ type ConnectionEvent struct

+ Address string

+ ConnectionID string

+ Err error

+ Generation uint64

+ type ConnectionHook func(ctx context.Context, event ConnectionEvent)

+ type LoadBalancer interface

+ Next func(ctx context.Context, candidates []ServerAddress) (ServerAddress, error)

+ type LoadBalancerError struct

+ Err error

+ func (*LoadBalancerError) Error() string

+ func (e *LoadBalancerError) Format(s fmt.State, _ rune)

+ func (e *LoadBalancerError) Unwrap() error

v0.1.0

Oct 5, 2026

Changes in this version

+ const DefaultNamespace

+ var ErrClosed = faults.ErrClosed

+ var ErrDestructiveRegistrationUnknown = errors.New("chronicle: destructive registration outcome unknown; new definitions refused")

+ var ErrIdentityRenameRefused = errors.New("chronicle: identity rename refused")

+ var ErrIdentityRenameUnknown = errors.New("chronicle: identity rename outcome unknown")

+ var ErrInvalidConfiguration = faults.ErrInvalidConfiguration

+ var ErrNotPrepared = errors.New("chronicle: client is not prepared")

+ var ErrNotRegistered = faults.ErrNotRegistered

+ var ErrPreparationInProgress = errors.New("chronicle: preparation is in progress")

+ var ErrProtocol = faults.ErrProtocol

+ var ErrUnsupported = faults.ErrUnsupported

+ func RegisterConstraintFactory[C any](registry *Registry, names []string, factory any, ...) error

+ func RegisterEventGeneration[Previous, Current any](registry *Registry, current events.Type[Current], generation events.Generation, ...) (events.Type[Previous], error)

+ func RegisterEventMigrationFactory[M any](registry *Registry, upgrade, previous events.Descriptor, factory any, ...) error

+ func RegisterEventMigration[Upgrade, Previous any](registry *Registry, upgrade events.Type[Upgrade], ...) error

+ func RegisterEvent[T any](registry *Registry, options ...events.TypeOption) (events.Type[T], error)

+ func RegisterProjectionFactory[P any](registry *Registry, id string, model readmodels.Descriptor, factory any, ...) error

+ func RegisterReactorHandler[E any](registry *Registry, id reactors.ID, handler func(context.Context, E) error, ...) error

+ func RegisterReactorHandlers(registry *Registry, id reactors.ID, handlers []reactors.Handler, ...) error

+ func RegisterReactorMiddleware(registry *Registry, factory any) error

+ func RegisterReactorSideEffectHandler(registry *Registry, handler reactors.SideEffectHandler) error

+ func RegisterReactor[R any](registry *Registry, factory any, options ...reactors.Option) error

+ func RegisterReadModelReactorHandlers[M any](registry *Registry, id reactors.ID, model readmodels.Model[M], ...) error

+ func RegisterReadModelReactor[R, M any](registry *Registry, model readmodels.Model[M], factory any, ...) error

+ func RegisterReadModel[T any](registry *Registry, options ...readmodels.ModelOption) (readmodels.Model[T], error)

+ func RegisterReducerHandlers[M any](registry *Registry, model readmodels.Model[M], id reducers.ID, ...) error

+ func RegisterReducer[R, M any](registry *Registry, model readmodels.Model[M], factory any, ...) error

+ func RegisterSeeder(registry *Registry, seeder seeding.Seeder) error

+ func RegisterSeederFactory[S seeding.Seeder](registry *Registry, factory any) error

+ func RegisterSeederFunc(registry *Registry, seed func(*seeding.Builder) error) error

+ type ArtifactRegistration = registration.Artifact

+ type Artifacts struct

+ Constraints []constraints.Definition

+ Events *events.Catalog

+ Projections []projections.Definition

+ Reactors []*reactors.Plan

+ ReadModels *readmodels.Catalog

+ Reducers []*reducers.Plan

+ type AuthenticationError = connection.AuthenticationError

+ type Client struct

+ func Dial(ctx context.Context, options ...ClientOption) (*Client, error)

+ func NewClient(options ...ClientOption) (*Client, error)

+ func NewClientContext(ctx context.Context, options ...ClientOption) (*Client, error)

+ func (c *Client) Artifacts(store StoreName) (Artifacts, error)

+ func (c *Client) Catalogs(store StoreName) (*events.Catalog, *readmodels.Catalog, error)

+ func (c *Client) Close() error

+ func (c *Client) CloseContext(ctx context.Context) error

+ func (c *Client) Connect(ctx context.Context) error

+ func (c *Client) EventStore(ctx context.Context, name StoreName, options ...StoreOption) (*EventStore, error)

+ func (c *Client) EventStores(ctx context.Context) ([]StoreName, error)

+ func (c *Client) EvictEventStores() error

+ func (c *Client) GoString() string

+ func (c *Client) Ready(ctx context.Context) error

+ func (c *Client) Shutdown(ctx context.Context) error

+ func (c *Client) String() string

+ type ClientOption func(*clientConfig)

+ func WithAppendOriginResolver(resolver eventsequences.AppendOriginResolver) ClientOption

+ func WithCausationProvider(provider metadata.CausationProvider) ClientOption

+ func WithCheckFirstAppendIntoAScope(enabled bool) ClientOption

+ func WithConnectTimeout(timeout time.Duration) ClientOption

+ func WithConnectionString(value string) ClientOption

+ func WithCorrelationProvider(provider metadata.CorrelationProvider) ClientOption

+ func WithDefaultConcurrencyStrategy(strategy eventsequences.ConcurrencyScopeStrategy) ClientOption

+ func WithDefaultSinkType(kind readmodels.SinkType) ClientOption

+ func WithDevelopmentDefaults() ClientOption

+ func WithEventEnrichers(providers ...events.EventEnricher) ClientOption

+ func WithEventTypeGenerationValidation(enabled bool) ClientOption

+ func WithGRPCConnection(conn *grpc.ClientConn) ClientOption

+ func WithIdentityProvider(provider metadata.IdentityProvider) ClientOption

+ func WithKeepAliveTimeout(timeout time.Duration) ClientOption

+ func WithLogger(logger *slog.Logger) ClientOption

+ func WithMaxReceiveMessageSize(bytes int) ClientOption

+ func WithMaxSendMessageSize(bytes int) ClientOption

+ func WithNamingPolicy(policy serialization.NamingPolicy) ClientOption

+ func WithNoAuthentication() ClientOption

+ func WithRegistrationRetry(policy RegistrationRetry) ClientOption

+ func WithRegistry(registry *Registry) ClientOption

+ func WithRegistryForStore(name StoreName, registry *Registry) ClientOption

+ func WithRootCausation(config metadata.RootCausation) ClientOption

+ func WithSRVResolver(resolver SRVResolver) ClientOption

+ func WithServices(factory reactors.ScopeFactory) ClientOption

+ func WithSkipCompatibilityCheck() ClientOption

+ func WithSkipKeepAlive() ClientOption

+ func WithTLS(config *tls.Config) ClientOption

+ func WithTokenSource(source TokenSource) ClientOption

+ type ClientPreparation struct

+ func CaptureClient(options ...ClientOption) (*ClientPreparation, error)

+ func (p *ClientPreparation) Client() *Client

+ func (p *ClientPreparation) Prepare(ctx context.Context, scopes reactors.ScopeFactory) (*Client, error)

+ type ClientStateError struct

+ Operation string

+ func (e *ClientStateError) Error() string

+ func (e *ClientStateError) Format(s fmt.State, _ rune)

+ func (e *ClientStateError) Unwrap() error

+ type CompatibilityError struct

+ Details []string

+ ServerVersion string

+ func (e *CompatibilityError) Error() string

+ type ConnectionString struct

+ func ParseConnectionString(value string) (ConnectionString, error)

+ func (s ConnectionString) Addresses() []ServerAddress

+ func (s ConnectionString) GoString() string

+ func (s ConnectionString) IsSRV() bool

+ func (s ConnectionString) String() string

+ type EnvelopeError = wire.EnvelopeError

+ type EventStore struct

+ func (s *EventStore) Captures() *captures.Service

+ func (s *EventStore) Compliance() *compliance.Manager

+ func (s *EventStore) Constraints() []constraints.Definition

+ func (s *EventStore) EventLog() *eventsequences.Sequence

+ func (s *EventStore) EventSequence(id events.SequenceID) (*eventsequences.Sequence, error)

+ func (s *EventStore) EventTypes() *events.Catalog

+ func (s *EventStore) ExternalServices() *externalservices.Service

+ func (s *EventStore) Identities() *IdentityManager

+ func (s *EventStore) Jobs() *jobs.Service

+ func (s *EventStore) Name() StoreName

+ func (s *EventStore) Namespace() Namespace

+ func (s *EventStore) Namespaces() *Namespaces

+ func (s *EventStore) Observers() *observation.Service

+ func (s *EventStore) Patterns() *patterns.Service

+ func (s *EventStore) PrepareSeeds(seeder seeding.Seeder) (*SeedBatch, error)

+ func (s *EventStore) PreviewProjection(ctx context.Context, declaration string, sequence ...events.SequenceID) (projections.Preview, error)

+ func (s *EventStore) Projections() []projections.Definition

+ func (s *EventStore) QueryProjection(ctx context.Context, declaration string, sequence ...events.SequenceID) (projections.QueryResult, error)

+ func (s *EventStore) ReadModels() *readmodels.Service

+ func (s *EventStore) RegisterProjection(ctx context.Context, declaration projections.Declaration) (result ProjectionRegistration, err error)

+ func (s *EventStore) Subscriptions() *eventstoresubscriptions.Service

+ func (s *EventStore) UnregisterReactor(ctx context.Context, id reactors.ID) error

+ func (s *EventStore) UnregisterReadModelReactor(ctx context.Context, id reactors.ID) error

+ func (s *EventStore) UnregisterReducer(ctx context.Context, id reducers.ID) error

+ func (s *EventStore) WaitForRegistration(ctx context.Context) (RegistrationOutcome, error)

+ func (s *EventStore) Webhooks() *webhooks.Service

+ type IdentityManager struct

+ func (m *IdentityManager) Rename(ctx context.Context, subject string, name identities.Name, ...) (result IdentityRenameResult, err error)

+ type IdentityRenameDisposition uint8

+ const IdentityRenameNotDispatched

+ const IdentityRenameObserved

+ const IdentityRenameRefused

+ const IdentityRenameUnknown

+ type IdentityRenameError struct

+ func (e *IdentityRenameError) Error() string

+ func (e *IdentityRenameError) Phase() string

+ func (e *IdentityRenameError) Reason() string

+ func (e *IdentityRenameError) Unwrap() []error

+ type IdentityRenameResult struct

+ Acknowledged bool

+ Disposition IdentityRenameDisposition

+ RequestCorrelationID metadata.CorrelationID

+ ResponseCorrelationID *metadata.CorrelationID

+ type Namespace = metadata.Namespace

+ type Namespaces struct

+ func (n *Namespaces) Ensure(ctx context.Context, namespace Namespace) error

+ func (n *Namespaces) List(ctx context.Context) ([]Namespace, error)

+ type PreparationError = artifacts.PreparationError

+ type ProjectionRegistration struct

+ Outcome RegistrationOutcome

+ Published bool

+ type RegistrationError struct

+ Outcome RegistrationOutcome

+ func (e *RegistrationError) Error() string

+ func (e *RegistrationError) Unwrap() error

+ type RegistrationOutcome = registration.Outcome

+ type RegistrationRetry = registration.Policy

+ type Registry struct

+ func NewRegistry() *Registry

+ func (r *Registry) AddConstraint(definition constraints.Definition) error

+ func (r *Registry) AddProjection(declaration projections.Declaration) error

+ func (r *Registry) ConfigureDeclaredConstraint(name string, configure func(*constraints.Builder)) error

+ func (r *Registry) WithProjection(declaration projections.Declaration) (*Registry, error)

+ type SRVResolver = connection.SRVResolver

+ type SeedBatch struct

+ func (b *SeedBatch) Register(ctx context.Context) error

+ type ServerAddress struct

+ Host string

+ Port uint16

+ func (a ServerAddress) String() string

+ type StoreName = metadata.StoreName

+ type StoreOption func(*storeConfig)

+ func WithNamespace(namespace Namespace) StoreOption

+ type Token = connection.Token

+ type TokenInvalidator interface

+ Invalidate func()

+ type TokenSource = connection.TokenSource

+ type ValidationResult = wire.ValidationResult

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL