Step 2 - Build Definitions
Overview
Neurelo's data definition comprises of three key elements - Schema, Auto-Generated APIs and Custom Queries. Definitions existing inside a project and are scoped to that particular project. Different projects will have their own definitions. Step 2 of the project onboarding process is to build the definitions (in particular, the schema) to be used for the project.
The "Build Definitions" phase in Neurelo plays a pivotal role in shaping how your project interacts with data. This step varies depending on your database setup and the presence of existing definitions. Here's what you need to know:
Automated Definition Building with an Existing Database:
When you linked a database as a data source in Step 1 of the onboarding and it contains pre-defined schemas or definitions, Neurelo automates the building of your project definitions. In this case, you will typically see the following processes completed automatically:
Neurelo Schema Added: The platform successfully integrates your existing schema into the Neurelo environment.
REST and GraphQL Data Access APIs Generated: Neurelo automatically generates REST and GraphQL APIs based on your existing database schema, facilitating easy data access.
API Documentation Generated: Alongside API generation, Neurelo creates comprehensive documentation for these APIs, enhancing usability and understanding.
If a valid schema was identified, Step 2 of the onboarding process is complete and the user can proceed to Step 3 (Creating an Environment).
If the introspected schema has errors, or Neurelo could not identify a valid schema then users will need to fix or build the schema by going to the editor
Manual Definition Building without Existing Database Definitions:
In scenarios where your database doesn’t have pre-defined schemas, you will encounter a different interface, with a prompt to go to the Neurelo definitions editor interface
This option leads you to a interface where you can:
Manage Database Schemas: Directly interact with and modify your database schema using branches and commits.
Customize Definitions: Perform customization and set up definitions according to your project requirements.
Additional Customization Settings: Access various settings to further tailor the definitions to your needs.
For more detailed actions and capabilities within the editor, refer to the following sections in this document
Once the definitions have been built, users can now proceed to Step 3 (Create an Environment).
Whether your project involves integrating existing definitions or creating new ones from scratch, the "Build Definitions" step in Neurelo ensures that your data models and APIs are precisely aligned with your project's needs.
Last updated
