SQL Gateway

Build 24.0.8957

Services

On the Services tab, you configure services to proxy MySQL or SQL Server connections to ODBC drivers. To run services as Windows services, select Run as a Windows Service on the Status tab.

If you choose to run your service as a Windows service, whenever you use a connection property that has a user-dependent path, you should use a hard-coded path instead. For example, if you have a custom schema, set the Location connection property path to

C:\Users\User\APPDATA\CData\Smartsheet Data Provider\Schema

For additional connection settings, such as configuring TLS/SSL, see Other.

Service Settings

The following settings configure the proxy service. Note that you must have Windows administrator access, as the SQL Gateway connects through system DSNs.

  • Service Name: Specify the name of the database.
  • SQL Server or MySQL: Select the database to emulate.
  • Data Source: Select the system DSN for the ODBC data source you want to access as a SQL Server or MySQL database.

  • SSL: Select this option to use TLS/SSL to encrypt client connections. You must configure TLS/SSL for SQL Server databases. See Other to configure the server certificate.
  • Port: Select the port the service will listen on.
  • Expose on Gateway: Enable this option to allow remote access to firewalled databases through an SSH server. You need to first configure the SSH Tunnel feature on the Tunneling tab. If the SSH server is running, the SQL Gateway will automatically select a port on the server: When connecting to the SSH server, specify the Remote Port value.

Startup Settings

Windows services have the following startup options:

  • Automatic: The service automatically starts at boot.

  • Manual: Services configured for manual startup can be started manually or from an application, such as the SQL Gateway or a script.
  • Disabled: The service can only be started manually from the Services snap-in to the Microsoft Management Console or the Task Manager.
You can start Windows services from the SQL Gateway's Services tab or from the Services snap-in to the Microsoft Management Console. To load the snap-in, enter "run" in the Start menu and then enter "services.msc".

Logging Options

Basic information about the service, such as startup and shutdown, is displayed on the Status tab.

To retrieve more verbose service-specific logs, select the Log Mode option and enable the Write Log to a File option on the service configuration dialog accessed on the Services tab.

The logging options on the Other tab will log to a file when the configured services start and stop and also any errors encountered in the SQL Gateway app itself.

Managing Incoming Connections

Advanced database connection settings, such as the idle connection timeout, are available on the Other tab.

Copyright (c) 2024 CData Software, Inc. - All rights reserved.
Build 24.0.8957