Skip to main content

Airbyte Salesforce

Airbyte是一个用于从API、数据库和文件到数据仓库和数据湖的ELT管道的数据集成平台。它拥有最大的ELT连接器目录，可连接到数据仓库和数据库。

此加载器将Salesforce连接器公开为文档加载器，允许您将各种Salesforce对象加载为文档。

安装 (Installation)​

首先，您需要安装airbyte-source-salesforce Python包。

#!pip install airbyte-source-salesforce

示例 (Example)​

请查看Airbyte文档页面以获取有关如何配置读取器的详细信息。 配置对象应遵循的JSON模式可以在Github上找到：https://github.com/airbytehq/airbyte/blob/master/airbyte-integrations/connectors/source-salesforce/source_salesforce/spec.yaml。

一般的形状如下所示：

{
  "client_id": "<oauth客户端ID>",
  "client_secret": "<oauth客户端密钥>",
  "refresh_token": "<oauth刷新令牌>",
  "start_date": "<从ISO格式的日期开始检索记录的日期，例如2020-10-20T00:00:00Z>",
  "is_sandbox": False, # 如果您使用沙盒环境，请设置为True
  "streams_criteria": [ # 可以加载的salesforce对象的过滤器数组
    {"criteria": "exacts", "value": "Account"}, # salesforce对象的确切名称
    {"criteria": "starts with", "value": "Asset"}, # 名称的前缀
    # 其他允许的条件：ends with, contains, starts not with, ends not with, not contains, not exacts
  ],
}

默认情况下，所有字段都存储为文档中的元数据，并且文本设置为空字符串。通过转换读取器返回的文档来构建文档的文本。

from langchain.document_loaders.airbyte import AirbyteSalesforceLoader

config = {
    # 您的Salesforce配置
}

loader = AirbyteSalesforceLoader(config=config, stream_name="asset") # 请查看上面链接的文档以获取所有流的列表

现在，您可以按照通常的方式加载文档。

docs = loader.load()

由于load返回一个列表，它将阻塞直到所有文档加载完成。为了更好地控制此过程，您还可以使用lazy_load方法，它返回一个迭代器：

docs_iterator = loader.lazy_load()

请记住，默认情况下，页面内容为空，元数据对象包含记录的所有信息。要在不同的方式创建文档，请在创建加载器时传入record_handler函数：

from langchain.docstore.document import Document

def handle_record(record, id):
    return Document(page_content=record.data["title"], metadata=record.data)

loader = AirbyteSalesforceLoader(config=config, record_handler=handle_record, stream_name="asset")
docs = loader.load()

增量加载 (Incremental loads)​

某些流允许增量加载，这意味着源会跟踪已同步的记录，并且不会再次加载它们。这对于具有大量数据并且经常更新的源非常有用。

要利用此功能，请存储加载器的last_state属性，并在再次创建加载器时传入它。这将确保仅加载新记录。

last_state = loader.last_state # 安全存储

incremental_loader = AirbyteSalesforceLoader(config=config, stream_name="asset", state=last_state)

new_docs = incremental_loader.load()