> For the complete documentation index, see [llms.txt](https://docs.infotopics.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.infotopics.com/features/management-console/connections.md).

# Connections

A connection holds everything WriteBackExtreme needs to reach one database: the driver, the host, the credentials and the groups allowed to use it. You create a connection once, and every schema that writes back to that database uses it. Usernames and passwords are encrypted before they are stored, and they are never sent back to the browser.

You need the **connection manager** role or an administrator account to open **Connections**.

Databricks, Snowflake, Teradata, SAP HANA and IBM DB2 talk to WriteBackExtreme over ODBC. On an on-premise installation, install the ODBC driver and, if you want to connect by DSN, create the DSN in your ODBC manager first: [How to setup ODBC](https://docs.infotopics.com/features/database-connections/snowflake/using-odbc.md).

## The connections overview

**Connections** lists every connection with its **Driver**, **Label**, **# Schemas**, **# Groups**, **Database** and **Host**. The menu at the end of each row gives you:

* **Edit…** — reopens the connection so you can change its settings. The system database that WriteBackExtreme stores its own configuration in has no **Edit…** entry; it can only be changed from the command line of the machine it runs on.
* **Group Membership** — a short dialog to add or remove the groups that may use this connection, without opening the whole form.
* **Remove** — deletes the connection and everything in it. WriteBackExtreme first checks whether any schema still uses the connection, and if one does you get **Unable to delete connection** instead, asking you to remove those schemas first.

<figure><img src="https://3247237607-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0gkOLIfzuEyMP2kvoT9o%2Fuploads%2Fgit-blob-13a1dd2df65b3dd3c39fc259862d62b721ccafd3%2FConsole_Connections_List.png?alt=media" alt=""><figcaption><p>The connections overview</p></figcaption></figure>

{% hint style="danger" %}
Deleting a connection cannot be undone. The confirmation says it plainly: *all data will be deleted as well and can't be undone*.
{% endhint %}

## Create a new connection

Creating a connection is a three-step wizard: **Select a driver.**, **Configure connection.** and **Test connection.** You cannot finish without a connection test that succeeds.

{% stepper %}
{% step %}

### Select a driver

Click **New** and pick the type of database you want to connect to. WriteBackExtreme 6.3 ships twelve drivers you can create a connection with:

| Driver                   | Notes                                                                                         |
| ------------------------ | --------------------------------------------------------------------------------------------- |
| **Microsoft SQL Server** | SQL Server 2016 or later.                                                                     |
| **MySQL**                | MySQL 5.7, 8.0 or higher.                                                                     |
| **PostgreSQL**           | The latest PostgreSQL versions.                                                               |
| **Amazon Redshift**      |                                                                                               |
| **Oracle Database**      |                                                                                               |
| **Azure Synapse**        | Text fields are limited to 4000 characters.                                                   |
| **Google Big Query**     |                                                                                               |
| **Snowflake**            | Over ODBC. Editing a schema is partially supported, because of limits in the database itself. |
| **Databricks**           | Over ODBC.                                                                                    |
| **Teradata**             | Over ODBC.                                                                                    |
| **Sap Hana**             |                                                                                               |
| **DB2**                  | IBM DB2, over ODBC.                                                                           |

<figure><img src="https://3247237607-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0gkOLIfzuEyMP2kvoT9o%2Fuploads%2Fgit-blob-ace43d4f37332c270fbea773bcf52be63a85c08e%2FConsole_Connections_DriverGrid.png?alt=media" alt=""><figcaption><p>Step 1: pick a driver</p></figcaption></figure>

{% hint style="warning" %}
In a trial environment the wizard warns you not to connect to production databases. Take that seriously: a trial runs on infrastructure that is not yours.
{% endhint %}
{% endstep %}

{% step %}

### Configure the connection

Every driver asks for a **Connection name** of at least two characters, and offers an optional **Color (optional)** and **Description (optional)** to make the connection easy to recognise in long lists.

**Authorized Groups** decides who may use the connection. Only users inside these groups see the connection and the schemas built on it, and the field starts out filled with the groups you are in yourself.

**Default Casting** controls how WriteBackExtreme writes table and column names: **Case sensitive (not recommended)**, **Lowercase (WBE default)** or **Uppercase**. Choose carefully — this one can only be set while you are creating the connection and is read-only afterwards.

<figure><img src="https://3247237607-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F0gkOLIfzuEyMP2kvoT9o%2Fuploads%2Fgit-blob-6693e616c179332d3186d3deb7ab0a9b310ba0c6%2FConsole_Connections_MySQLForm.png?alt=media" alt=""><figcaption><p>Step 2: the MySQL form</p></figcaption></figure>

The remaining fields depend on the driver you picked. The full list, per driver, is on a page of its own:

{% content-ref url="/pages/AP9GMBk1e8Qt1NRtUFQW" %}
[Connection fields per driver](https://docs.infotopics.com/features/management-console/connections/connections-driver-fields.md)
{% endcontent-ref %}
{% endstep %}

{% step %}

### Test the connection

The last step shows the whole configuration again, read-only, with a **Test connection** button. Click it and WriteBackExtreme opens a real connection to the database:

* **Connection success!** — **Create connection** becomes available.
* **Connection test failed.** — expand **Show full error message** to see what the database said. Host names and IP addresses are stripped out of that message on purpose.
* **Too many connection tests.** — you are testing faster than five times a minute. Wait a minute and try again.

**Create connection** stays disabled until a test succeeds, so a connection you cannot reach never reaches your schema list.
{% endstep %}
{% endstepper %}

## Change an existing connection

Open a connection and click **Edit** to make its fields editable, then **Save**. Editing is not gated on a test, so test the connection yourself after you change a host or a password — nothing stops you from saving a connection that no longer works.

{% hint style="warning" %}
Changing an existing connection affects every schema built on it. If you are moving to a different database, a new connection is usually safer than editing the old one.
{% endhint %}

## Groups and schema permissions

WriteBackExtreme uses groups to decide who may reach which data:

* Users are members of groups.
* A connection is assigned to one or more groups through **Authorized Groups**.
* Users reach a connection, and the schemas on it, through their group membership.

Because the schemas under a connection carry their own per-group permissions, changing a connection's groups changes those schemas too.

### Adding a group: Copy permissions

When you add a group to a connection that already has schemas, WriteBackExtreme opens **Copy permissions**. The new group has no permissions on those schemas yet, so the dialog asks which existing group to copy them from. Pick that group in **Select group** and click **OK**.

{% hint style="warning" %}
Clicking **OK** without selecting a group leaves the new group with no permissions at all on those schemas. Its members will see the connection but no data. Either pick a group to copy from, or set the permissions per schema afterwards.
{% endhint %}

### Removing a group

Removing a group from a connection also removes that group's permissions on every schema of that connection. There is no confirmation and no undo: if you add the group back, you are asked to copy permissions again, as if it were new.

Groups can be changed from the connection form, or straight from the overview through **Group Membership** in the row menu.

## Quirks with SQL Server

### Connecting with a service account

The SQL Server form has a **Login with service account** checkbox, which hides the username and password fields: the connection then runs as the account the WriteBackExtreme application itself runs under, and the credentials are passed through by the driver. This is how you use Windows Authentication for a SQL Server connection.

{% hint style="warning" %}
In 6.3.4 this checkbox is not stored with the connection: reopen the connection and it shows unticked again. Until that is fixed, leave **Username** and **Password** empty instead — an empty username and password have the same effect, and that does persist.
{% endhint %}

### A schema other than dbo

Most SQL Server databases use the `dbo` schema. To write to a different one, set the default schema on the database user:

```
ALTER USER [username] WITH DEFAULT_SCHEMA = [your_schema]
```

### Advanced configuration

**Advanced configuration** holds two TLS settings: **Disable ssl certficate validation for the SQL database** and **SQL Server database uses SSL encryption**. New connections start with encryption on and the server certificate trusted, which is what most SQL Server installations need.

## ODBC setup

Snowflake, Databricks, Teradata, SAP HANA and DB2 need an ODBC driver on the machine running WriteBackExtreme, and optionally a DSN. [Our ODBC examples](https://docs.infotopics.com/features/database-connections.md) walk through that configuration.


---

# 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 by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.infotopics.com/features/management-console/connections.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

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.
