> 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/database-connections.md).

# Database connections

A connection holds everything WriteBackExtreme needs to reach one database: the driver, the address and the credentials. You create it once, and then point as many schemas at it as you like. Think of a connection as the authorised path to one database server and one database.

Access to connections is restricted to administrators and to users with the connection manager role. Passwords are stored encrypted.

### Create a connection

Go to **Connections** in the management console and press **New**. The wizard has three steps: **Select a driver**, **Configure connection** and **Test connection**, and ends with **Create connection**.

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

Every driver asks for the same handful of general fields:

| Field                      | Notes                                                                                                                                   |
| -------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- |
| **Connection name**        | Required. This is the name your schema authors pick from.                                                                               |
| **Color (optional)**       | Gives the connection a colour in the overview.                                                                                          |
| **Description (optional)** | Free text.                                                                                                                              |
| **Authorized Groups**      | Only users in these groups see this connection and its schemas.                                                                         |
| **Default Casting**        | How WriteBackExtreme cases table and column names: **Lowercase (WBE default)**, **Uppercase**, or **Case sensitive (not recommended)**. |

{% hint style="warning" %}
**Default Casting** can only be set when you create a connection. It cannot be changed afterwards.
{% endhint %}

Press **Test connection** to check the details before you save. On failure, **Show full error message** gives you the database's own error. Testing is rate limited, so **Too many connection tests.** simply means you should wait a moment.

{% hint style="info" %}
A connection cannot be deleted while schemas still use it. Remove its schemas first.
{% endhint %}

### Supported databases

| Database             | Connects through | Notes                                                                                        |
| -------------------- | ---------------- | -------------------------------------------------------------------------------------------- |
| Microsoft SQL Server | Native           | Version 2016 or later.                                                                       |
| MySQL                | Native           |                                                                                              |
| PostgreSQL           | Native           |                                                                                              |
| Amazon Redshift      | Native           | Default port `5439`. The port field shows `5432` as a placeholder, so type the port you use. |
| Azure Synapse        | Native           | Text fields are limited to 4000 characters.                                                  |
| Google Big Query     | Native           | Authenticates with a service account key file.                                               |
| Oracle Database      | JDBC             | See [Oracle](https://docs.infotopics.com/features/database-connections/oracle.md).           |
| Sap Hana             | JDBC             |                                                                                              |
| Snowflake            | ODBC             | See [Snowflake](https://docs.infotopics.com/features/database-connections/snowflake.md).     |
| Databricks           | ODBC             | See [DataBricks](https://docs.infotopics.com/features/database-connections/databricks.md).   |
| Teradata             | ODBC             | Needs a DSN on the server.                                                                   |
| DB2                  | ODBC             | See [IBM DB2](https://docs.infotopics.com/features/database-connections/ibm-db2.md).         |

### ODBC

Snowflake, Databricks, Teradata and DB2 connect through ODBC. For an on-premises installation you install the driver yourself on the machine that runs WriteBackExtreme, and configure it with ODBC Data Source Administrator on Windows or `/etc/odbc.ini` and `/etc/odbcinst.ini` on Linux.

The Docker image already includes the ODBC drivers for Snowflake, Databricks and SQL Server.

The databases below need a little more setup than the rest:

{% content-ref url="/pages/g1TNNLktnKr4DuAaVzcn" %}
[DataBricks](https://docs.infotopics.com/features/database-connections/databricks.md)
{% endcontent-ref %}

{% content-ref url="/pages/eAZB5CrA2Iijzxdk3sv9" %}
[Snowflake](https://docs.infotopics.com/features/database-connections/snowflake.md)
{% endcontent-ref %}


---

# 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/database-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.
