totvslabs/pycarol

pyCarol镜像说明

镜像概述

totvslabs/pycarol镜像提供Carol平台的Python API工具库（pyCarol）及Python 3.6运行环境，帮助开发者快速搭建与Carol平台交互的开发环境，无需手动安装依赖。

核心功能

1. Carol连接初始化：支持用户名密码、API Key两种认证方式，可通过环境变量自动加载配置。
2. 数据查询：提供过滤查询（类型过滤、术语过滤、聚合操作）、命名查询（带参数预定义查询）功能。
3. 数据发送：支持创建连接器、staging schema及表，批量发送数据到Carol平台。
4. 日志记录：将日志信息发送到Carol平台，支持多级别日志。
5. 应用设置管理：访问Carol应用的配置参数。

使用场景

• Carol平台的数据集成与同步任务。
• 基于Carol的自动化数据分析或业务流程。
• 快速验证Carol API功能的开发测试环境。

配置说明

环境变量配置

镜像支持通过环境变量自动加载连接参数，常用变量：

• CAROLTENANT：租户名称
• CAROLAPPNAME：应用名称
• CAROLORGANIZATION：组织名称
• CAROLAPPOAUTH：API Key
• CAROLCONNECTORID：连接器ID
• CAROLUSER：用户名
• CAROLPWD：密码

Docker部署示例

1. 直接运行容器（使用.env文件）

创建.env文件包含上述变量，执行：

bash
docker run -it --env-file .env docker.xuanyuan.run/totvslabs/pycarol bash

进入容器后即可使用pyCarol库。

2. Docker Compose示例

yaml
version: '3'
services:
  pycarol:
    image: docker.xuanyuan.run/totvslabs/pycarol
    env_file: .env
    volumes:
      - ./your_code:/app
    working_dir: /app
    command: python your_script.py

使用示例

初始化Carol连接

python
from docker.xuanyuan.run/pycarol import Carol
from docker.xuanyuan.run/dotenv import load_dotenv
load_dotenv() # 加载.env文件变量
carol = Carol()

执行过滤查询

python
from pycarol.filter import TYPE_FILTER, TERM_FILTER, Filter
from pycarol import Query

json_query = Filter.Builder() \
    .must(TYPE_FILTER(value='ratingsGolden')) \
    .must(TERM_FILTER(key='mdmGoldenFieldAndValues.userid.raw', value='123')) \
    .build().to_json()

query = Query(carol, page_size=10, max_hits=200, fields=['mdmGoldenFieldAndValues.mdmaddress.coordinates']).query(json_query).go()
print(query.results)