external

package

v0.0.1 Latest Latest Go to latest Published: Aug 19, 2025 License: GPL-3.0 Imports: 5 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/ethpandaops/cbt

Links

Open Source Insights

Documentation ¶

Overview ¶

Package external provides external model configuration and validation

Index ¶

Constants
Variables
type Config
- func (c *Config) GetID() string
- func (c *Config) Validate() error
type SQL
- func NewExternalSQL(content []byte) (*SQL, error)
type SQLParser

Constants ¶

View Source

const ExternalTypeSQL = "sql"

ExternalTypeSQL identifies SQL external models

Variables ¶

View Source

var (
	// ErrDatabaseRequired is returned when database is not specified
	ErrDatabaseRequired = errors.New("database is required")
	// ErrTableRequired is returned when table is not specified
	ErrTableRequired = errors.New("table is required")
	// ErrPartitionRequired is returned when partition is not specified
	ErrPartitionRequired = errors.New("partition is required")
	// ErrTTLRequired is returned when TTL is not specified
	ErrTTLRequired = errors.New("ttl is required")
)

View Source

var (
	// ErrInvalidFrontmatter is returned when frontmatter is invalid
	ErrInvalidFrontmatter = errors.New("invalid frontmatter")
	// ErrSQLContentRequired is returned when SQL content is not specified
	ErrSQLContentRequired = errors.New("sql content is required")
)

Functions ¶

This section is empty.

Types ¶

type Config ¶

type Config struct {
	Database  string         `yaml:"database" validate:"required"`
	Table     string         `yaml:"table" validate:"required"`
	Partition string         `yaml:"partition" validate:"required"`
	TTL       *time.Duration `yaml:"ttl"`
	Lag       uint64         `yaml:"lag"`
}

Config defines configuration for external models

func (*Config) GetID ¶

func (c *Config) GetID() string

GetID returns the unique identifier for the external model

func (*Config) Validate ¶

func (c *Config) Validate() error

Validate checks if the external configuration is valid

type SQL ¶

type SQL struct {
	Config  `yaml:",inline"`
	Content string `yaml:"-"`
}

SQL represents an external SQL model with YAML frontmatter

func NewExternalSQL ¶

func NewExternalSQL(content []byte) (*SQL, error)

NewExternalSQL creates a new external SQL model from content

func (*SQL) GetConfig ¶

func (c *SQL) GetConfig() Config

GetConfig returns the external model configuration

func (*SQL) GetType ¶

func (c *SQL) GetType() string

GetType returns the external model type

func (*SQL) GetValue ¶

func (c *SQL) GetValue() string

GetValue returns the SQL content

func (*SQL) Validate ¶

func (c *SQL) Validate() error

Validate checks if the external SQL model is valid

type SQLParser ¶

type SQLParser struct{}

SQLParser parses SQL external models

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL