Connection

Description

Configuration

NAME	TYPE	DESCRIPTION	REQUIRED	READONLY
hostname	string		true	false
username	string		true	false
password	string		true	false
database	string		true	false
port	integer		true	false
ssh	boolean		false	false
ssh_user	string		false	false
ssh_host	string		false	false
ssh_port	integer		false	false
ssh_private_key	string		false	false
aws_access_key_id	string	Access Key ID with read/write access to a bucket. More info: https://docs.polytomic.com/docs/redshift	false	false
aws_secret_access_key	string		false	false
aws_user	string		false	true
s3_bucket_name	string	Name of bucket used for staging data load files	false	false
s3_bucket_region	string	Region of bucket. Note: must match region of redshift server	false	false

Example

1 {
2   "name": "redshift connection",
3   "type": "redshift",
4   "configuration": {
5     "aws_access_key_id": "AKIAIOSFODNN7EXAMPLE",
6     "aws_secret_access_key": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY",
7     "database": "mydb",
8     "hostname": "mycluster.us-west-2.redshift.amazonaws.com",
9     "password": "password",
10     "port": 5439,
11     "s3_bucket_name": "my-bucket",
12     "s3_bucket_region": "us-west-2",
13     "ssh": false,
14     "ssh_host": "",
15     "ssh_port": 22,
16     "ssh_private_key": "",
17     "ssh_user": "",
18     "username": "redshift_user"
19   }
20 }

Model Sync

Source

Configuration

NAME	TYPE	REQUIRED	READONLY
query	string	false	false
schema	string	false	false
table	string	false	false
view	string	false	false

Example

1 {
2   ...
3   "configuration": {
4     "query": "SELECT * FROM sampledata.users",
5     "schema": "sampledata",
6     "table": "users",
7     "view": "active_users"
8   }
9 }

Target

Configuration

NAME	TYPE	DESCRIPTION	REQUIRED	READONLY
preserve_table_on_resync	boolean	Preserve destination table when resyncing	false	false

Example

1 {
2   ...
3   "target": {
4       "configuration": {
5         "preserve_table_on_resync": false
6     }
7   }
8 }

Bulk Sync

Source

N/A

Destination

Configuration

NAME	TYPE	REQUIRED	READONLY
advanced	object	false	false
mirror_schemas	boolean	false	false
schema	string	false	false

Example

1 {
2   ...
3   "destination_configuration": {
4     "advanced": {
5         "table_prefix": "",
6         "truncate_existing": false
7     },
8     "mirror_schemas": false,
9     "schema": "schema"
10   }
11 }

Getting started

Configuring your connections

Code examples

Redshift

Connection

Description

Configuration

Example

Model Sync

Source

Configuration

Example

Target

Configuration

Example

Bulk Sync

Source

Destination

Configuration

Example

1	{
2	"name": "redshift connection",
3	"type": "redshift",
4	"configuration": {
5	"aws_access_key_id": "AKIAIOSFODNN7EXAMPLE",
6	"aws_secret_access_key": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY",
7	"database": "mydb",
8	"hostname": "mycluster.us-west-2.redshift.amazonaws.com",
9	"password": "password",
10	"port": 5439,
11	"s3_bucket_name": "my-bucket",
12	"s3_bucket_region": "us-west-2",
13	"ssh": false,
14	"ssh_host": "",
15	"ssh_port": 22,
16	"ssh_private_key": "",
17	"ssh_user": "",
18	"username": "redshift_user"
19	}
20	}

1	{
2	...
3	"configuration": {
4	"query": "SELECT * FROM sampledata.users",
5	"schema": "sampledata",
6	"table": "users",
7	"view": "active_users"
8	}
9	}

1	{
2	...
3	"target": {
4	"configuration": {
5	"preserve_table_on_resync": false
6	}
7	}
8	}

1	{
2	...
3	"destination_configuration": {
4	"advanced": {
5	"table_prefix": "",
6	"truncate_existing": false
7	},
8	"mirror_schemas": false,
9	"schema": "schema"
10	}
11	}