Airbyte Shopify
Airbyte是一个用于从API、数据库和文件到数据仓库和数据湖的ELT管道的数据集成平台。它拥有最大的ELT连接器目录,可连接到数据仓库和数据库。
此加载器将Shopify连接器公开为文档加载器,允许您将各种Shopify对象加载为文档。
安装 (Installation)
首先,您需要安装airbyte-source-shopify
Python包。
#!pip install airbyte-source-shopify
示例 (Example)
请查看Airbyte文档页面以获取有关如何配置读取器的详细信息。配置对象应遵循的JSON模式可以在Github上找到:https://github.com/airbytehq/airbyte/blob/master/airbyte-integrations/connectors/source-shopify/source_shopify/spec.json。
一般的形状如下所示:
{
"start_date": "<从ISO格式开始检索记录的日期,例如2020-10-20T00:00:00Z>",
"shop": "<要从中检索文档的商店名称>",
"credentials": {
"auth_method": "api_password",
"api_password": "<您的API密码>"
}
}
默认情况下,所有字段都存储为文档中的元数据,并且文本设置为空字符串。通过转换读取器返回的文档来构建文档的文本。
from langchain.document_loaders.airbyte import AirbyteShopifyLoader
config = {
# 您的Shopify配置
}
loader = AirbyteShopifyLoader(config=config, stream_name="orders") # 请查看上面链接的文档以获取所有流的列表
现在,您可以按照通常的方式加载文档。
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 = AirbyteShopifyLoader(config=config, record_handler=handle_record, stream_name="orders")
docs = loader.load()
增量加载 (Incremental loads)
某些流允许增量加载,这意味着源会跟踪已同步的记录,并且不会再次加载它们。这对于具有大量数据且经常更新的源非常有用。
要利用此功能,请存储加载器的last_state
属性,并在再次创建加载器时传入它。这将确保只加载新记录。
last_state = loader.last_state # 安全存储
incremental_loader = AirbyteShopifyLoader(config=config, stream_name="orders", state=last_state)
new_docs = incremental_loader.load()