Database Engine - Structure and Usage Procedure

1\ schema designer overview the schema designer is the core module of the database engine that allows users to design, visualize, and manage the database structure of an application through an intuitive visual interface it helps users define tables, columns, data types, and primary keys without writing sql manually this page acts as the starting point for creating or managing the database schema for a selected project purpose of schema designer to visually design database schemas to create tables and define their structure to ensure proper data organization and integrity to simplify database setup for both technical and non technical users getting started with schema designer when accessing the schema designer for the first time, users will see a “no schema available” state this indicates that no database schema has been created yet for the project the following options are available to begin schema creation 1\ generate schema from pages button generate schema this option automatically generates a database schema based on the application pages use case ideal for quick setup reduces manual effort automatically maps page fields to database tables and columns behavior scans application pages creates tables and columns based on detected fields helps bootstrap the database structure instantly 2\ add new table button add new table this option allows users to manually create database tables steps involved click add new table provide a table name add columns to the table assign appropriate data types (e g , text, number, date, boolean) define constraints such as primary keys use case full control over schema design suitable for custom or complex data models 3\ adding columns and data types each table can contain multiple columns for every column specify a column name select an appropriate data type configure additional properties if required choosing correct data types ensures efficient storage data accuracy better performance 4\ primary key definition users can mark one or more columns as primary keys purpose of primary keys uniquely identify each record in a table ensure data integrity enable efficient indexing and relationships 5\ saving schema changes button save changes once schema design is complete click save changes to persist the schema changes are stored and applied to the database unsaved changes will not be reflected 2\ tables overview the tables section in the database engine allows users to view, manage, and modify database tables that are created using the schema designer this page acts as the central management console for all tables within a project users can create new tables, validate schema changes, merge existing tables, and manage master tables from this interface purpose of tables module view all existing database tables edit table structures and configurations perform schema level operations export and inspect schema definitions access apis generated for tables tables page layout the tables page consists of action toolbar (table operations) schema export and api access options table listing area empty state guidance when no tables exist table actions 1\ create new table button create new table allows users to manually create a new database table functionality define table name add columns and data types configure primary keys and constraints use case creating custom tables extending the database schema manually 2\ check schema changes button check schema changes validates differences between the current schema and pending changes functionality detects structural changes helps review modifications before applying prevents unintended schema updates use case ensuring schema consistency reviewing updates before deployment 3\ merge tables button merge tables combines multiple tables into a single table structure functionality merges selected tables consolidates columns and data reduces schema redundancy use case optimizing database design simplifying related datasets 4\ create master table button create master table creates a centralized master table to manage shared or reference data functionality acts as a common reference table improves data normalization enables consistent data usage across modules schema utilities export schema button export schema allows users to export the database schema definition purpose backup schema structure share schema across environments documentation and auditing json viewer button json viewer displays the schema in json format purpose technical inspection debugging and integration developer level visibility view apis button view apis shows automatically generated apis for the database tables purpose backend integration data access through rest apis accelerates application development empty state – no tables available when no tables are present the system displays “no tables available” users are guided to create tables via the schema designer this ensures a clear workflow and avoids confusion for first time users 3\ diagram (entity relationship diagram) overview the diagram section provides a visual representation of the database schema using an entity relationship diagram (erd) it helps users understand how tables are structured and how they are related to each other within the database this view is especially useful for analyzing data relationships, validating schema design, and communicating database structure clearly purpose of entity relationship diagram visualize all database tables as entities display relationships between tables understand primary and foreign key connections improve database design clarity and accuracy diagram workspace the central canvas displays tables as individual entities relationships represented as connecting lines a grid based layout for easy alignment and readability users can interact with the canvas to explore complex schemas efficiently schema information at the top of the diagram, schema statistics are displayed total tables number of tables in the schema total relationships number of defined relationships this provides a quick overview of schema complexity 4\ migrations (database migration) overview the migrations module enables users to import an existing database schema into the database engine quickly this feature is designed to simplify onboarding by allowing schema extraction from existing databases instead of creating everything manually users can migrate schemas either through file upload or online database connection purpose of database migration import existing database structures reuse schemas from legacy or external systems reduce manual schema recreation accelerate application setup migration options 1\ file upload option file upload allows users to upload database dump or structured data files supported file types sql dump bak maximum file size 100 mb behavior parses the uploaded file extracts schema definitions imports tables and relationships into the system 2\ online connection option online connection allows schema import directly from a live database using connection credentials use case migrating from production or staging databases real time schema extraction database type selection field database type users must select the source database type before migration example postgresql this ensures accurate parsing and compatibility during schema extraction upload database dump users can upload files using drag and drop manual file selection accepted formats sql dumps containing schema definitions backup files structured data for schema inference this section acts as the primary input for migration upload instructions file format information for postgresql migrations upload sql dump files files should contain create table statements constraints and relationships should be defined in the dump this ensures complete and accurate schema extraction what the system extracts during migration, the system automatically extracts complete table schemas column definitions and data types primary keys foreign keys table relationships indexes and constraints this guarantees that the imported schema closely matches the source database 5\ custom apis overview the custom apis module allows users to design and generate custom api endpoints directly from the database without writing backend code this feature enables seamless data access and integration for applications using rest style apis users can visually configure api logic or switch to code based configuration if required purpose of custom apis create custom api endpoints perform database operations through apis enable secure and structured data access reduce backend development effort create new api button new api creates a new custom api configuration api configuration section api name defines a unique name for the api example get user profile endpoint defines the http method and url path components http method (get, post, put, delete) api route path example /api/users/{id}/profile description provides a brief explanation of what the api does purpose improves readability helps team members understand api functionality api builder operation type defines the type of database operation supported operations read data create data update data delete data table selection specifies the primary database table used by the api select fields allows users to choose which columns should be included in the api response benefit optimized responses improved performance filters button add filter adds conditions to filter records example fetch user by id retrieve active records only join related tables button add join joins related tables using defined relationships use case fetching relational data creating complex api responses sorting defines result ordering options sort by selected column ascending or descending order limit results restricts the number of records returned example limit = 100 api generation generate api button generate api creates the api endpoint based on the configured settings validation and save options validate checks api configuration for errors save stores the api definition visual builder / code toggle switch between ui based and code based api creation summary the database engine in simplita ai is a comprehensive solution for designing, managing, and integrating databases through a visual, low code interface it enables users to create and manage schemas, view and edit tables, visualize relationships using er diagrams, migrate existing databases, and generate custom apis without writing complex backend code this unified approach ensures faster development, improved data integrity, and seamless application integration