mysql

package

v0.13.0 Latest Latest Go to latest Published: Apr 19, 2026 License: Apache-2.0 Imports: 12 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 ¶

MySQL

Extract table metadata from a MySQL server.

Usage

source:
  name: mysql
  config:
    connection_url: admin:pass123@tcp(localhost:3306)/
    exclude:
      databases:
        - database_a
        - database_b
      tables:
        - database_c.table_a

Configuration

Key	Type	Required	Description
`connection_url`	`string`	Yes	MySQL connection URL.
`exclude.databases`	`[]string`	No	List of databases to exclude.
`exclude.tables`	`[]string`	No	List of tables to exclude (`database.table` format).

Entities

Type: table
URN format: urn:mysql:{scope}:table:{database}.{table}

Properties

Property	Type	Description
`properties.columns`	`[]object`	List of column metadata objects.

Column object

Field	Type	Description
`name`	`string`	Column name.
`description`	`string`	Column comment (omitted when empty).
`data_type`	`string`	Data type of the column.
`is_nullable`	`bool`	Whether the column is nullable.
`length`	`int`	Maximum character length (omitted when 0).

Edges

Source	Target	Type	Description
`table`	`table`	`references`	Foreign key relationship to the referenced table.

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 extraction of data from MySQL

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 extracts the data from the MySQL server and collected through the emitter

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

mysql.go

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