> For the complete documentation index, see [llms.txt](https://docs.personify.be/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.personify.be/concepts/connectors/database-connector.md).

# Database connector

The database connector is a implementation used for connecting to remote systems that are using JDBC. This includes databases like Oracle, MySQL, PostgreSQL, H2,.....

A valid driver has to be available in the classpath.

The scope of the connector is limited to a single table. Implementing views on the database can extend the behaviour.

## Configuration <a href="#configuration" id="configuration"></a>

Below are all the parameters you can specify on this connector.

| name       | description                                 |
| ---------- | ------------------------------------------- |
| jdbcUrl    | the jdbcUrl (correct syntax)                |
| username   | the username used for authenticating        |
| password   | the password used for authenticating        |
| driver     | the fully qualified classname of the driver |
| table      | the name of the database table              |
| test-query | query used for testing (select 1)           |

## Supported functions <a href="#supported-functions" id="supported-functions"></a>

Below are the implemented operations on this connector.

| name      |     | description                         |
| --------- | --- | ----------------------------------- |
| create    | yes | implemented                         |
| find      | yes | implemented                         |
| search    | yes | implemented                         |
| update    | yes | implemented                         |
| delete    | yes | implemented                         |
| disable   | no  |                                     |
| archive   | no  |                                     |
| unarchive | no  |                                     |
| ping      | yes | pings the connection                |
| validate  | yes | validates the configuration on init |

## Open issues <a href="#open-issues" id="open-issues"></a>

* sorting
* paging
* multiple tables


---

# 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.personify.be/concepts/connectors/database-connector.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.