84 lines
2.5 KiB
Go
84 lines
2.5 KiB
Go
// Package sinks provides sink abstractions, a sink driver registry, and several
|
|
// built-in sink drivers.
|
|
//
|
|
// Built-in drivers:
|
|
// - stdout
|
|
// - nats
|
|
// - postgres
|
|
//
|
|
// # NATS built-in overview
|
|
//
|
|
// The NATS sink publishes each event as JSON to a configured subject.
|
|
//
|
|
// Required params:
|
|
// - url: NATS server URL (for example, nats://localhost:4222)
|
|
// - exchange: NATS subject to publish to
|
|
//
|
|
// Example config:
|
|
//
|
|
// sinks:
|
|
// - name: nats_main
|
|
// driver: nats
|
|
// params:
|
|
// url: nats://localhost:4222
|
|
// exchange: feedkit.events
|
|
//
|
|
// # Postgres built-in overview
|
|
//
|
|
// The postgres sink is intentionally split between downstream daemon ownership
|
|
// and feedkit ownership:
|
|
// - downstream code registers table schema + event mapping functions
|
|
// - feedkit manages DB connection, create-if-missing DDL, transactional
|
|
// inserts, and prune helpers
|
|
//
|
|
// Example config:
|
|
//
|
|
// sinks:
|
|
// - name: pg_main
|
|
// driver: postgres
|
|
// params:
|
|
// uri: postgres://localhost:5432/feedkit?sslmode=disable
|
|
// username: feedkit_user
|
|
// password: feedkit_pass
|
|
//
|
|
// Example downstream wiring:
|
|
//
|
|
// sinks.MustRegisterPostgresSchema("pg_main", sinks.PostgresSchema{
|
|
// Tables: []sinks.PostgresTable{
|
|
// {
|
|
// Name: "events",
|
|
// Columns: []sinks.PostgresColumn{
|
|
// {Name: "event_id", Type: "TEXT", Nullable: false},
|
|
// {Name: "emitted_at", Type: "TIMESTAMPTZ", Nullable: false},
|
|
// {Name: "payload_json", Type: "JSONB", Nullable: false},
|
|
// },
|
|
// PrimaryKey: []string{"event_id"},
|
|
// PruneColumn: "emitted_at",
|
|
// },
|
|
// },
|
|
// MapEvent: func(ctx context.Context, e event.Event) ([]sinks.PostgresWrite, error) {
|
|
// b, err := json.Marshal(e.Payload)
|
|
// if err != nil {
|
|
// return nil, err
|
|
// }
|
|
// return []sinks.PostgresWrite{
|
|
// {
|
|
// Table: "events",
|
|
// Values: map[string]any{
|
|
// "event_id": e.ID,
|
|
// "emitted_at": e.EmittedAt,
|
|
// "payload_json": string(b),
|
|
// },
|
|
// },
|
|
// }, nil
|
|
// },
|
|
// })
|
|
//
|
|
// Pruning via type assertion:
|
|
//
|
|
// if p, ok := sink.(sinks.PostgresPruner); ok {
|
|
// _, _ = p.PruneKeepLatest(ctx, "events", 10000)
|
|
// _, _ = p.PruneOlderThan(ctx, "events", time.Now().UTC().AddDate(0, -1, 0))
|
|
// }
|
|
package sinks
|