api

Documentation

Overview

Package api contains the api used by scribe

Index

• func InitDB(ctx context.Context, databaseType string, path string, metrics metrics.Handler, ...) (db.EventDB, error)
• func Start(ctx context.Context, cfg Config, handler metrics.Handler) error
• type Config

Functions

func InitDB

func InitDB(ctx context.Context, databaseType string, path string, metrics metrics.Handler, skipMigrations bool) (db.EventDB, error)

InitDB initializes a database given a database type and path. TODO: use enum for database type.

func Start

func Start(ctx context.Context, cfg Config, handler metrics.Handler) error

Start starts the api server.

Types

type Config

type Config struct {
	// Port is the http port for the api.
	Port uint16
	// Database is the database type.
	// TODO: should be enum
	Database string
	// Path is the path to the database or db connection.
	// TODO: should be renamed
	Path string
	// OmniRPCURL is the url of the omnirpc service.
	OmniRPCURL string
	// SkipMigrations skips the database migrations.
	SkipMigrations bool
}

Config contains the config for the api.