- Overview
- Platform setup and administration
- Platform setup and administration
- Platform architecture
- Data Bridge onboarding overview
- Connecting a Peak-managed data lake
- Connecting a customer-managed data lake
- Creating an AWS IAM role for Data Bridge
- Connecting a Snowflake data warehouse
- Connecting a Redshift data warehouse (public connectivity)
- Connecting a Redshift data warehouse (private connectivity)
- Reauthorizing a Snowflake OAuth connection
- Using Snowflake with Peak
- SQL Explorer overview
- Roles and permissions
- User management
- Inventory management solution
- Commercial pricing solution
- Merchandising solution
Supply Chain & Retail Solutions user guide
Configuring a Microsoft SQL Server connector
A Microsoft SQL Server connector extracts data directly from your SQL Server instances into Peak, enabling you to pull specific datasets for analysis.
Prerequisites
Before configuring a Microsoft SQL Server connector, ensure you meet the following requirements:
- You have access to Peak with permissions to configure Data Sources.
- You have SQL Server credentials (host, port, username, password, database name).
- Your SQL Server instance is accessible from Peak (network connectivity and firewall rules configured).
Configuring the connection
- In Peak, open Manage and select Data Sources.
- Select Add feed and choose the MSSQL connector.
- At the Connection stage, either select an existing connection from the dropdown or select New connection.
- Enter the connection parameters. See Connection parameters.
- Select Test to validate the connection. If the test fails, hover over the info icon for details.
- Select Save and proceed to the next stage.
Connection parameters
| Parameter | Description |
|---|---|
| Connection name | A name for this connection. Use alphanumeric characters. |
| Database host | The hostname, IP address, or full server name in host\server format. |
| Database port | The port your database uses (typically 1433). |
| Database username | A user with DBA or SYSDBA privileges. |
| Database password | The password for the database user. |
| Database name | The name of the database. |
Connecting through SSH
If your database requires an SSH tunnel, select Connect through SSH and enter the following:
| Parameter | Description |
|---|---|
| SSH host or IP | The SSH server host or IP address. |
| SSH port | The SSH port (typically 22). |
| SSH user | The SSH server username. |
| SSH password | Optional. The SSH server password. |
| Public key | Required if no password is used. Copy the public key and add it to the SSH server. |
Peak's external IP address is the same across all tenants. Add it to your SSH server allowlist to allow the connection.
Configuring import settings
- Select the database table to ingest and preview the data.
- Select a load type: Truncate and insert, Incremental, or Upsert. See Load types.
- Optionally, add field filters by operator and value.
- Add a primary key if using the upsert load type (required for upsert).
- Enter a feed name following these rules:
- Use only alphanumeric characters and underscores.
- Must start with a letter.
- Must not end with an underscore.
- Maximum 50 characters.
Configuring the destination
Select where your data will be ingested. Available options depend on your configured data warehouse. See Destination options.
Configuring the trigger
Set up how and when the feed runs. See Triggers and watchers.
Result
Peak creates the MSSQL connector feed and runs it according to the selected trigger. You can monitor feed runs and troubleshoot failures from Manage > Data Sources.