driver

Documentation

Overview

Package driver implements driver capability interfaces and drivers for local development.

Index

• type WithCreate
• type WithDestroy
• type WithMigrations
• type WithNamespace
• type WithPatches
• type WithReleases
• type WithSource

Types

type WithCreate

type WithCreate interface {
	Create(ctx context.Context, out io.Writer) error
}

WithCreate represents the creation method interface for a driver.

type WithDestroy

type WithDestroy interface {
	Destroy(ctx context.Context, out io.Writer) error
}

WithDestroy represents the destroying method interface for a driver.

type WithMigrations

type WithMigrations interface {
	Migrations() *types.Migrations
}

WithMigrations represents the method interface for extracting the migrations from a driver. This method is likely to be used by a database driver which manipulates migrations.

type WithNamespace

type WithNamespace interface {
	Namespace() *string
}

WithNamespace represents a method interface for extracting the namespace on which the driver operates. This is likely to be used by a kubernetes driver.

type WithPatches

type WithPatches interface {
	Patches(name string) *types.Patches
}

WithPatches represents an interface for extracting patches from a driver. Patches are pre-execution hooks for dynamic driver configuration.

type WithReleases

type WithReleases interface {
	Releases() *types.Releases
}

WithReleases represents the method interface for extracting releases from a driver. This is likely to be used by a kubernetes like driver for obtaining releases which contain kubernetes manifests.

type WithSource

type WithSource interface {
	Source(ctx context.Context, out io.Writer) error
}

WithSource represents a driver that is able to return its connection string.