# Connect Vertica to dbt Core

Local development

VENDOR-SUPPORTED PLUGIN

If you're interested in contributing, check out the source code for each repository listed below.

* **Maintained by**: Vertica
* **Authors**: Vertica (Former authors: Matthew Carter, Andy Regan, Andrew Hedengren)
* **GitHub repo**: [vertica/dbt-vertica](https://github.com/vertica/dbt-vertica) [![](https://img.shields.io/github/stars/vertica/dbt-vertica?style=for-the-badge)](https://github.com/vertica/dbt-vertica)
* **PyPI package**: `dbt-vertica` [![](https://badge.fury.io/py/dbt-vertica.svg)](https://badge.fury.io/py/dbt-vertica)
* **Slack channel**: [n/a](https://www.getdbt.com/community/)
* **Supported dbt Core version**: v1.8.5 and newer
* **dbt support**: Not Supported
* **Minimum data platform version**: Vertica 24.3.0

## Installing dbt-vertica

Use `pip` to install the adapter. Use the following command for installation:

`python -m pip install dbt-vertica`

## Configuring dbt-vertica

For Vertica-specific configuration, please refer to [Vertica configs.](../../../reference/resource-configs/vertica-configs.md)

### Connecting to Vertica with dbt-vertica

#### Username / password authentication

Configure your dbt profile for using Vertica:

##### Vertica connection information

profiles.yml

```yaml
your-profile:
  outputs:
    dev:
      type: vertica # Don't change this!
      host: [hostname]
      port: [port] # or your custom port (optional)
      username: [your username]
      password: [your password]
      database: [database name]
      oauth_access_token: [access token]
      schema: [dbt schema]
      connection_load_balance: True
      backup_server_node: [list of backup hostnames or IPs]
      retries: [1 or more]
      autocommit: False
      
      threads: [1 or more]
  target: dev
```

##### Description of Profile Fields:

| Property                  | Description                                                                                                                                                                                                                                                  | Required? | Default Value                                         | Example                                                                                                       |
| ------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | --------- | ----------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- |
| type                      | The specific adapter to use.                                                                                                                                                                                                                                 | Yes       | None                                                  | vertica                                                                                                       |
| host                      | The host name or IP address of any active node in the Vertica Server.                                                                                                                                                                                        | Yes       | None                                                  | 127.0.0.1                                                                                                     |
| port                      | The port to use, default or custom.                                                                                                                                                                                                                          | Yes       | 5433                                                  | 5433                                                                                                          |
| username                  | The username to use to connect to the server.                                                                                                                                                                                                                | Yes       | None                                                  | dbadmin                                                                                                       |
| password                  | The password to use for authenticating to the server.                                                                                                                                                                                                        | Yes       | None                                                  | my\_password                                                                                                  |
| database                  | The name of the database running on the server.                                                                                                                                                                                                              | Yes       | None                                                  | my\_db                                                                                                        |
| oauth\_access\_token      | To authenticate via OAuth, provide an OAuth Access Token that authorizes a user to the database.                                                                                                                                                             | No        | ""                                                    | Default: ""                                                                                                   |
| schema                    | The schema to build models into.                                                                                                                                                                                                                             | No        | None                                                  | VMart                                                                                                         |
| connection\_load\_balance | A Boolean value that indicates whether the connection can be redirected to a host in the database other than host.                                                                                                                                           | No        | True                                                  | True                                                                                                          |
| backup\_server\_node      | List of hosts to connect to if the primary host specified in the connection (host, port) is unreachable. Each item in the list should be either a host string (using default port 5433) or a (host, port) tuple. A host can be a host name or an IP address. | No        | None                                                  | \['123.123.123.123','[www.abc.com',('123.123.123.124',5433)](http://www.abc.com',\('123.123.123.124',5433\))] |
| retries                   | The retry times after an unsuccessful connection.                                                                                                                                                                                                            | No        | 2                                                     | 3                                                                                                             |
| threads                   | The number of threads the dbt project will run on.                                                                                                                                                                                                           | No        | 1                                                     | 3                                                                                                             |
| label                     | A session label to identify the connection.                                                                                                                                                                                                                  | No        | An auto-generated label with format of: dbt\_username | dbt\_dbadmin                                                                                                  |
| autocommit                | Boolean value that indicates if the connection can enable or disable auto-commit.                                                                                                                                                                            | No        | True                                                  | False                                                                                                         |

For more information on Vertica’s connection properties please refer to [Vertica-Python](https://github.com/vertica/vertica-python#create-a-connection) Connection Properties.

## Was this page helpful?

YesNo

[Privacy policy](https://www.getdbt.com/cloud/privacy-policy)[Create a GitHub issue](https://github.com/dbt-labs/docs.getdbt.com/issues)

This site is protected by reCAPTCHA and the Google [Privacy Policy](https://policies.google.com/privacy) and [Terms of Service](https://policies.google.com/terms) apply.