sqltrace

type ActiveTrace struct {
	ID          string
	SessionName string
	// Statements created and started the XE session, as the factory ran them.
	Statements []string
	// Database is a readable label for the database patterns the capture's
	// session is predicated on (the context's database when none were asked for).
	Database  string
	StartedAt time.Time
	StopAt    time.Time
	StoppedAt time.Time
	Options   xetrace.CreateOptions
	Error     string
	// contains filtered or unexported fields
}

type EventRow struct {
	Name          string    `json:"name" pretty:"label=Event" filter:"terms"`
	StatementType string    `json:"statementType" pretty:"label=Type" filter:"terms"`
	Timestamp     time.Time `json:"timestamp" pretty:"label=Time" sort:"timestamp"`
	DurationMs    float64   `json:"durationMs" pretty:"label=Duration,type=duration,unit=ms" sort:"durationMs"`
	CPUMs         float64   `json:"cpuMs" pretty:"label=CPU,type=duration,unit=ms" sort:"cpuMs"`
	LogicalReads  int64     `json:"logicalReads" pretty:"label=Logical reads" sort:"logicalReads"`
	PhysicalReads int64     `json:"physicalReads" pretty:"label=Physical reads" sort:"physicalReads"`
	Writes        int64     `json:"writes" sort:"writes"`
	RowCount      int64     `json:"rowCount" pretty:"label=Rows" sort:"rowCount"`
	Database      string    `json:"database" filter:"terms"`
	ClientApp     string    `json:"clientApp" pretty:"label=App" filter:"terms"`
	ClientHost    string    `json:"clientHost" pretty:"label=Host" filter:"terms"`
	Username      string    `json:"username" pretty:"label=User" filter:"terms"`
	SessionID     int       `json:"sessionId" pretty:"label=Session" filter:"exact"`

	SQL          string   `json:"sql" pretty:"label=SQL" filter:"text"`
	RawStatement string   `json:"rawStatement" pretty:"hide"`
	Tables       []string `json:"tables"`

	ErrorNumber       int              `json:"errorNumber" pretty:"label=Error"`
	ErrorMessage      string           `json:"errorMessage" pretty:"label=Error message" filter:"text"`
	ObjectName        string           `json:"objectName" pretty:"label=Object" filter:"terms"`
	ObjectType        string           `json:"objectType" pretty:"label=Object type" filter:"terms"`
	ParamsUnavailable bool             `json:"paramsUnavailable" pretty:"label=Params unavailable"`
	AdditionalFields  map[string]any   `json:"additionalFields,omitempty" pretty:"hide"`
	Deadlock          *deadlocks.Graph `json:"deadlock,omitempty" pretty:"hide"`

	ActivityID  string     `json:"activityId" pretty:"hide"`
	ActivitySeq int        `json:"activitySeq" pretty:"hide"`
	Children    []EventRow `json:"children" pretty:"hide"`
}

type Opened struct {
	Name       string
	Statements []string
	FinalDelay time.Duration
}

type RecordStore interface {
	Append(ctx context.Context, stream, kind string, rows []recordstore.Row) (recordstore.AppendResult, error)
	Seal(ctx context.Context, stream string) error
	EventsRef(ctx context.Context, stream string, from, to int64) (query.EventsRef, error)
}

type Registry struct {
	// contains filtered or unexported fields
}

type RegistryOptions struct {
	// DB leases the context's write pool for one capture; the release runs
	// after the capture's final drain and session drop.
	DB func(context.Context) (*sql.DB, func(), error)
	// Store is where captured rows are committed.
	Store RecordStore
	// NewSession creates the XE session (CreateXESession in production).
	NewSession XEFactory
	// CurrentDatabase names the context's database, which a capture scopes to
	// when it names none (CurrentDatabase in production).
	CurrentDatabase func(context.Context, *sql.DB) (string, error)
}

type StartOptions struct {
	xetrace.CreateOptions
	// Duration bounds the trace. Zero means run until Stop.
	Duration time.Duration
	// Poll is the ring-buffer poll interval. Zero defaults to 1s.
	Poll time.Duration
}

type XEFactory func(ctx context.Context, db *sql.DB, opts xetrace.CreateOptions) (XESession, Opened, error)

type XESession interface {
	Poll(ctx context.Context) (xetrace.TargetSnapshot, error)
	Drop(ctx context.Context) error
}