https://github.com/heroku/heroku-connect-plugin
CLI plugin for Heroku Connect (experimental)
https://github.com/heroku/heroku-connect-plugin
heroku heroku-cli-plugin heroku-connect
Last synced: 7 months ago
JSON representation
CLI plugin for Heroku Connect (experimental)
- Host: GitHub
- URL: https://github.com/heroku/heroku-connect-plugin
- Owner: heroku
- License: apache-2.0
- Created: 2015-04-28T17:40:42.000Z (over 10 years ago)
- Default Branch: main
- Last Pushed: 2025-04-21T11:54:41.000Z (9 months ago)
- Last Synced: 2025-06-10T04:07:53.620Z (7 months ago)
- Topics: heroku, heroku-cli-plugin, heroku-connect
- Language: JavaScript
- Homepage:
- Size: 591 KB
- Stars: 23
- Watchers: 93
- Forks: 9
- Open Issues: 14
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
- Codeowners: CODEOWNERS
- Security: SECURITY.md
Awesome Lists containing this project
README
# Heroku Connect CLI Plugin
## Install
```shell
$ heroku plugins:install @heroku-cli/heroku-connect-plugin
Installing plugin @heroku-cli/heroku-connect-plugin... installed
```
## Help
```shell
$ heroku help connect
```
## Commands
```text
heroku connect:db:set - Set database parameters
heroku connect:diagnose - Display diagnostic information about a connection
heroku connect:export - Export a mapping configuration JSON file
heroku connect:import FILE - Import a mapping configuration JSON file
heroku connect:info - Display connection information
heroku connect:mapping:state MAPPING - Return the state of a mapping
heroku connect:mapping:delete MAPPING - Delete an existing mapping
heroku connect:mapping:reload MAPPING - Reload a mapping's data from Salesforce
heroku connect:pause - Pause a connection
heroku connect:resume - Resume a connection
heroku connect:restart - Restart a connection
heroku connect:sf:auth - Authenticate a connection to Salesforce
heroku connect:state - Return the state flag for a single connection
```
## Examples
Download an existing mapping configuration
```shell
$ heroku connect:export
Saved config-file: app-name-resource-name.json
```
## Tutorial
Make sure you have a Heroku app, with a Postgres database attached
### Add the Heroku Connect add-on to your app
```shell
$ heroku addons:create herokuconnect
```
### Link the new connection (the Heroku Connect add-on instance) to your Heroku user
```shell
$ heroku connect:info
```
### Now link the connection to the database, specifying the config var and schema name
```shell
$ heroku connect:db:set --db=DATABASE_URL --schema=salesforce
settings database parameters... done
db_key: DATABASE_URL
schema_name: salesforce
```
If either option is not supplied, this command will ask for a value.
### Authorize the connection to access your Salesforce organization
```shell
$ heroku connect:sf:auth
Launching Salesforce for authorization. If your browser doesn't open, please copy the following URL to proceed:
https://login.salesforce.com/services/oauth2/authorize?…
This will launch your browser for an interactive authorization session.
```
### Verify that connection is now in 'IDLE' state
```shell
$ heroku connect:state
IDLE
```
### Now restore the exported configuration
This could be exported using the `connect:export` command or directly through the Heroku Connect dashboard. By editing this configuration file, you can add and edit existing mappings easily.
```shell
$ heroku connect:import app-name-resource-name.json
Upload complete
```
If you need to delete a mapping after the configuration has been imported, you can use a separate command for that:
```shell
$ heroku connect:mapping:delete Contact
```
### Connect to your database to see the data
```shell
$ heroku pg:psql
> select * from salesforce.contact;
```
## Contributing
Read the following:
- [Developing CLI Plugins](https://devcenter.heroku.com/articles/developing-cli-plugins)
- [Testing CLI Plugins](https://devcenter.heroku.com/articles/testing-cli-plugins)
- [CLI Style Guide](https://devcenter.heroku.com/articles/cli-style-guide)