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
  • Introduction
  • Video Guide
  • Using the Data Viewer in an environment
  • Loading the Data Viewer
  • Hide Columns
  • Rows per page
  • Pagination
  • Long values inside the table cell
  • Refresh Data
  1. Guides

Data Viewer

PreviousSyncing BranchesNextEnvironment/Data Source Tags

Last updated 8 months ago

Introduction

During the development and testing process, there is sometimes the need to view the data in the database being used to validate and debug api outputs, or to construct access operations. Neurelo offers a handy data viewer inside environments to quickly view data from the database attached to the environment.

Also, the Data Viewer uses the same API key to access the data as you would use in your API/SDK calls to Neurelo, which makes it easier to confirm and validate, or debug the data you are working with when using the key. Any access control policies applied to the API Keys will also be enforced.

This feature is supported for PostgreSQL, MySQL, and MongoDB

Video Guide

If you prefer a more visual experience, please check out this video overview for this feature

Using the Data Viewer in an environment

Loading the Data Viewer

Step into your project from Neurelo's dashboard and navigate to the Environments section of your project using the left side navigation bar.

Select the Environment you wish to use and you will find the “Data Viewer” button on the environment card. Click the “Data Viewer” button to take you to the "Data Viewer" tab under Environment Detail Page.

The data viewer feature needs the environment to be running before you can use it. Please make sure the runners for the environment have been started. You can validate the runner status from the status dot next to the environment name -- green means running, red means stopped, and orange means they are in the process of being deployed.

Make sure the environment is using the commit with the schema you are working on, has all migrations applied and is using the database that you want to view.

To use the Data Viewer, you need a valid API Key. If no API Key has been configured for the data viewer, you will see this message: “Please enter a valid API Key to view data” and the “Enter API Key” button will be shown. Click on this button to see API Key dialog box for Data Viewer.

If you already have an API Key for your environment, you can paste it into the displayed input box. If not, you can click the “Plus” button inside the input box to create a new API Key. Now you can hit the “Save & Apply” button. This will refresh the page and you will be able view the data from your tables and collections.

Hide Columns

This feature lets you hide selected fields from your table view, you can view them later by simply un-checking the column name.

Rows per page

  • This feature is a select box that lets you configure how many rows are fetched and displayed on a single page.

  • By default, 20 rows per page will be displayed

Pagination

  • Displayed data is paginated and you can click on the right and left arrows to view the previous or next page respectively.

  • It also lets you input a page value directly. Click the current page number to view an input box. You can directly navigate to any page and click outside the input box to apply changes.

  • When the input box is focused, you can click up or down to increase or decrease page number respectively.

Long values inside the table cell

  • Long values inside displayed cells will be auto truncated. To see the fulls values inside your “Data Viewer” table, you can click the cell to expand the value in a scrollable section.

  • To collapse and view the previous state, click the expanded cell.

Refresh Data

  • At times when you are testing your application you might need to reload the displayed data to view updated results.

  • For this you can use the “Refresh Data” button located above the content section of “Data Viewer”

  • Clicking on this button will instantly reload data without the need to refresh the page.

If you do not have any data, you can check our “” feature to populate your data source with some random data to get you started.

Data Generator