db

Documentation

Index

• Variables
• type AuditLogDB
• type ConfigDB
• type ContributorDB
• type DeleteStatus
• type GetSuggestionsOptions
• type Interface
• type ListPolicyOptions
• type ListRoleOptions
• type ListUserOptions
• type Migrator
  • func NewMigrator(dbURL *url.URL, migrations ...string) (Migrator, error)
  • func NewPostgresMigrator(dbURL *url.URL, migrations ...string) (Migrator, error)
• type NewMigratorFunc
• type OrgPolicyDB
• type PostgresMigrator
  • func (p *PostgresMigrator) Down(ctx context.Context) error
  • func (p *PostgresMigrator) Up(ctx context.Context) error
• type ProjectsDB
• type QueryAuditLogOptions
• type RecoveryDB
• type RoleDB
• type SecretDB
• type SessionDB
• type SuggestionsDB
• type TokensDB
• type UserDB

Variables

var ErrCannotFindContributor = errors.New("cannot find requested contributor")

var ErrCannotFindPolicy = errors.New("cannot find requested policy")

var ErrCannotFindProject = errors.New("cannot find requested project")

var ErrCannotFindRole = errors.New("cannot find requested role")

var ErrCannotFindSecret = errors.New("cannot find requested secret")

var ErrCannotFindSuggestion = errors.New("cannot find requested suggestion")

var ErrCannotFindUser = errors.New("cannot find requested user")

var ErrDuplicateKey = errors.New("duplicate key")

var ErrNoRows = errors.New("no rows")

Types

type AuditLogDB

type AuditLogDB interface {
	Add(context.Context, auditModels.Event) error
	Query(context.Context, QueryAuditLogOptions) ([]auditModels.Event, error)
}

type ConfigDB

type ConfigDB interface {
	Create(context.Context, models.Config) error
	Get(context.Context) (*models.Config, error)
}

type ContributorDB

type ContributorDB interface {
	Add(context.Context, models.Label, models.Email) (*models.Contributor, error)
	Get(context.Context, models.Label, models.Email) (*models.Contributor, error)
	List(context.Context, models.Label) ([]models.Contributor, error)
	Delete(context.Context, models.Label, models.Email) (*models.Contributor, error)
}

type DeleteStatus

type DeleteStatus string

const (
	DeleteStatusDeleted      DeleteStatus = "deleted"
	DeleteStatusDoesNotExist DeleteStatus = "does_not_exist"
	DeleteStatusError        DeleteStatus = "error"
)

type GetSuggestionsOptions

type GetSuggestionsOptions struct {
	Options *struct {
		Offset uint64
		Limit  uint64
	}

	FilterProjectLabel string
}

type Interface

type Interface interface {
	Roles() RoleDB
	Users() UserDB
	Projects() ProjectsDB
	Suggestions() SuggestionsDB
	Contributors() ContributorDB
	Config() ConfigDB
	Secrets() SecretDB
	Tokens() TokensDB
	Session() SessionDB
	Recoveries() RecoveryDB
	OrgPolicyDB() OrgPolicyDB
	AuditLog() AuditLogDB
}

type ListPolicyOptions

type ListPolicyOptions struct {
	Options *struct {
		Offset uint64
		Limit  uint64
	}

	FilterIDs []string
}

type ListRoleOptions

type ListRoleOptions struct {
	Offset uint64
	Limit  uint64
}

type ListUserOptions

type ListUserOptions struct {
	Options *struct {
		Offset uint64
		Limit  uint64
	}

	FilterIDs []string
}

type Migrator

type Migrator interface {
	Up(context.Context) error
	Down(context.Context) error
}

Migrator represents backend/database migrations See a concrete implementation of this interface (e.g. PostgresMigrator) for more details.

func NewMigrator

func NewMigrator(dbURL *url.URL, migrations ...string) (Migrator, error)

NewMigrator returns a new migrator for the given db type (based off of the provided URL)

func NewPostgresMigrator

func NewPostgresMigrator(dbURL *url.URL, migrations ...string) (Migrator, error)

NewPostgresMigrator returns a postgres migrator that adheres to the Migrator interface

type NewMigratorFunc

type NewMigratorFunc func(dbURL *url.URL, migrations ...string) (Migrator, error)

NewMigratorFunc represents a constructor of a Migrator implementation

type OrgPolicyDB

type OrgPolicyDB interface {
	Get(context.Context) ([]models.Policy, error)
	AddPolicy(context.Context, string) error
	RemovePolicy(context.Context, string) error
}

type PostgresMigrator

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

PostgresMigrator implements the Migrator interface for a postgres backend.

func (*PostgresMigrator) Down

func (p *PostgresMigrator) Down(ctx context.Context) error

Down rolls the db back to initial state (ie undoes all of the migrations)

func (*PostgresMigrator) Up

func (p *PostgresMigrator) Up(ctx context.Context) error

Up runs all of the provided migrations

type ProjectsDB

type ProjectsDB interface {
	Get(context.Context, models.Label) (*models.Project, error)
	GetByID(context.Context, string) (*models.Project, error)
	Create(context.Context, models.Project) error
	Update(context.Context, models.Project) error

	List(context.Context) ([]models.Project, error)
	ListByStatus(context.Context, models.ProjectStatus) ([]models.Project, error)

	CreateProjectSpec(context.Context, models.Policy, SecretDB) error
	GetProjectSpec(context.Context, string, SecretDB) (*models.Policy, error)
}

type QueryAuditLogOptions

type QueryAuditLogOptions struct {
	Offset     int
	Limit      int
	EventName  string
	GrepString string
}

type RecoveryDB

type RecoveryDB interface {
	Get(context.Context, string) (*models.Recovery, error)
	Create(context.Context, models.Recovery) error
	Delete(context.Context, string) error
}

type RoleDB

type RoleDB interface {
	Get(context.Context, models.Label) (*models.Role, error)
	GetByID(context.Context, string) (*models.Role, error)
	List(context.Context, *ListRoleOptions) ([]*models.Role, error)

	GetAll(context.Context, string) (*models.UserRoles, error)

	SetOrgRole(context.Context, models.Email, models.Label) (*models.Assignment, error)
	GetOrgRole(context.Context, models.Email) (*models.Role, error)
	SetProjectRole(context.Context, models.Email, models.Label, models.Label) (*models.Assignment, error)
	GetProjectRole(context.Context, models.Email, string) (*models.Role, error)

	CreateSystemRoles(context.Context) error
}

type SecretDB

type SecretDB interface {
	Create(context.Context, models.SecretArg) error
	Delete(context.Context, string) (DeleteStatus, error)
	Get(context.Context, string) (*models.SecretArg, error)
}

type SessionDB

type SessionDB interface {
	Get(context.Context, string) (*models.Session, error)
	Create(context.Context, models.Session) error
	Delete(context.Context, string) error
}

type SuggestionsDB

type SuggestionsDB interface {
	CreateSuggestion(context.Context, models.Suggestion) error
	GetSuggestions(context.Context, GetSuggestionsOptions) ([]models.Suggestion, error)
	GetSuggestion(context.Context, string) (*models.Suggestion, error)
	UpdateSuggestion(context.Context, models.Suggestion) error
}

type TokensDB

type TokensDB interface {
	Get(context.Context, string) (*models.Token, error)
	Create(context.Context, models.Token) error
	Delete(context.Context, string) error
	ListByUserID(context.Context, string) ([]models.Token, error)
}

type UserDB

type UserDB interface {
	Create(context.Context, models.User) error
	Update(context.Context, string, models.User) error
	Delete(context.Context, models.Email) (DeleteStatus, error)
	Get(context.Context, models.Email) (*models.User, error)
	GetByID(context.Context, string) (*models.User, error)
	List(context.Context, *ListUserOptions) ([]models.User, error)
}