Skip to content

Redshift

Setup instructions

Your Redshift cluster must be accessible over the internet.

Learn how to make your cluster accessible in the Redshift documentation.

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 )
Serverless Requirements

If you're running CS Tools    serverless, you'll want to ensure you install these    python requirements.

🧙 Don't know what this means? It's probably safe to ignore it.

How do I use the Syncer in commands?

CS Tools accepts syncer definitions in either declarative or configuration file form.

Find the copy button to the right of the code block.

Simply write the parameters out alongside the command.

cs_tools tools searchable metadata --syncer "redshift://host=mycluster.abc123xyz789.us-west-2.redshift.amazonaws.com&port=5439&database=thoughtspot&username=tsadmin&secret=[redacted]" --config dogfood

* when declaring multiple parameters inline, you should wrap the enter value in quotes.

  1. Create a file with the .toml extension.

    syncer-overwrite.toml 

    [configuration]
host = "mycluster.abc123xyz789.us-west-2.redshift.amazonaws.com"
port = 5439
database = "thoughtspot"
username = "tsadmin"
secret = "[redacted]"
load_strategy = "TRUNCATE"
    * this is a complete example, not all parameters are required.

  2. Write the filename in your command in place of the parameters.

    cs_tools tools searchable metadata --syncer redshift://syncer-overwrite.toml --config dogfood