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 Builder in Neurelo
  1. Definitions
  2. Neurelo Schema Editor

Schema Builder

PreviousNeurelo Schema EditorNextJSON/YAML Editor

Last updated 1 year ago

Overview

The Schema Builder Mode in the schema editor enables users to quickly create, update, manage and view their project level schema (data models) with a simple and intuitive UI.

For more details and examples about Neurelo's Schema Language (NSL), check out the

Exploring the Schema Builder in Neurelo

The Schema Builder in Neurelo is an interactive tool that allows you to visualize and modify the structure of your database. Here’s how you can navigate and use the Schema Builder:

Viewing Objects:

  • The Schema Builder displays all objects defined in your database schema.

  • Clicking on an object brings up detailed information in the Builder section of the page.

  • You can add and delete objects from here

Inspecting Object Details:

  • Properties: This section shows the properties of the selected object. Click on any property to view and edit its details. You can also create new properties.

  • Relationships: Here you can see how the selected object relates to other objects in your database. You can add and edit relationships

  • Constraints: This includes configurations such as unique, index and identifier for that object which you can add/delete/update from here.

Editing Property Details:

  • Type Format: When a property is selected, you can define its type and format using a dropdown menu with options like "integer," "bigInt," "float," and others.

  • Property Settings: Below the Type Format, there’s a list of checkboxes for settings such as "Identifier," "Unique," and "Nullable."

  • Description: Add a description for the property for better understanding and documentation.

  • Source Settings: Sometimes the property needs to be configured differently inside the actual database, different from the name of the property in Neurelo's schema.

    • Source Name: Specify the name of this property inside the database

    • Source Type: Map the Neurelo type explicity to a particular type inside the database

Configuring Default Settings for a Property:

  • Default Type: Choose between "value" and "function" from the dropdown. This setting determines the "default" handling for the property in the database.

  • Depending on the Default Type:

    • If "value" is selected, you'll be prompted to enter a "Default Value"

    • If "function" is chosen, you'll need to specify a "Default Function"

The Schema Builder is a comprehensive and useful tool within Neurelo that provides detailed viewing and editing capabilities for your database schema, ensuring that you can accurately define and refine the properties and relationships of your database objects.

All changes made needed to be "Commit"'ed to use in other parts of the project. The commit part is covered in the next page and under ""

Branches and Commits
NSL guide