Overview
Connections represent Entegrata’s link to your data sources. Each connection securely stores authentication credentials and defines default collection settings for all resources within that data source.Key Concepts
What is a Connection?
A Connection provides the secure bridge between Entegrata and a data source (database, API, file system). Each connection includes:credentials
required
Secure credentials (username/password, API keys, tokens) used to access your data source
configuration
required
Technical details needed to reach your data source (host, port, database name, API endpoint)
schedule
Default schedule that determines when resources collect data (can be overridden per resource)
enum
required
Current state of the connection:
- Active - Connection is operational and resources can collect
- Inactive - Connection is paused; no data collection occurs
Connection Lifecycle
1
Creation
Add a new connection by providing data source type and authentication details
2
Discovery
Entegrata automatically discovers available resources (tables, views, endpoints)
3
Configuration
Set connection-level collection defaults (schedule, throttling, status)
4
Active Use
Resources collect data according to configured schedules
5
Maintenance
Update credentials, adjust settings, or troubleshoot issues as needed
6
Deletion
Remove connection when no longer needed (preserves collected data)
Each data source type has specific authentication requirements and available connection parameters.
Connection vs. Resources
It’s important to understand the relationship:Authentication Methods
SQL Authentication
Username and password-based authentication for SQL databases:- Standard login credentials
- Password expiration tracking
- Connection string parameters
Windows Authentication (coming soon)
Domain-based authentication for on-premise SQL Server:- Uses Windows domain credentials
- No password required (trusted connection)
- Requires domain connectivity
API Keys and Tokens
Token-based authentication for cloud APIs:- API keys for various services
- OAuth tokens for various platforms
- Bearer tokens for REST APIs
Azure Entra ID (Managed Identity)
Passwordless authentication for Azure-hosted environments:- No credentials required — authentication is handled by your Azure tenant
- Uses the managed identity assigned to the hosting environment
- Recommended for Azure-hosted data sources
Azure Entra Service Principal
Application-based authentication for Azure services:- Requires Tenant ID, Client ID, and either a Client Secret or Client Certificate from an Azure AD app registration
- Credentials must be rotated before expiration
- Use when Managed Identity is not available
Connection Settings
Collection Schedule
Determines when resources in this connection collect data:- Interval-based: Regular time intervals (minutely, hourly, daily)
- Time-based: Specific times (e.g., “Daily at 2:00 AM”)
Throttle Profile
Controls collection speed to manage source system load:- Safe - Slower collection to reduce impact on source systems (least resource intensive)
- Standard - Normal collection speed for most use cases (default)
- Faster - Faster collection for time-sensitive data (medium resource intensive)
- Fastest - Fastest collection from read replicas (most resource intensive)
Secret Expiration
Track when authentication credentials expire:- Set expiration date for passwords and API keys
- Receive notifications before expiration
- Plan credential rotation in advance
Connection Status
Active
- Collection is allowed
- Resources can collect according to schedule
- Discovery runs automatically every 3 hours
Inactive
- Collection is paused
- All resources stop collecting (even if individually enabled)
- Discovery does not run
Getting Started
Creating Connections
Step-by-step guide to add a new data source connection
Viewing Connections
Browse and search your configured connections
Editing Connections
Update credentials and connection settings
Collection Settings
Configure schedules and collection behavior
Next Steps
Once your connection is created:1
Discovery
Wait for automatic discovery or trigger it manually to find resources
2
Configure Resources
Enable the specific tables, views, or endpoints you want to collect
3
Monitor Jobs
Track collection execution and performance
Managing Resources
Configure individual resources within your connection
Discovery
Learn how Entegrata discovers resources
