For the complete documentation index, see llms.txt. This page is also available as Markdown.

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, you manage the available server connections for the workspace.

Server Connections section of workspace settings with a defined server connection.

When you create a server connection during data export, during database connection creation, 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.

New Server Connection panel to create a server connection
  1. 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.

  2. 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.

  3. 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.

  4. 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.

Edit Server Connection panel
  1. On the connection details panel, update the 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.

  2. To test the updated configuration, click Test Connection.

  3. 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.

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:

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:

New Server Connection panel for a Databricks connection
  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:

New Server Connection panel for a Google BigQuery connection
  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.

  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:

New Server Connection panel for a Snowflake connection
  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.

Fields for the RSA Key Pair authentication option for a Snowflake connection
  1. In the Warehouse field, provide the name of the warehouse that runs the connection.

  2. 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.

Last updated

Was this helpful?