coredb

Documentation

Index

• Constants
• Variables
• type Config
• type Info
• type Source
  • func New(c Config) *Source
  • func (s *Source) AsModule() bool
  • 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) Info() Info
  • func (s *Source) IsReadonly() bool
  • func (s *Source) Name() string

Constants

const (
	Version = "0.0.8"
)

Variables

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

var InitSchema string

Types

type Config

type Config struct {
	Path     string `json:"path"`
	ReadOnly bool   `json:"read_only"`

	// S3 for now only supports s3://
	S3Region   string `json:"s3_region"`
	S3Key      string `json:"s3_key"`
	S3Secret   string `json:"s3_secret"`
	S3UseSSL   bool   `json:"s3_use_ssl"`
	S3Endpoint string `json:"s3_endpoint"`
}

type Info

type Info struct {
	Version string               `json:"version"`
	Type    types.DataSourceType `json:"type"`
}

type Source

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

func New

func New(c Config) *Source

func (*Source) AsModule

func (s *Source) AsModule() bool

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) Info

func (s *Source) Info() Info

func (*Source) IsReadonly

func (s *Source) IsReadonly() bool

func (*Source) Name

func (s *Source) Name() string