npm package: @heroku-cli/plugin-data
Description: A Heroku CLI Plugin for managing Heroku Data
Author: Heroku
Latest version: 2.0.0

# Heroku CLI Data Plugin

A Heroku CLI Plugin for managing Heroku Data Addons and Features

- Connectors
- Enhanced Certificates

[![oclif](https://img.shields.io/badge/cli-oclif-brightgreen.svg)](https://oclif.io)
[![Version](https://img.shields.io/npm/v/@heroku-cli/plugin-data-connectors.svg)](https://npmjs.org/package/@heroku-cli/plugin-data-connectors)
![Node CI](https://github.com/heroku/heroku-cli-plugin-data/actions/workflows/ci.yml/badge.svg)
[![Downloads/week](https://img.shields.io/npm/dw/@heroku-cli/plugin-data-connectors.svg)](https://npmjs.org/package/@heroku-cli/plugin-data-connectors)
[![License](https://img.shields.io/npm/l/@heroku-cli/plugin-data-connectors.svg)](https://github.com/heroku/heroku-cli-plugin-data-connectors/blob/main/package.json)

You can read more about Heroku Data Connectors on [Dev
Center](https://devcenter.heroku.com/articles/heroku-data-connectors).

You can read more about Heroku Data Enhanced Certificates on the [Dev Center](https://devcenter.heroku.com/articles/heroku-data-enhanced-certificates).

<!-- toc -->
* [Heroku CLI Data Plugin](#heroku-cli-data-plugin)
* [Usage](#usage)
* [Commands](#commands)
<!-- tocstop -->
# Usage
```sh-session
$ heroku plugins:install data
$ heroku COMMAND
running command...
$ heroku (-v|--version|version)
@heroku-cli/plugin-data-connectors/0.2.2 darwin-x64 node-v12.10.0
$ heroku --help [COMMAND]
USAGE
  $ heroku COMMAND
...
```
<!-- usagestop -->
# Commands
<!-- commands -->
* [`heroku data:connectors`](#heroku-dataconnectors)
* [`heroku data:connectors:create`](#heroku-dataconnectorscreate)
* [`heroku data:connectors:destroy CONNECTOR`](#heroku-dataconnectorsdestroy-connector)
* [`heroku data:connectors:info CONNECTOR`](#heroku-dataconnectorsinfo-connector)
* [`heroku data:connectors:list`](#heroku-dataconnectorslist)
* [`heroku data:connectors:pause CONNECTOR`](#heroku-dataconnectorspause-connector)
* [`heroku data:connectors:resume CONNECTOR`](#heroku-dataconnectorsresume-connector)
* [`heroku data:connectors:update CONNECTOR`](#heroku-dataconnectorsupdate-connector)
* [`heroku data:connectors:wait CONNECTOR`](#heroku-dataconnectorswait-connector)
* [`heroku data:enhanced-certificates:disable ADDON`](#heroku-dataenhanced-certificatesdisable-addon)
* [`heroku data:enhanced-certificates:enable ADDON`](#heroku-dataenhanced-certificatesenable-addon)
* [`heroku data:enhanced-certificates:status ADDON`](#heroku-dataenhanced-certificatesstatus-addon)
* [`heroku data:labs:disable FEATURE`](#heroku-datalabsdisable-feature)
* [`heroku data:labs:enable FEATURE`](#heroku-datalabsenable-feature)
* [`heroku data:labs:list ADDON`](#heroku-datalabslist-addon)

## `heroku data:connectors`

List all Data Connectors for a particular app or addon

```
USAGE
  $ heroku data:connectors [--addon <value>] [-a <value>] [--json | --table] [-r <value>]

FLAGS
  -a, --app=<value>     app to run command against
  -r, --remote=<value>  git remote of app to use
      --addon=<value>   The ID or name for the addon your connector is attached to
      --json            Return the results as JSON
      --table           Return the results as a table

DESCRIPTION
  List all Data Connectors for a particular app or addon
  Read more about this feature at https://devcenter.heroku.com/articles/heroku-data-connectors

ALIASES
  $ heroku data:connectors:list

EXAMPLES
  $ heroku data:connectors -a your-app

  $ heroku data:connectors --app=your-app --json

  $ heroku data:connectors --addon=your-postgres-addon --table
```

_See code: [src/commands/data/connectors/index.ts](https://github.com/heroku/heroku-cli-plugin-data/blob/v2.0.0/src/commands/data/connectors/index.ts)_

## `heroku data:connectors:create`

create a new Data Connector

```
USAGE
  $ heroku data:connectors:create --source <value> --store <value> -t <value>... [-a <value>] [--exclude-column <value>...]
    [--name <value>]

FLAGS
  -a, --app=<value>                app to run command against
  -t, --table=<value>...           (required) Tables to include
      --exclude-column=<value>...  Columns to exclude
      --name=<value>               Name of the connector
      --source=<value>             (required) The name of the database add-on whose change data you want to store
      --store=<value>              (required) The name of the database add-on that will store the change data

DESCRIPTION
  create a new Data Connector
  Read more about this feature at https://devcenter.heroku.com/articles/heroku-data-connectors

EXAMPLES
  $ heroku data:connectors:create --store kafka-lovely-12345 --source postgresql-neato-98765 --table public.posts --table public.comments

  $ heroku data:connectors:create --store kafka-lovely-12345 --source postgresql-neato-98765 --table public.users --exclude-column public.users.password
```

_See code: [src/commands/data/connectors/create.ts](https://github.com/heroku/heroku-cli-plugin-data/blob/v2.0.0/src/commands/data/connectors/create.ts)_

## `heroku data:connectors:destroy CONNECTOR`

Destroy a Data Connector

```
USAGE
  $ heroku data:connectors:destroy CONNECTOR [--confirm <value>]

ARGUMENTS
  CONNECTOR  name of the connector

FLAGS
  --confirm=<value>  confirms destroying the connector if passed in

DESCRIPTION
  Destroy a Data Connector
  Read more about this feature at https://devcenter.heroku.com/articles/heroku-data-connectors

EXAMPLES
  $ heroku data:connectors:destroy gentle-connector-1234

  $ heroku data:connectors:destroy gentle-connector-1234 --confirm gentle-connector-1234
```

_See code: [src/commands/data/connectors/destroy.ts](https://github.com/heroku/heroku-cli-plugin-data/blob/v2.0.0/src/commands/data/connectors/destroy.ts)_

## `heroku data:connectors:info CONNECTOR`

Get information about a Data Connector

```
USAGE
  $ heroku data:connectors:info CONNECTOR [--json]

ARGUMENTS
  CONNECTOR  name of the connector

FLAGS
  --json  Return the results as JSON

DESCRIPTION
  Get information about a Data Connector
  Read more about this feature at https://devcenter.heroku.com/articles/heroku-data-connectors

EXAMPLES
  $ heroku data:connectors:info gentle-connector-1234

  $ heroku data:connectors:info gentle-connector-1234 --json
```

_See code: [src/commands/data/connectors/info.ts](https://github.com/heroku/heroku-cli-plugin-data/blob/v2.0.0/src/commands/data/connectors/info.ts)_

## `heroku data:connectors:list`

List all Data Connectors for a particular app or addon

```
USAGE
  $ heroku data:connectors:list [--addon <value>] [-a <value>] [--json | --table] [-r <value>]

FLAGS
  -a, --app=<value>     app to run command against
  -r, --remote=<value>  git remote of app to use
      --addon=<value>   The ID or name for the addon your connector is attached to
      --json            Return the results as JSON
      --table           Return the results as a table

DESCRIPTION
  List all Data Connectors for a particular app or addon
  Read more about this feature at https://devcenter.heroku.com/articles/heroku-data-connectors

ALIASES
  $ heroku data:connectors:list

EXAMPLES
  $ heroku data:connectors -a your-app

  $ heroku data:connectors --app=your-app --json

  $ heroku data:connectors --addon=your-postgres-addon --table
```

## `heroku data:connectors:pause CONNECTOR`

Pause change event creation on a Data Connector

```
USAGE
  $ heroku data:connectors:pause CONNECTOR

ARGUMENTS
  CONNECTOR  name of the connector

DESCRIPTION
  Pause change event creation on a Data Connector
  Read more about this feature at https://devcenter.heroku.com/articles/heroku-data-connectors

EXAMPLES
  $ heroku data:connectors:pause gentle-connector-1234
```

_See code: [src/commands/data/connectors/pause.ts](https://github.com/heroku/heroku-cli-plugin-data/blob/v2.0.0/src/commands/data/connectors/pause.ts)_

## `heroku data:connectors:resume CONNECTOR`

Resume change event creation on a Data Connector

```
USAGE
  $ heroku data:connectors:resume CONNECTOR

ARGUMENTS
  CONNECTOR  name of the connector

DESCRIPTION
  Resume change event creation on a Data Connector
  Read more about this feature at https://devcenter.heroku.com/articles/heroku-data-connectors

EXAMPLES
  $ heroku data:connectors:resume gentle-connector-1234
```

_See code: [src/commands/data/connectors/resume.ts](https://github.com/heroku/heroku-cli-plugin-data/blob/v2.0.0/src/commands/data/connectors/resume.ts)_

## `heroku data:connectors:update CONNECTOR`

Update the settings, tables, and columns to exclude for a Data Connector

```
USAGE
  $ heroku data:connectors:update CONNECTOR [--setting <value>...] [--add-table <value>...] [--remove-table <value>...]
    [--exclude-column <value>...] [--remove-excluded-column <value>...]

ARGUMENTS
  CONNECTOR  name of the connector

FLAGS
  --add-table=<value>...               Tables to add
  --exclude-column=<value>...          Columns to exclude
  --remove-excluded-column=<value>...  Columns to no longer exclude
  --remove-table=<value>...            Tables to remove
  --setting=<value>...

DESCRIPTION
  Update the settings, tables, and columns to exclude for a Data Connector
  Read more about this feature at https://devcenter.heroku.com/articles/heroku-data-connectors#update-configuration

EXAMPLES
  $ heroku data:connectors:update gentle-connector-1234 --setting key=value --setting otherKey=otherValue --add-table public.posts --add-table public.people --remove-table public.messages --exclude-column public.posts.key --remove-excluded-column public.parcels.key
```

_See code: [src/commands/data/connectors/update.ts](https://github.com/heroku/heroku-cli-plugin-data/blob/v2.0.0/src/commands/data/connectors/update.ts)_

## `heroku data:connectors:wait CONNECTOR`

Wait for your Data Connector to be provisioned

```
USAGE
  $ heroku data:connectors:wait CONNECTOR

ARGUMENTS
  CONNECTOR  name of the connector

DESCRIPTION
  Wait for your Data Connector to be provisioned
  Read more about this feature at https://devcenter.heroku.com/articles/heroku-data-connectors

EXAMPLES
  $ heroku data:connectors:wait gentle-connector-1234
```

_See code: [src/commands/data/connectors/wait.ts](https://github.com/heroku/heroku-cli-plugin-data/blob/v2.0.0/src/commands/data/connectors/wait.ts)_

## `heroku data:enhanced-certificates:disable ADDON`

Disable enhanced certificates on an Addon

```
USAGE
  $ heroku data:enhanced-certificates:disable ADDON [-a <value>]

ARGUMENTS
  ADDON  name of the addon

FLAGS
  -a, --app=<value>  app to run command against

DESCRIPTION
  Disable enhanced certificates on an Addon
  Read more about this feature at https://devcenter.heroku.com/articles/heroku-data-enhanced-certificates
```

_See code: [src/commands/data/enhanced-certificates/disable.ts](https://github.com/heroku/heroku-cli-plugin-data/blob/v2.0.0/src/commands/data/enhanced-certificates/disable.ts)_

## `heroku data:enhanced-certificates:enable ADDON`

Enable enhanced certificates on an Addon

```
USAGE
  $ heroku data:enhanced-certificates:enable ADDON [-a <value>]

ARGUMENTS
  ADDON  name of the addon

FLAGS
  -a, --app=<value>  app to run command against

DESCRIPTION
  Enable enhanced certificates on an Addon
  Read more about this feature at https://devcenter.heroku.com/articles/heroku-data-enhanced-certificates

EXAMPLES
  $ heroku data:enhanced-certificates:enable happy-postgres-1234 -a example-app
```

_See code: [src/commands/data/enhanced-certificates/enable.ts](https://github.com/heroku/heroku-cli-plugin-data/blob/v2.0.0/src/commands/data/enhanced-certificates/enable.ts)_

## `heroku data:enhanced-certificates:status ADDON`

Get the status of Enhanced Certificates

```
USAGE
  $ heroku data:enhanced-certificates:status ADDON [-a <value>] [--json]

ARGUMENTS
  ADDON  name of the addon

FLAGS
  -a, --app=<value>  app to run command against
      --json         Return the results as JSON

DESCRIPTION
  Get the status of Enhanced Certificates
  Read more about this feature at https://devcenter.heroku.com/articles/heroku-data-enhanced-certificates
```

_See code: [src/commands/data/enhanced-certificates/status.ts](https://github.com/heroku/heroku-cli-plugin-data/blob/v2.0.0/src/commands/data/enhanced-certificates/status.ts)_

## `heroku data:labs:disable FEATURE`

Disable experimental features on an addon

```
USAGE
  $ heroku data:labs:disable FEATURE --addon <value> [-a <value>]

ARGUMENTS
  FEATURE  name of the feature

FLAGS
  -a, --app=<value>    app to run command against
      --addon=<value>  (required) The addon you want to disable features on

DESCRIPTION
  Disable experimental features on an addon

EXAMPLES
  $ heroku data:labs:disable wal-compression --addon=happy-postgres-1234 -a example-app
```

_See code: [src/commands/data/labs/disable.ts](https://github.com/heroku/heroku-cli-plugin-data/blob/v2.0.0/src/commands/data/labs/disable.ts)_

## `heroku data:labs:enable FEATURE`

Enable experimental features on an addon

```
USAGE
  $ heroku data:labs:enable FEATURE --addon <value> [-a <value>]

ARGUMENTS
  FEATURE  name of the feature

FLAGS
  -a, --app=<value>    app to run command against
      --addon=<value>  (required) The addon you want to enable features on

DESCRIPTION
  Enable experimental features on an addon

EXAMPLES
  $ heroku data:labs:enable wal-compression --addon=happy-postgres-1234 -a example-app
```

_See code: [src/commands/data/labs/enable.ts](https://github.com/heroku/heroku-cli-plugin-data/blob/v2.0.0/src/commands/data/labs/enable.ts)_

## `heroku data:labs:list ADDON`

List available experimental features on an addon and their statuses

```
USAGE
  $ heroku data:labs:list ADDON [-a <value>]

ARGUMENTS
  ADDON  name of the addon

FLAGS
  -a, --app=<value>  app to run command against

DESCRIPTION
  List available experimental features on an addon and their statuses

EXAMPLES
  $ heroku data:labs:list happy-postgres-1234
```

_See code: [src/commands/data/labs/list.ts](https://github.com/heroku/heroku-cli-plugin-data/blob/v2.0.0/src/commands/data/labs/list.ts)_
<!-- commandsstop -->