Skip to content

Redshift

Redshift is a powerful data warehousing service provided by Amazon Web Services (AWS). It's designed to help businesses quickly analyze large amounts of data.

Redshift's combination of high performance, scalability, cost-effectiveness, ease of use, and advanced analytics capabilities make it a highly useful data warehousing solution for businesses of all sizes, especially those dealing with large and growing datasets.

Setup instructions

If you face issues with connectivity to your Redshift cluster, make sure you can first access the cluster from your local machine.

You can learn how to make your cluster accessible in the Redshift documentation.

Redshift parameters

Required parameters are in red and Optional parameters are in blue.


  • host, the URL of your Redshift database

  • port, the port number where your Redshift database is located
    default: 5439

  • database, the database to write new data to
    if tables do not exist in the database location already, we'll auto-create them

  • username, your Redshift username

  • secret, the secret value to pass to the authentication mechanism
    this will be your password

  • load_strategy, how to write new data into existing tables
    default: APPEND ( allowed: APPEND, TRUNCATE, UPSERT )
How do I use the Redshift syncer in commands?

cs_tools tools searchable bi-server --syncer redshift://host=0.0.0.0&database=...&username=admin&password=...&load_strategy=upsert

- or -

cs_tools tools searchable bi-server --syncer redshift://definition.toml

Definition TOML Example

definition.toml

[configuration]
host = "mycluster.us0I3nrnge4i.us-west-2.redshift.amazonaws.com"
database = "..."
username = "admin"
secret = "..."
load_strategy = "upsert"