npm package: @heroku-cli/plugin-data-connectors
Description: A Heroku CLI Plugin for managing Heroku Data Connectors
Author: @heroku heroku-front-end@salesforce.com
Latest version: 1.0.1

heroku-cli-plugin-data-connectors
==========================

A Heroku CLI Plugin for managing Heroku Data Connections

[![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)
[![CircleCI](https://circleci.com/gh/heroku/heroku-cli-plugin-data-connectors/tree/main.svg?style=shield)](https://circleci.com/gh/heroku/heroku-cli-plugin-data-connectors/tree/main)
[![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).

<!-- toc -->
* [Usage](#usage)
* [Commands](#commands)
<!-- tocstop -->
# Usage
```sh-session
$ heroku plugins:install data-connectors
$ 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: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:connectors`

List all Data Connectors for a particular app or addon

```
USAGE
  $ heroku data:connectors

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

DESCRIPTION
  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-connectors/blob/v1.0.1/src/commands/data/connectors/index.ts)_

## `heroku data:connectors:create`

create a new Data Connector

```
USAGE
  $ heroku data:connectors:create

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

DESCRIPTION
  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-connectors/blob/v1.0.1/src/commands/data/connectors/create.ts)_

## `heroku data:connectors:destroy [CONNECTOR]`

Destroy a Data Connector

```
USAGE
  $ heroku data:connectors:destroy [CONNECTOR]

OPTIONS
  --confirm=confirm  confirms destroying the connector if passed in

DESCRIPTION
  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-connectors/blob/v1.0.1/src/commands/data/connectors/destroy.ts)_

## `heroku data:connectors:info [CONNECTOR]`

Get information about a Data Connector

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

OPTIONS
  --json  Return the results as JSON

DESCRIPTION
  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-connectors/blob/v1.0.1/src/commands/data/connectors/info.ts)_

## `heroku data:connectors:pause [CONNECTOR]`

Pause change event creation on a Data Connector

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

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

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

_See code: [src/commands/data/connectors/pause.ts](https://github.com/heroku/heroku-cli-plugin-data-connectors/blob/v1.0.1/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]

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

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

_See code: [src/commands/data/connectors/resume.ts](https://github.com/heroku/heroku-cli-plugin-data-connectors/blob/v1.0.1/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]

OPTIONS
  --add-table=add-table                            Tables to add
  --exclude-column=exclude-column                  Columns to exclude
  --remove-excluded-column=remove-excluded-column  Columns to no longer exclude
  --remove-table=remove-table                      Tables to remove
  --setting=setting

DESCRIPTION
  Read more about this feature at https://devcenter.heroku.com/articles/heroku-data-connectors#update-configuration

EXAMPLE
  $ 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-connectors/blob/v1.0.1/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]

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

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

_See code: [src/commands/data/connectors/wait.ts](https://github.com/heroku/heroku-cli-plugin-data-connectors/blob/v1.0.1/src/commands/data/connectors/wait.ts)_
<!-- commandsstop -->