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
  • Accessing the Definitions Section in Neurelo

Definitions

PreviousMock Data GenerationNextNeurelo Schema Editor

Last updated 1 year ago

Overview

Neurelo's data definition comprises of three key elements - Schema, Auto Generated APIs and Custom Queries. Definitions exist inside a project and are scoped only to that project.

Definitions are configured at a project level and can be deployed across different environments inside that project. Neurelo definitions are version controlled (using the notion of branches and commits) and include comprehensive documentation.

Neurelo Data Definitions = Schema + Migrations + Auto Generated APIs + Custom APIs

Schema: Programmable representation of users data model for that specific project. Neurelo supports JSON and YAML codification of data models using definition.

Auto Generated APIs and API Docs: Neurelo instantly Auto Generates Data APIs (for all your CRUD operations across single or multiple entities and advanced queries) based on schema defined within the project. Neurelo generates and API endpoints.

Custom Query Endpoints: Custom Query endpoints feature allows users to define (or use Neurelo's AI Assist functionality to generate) database specific native query code, especially for complex queries, and instantly make them available as REST or GraphQL API endpoints.

Accessing the Definitions Section in Neurelo

The Definitions section in Neurelo is an integral part of your project where you can manage and modify your database schema, custom queries, and view API documentation. Here’s how to navigate to this section:

  1. Locating the Definitions Section:

    • On your Neurelo Dashboard, look at the sidebar (left pane).

    • The Definitions section is conveniently located right below the "Dashboard" section and above the "Environments" section.

  2. Opening the Definitions Section:

    • Click on the "Definitions" option for the project.

    • This action will open up the Definitions section, where you can engage with various aspects of your project’s schema and related elements.

The Definitions section is a critical workspace for the project setup and customization. It offers tools and features to shape the data model and API structure of your project, ensuring that your database aligns perfectly with your project's requirements.

Neurelo's Schema Language
REST
GraphQL