Writer Directives

The directives that are processed by the CartoDB writer are listed below. The suffixes shown are prefixed by the current <WriterKeyword>_ in a mapping file. By default, the <WriterKeyword> for the CartoDB writer is CARTODB.

DATASET

Required/Optional

Required

Workbench Parameter

Destination CartoDB Account

DEF

Required/Optional

Required

Each CartoDB table must be defined before it can be written. The general form of a CartoDB definition statement is:

CARTODB_DEF <tableName>	                                         \
	cartodb_type <wkb_type>                                    \
	[fme_table_handling (CREATE_IF_MISSING | DROP_AND_CREATE)] \
	[<fieldName> <fieldType>] +

When the destination table does not exist, the table definition specifies the table that will be created. When the destination table exists and is not being dropped, the fields and types listed should match those of the existing table.

Fields in the table definition that do not match any existing columns will be ignored by the writer. Where <fieldType> is specified, it should be a field type supported by the target database.

The configuration parameters present on the definition line are described in the following table:

Parameter	Contents
tableName	The name of the table to be written. If a table with the specified name exists, it will be overwritten if the fme_table_handling DEF line parameter is set to DROP_AND_CREATE. Otherwise the table will be appended. Valid values for table names include any character string devoid of SQL-offensive characters and less than 255 characters in length. Additionally, table names must not contain "." characters.
fme_table_handling	The action to be taken when with existing tables. May of be one of: DROP_AND_CREATE CREATE_IF_MISSING
fieldName	The name of the field to be written. Valid values for field name include any character string devoid of SQL-offensive characters and less than 255 characters in length.
fieldType	The type of a column in a table. The valid values for the field type are listed in the CartoDB Feature Representation section.

API_KEY

Required/Optional

Required

Workbench Parameter

API Key

MULTIUSER_ACCOUNT

Required/Optional

Required

Mapping File Syntax

CARTODB_MULTIUSER_ACCOUNT [YES | NO]

Workbench Parameter

Multiuser Account

USERNAME_ENCODED

Required/Optional

Optional

Mapping File Syntax

CARTODB_USERNAME_ENCODED <fme-encoded username>

Workbench Parameter

Username

API_URL

Required/Optional

Optional

Workbench Parameter

API URL

TRANSACTION_SIZE

Required/Optional

Optional