coredb

Documentation

Index

• Variables
• type Config
• type Source
  • func New(c Config) *Source
  • func (s *Source) Attach(ctx context.Context, db *db.Pool) error
  • func (s *Source) Catalog(ctx context.Context) cs.Source
  • func (s *Source) Engine() engines.Engine
  • func (s *Source) IsReadonly() bool
  • func (s *Source) Name() string

Variables

var (
	ErrDBIsNotInitialized   = errors.New("db is not initialized")
	ErrDBIsDifferentVersion = errors.New("db is different version")
)

Types

type Config

type Config struct {
	Path     string
	ReadOnly bool

	// S3 for now only supports s3://
	S3Region   string
	S3Key      string
	S3Secret   string
	S3UseSSL   bool
	S3Endpoint string
}

type Source

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

func New

func New(c Config) *Source

func (*Source) Attach

func (s *Source) Attach(ctx context.Context, db *db.Pool) error

func (*Source) Catalog

func (s *Source) Catalog(ctx context.Context) cs.Source

func (*Source) Engine

func (s *Source) Engine() engines.Engine

func (*Source) IsReadonly

func (s *Source) IsReadonly() bool

func (*Source) Name

func (s *Source) Name() string