To define a new connection from the Connection parameter in a Carto Database format:
- Select Add Database Connection. See database-specific parameters below, as well as the section Adding a Database Connection in a Workspace in Using Database Connections The new connection can be made visible only to the current user, or can be shared among multiple users.
Note: To select an existing, previously defined connection, see the section Reusing a Database Connection in Using Database Connections
Database Connection
CartoDB
Name
Enter a name for the new connection.
Connection Parameters
CARTO Account
This parameter must contain the name of the source CARTO account. The account name is the same as the username that is used to log into the account on the CARTO website.
Note: For CARTO Multiuser Enterprise accounts, note that this is not the same as the organization name.
API Key
CARTO accounts are protected by API keys, which can be found in Your API keys in the CARTO web interface.
Note: In FME, it is currently only possible to create a Carto database connection using the Master Key.
- If the API key is left blank (default), FME can read public tables associated with the CARTO account.
- If the API key is specified, FME can read both public and private tables associated with the CARTO account.
Multiuser Account
When using CARTO Multiuser Enterprise, multiple users can be associated with one account.
If you are Multiuser Account user, enter your username here. FME will access the associated CARTO Multiuser Account.
Local CARTO Server
When using a local CARTO server, the base URL for connecting to the database can be changed using the API URL value.
If you are not running your own instance of CARTO, leave this parameter blank. If the API URL is left blank, then FME will use the default API URL to access your CARTO account.
CARTO has a SQL API, which allows FME to read and write data to CARTO tables. This API is usually located at https://[account_name].carto.com/api/v2/sql.
- If you are running your own instance of the open source CARTO software, this API location may be different.
- If the API URL is specified, then FME will use a URL in the form of:
https://[account_name].[API_URL_value]