Using the Amazon Redshift
connection type, you can connect an Amazon Redshift database.
Click Data Source
button in the configuration panel to add a new data connection.
Click CREATE NEW
to launch a new connection from the connection type panel.
Click Amazon Redshift
connection button in the connection type panel.
Set the server Name
and port number
where the Amazon Redshift service is running.
Enter the user name
and password
to connect to the Amazon Redshift.
There are two connection types available in a data source:
In this connection type, a data source is directly fetched from source. Choose the Live
mode option for this connection.
NOTE: To connect data source with SSH, enable the SSH check box in the NEW DATA SOURCE configuration panel and enter the required credentials.
The selected database will be opened in the data design view window.
Drag and drop the table from table list, and click Save
button to save the data source with valid name.
In this connection type, a data source is fetched from source periodically. Choose the Extract
mode option for this connection.
NOTE: Initially, data will be extracted based on the Max Rows selected in order to proceed with data model creation. The remaining records (there is no limit) will be extracted during the next refresh.
Select the recurrence type, recurrence start, and end dates in the Refresh Setting dialog box.
Schedule
.Click Connect
to redshift server with configured details.
The Extract Data dialog opens. This dialog has two modes of connection either via Table or Custom query.
Click Save
to save the data source with a relevant name.
NOTE: In future, you can edit the connection information for both live and extract mode connections using the Edit Connection option.
Type while creating the data source needs to be redshift.
Through the REST API, only the live mode data source can be created and edited.
Parameters | Details |
---|---|
Servername required | `string` Server name or Host name of the connection |
Port required | `string` Port number used to connect to the redshift instance. |
Username required | `string` A valid user name for the connection |
Password required | `string` A valid Password for the connection |
Database required | `string` database which needs to be connected |
Schemaname required for table mode | `string` Enter a valid Schemaname |
Tablename required for table mode | `string` Enter a valid Tablename |
Query required for code view mode | `string` Enter a valid Query |
AdvancedSettings optional | `string` Additional optional connection parameters can be provided. By default, it is empty. |
CommandTimeout optional | `string` Enter a valid Timeout for connection. By default, it is 300 |
IsSshConnection optional | `boolean` Enable or disable SSH. By default, it is false. |
SshServerName optional | `string` Enter a valid Ssh Server name. By default, it is empty. |
SshPort optional | `integer` Enter a valid Ssh Port number. |
SshUserName optional | `string` Enter a valid Ssh User name. By default, it is empty. |
SshPassword optional | `string` Enter a valid Ssh Password. By default, it is empty. |
Expressions optional | `Array of Objects` |
Parameters | Details |
---|---|
Name required | `string` Name of the Expression |
Expression required | `string`
Expression
|
NOTE: For editing Data Source via API. All the parameters are optional. The parameter which needs to be changed can be provided.
Parameters | Details |
---|---|
Name required | `string` Name of the Expression |
Expression required | `string`
Expression
|
Action optional | `string` add/delete/edit By default, it is add. |
NewName optional | `string` For renaming the expression. This is applicable only if the Action is edit |
"Connection": [
{
"Servername": "string",
"Port": "string",
"Username": "string",
"Password": "string",
"Database": "string",
"Schemaname": "string",
"Tablename": "string",
"AdvancedSettings": "string",
"CommandTimeout": "string",
"IsSshConnection": "false",
"SshServerName": "string",
"SshPort": 0,
"SshUsername": "string",
"SshPassword": "string",
"Expressions" : [{
"Name": "Expression1",
"Expression" : "SUM(numeric expression)"
},
{
"Name": "Expression2",
"Expression" : "UPPER(string expression)"
}]
}
]
"Connection": [
{
"Servername": "string",
"Port": "string",
"Username": "string",
"Password": "string",
"Database": "string",
"Schemaname": "string",
"Tablename": "string",
"AdvancedSettings": "string",
"CommandTimeout": "string",
"IsSshConnection": "false",
"SshServerName": "string",
"SshPort": 0,
"SshUsername": "string",
"SshPassword": "string",
"Expressions" : [{
"Name": "Expression1",
"Expression" : "SUM(numeric expression)",
"NewName" : "Sum",
"Action": "edit"
},
{
"Name": "Expression2",
"Expression" : "UPPER(string expression)"
"Action": "delete"
}]
}
]
NOTE: Through Rest API, the data source can be created or edited with only one table. If different table is provided in edit data source, the table will be replaced. The widgets will be retained only if the schema is same as the previous table.
"Connection": [
{
"Servername": "string",
"Port": "string",
"Username": "string",
"Password": "string",
"Database": "string",
"Query": "string",
"AdvancedSettings": "string",
"CommandTimeout": "string",
"IsSshConnection": "false",
"SshServerName": "string",
"SshPort": 0,
"SshUsername": "string",
"SshPassword": "string",
"Expressions" : [{
"Name": "Expression1",
"Expression" : "SUM(numeric expression)"
},
{
"Name": "Expression2",
"Expression" : "UPPER(string expression)"
}]
}
]