Connect to Greenplum
Follow these steps to connect to a Greenplum database and create a Greenplum data source:
Refer to Additional Information for additional performance tips and information about Greenplum feature support.
Configure User Access Rights
We recommend that you create a dedicated user and user role for integration with the GoodData platform.
Steps:
Create a user role and grant the following access rights to it:
GRANT CONNECT ON DATABASE {database_name} TO ROLE {role_name}; GRANT USAGE ON SCHEMA {schema_name} TO ROLE {role_name}; GRANT SELECT ON ALL TABLES IN SCHEMA {schema_name} TO ROLE {role_name};
If you intend to enable pre-aggregation caching, additional usage rights have to be granted for your pre-aggregation schema
cache_schema_name
:GRANT USAGE, CREATE ON SCHEMA {cache_schema_name} TO ROLE {role_name};
Create a user and grant it with the user role:
GRANT ROLE {role_name} TO USER {user_name};
Make the user role default for the user:
ALTER USER {user_name} SET DEFAULT_ROLE={role_name};
Create a Greenplum Data Source
Once you have configured your Greenplum user, you can proceed to create a Greenplum data source that you can then connect to.
Steps:
Open your workspace, switch to the tab Data and click the Create model button.
On the left panel in section Data Sources, click the + icon.
The Connect data dialog opens.
Select Greenplum.
The following dialog opens:
Fill in your Greenplum credentials and click Connect.
You have created a Greenplum data source.
Steps:
Create a Greenplum data source with the following API call:
curl $HOST_URL/api/v1/entities/dataSources \ -H "Content-Type: application/vnd.gooddata.api+json" \ -H "Accept: application/vnd.gooddata.api+json" \ -H "Authorization: Bearer $API_TOKEN" \ -X POST \ -d '{ "data": { "type": "dataSource", "id": "<unique_id_for_the_data_source>", "attributes": { "name": "<data_source_display_name>", "url": "jdbc:postgresql://<host>:5432/<database_name>", "schema": "<schema_name>", "type": "GREENPLUM", "username": "<username>", "password": "<password>" } } }' | jq .
To confirm that the data source has been created, ensure the server returns the following response:
{ "data": { "type": "dataSource", "id": "<unique_id_for_the_data_source>", "attributes": { "name": "<data_source_display_name>", "url": "jdbc:postgresql://<host>:5432/<database_name>", "schema": "<schema_name>", "type": "GREENPLUM", "username": "<username>" } }, "links": { "self": "$HOST_URL/api/v1/entities/dataSources/<unique_id_for_the_data_source>" } }
Additional Information
Performance Tips
If your database holds a large amount of data, consider optimizing it before connecting the database to GoodData. For tips on how to optimize Greenplum performance, see Optimizing Greenplum Performance article on their website.
Query Timeout
Query timeout is configurable per application instance. It is a parameter of the sql-executor service, default value is 160 seconds.
Query timeout is closely related to the ACK timeout. Proper configuration of the system requires that ACK timeout is longer than query timeout. Default ACK timeout value is 170 seconds.
Note
When a query fails on query timeout, the REST API call returns error code 500. Please note that this is subject to change in a future release.
Supported URL Parameters
- adaptiveFetch
- adaptiveFetchMaximum
- adaptiveFetchMinimum
- allowEncodingChanges
- ApplicationName
- assumeMinServerVersion
- autosave
- binaryTransferDisable
- binaryTransferEnable
- cleanupSavepoints
- connectTimeout
- currentSchema
- defaultRowFetchSize
- disableColumnSanitiser
- escapeSyntaxCallMode
- gssEncMode
- hostRecheckSeconds
- loadBalanceHosts
- loginTimeout
- logUnclosedConnections
- options
- preferQueryMode
- preparedStatementCacheQueries
- preparedStatementCacheSizeMiB
- readOnly
- reWriteBatchedInserts
- socketFactory
- socketTimeout
- ssl
- sslcert
- sslfactory
- sslmode
- sslpassword
- sslpasswordcallback
- targetServerType
- tcpKeepAlive