Documentation
문서 검색
karat

+

K

API 참조 ↗
데이터 통합PythonAPI ReferenceFoundry 커넥터

본 번역은 검증되지 않았습니다. AIP를 통해 영문원문으로부터 번역되었습니다.

Foundry 커넥터

Transforms API에서 Foundry와 상호작용하기 위한 커넥터.

커넥터는 대화식으로 사용하여 TransformInput 및 TransformOutput 오브젝트를 구성하고 Transform을 실행하는 데 사용할 수 있습니다.

FoundryConnector

class transforms.foundry.connectors.FoundryConnector(service_config, auth_header, filesystem_id=None, fallback_branches=None, resolver=None)

  • Foundry 서비스에 접근하기 위한 진입점입니다.
  • Foundry 오브젝트는 데이터셋을 조작하기 위한 API를 제공함으로써 Foundry 서비스와의 상호작용을 관리합니다.

파라미터

  • service_config (dict)
    • Java 클래스인 com.palantir.remoting.api.config.service.ServicesConfigBlock의 JSON 사양에 맞는 설정 사전입니다.
  • auth_header (str)
    • Foundry 서비스에 연결할 때 사용하는 인증 스트링입니다.
  • filesystem_id (str, 선택 사항)
    • 사용할 백업 파일 시스템입니다.
  • fallback_branches (목록[str], 선택 사항)
    • 대체 브랜치입니다.
  • resolver (Callable[[str], str], 선택 사항)
    • 데이터셋 별칭을 rid로 해석하는 함수입니다. 기본값은 별칭을 프로젝트 경로로 해석합니다.

input(alias=None, rid=None, branch=None, end_txrid=None, start_txrid=None, schema_version=None)

  • 주어진 파라미터로부터 TransformInput을 구성합니다.
  • TransformInput을 구성하는 데 사용된 _resource identifier_는 주어진 alias에서 해결될 것이며, rid 파라미터가 전달되지 않았을 경우에만 해당합니다.

파라미터

  • alias (str, 선택 사항)
    • 데이터셋의 별칭입니다.
  • rid (str, 선택 사항)
    • 데이터셋의 리소스 식별자입니다.
  • branch (str, 선택 사항)
    • 데이터셋을 읽을 브랜치입니다. 설정되지 않은 경우, _Catalog_에 존재하는 fallbacks 목록의 첫 번째 브랜치가 선택됩니다.
  • end_txrid (str, 선택 사항)
    • 뷰의 종료 트랜잭션입니다. 설정되지 않은 경우, 주어진 브랜치의 최신 트랜잭션으로 기본값이 설정됩니다.
  • start_txrid (str, 선택 사항)
    • 뷰의 시작 트랜잭션입니다.
  • schema_version (str, 선택 사항)
    • 읽기에 사용할 스키마 버전입니다. 설정되지 않은 경우, 주어진 브랜치의 최신 스키마 버전으로 기본값이 설정됩니다.

반환값

  • 요청된 데이터셋을 나타내는 입력 오브젝트입니다.

반환 유형

발생할 수 있는 예외

  • ValueError
    • alias 또는 rid 중 하나만(둘 다 아님) 지정되지 않았을 경우.
  • ValueError
    • 브랜치가 지정되지 않았고, _Catalog_에서 대체 브랜치를 찾을 수 없는 경우.

output(alias=None, rid=None, branch=None, txrid=None, filesystem_id=None)

  • 주어진 별칭 또는 rid에서 TransformOutput을 구성합니다.
  • transforms.api.TransformOutput을 구성하는 데 사용된 _resource identifier_는 주어진 alias에서 해결될 것이며, rid 파라미터가 전달되지 않았을 경우에만 해당합니다.

파라미터

  • alias (str, 선택 사항)
    • 데이터셋의 별칭입니다.
  • rid (str, 선택 사항)
    • 데이터셋의 리소스 식별자입니다.
  • branch (str, 선택 사항)
    • 데이터셋을 쓸 브랜치입니다. 설정되지 않은 경우, fallbacks 목록의 첫 번째 브랜치가 선택됩니다.
  • txrid (str, 선택 사항)
    • 데이터를 쓸 트랜잭션입니다.
  • filesystem_id (str, 선택 사항)
    • 데이터셋이 이미 존재하지 않는 경우, 데이터셋을 생성할 파일 시스템입니다.

반환값

  • 요청된 데이터셋을 나타내는 결과물 오브젝트입니다.

반환 유형

발생할 수 있는 예외

  • ValueError
    • alias 또는 rid 중 하나만(둘 다 아님) 지정되지 않았을 경우.

run(transform)

  • 주어진 Transform을 최신 입력값과 결과물을 사용하여 실행합니다.

파라미터

auth_header

  • str
    • Foundry에 연결하는 데 사용되는 인증 헤더입니다.

fallback_branches

  • 목록[str]
    • 데이터셋을 검색하는 데 사용되는 대체 브랜치입니다.

spark_session