RedshiftSource

RedshiftSources hold the connection information to Amazon Redshift data sources.

Example

Basic Username/PasswordIAM Authentication

    sources:
      - name: redshift_source
        type: redshift
        database: dev
        host: my-cluster.abcdefghij.us-east-1.redshift.amazonaws.com
        port: 5439
        username: {{ env_var('REDSHIFT_USER') }}
        password: {{ env_var('REDSHIFT_PASSWORD') }}
        db_schema: public

    sources:
      - name: redshift_source
        type: redshift
        database: dev
        host: my-cluster.abcdefghij.us-east-1.redshift.amazonaws.com
        port: 5439
        username: {{ env_var('REDSHIFT_USER') }}
        cluster_identifier: my-cluster
        region: us-east-1
        iam: true
        db_schema: public

Note

Recommended environment variable use is covered in the sources overview.

Attributes

Field	Type	Default	Description
path	string	None	A unique path to this object
name	string	None	The unique name of the object across the entire project.
file_path	string	None	The path to the file that contains the object definition.
host	string	None	The host url of the database.
port	integer	None	The port of the database.
database	string	None	The database that the Visivo project will use in queries.
username	string	None	Username for the database.
password	string	None	Password corresponding to the username.
db_schema	string	None	The schema that the Visivo project will use in queries.
type	string	None
cluster_identifier	string	None	The cluster identifier for IAM authentication.
region	string	None	The AWS region where your Redshift cluster is located.
iam	boolean	False	Use IAM authentication instead of username/password.
ssl	boolean	True	Use SSL connection to Redshift.
connection_pool_size	integer	1	The pool size that is used for this connection.