Skip to main content

SQL Import Guide

Use SQL import when you want database structure to be visible alongside product flows, services, and architecture context in UiGraph.

Supported dialects​

  • PostgreSQL
  • MySQL
  • SQLite

What SQL import gives you​

  • visual table structures
  • visible primary and foreign key relationships
  • a database view that can sit next to flows and architecture diagrams
  • a shared reference point for product and engineering discussions

Typical workflow​

  1. Prepare a .sql schema file from your source system.
  2. Import it into UiGraph.
  3. Review the resulting table layout and relationships.
  4. Use the visual model as part of broader system documentation.
  • keep schema files close to the service or repository they describe
  • prefer representative schema definitions over ad hoc partial dumps
  • update the imported schema when structure changes in production systems

What to review after import​

  • table coverage
  • key relationships
  • naming consistency
  • whether the imported model matches how your team explains the domain

Best practices​

  • import one bounded schema or service database at a time
  • keep SQL files in version control
  • use SQL import as a shared documentation artifact, not just a one-time migration tool
  • pair imported tables with surrounding product or architecture context when it helps explain the system