OverviewArchitectureRecipeSourceProcessorSinkContext Graph for AI
OverviewArchitectureRecipeSourceProcessorSinkContext Graph for AI

MySQL

Extracts tables and their columns from every database on a MySQL server. Emits table entities, plus references edges for foreign keys.

Usage

source:
  name: mysql
  scope: my-scope
  config:
    connection_url: admin:pass123@tcp(localhost:3306)/

Configuration

KeyTypeDescriptionRequired
connection_urlstringMySQL connection URL, in Go DSN format.Yes
exclude.databases[]stringDatabase names to skip.No
exclude.tables[]stringTables to skip, in database.table format.No

Output

Entity type: table

URN pattern: urn:mysql:{scope}:table:{database}.{table}

Notable properties:

  • columns - List of column objects. Each has name, data_type, is_nullable, description (the column comment, omitted when empty), and length (omitted when zero).

Edges

Edge typeFromTo
referencestabletable

One references edge is created per foreign key, pointing from the table to the table it references.

Notes

The system databases information_schema, mysql, performance_schema, and sys are always skipped.

Microsoft SQL ServerNotion
On this page
UsageConfigurationOutputEdgesNotes