Neurelo Build Docs
Neurelo Build Docs
  • Introduction
    • Core Concepts
    • Key Features
  • Getting Started
    • Sign-in/Sign-up
    • Dashboard
      • Collapsible Sidebar
      • Light/Dark Mode
      • Account Settings
      • Audit Events
      • User Management
        • Permissions (Member v/s Admin)
      • Org Settings
    • Starting your Neurelo Project
      • Quick Start Guide
      • Step 1 - Add a Data Source
      • Step 2 - Build Definitions
      • Step 3 - Create an Environment
      • Step 4 - Create an API Key
      • Step 5 - Start Runners
      • Try your Neurelo APIs
  • "How to" Videos
    • Product Overview
    • Neurelo APIs & SDKs
    • Project Setup
    • Definitions
    • Environments
    • Data Sources
    • Organization Management
    • Creating and Using Custom Queries
    • Using the Schema Builder to build Relationships
    • Mock Data Generation
  • Definitions
    • Neurelo Schema Editor
      • Schema Builder
      • JSON/YAML Editor
      • Schema Visualization: Entity-Relationship Diagram (ERD)
    • Custom APIs for Complex Queries
      • Write and Commit Custom Queries
      • AI-Assisted Query Generation
      • Deploying Custom API Endpoints
      • Using Variables in your Custom Query
    • Branches and Commits
    • API Docs
  • Environments
    • Creating a new Environment
    • API Playground
    • Observability
    • Migrations
    • API Keys
  • Data Sources
    • PostgreSQL
    • MySQL
    • MongoDB
  • Guides
    • Provisioning Cloud Databases for using with Neurelo
      • PostgreSQL
        • AWS RDS (PostgreSQL)
      • MySQL
        • AWS RDS (MySQL)
      • MongoDB Atlas
    • Mock Data Generation
    • Wipe Data Source
    • Remote Git Repository for Definitions
      • Connecting a Remote Git Repo
      • Creating Commits from Neurelo
      • Syncing Branches
    • Data Viewer
    • Environment/Data Source Tags
    • How to work with Embedded documents and References in MongoDB
    • How to download and use the Postman Collection for your Project
    • Building Python applications with Postgres and FastAPI
    • CI Integration using Neurelo CLI
    • Schema Migrations
    • Schema AI Assist
    • Auto-Introspection
    • Access Policies
    • User Auth
      • Google
      • GitHub
      • GitLab
    • MongoDB Atlas - Migrate GraphQL to Neurelo
    • MongoDB Atlas - Migrate REST Data APIs to Neurelo
  • MongoDB Atlas - Migrate REST Data APIs to Neurelo
  • MongoDB Atlas - Migrate GraphQL APIs to Neurelo
  • Neurelo Schema Language (NSL)
    • Example 1 - DVD Rentals
    • Example 2 - Simple "Posts" App
    • Example 3 - Bookstore
  • Neurelo API Reference (REST)
    • Examples of Neurelo Auto-Generated REST API endpoints
      • Example 1 - Simple “Posts” application
      • Example 2 - "DVD Rentals" application
      • Example 3 - "Bookstore” application
      • cURL API Examples
  • Neurelo API Reference (GraphQL)
  • SDKs
    • TypeScript / JavaScript SDK
    • Go SDK
    • Python SDK
      • Python SDK Tutorial -- News Application
        • News Application using Neurelo’s Python SDKs
  • CLI (Preview Version)
  • Self-Hosted Neurelo Gateways
  • Tutorials
    • Building a Real Time Chat Application with Neurelo and MongoDB using Python
    • Building A Financial Terminal with Neurelo and MongoDB in Rust
    • Building a Restaurant Management System with Neurelo and MongoDB using GraphQL in just a few minutes
    • Bringing Neurelo’s Data APIs to Life Instantly with MySQL
  • Project Examples
  • References
    • Supported Databases
    • Supported OS and Browsers
  • Support
Powered by GitBook
On this page
  • Overview
  • Exploring the Schema Visualization in Neurelo
  • Viewing the ERD
  • Inspecting ERD Details:
  1. Definitions
  2. Neurelo Schema Editor

Schema Visualization: Entity-Relationship Diagram (ERD)

PreviousJSON/YAML EditorNextCustom APIs for Complex Queries

Last updated 1 year ago

Overview

Visual Data Schema, often presented in the Entity-Relationship Diagram (ERD) format, plays a pivotal role in understanding and designing complex database schemas. With an ERD, developers can visually understand the relationships between different entities, such as tables, in their database schema. This visual representation offers a clear and intuitive overview of the database structure, facilitating effective communication among team members and aiding in the identification of potential design flaws or optimization opportunities. Additionally, ERD views serve as valuable documentation for both current and future development efforts, ensuring consistency and coherence in database design.

Neurelo supports schema visualization for PostgreSQL, MySQL and MongoDB, providing developers with intuitive insights into their database schema layout.

Exploring the Schema Visualization in Neurelo

The Schema Visualization feature allows you to visualize the structure of your database in the ERD view. Here’s how you can navigate and use Schema Visualization:

Viewing the ERD

  • Access the "Definition" section for your project from the left navigation bar.

  • This will display the Schema in either JSON, YAML or the Schema Builder view based on your last selectiom

  • Next to the mode selector near the top right, you will see the icon toolbar. In there, click on the "ERD" icon as show below

Inspecting ERD Details:

  • Block: A block in an ERD view represents an object (table/collection in PostgreSQL and MySQL) or an innerObject (MongoDB only - embedded document) in a database, with each row representing a specific attribute or property of that entity.

  • Lines: In an ERD view, a line shows that entities are linked in the database model. Neurelo's ERD view enhances clarity with multi-color connection lines, resembling a rainbow.

You can click on a block to narrow the focus to only those entities that are connected to the selected entity

You can click on particular line linking two blocks, to focus on the two entities connected with that line

  • Navigation Helper: To aid in navigating extensive schemas, Neurelo offers a visual navigation helper located at the bottom right of the screen, providing users with a clear indication of their current location within the expansive data schema.

  • ERD Settings: Neurelo offers users to customize ERD navigation direction, background, and connection line colors, tailoring the visual representation to suit their preferences and workflow.