Connecting to Microsoft SQL Server can be done natively using an IDE or any supported client library. Alternatively, you can use the sqlcmd command line utility for one-off executions.

Prerequisites

To get the most out of this guide, you will need to:

Features

The table below explains which features are available for this kind of connection.

  • Native - This refers to when a database client connects through a specific protocol, such as an IDE or client libraries through hoop connect <connection-name>.
  • One Off - This term refers to accessing this connection from hoop web panel.
FeatureNativeOne OffDescription
TLS Termination Proxy

The local proxy terminates the connection with TLS, enabling the connection with the remote server to be TLS encrypted.
Audit

The gateway store and audit the queries being issued by the client
Data Masking (DLP)

A policy can be enabled to mask sensitive fields dynamically when performing queries in the database.
Credentials Offload

The user authenticates via SSO instead of using database credentials.
Interactive Access

Interactive access is available when using an IDE or connecting via a terminal to perform analysis exploration.

Configuration

NameTypeRequiredDescription
HOSTenv-varyesThe IP or Host of the SQL Server
PORTenv-varyesThe port of the SQL server
USERenv-varyesThe user with access to the instance
PASSenv-varyesThe password with access to the instance
DBenv-varyesThe name of the database to connect (Required when using the connection via the command line).
INSECUREenv-varnoIf the connection will ignore the chain of certificates presented by the server. (the connection will be subject to man-in-the-middle attacks if the network is not reliable. By default, this option is set to false)

Connection setup

Create a new TCP connection in hoop’s web panel.

Access the connection

CLI

hoop connect <connection-name>

connection: mssql | session: 5531dc59-febc-4eee-af26-96e0e0de6769

---------------------mssql-credentials----------------------
      host=127.0.0.1 port=1444 user=noop password=noop
------------------------------------------------------------
ready to accept connections!

Web panel