Atlas
Entities

Entities

Entities are the fundamental building blocks of Atlas. They represent any tabular data within your organization's assets that are essential for daily operations.

Types of Entities

Atlas currently supports the following entity types:

  • Google Sheets
  • Relational Databases
  • APIs

When registering an entity, Atlas requires the following parameters:

  • Entity Name: A unique identifier for the entity
  • Entity Type: The category of entity (e.g., Google Sheet, Database, API)
  • Columns: The data fields contained within the entity
  • Primary Key: The column(s) that uniquely identify each row in the entity

Google Sheets

Atlas can register any table in Google Sheets as an entity by specifying:

  • Spreadsheet ID: The unique identifier found in the Google Sheet URL
  • Sheet Name: The specific sheet containing the data
  • Origin: The coordinates of the top-left cell of the table
  • Margin: The number of blank rows and columns surrounding the table

Relational Database Tables and Views

Atlas can register any table or view from major relational databases (MySQL, PostgreSQL, SQL Server, Oracle, etc.) by specifying:

  • Schema: The database schema containing the entity
  • Table Name: The name of the table or view to register
  • Object Type: Whether the entity is a table or view
  • Connection String: The credentials and information needed to connect to the database

APIs

Atlas can register any API as an entity by specifying:

  • API Name: A unique identifier for the API
  • API URL: The endpoint URL
  • API Method: The HTTP method (GET, POST, etc.)
  • API Headers: Any required request headers
  • API Body: The request body structure
  • API Response: The expected response schema

Need support for a different entity type? We actively add new entity types based on customer requirements at no additional cost. If you need to integrate with a specific entity type not listed here, contact our support team and we'll work with you to add it to our platform.

Relationships

Relationships define the connections between entities, representing both logical and physical associations. They are specified by:

  • Name: A descriptive name for the relationship
  • Relationship Type: The category of relationship (foreign key, many-to-many, etc.)
  • Source Entity: The entity where the relationship originates
  • Target Entity: The entity to which the relationship connects