clickhouse

package

v0.13.0 Latest Latest Go to latest Published: Apr 19, 2026 License: Apache-2.0 Imports: 11 Imported by: 0

Details

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

Repository

github.com/raystack/meteor

Links

Open Source Insights

README ¶

ClickHouse

Extract table metadata from a ClickHouse server.

Usage

source:
  name: clickhouse
  config:
    connection_url: tcp://localhost:9000?username=admin&password=pass123&debug=true
    exclude:
      databases: [database_a, database_b]
      tables: [database_c.table_a]

Configuration

Key	Type	Required	Description
`connection_url`	`string`	Yes	ClickHouse connection URL.
`exclude.databases`	`[]string`	No	List of databases to exclude.
`exclude.tables`	`[]string`	No	List of tables to exclude, in `database.table` format.

Entities

Entity type: table
URN format: urn:clickhouse:{scope}:table:{database}.{table}

Property	Type	Description
`properties.columns`	`[]object`	List of column objects.
`properties.columns[].name`	`string`	Column name.
`properties.columns[].data_type`	`string`	Column data type.
`properties.columns[].description`	`string`	Column description (if available).

Edges

This extractor does not emit edges.

Contributing

Refer to the contribution guidelines for information on contributing to this module.

Documentation ¶

Index ¶

type Config
type Exclude
type Extractor
- func New(logger log.Logger) *Extractor
- func (e *Extractor) Extract(ctx context.Context, emit plugins.Emit) error
- func (e *Extractor) Init(ctx context.Context, config plugins.Config) (err error)

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Config ¶

type Config struct {
	ConnectionURL string  `json:"connection_url" yaml:"connection_url" mapstructure:"connection_url" validate:"required"`
	Exclude       Exclude `json:"exclude" yaml:"exclude" mapstructure:"exclude"`
}

Config holds the connection URL for the extractor

type Exclude ¶

type Exclude struct {
	Databases []string `json:"databases" yaml:"databases" mapstructure:"databases"`
	Tables    []string `json:"tables" yaml:"tables" mapstructure:"tables"`
}

type Extractor ¶

type Extractor struct {
	plugins.BaseExtractor
	// contains filtered or unexported fields
}

Extractor manages the output stream and logger interface for the extractor

func New ¶

func New(logger log.Logger) *Extractor

New returns a pointer to an initialized Extractor Object

func (*Extractor) Extract ¶

func (e *Extractor) Extract(ctx context.Context, emit plugins.Emit) error

Extract checks if the extractor is configured and if the connection to the DB is successful and then starts the extraction process

func (*Extractor) Init ¶

func (e *Extractor) Init(ctx context.Context, config plugins.Config) (err error)

Init initializes the extractor

Source Files ¶

View all Source files

clickhouse.go

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