MariaDB

marmotdata/mariadb

Discover databases, tables, views and sequences from MariaDB servers

Databases Assets Lineage Experimental

The MariaDB plugin discovers a database and its tables, views and sequences from a MariaDB server. It captures column information (including invisible and generated columns), row and size statistics, foreign key relationships and view lineage (a view is fed by the tables it reads: base table -> view).

Required Permissions

The user needs read access to the database and the information schema. SHOW VIEW is needed to read view definitions:

CREATE USER 'marmot_reader'@'%' IDENTIFIED BY 'your-password';
GRANT SELECT, SHOW VIEW ON your_database.* TO 'marmot_reader'@'%';

In the UI

Point-and-click, no config file needed.

1 Open Runs Create pipeline
2 Pick MariaDB from the plugin list.
3 Fill in the wizard, set a schedule, save.

Read the UI guide

With the CLI

Save a YAML config, then run marmot ingest.

ingest.yaml yaml

name: my-mariadb-pipeline
runs:
  - mariadb:
      host: "<host>"
      user: "<user>"
      database: "<database>"

$ marmot ingest -c ingest.yaml

Read the CLI guide

Not using plugins? Other ways to populate Marmot

Terraform Declare assets as infrastructure-as-code. Pulumi Native TypeScript, Python, or Go resources. Kubernetes Operator Sync assets from Kubernetes custom resources.

Configuration

15 top-level fields. * marks required fields.

tags multiselect

Tags to apply to discovered assets

external_links object[]

External links to show on all assets

name string

Display name for the link

icon string

Icon identifier for the link

url string

URL to the external resource

filter object

Filter discovered assets by name (regex)

include multiselect

Include patterns for resource names (regex)

exclude multiselect

Exclude patterns for resource names (regex)

host string

MariaDB server hostname or IP address

port int

MariaDB server port

default: 3306

user string

Username for authentication

password password

Password for authentication

database string

Database to discover

tls select

TLS mode (false, true, skip-verify, preferred)

default: false

false true skip-verify preferred

include_columns bool

Whether to include column information in table and view schemas

default: true

include_views bool

Whether to discover views

default: true

include_sequences bool

Whether to discover sequences

default: true

include_row_counts bool

Whether to include approximate row counts in table metadata

default: true

include_statistics bool

Whether to emit row count, size and column count statistics

default: true

discover_foreign_keys bool

Whether to discover foreign key relationships

default: true

Assets emitted

Metadata this plugin attaches to each discovered asset.

Database

MariaDBDatabaseFields

6 fields

The metadata fields the plugin emits for the database asset.

host string

MariaDB server hostname

port int

MariaDB server port

database string

Database name

server_version string

MariaDB server version

character_set string

Default character set of the database

collation string

Default collation of the database

MariaDB

MariaDBFields

17 fields

The metadata fields the plugin emits for table, view and sequence assets.

host string

MariaDB server hostname

port int

MariaDB server port

database string

Database name

schema string

Schema name (same as the database in MariaDB)

table_name string

Object name

object_type string

Object type (table, view, sequence)

engine string

Storage engine

collation string

Table collation

row_count int

Approximate row count

data_length int

Data size in bytes

index_length int

Index size in bytes

auto_increment int

Next auto increment value

created string

Creation timestamp

updated string

Last update timestamp

comment string

Table comment

system_versioned bool

Whether the table keeps row history (WITH SYSTEM VERSIONING)

temporary bool

Whether the table is temporary (only when the server exposes it)

View

MariaDBViewFields

4 fields

The extra metadata fields emitted for views.

check_option string

WITH CHECK OPTION setting (NONE, LOCAL, CASCADED)

is_updatable bool

Whether the view accepts writes

definer string

Account that defined the view

security_type string

SQL SECURITY setting (DEFINER, INVOKER)

Sequence

MariaDBSequenceFields

6 fields

The extra metadata fields emitted for sequences.

start_value int

Value the sequence started at

minimum_value int

Smallest value the sequence produces

maximum_value int

Largest value the sequence produces

increment int

Step between values

cache_size int

Number of values cached per fetch

cycle_option bool

Whether the sequence restarts after reaching its limit

Column

MariaDBColumnFields

11 fields

The per-column fields embedded in an asset's schema.

column_name string

Column name

data_type string

Full column type, for example varchar(255) or int(11)

is_nullable bool

Whether null values are allowed

is_primary_key bool

Whether the column is part of the primary key

default_expression string

Default value or expression

description string

Column comment

is_auto_increment bool

Whether the column auto-increments

is_generated bool

Whether the column is computed from an expression

is_invisible bool

Whether the column is hidden from SELECT *

character_set string

Character set

collation string

Collation