Skip to content

Commit

Permalink
Fix installation instructions, update structure of markdown
Browse files Browse the repository at this point in the history
  • Loading branch information
eablack committed Aug 19, 2024
1 parent ea62f99 commit ef00818
Showing 1 changed file with 71 additions and 48 deletions.
119 changes: 71 additions & 48 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,88 +1,111 @@
Heroku Connect CLI Plugin
==================
# Heroku Connect CLI Plugin

# Install
## Install

$ heroku plugins:install heroku-connect-plugin
```shell
$ heroku plugins:install @heroku-cli/heroku-connect-plugin
Installing plugin @heroku-cli/heroku-connect-plugin... installed
```

## Help

# Help
```shell
$ heroku help connect
```

heroku help connect
## Commands

# 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
```

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
## Examples

Download an existing mapping configuration

$ heroku connect:export
Saved config-file: app-name-resource-name.json
```shell
$ heroku connect:export
Saved config-file: app-name-resource-name.json
```

# Tutorial
## Tutorial

Make sure you have a Heroku app, with a Postgres database attached

## Add the Heroku Connect add-on to your app
### Add the Heroku Connect add-on to your app

$ heroku addons:create herokuconnect
```shell
$ heroku addons:create herokuconnect
```

## Link the new connection (the Heroku Connect add-on instance) to your Heroku user
### Link the new connection (the Heroku Connect add-on instance) to your Heroku user

$ heroku connect:info
```shell
$ heroku connect:info
```

## Now link the connection to the database, specifying the config var and schema name
### Now link the connection to the database, specifying the config var and schema name

$ heroku connect:db:set --db=DATABASE_URL --schema=salesforce
settings database parameters... done
db_key: DATABASE_URL
schema_name: salesforce
```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
### Authorize the connection to access your Salesforce organization

$ heroku connect:sf:auth
Launching Salesforce for authorization. If your browser doesn't open, please copy the following URL to proceed:
```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?…
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
### Verify that connection is now in 'IDLE' state
$ heroku connect:state
IDLE
```shell
$ heroku connect:state
IDLE
```
## Now restore the exported configuration
### 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.
$ heroku connect:import app-name-resource-name.json
Upload complete
```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:
$ heroku connect:mapping:delete Contact
```shell
$ heroku connect:mapping:delete Contact
```
## Connect to your database to see the data
### Connect to your database to see the data
$ heroku pg:psql
> select * from salesforce.contact;
```shell
$ heroku pg:psql
> select * from salesforce.contact;
```
## Contributing
Expand Down

0 comments on commit ef00818

Please sign in to comment.