DataExtension

Represents a data extension within a Salesforce Marketing Cloud account. A data extension is a custom table that stores subscriber or relational data used for segmentation, personalization, or automation. This table allows you to query, create, and manage data structures that support targeted communications.

Table-Specific Information

Select

The connector uses the Salesforce Marketing Cloud APIs to process the following WHERE clause operators for all but date-time values: =, !=, <>, >, >=, <, <=, IN. For date-time values, only > and < are supported. The connector processes other filters client-side within the connector.

For example, the following (but not only) queries are processed server side:

SELECT * FROM DataExtension WHERE CreatedDate > '2017/01/25'

Insert

You must specify the following fields when inserting to this table: Name, CustomerKey, and Fields.

Note: The Salesforce Marketing Cloud APIs have problems with DataExtensions with names longer than 40 characters. Try to limit the name to something relatively short.

INSERT INTO DataExtension (Name, CustomerKey, Fields) VALUES ('TestName', 'TestCustomerKey', 'fieldname1;fieldname2;fieldname3')

Update

You must specify the ObjectId or CustomerKey or Name in the WHERE clause when executing an update against this table.

UPDATE DataExtension SET ResetRetentionPeriodOnImport = true WHERE ObjectId = 'nzxcaslkjd-123'

Delete

You must specify the ObjectId or CustomerKey or Name in the WHERE clause when executing a delete against this table.

DELETE FROM DataExtension WHERE ObjectId = 'nzxcaslkjd-123'

Columns


Name	Type	ReadOnly	Description
ObjectID [KEY]	String	False	Specifies the system-controlled identifier (Id) that uniquely identifies the data extension object. This value is assigned internally and cannot be modified by users.
PartnerKey	String	False	Specifies the unique partner-provided key that is associated with the data extension. This value is available only through API interactions.
CustomerKey	String	False	Specifies the user-supplied unique Id for the data extension within its object type. This value is often used in programmatic operations and configuration workflows.
Name	String	False	Specifies the name of the data extension. The value is visible in the user interface and is used to identify the resource in Salesforce Marketing Cloud applications.
CreatedDate	Datetime	False	Indicates the date and time when the data extension was created. This value is system-controlled.
ModifiedDate	Datetime	False	Indicates the date and time when the system last modified the data extension. This information assists with auditing and lifecycle tracking.
Client_ID	Int	False	Specifies the Id of the client associated with the data extension.
Description	String	False	Provides descriptive information about the purpose and usage of the data extension. This text helps administrators and developers understand the intended function of the stored data.
IsSendable	Bool	False	Returns a value of 'true' when the data extension can be used as a sendable audience in message sends. It returns a value of 'false' when the data extension is not eligible for send operations.
IsTestable	Bool	False	Returns a value of 'true' when the data extension can be used in test sends. It returns a value of 'false' when the data extension cannot participate in test send processes.
SendableDataExtensionField_Name	String	False	Specifies the name of the sendable field within the data extension. This field must correspond to a value that can be mapped to a subscriber identifier.
SendableSubscriberField_Name	String	False	Specifies the name of the subscriber field to which the sendable data-extension field is mapped. This mapping establishes the subscriber context used during email sends.
Template_CustomerKey	String	False	Specifies the user-supplied unique Id of the data extension template, if one is used. This value identifies the template structure from which the data extension was created.
CategoryID	Long	False	Specifies the Id of the folder that stores the data extension in the folder hierarchy.
Status	String	False	Indicates the status of the data extension. This value represents conditions such as active, inactive, or deleted.
IsPlatformObject	Bool	False	Returns a value of 'true' when the data extension is classified as a platform object. It returns a value of 'false' when the data extension does not qualify as a platform-level resource.
DataRetentionPeriodLength	Int	False	Specifies the number of time units that determine how long the data extension retains stored records before removal.
DataRetentionPeriodUnitOfMeasure	Int	False	Specifies the unit of time (for example, days or months) that is associated with the data retention period.
RowBasedRetention	Bool	False	Returns a value of 'true' when the data retention policy removes records based on individual rows. It returns a value of 'false' when the system deletes the entire data extension at the end of the retention cycle.
ResetRetentionPeriodOnImport	Bool	False	Returns a value of 'true' when a successful import causes the retention period to restart. It returns a value of 'false' when the retention period continues without being reset after imports.
DeleteAtEndOfRetentionPeriod	Bool	False	Returns a value of 'true' when the data extension is deleted at the end of its retention period. It returns a value of 'false' when the data extension remains available after the retention period ends.
RetainUntil	String	False	Specifies the date that marks the end of the retention period for the data extension. This value is system-calculated based on the configured retention policy.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
Fields	String	Specifies a semicolon-separated list of field names that should be added to the data extension. This value is a pseudocolumn used for defining field creation operations.

CData Python Connector for Salesforce Marketing Cloud