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
  1. Guides

Wipe Data Source

PreviousMock Data GenerationNextRemote Git Repository for Definitions

Last updated 1 year ago

Overview

Neurelo offers the “Wipe Data Source” feature, designed to erase all data from your database and reset your database schema. This feature is especially valuable for clearing your test databases, helping in troubleshooting, or facilitating a rapid environment refresh.

It is recommended that you ONLY use this feature with test databases. Do NOT use this feature with data sources with data you may not want to lose e.g. staging or production

To initiate the wipe, navigate to your “Data Sources” tab and select the Data Source you wish to wipe.

In the “Data Sources” view, the Wipe Data Source option is available in the Danger Zone section at the bottom of the settings. You will notice that the Wipe Data Source action in the “Danger Zone” is disabled by default.

This is a safety measure and is due to Neurelo's default setting of enabling “Wipe Protection” for every project. This helps safeguard against unintended data loss. Neurelo will not proceed with wiping your data source as long as this flag is active.

To proceed with wiping the data source, you must disable this flag. You can do this by toggling off the “Wipe Protection” switch and then clicking on “Save.”

It is also important to ensure that your environment runners are stopped before wiping your data source to avoid any inconsistent behavior with your API queries.

Once these actions are complete, you can click on the “Wipe” button located in the “Danger Zone” section. A dialog for wiping the data source will then appear.

Input the specified confirmation text to confirm your intention to wipe your data source. Be mindful that this action is irreversible. After confirmation, click on the “Wipe Data Source” button.

A notification will appear in the top right corner of the page, indicating that the wipe data source process has started. Following successful completion, a message stating “Data Source wiped successfully” will be displayed. This action will also be reflected in Neurelo’s audit logs.