Introduction
To connect to a Microsoft SQL Server database, a SQL Server instance must be accessible along with valid database credentials. Depending on your network setup, you may also need SSH tunnel details if direct database access is not available.
Setup & Authentication
Overview
Your customer’s setup:
- Provide SQL Server connection details (host, port, database, and credentials).
- Optionally configure SSH tunnelling if required by their network.
Remote Setup in Microsoft SQL Server – performed by your customer
Your customer must provide the connection details for their SQL Server instance.
- Ensure the SQL Server instance allows remote connections.
- Confirm firewall rules allow inbound connections on the specified port.
- Create database credentials with appropriate read/write permissions (as required).
If SSH tunnelling is required, your customer must also provide SSH connection details.
Cyclr Connector Installation
When installing a Microsoft SQL Server Connector, the following values are used:
| Property | Description |
|---|---|
| Server | Hostname or IP address of the SQL Server instance |
| Port | Port number for the SQL Server (default typically 1433) |
| Database | Name of the target database |
| User | Username for database authentication |
| Password | Password for database authentication |
| Schema (optional) | Default table schema applied to enhanced objects |
| SSH Tunnel? (optional) | Set to true if connecting via SSH tunnel |
| SSH Host (optional) | Hostname or IP of the SSH server |
| SSH Port (optional) | Port for SSH access (default typically 22) |
| SSH Username (optional) | Username for SSH authentication |
| SSH Password (optional) | Password for SSH authentication (if not using key auth) |
| SSH Private Key (optional) | Private key for SSH authentication (can be used instead of password) |