tabsdata.SalesforceSource#

class SalesforceSource(
credentials: SalesforceCredentials,
query: str | list[str],
instance_url: str = None,
include_deleted: bool = False,
initial_last_modified: str = None,
**kwargs,
)#

Bases: SourcePlugin

__init__(
credentials: SalesforceCredentials,
query: str | list[str],
instance_url: str = None,
include_deleted: bool = False,
initial_last_modified: str = None,
**kwargs,
)#
Initializes the SalesforceSource with the given query(s) and the credentials

required to access Salesforce.

Parameters:

  • credentials (SalesforceCredentials) – The credentials to access Salesforce.

  • query (str | list[str]) – The query or queries to execute in Salesforce. It can be a single string or a list of strings.

  • instance_url (str, optional) – The URL of the instance to which we want to connect. Only necessary when the username and password are associated to more than one instance. Defaults to None.

  • include_deleted (bool, optional) – Whether to include deleted records in the query results. Defaults to False.

  • initial_last_modified (str, optional) – The initial last modified date to use in the queries. This is useful when we want to query only the records that have been modified since a certain date. Defaults to None. If provided, it must be a string in Salesforce datetime format (with informed timezone) and the query must contain the token $lastModified, which will be replaced by the latest ‘last_modified’ value in each execution.

Methods

__init__(credentials, query[, instance_url, ...])

Initializes the SalesforceSource with the given query(s) and the credentials

chunk(working_dir)

Trigger the import of the data. This must be implemented in any class that

stream(working_dir)

Attributes

LAST_MODIFIED_COLUMN

LAST_MODIFIED_TOKEN

credentials

initial_values

Return a dictionary with the initial values to be stored after execution of the plugin.

query