> For the complete documentation index, see [llms.txt](https://docs.tonic.ai/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.tonic.ai/fabricate/workspaces/workspace-server-connections.md).

# Configuring available server connections for a workspace

When you add a database connection to a project, or export data to an external database, you select the server connection to use.

From the **Server Connections** section of the [workspace settings page](/fabricate/workspaces/workspaces-manage.md#workspace-settings-display), you manage the available server connections for the workspace.

<figure><img src="/files/2LriEP9wW0TWcv1hhoKh" alt=""><figcaption><p>Server Connections section of workspace settings with a defined server connection.</p></figcaption></figure>

When you create a server connection during [data export](/fabricate/database-data/generating-and-using-database-data/data-agent-db-export-data.md), during [database connection creation](/fabricate/project-and-database-management/data-agent-db-create-manage/database-add-connection.md), you can choose whether to add the connection to the workspace server connections list.

## Adding a server connection

From the **Server Connections** list, to add a server connection:

1. Click **Add Server Connection**.

<figure><img src="/files/QCoEC8fLK2rZNXVq5YHb" alt=""><figcaption><p>New Server Connection panel to create a server connection</p></figcaption></figure>

2. On the **New Server Connection** panel, to use a connection string to populate the connection fields, in the **Connection URL** field, paste the string.\
   \
   When it uses a connection string to populate the fields, Fabricate sets **Name** to the host value. You can change the name to a different value.
3. If you do not use a connection string, then:
   1. Under **Platform**, click the server platform.
   2. In the **Name** field, provide a name to use to identify the server connection.
   3. Provide the [connection details](#connection-details).
4. To test the connection, click **Test Connection**.

   \
   Note that for Google BigQuery, Fabricate prompts you to provide a dataset to use for the connection test.
5. To save the connection, click **Create Server Connection**.

## Editing a server connection

To edit a server connection:

1. Click the edit icon for the server connection.

<figure><img src="/files/Lug0BFgmz8BZ1zVXOCTM" alt=""><figcaption><p>Edit Server Connection panel</p></figcaption></figure>

2. On the connection details panel, update the [connection details](#connection-details).\
   \
   Note that Fabricate does not display the existing content of password, secret, or private key fields. If you are not changing those values for a server connection, then leave the field empty.
3. To test the updated configuration, click **Test Connection**.
4. To save the changes, click **Save Changes**.

## Connection details

### Platforms other than Databricks, Google BigQuery, or Snowflake

For platforms other than Databricks, Google BigQuery, or Snowflake, the connection fields are:

1. In the **Host** field, provide the hostname for the server.
2. In the **Port** field, provide the port to connect through.
3. From the **SSL/TLS** dropdown list, select whether to enable or require Secure Socket Layer (SSL) or Transport Layer Security (TLS).

   \
   Some platforms include `verify-ca` and `verify-full` options. For those options, you must add the required certificate to the [account certificates list](/fabricate/fabricate-accounts-and-users/account-ca-certificates.md).

#### Selecting the authentication method

For the following connection types, from the **Authentication** dropdown list, select the type of authentication to use:

* PostgreSQL
* MySQL
* SQL Server
* Amazon Redshift

Other platforms always use a username and password.

The options are:

* **Username & Password**. This is the default.
* **AWS IAM Role**. To use this option, you must first [configure the available AWS roles for the workspace](/fabricate/workspaces/workspace-aws-roles.md). Note that this option is not available for SQL Server.
* **Azure AD Service Principal**. To use this option, you must first [configure the available Azure service principals for the workspace](/fabricate/workspaces/workspace-service-principals.md). Note that this option is not available for Amazon Redshift.

#### Providing a username and password

For username and password authentication:

1. In the **Username** field, provide the username to use to make the connection.
2. In the **Password** field, provide the password.

#### Providing an AWS role

For AWS IAM role authentication:

1. In the **Username** field, provide the username to use to make the connection.
2. From the **AWS Role** dropdown, select the role to use.

#### Providing an Azure service principal

For Azure AD service principal authentication:

1. In the **Username** field, provide the username for the Microsoft Entra user to use to make the connection. The user must be mapped to the service principal that you select.
2. From the **Azure Service Principal** dropdown, select the service principal to use.

### Databricks

For Databricks:

<figure><img src="/files/brVzwyJhcqwGifqRv6vl" alt=""><figcaption><p>New Server Connection panel for a Databricks connection</p></figcaption></figure>

1. In the **Host** field, provide the host where the database is located.
2. From the **Credential Type** dropdown list, select the type of authentication to use. The options are:
   * **Service Principal**
   * **Personal Access Token**
3. For **Service Principal** authentication:
   1. In the **Client ID** field, provide the client identifier.
   2. In the **Secret** field, provide the secret that is associated with the client identifier.
4. For **Personal Access Token** authentication, in the **Access Token** field, provide the access token to authenticate to the database.
5. In the **Warehouse ID** field, provide the data warehouse for the data.

### Google BigQuery

For Google BigQuery:

<figure><img src="/files/h17tALHLh6fzFhtJ1yxm" alt=""><figcaption><p>New Server Connection panel for a Google BigQuery connection</p></figcaption></figure>

1. In the **Google Cloud Project ID** field, provide the identifier of the Google Cloud project where the data is located.
2. In the **Service Account Key** field, provide the service account key to use to connect to the project. [How to generate a service account key](https://docs.cloud.google.com/iam/docs/keys-create-delete).
3. In the **Location** field, specify the location of the project.\
   \
   If you do not provide a location for the server connection, then when you connect to a dataset, Fabricate uses the dataset to determine the location.

Note that when you test a Google BigQuery server connection, Fabricate prompts you to provide a dataset to use for the connection test.

### Snowflake

For Snowflake:

<figure><img src="/files/aGrTQdCShFvWAv1cOdkD" alt=""><figcaption><p>New Server Connection panel for a Snowflake connection</p></figcaption></figure>

1. In the **Account Identifier** field, provide the identifier for the Snowflake account that owns the connection.
2. From the **Credential Type** dropdown list, select the type of credentials to use for the connection. The options are:
   * **Password**
   * **RSA Key Pair**
3. If you select **Password**:
   1. In the **Username** field, provide the username for the connection.
   2. In the **Password** field, provide the password for the connection.
4. If you select **RSA Key Pair**:
   1. In the **Username** field, provide the username for the connection.
   2. In the **Private** **Key** field, paste an unencrypted, PEM-encoded private key.

<figure><img src="/files/OfgAvkuTnow6xRVJvhHz" alt=""><figcaption><p>Fields for the RSA Key Pair authentication option for a Snowflake connection</p></figcaption></figure>

5. In the **Warehouse** field, provide the name of the warehouse that runs the connection.
6. In the **Role** field, provide the name of the role to use for the connection.

## Deleting a server connection

You cannot delete a server connection that is either:

* Used in a database connection.
* The server connection for a database export target. Before you can delete the server connection, you must remove the export target.

From the **Server Connections** list, to delete a connection, click its delete option.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.tonic.ai/fabricate/workspaces/workspace-server-connections.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.