Microsoft SQL Server

This is a general procedure of creating a Microsoft SQL Server database connection. Follow these instructions to use the interface of the New connection dialog for this particular database type.

Use the General tab of the New Microsoft SQL Server connection dialog to set up the parameters that are specific for this database type.

Configure a Microsoft SQL Server connection

Open the New Microsoft SQL Server connection dialog. Select the tab for one of the two options:
- From the editor, to attach the new database to a specific notebook
- From the Home page, to add a database connection to a workspace
- Go to Main menu | Tools | Attached data or click the Attached data icon on the left-hand sidebar.
- Click New connection and select New database connection.
- In the New database connection dialog, select Microsoft SQL Server.
- On the Home page, select the workspace where you want to create the connection.
- Select Databases from the menu under the workspace name.
- Click the Add connection button in the upper right corner. The New database connection dialog will open.
- In the New database connection dialog, select Microsoft SQL Server.
On the General tab, select the connection type.
- default: to connect by specifying the Host, Port, and Database.
- Unix Socket: to connect by using a Unix socket file
- URL only: to connect by providing the URL of a pre-built connection.
  Use this method to pass additional parameters. For example, add &SSL=true to the URL string to enable SSL.
Proceed based on the selected connection type:
1. In the Host field, type your server address.
2. In the Port field, type the port. The default port is 1433.
  Real port numbers might be different on your system. Verify that you use a correct port number with your database administrator, server settings, or hosting provider.
3. In the Instance, type the instance you want to connect to.
4. Under Authentication, select an authentication method:
  - User & Password: to use your login and password
  - No auth: to connect without authentication required
5. In the User and Password fields, specify your credentials if required by the selected authentication method.
6. In the Database field, type the database name to which you want to connect.
1. Under Authentication, select an authentication method:
  - User & Password: to use your login and password
  - No auth: to connect without authentication required
2. In the User and Password fields, specify your credentials if required by the selected authentication method.
3. In the Database field, type the database name to which you want to connect.
1. Under Authentication, select an authentication method:
  - User & Password: to use your login and password
  - No auth: to connect without authentication required
2. In the User and Password fields, specify your credentials if required by the selected authentication method.
3. In the URL field, provide the URL of the pre-built connection you want to establish.
Click the Test connection button at the bottom of the dialog.
Once the connection is successfully tested, click the Save and close button.

Results

If created for a specific notebook, the new connection will be automatically added to the workspace. You can later attach this database to any other notebook from this workspace.
If created for a workspace, this connection is added to the workspace databases and can be attached to any noteboook from this workspace.

Last modified: 27 October 2023