status

package

v0.1.0-alpha12 Latest Latest Go to latest Published: Jun 10, 2022 License: Apache-2.0 Imports: 8 Imported by: 0

Details

Package status provides all components required to serve data ingestion status via an HTTP API. It includes the transport & persistence layers.

This section is empty.

This section is empty.

This section is empty.

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

The HTTP type contains HTTP request handlers that return the status of data ingestion.

func NewHTTP(statuses Repository) *HTTP

NewHTTP returns a new instance of the HTTP type that will serve status data queried from the Repository implementation.

func (h *HTTP) Register(router *mux.Router)

Register the HTTP routes into the given router.

func (h *HTTP) Status(w http.ResponseWriter, r *http.Request)

Status handles an inbound HTTP GET request that returns information on the status of data ingestion from the Repository.

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

The PostgresRepository is a Repository implementation that queries status data from a postgres-compatible database.

func NewPostgresRepository(db *sql.DB) *PostgresRepository

NewPostgresRepository returns a new instance of the PostgresRepository type that will perform queries against the provided sql.DB instance.

func (r *PostgresRepository) Status(ctx context.Context) (Status, error)

Status returns the current status of data within the database.

type Repository interface {
	Status(ctx context.Context) (Status, error)
}

The Repository interface describes types that can query the status of the data within the persistent storage.

type Status struct {
	LastIngestTimestamp time.Time `json:"lastIngestTimestamp"`
}

The Status type contains fields describing the current status of the data within the backend.