Skip to content

Commit

Permalink
main: linking readme to the docs
Browse files Browse the repository at this point in the history
  • Loading branch information
balinthaller committed Mar 27, 2021
1 parent 4828b8a commit 45352f2
Showing 1 changed file with 1 addition and 24 deletions.
25 changes: 1 addition & 24 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,27 +24,4 @@ pip install carte-cli[postgres]

## Usage

### AWS Glue
Carte uses the Boto3 library to fetch the Glue catalog. This means you need an AWS CLI profile defined that can access the required databases and tables.

### PostgreSQL
For PostgreSQL, you need to construct a connection string with your username, password, the DB's host, and the database you'd like to extract on the host.

Carte CLI works from a YAML config that you have to specify when running an extraction. An example config with both Glue and Postgres:

``` yaml
connections:
- type: glue
name: aws_glue
- type: postgresql
config:
connection_string: 'postgresql://<user>:<password>@<host>:<port>/<database>'
```
If you name this config `extract.config.yml`, then you can run an extraction with:

``` sh
carte extract extract.config.yml -o data/datasets
```

where the `-o` flag specifies the output folder.
See [the docs](https://docs.cartedata.com)

0 comments on commit 45352f2

Please sign in to comment.