Python 클라이언트 API 참조

Python 클라이언트 API 참조 (Python Client API Reference)

이 페이지는 DuckDB Python 클라이언트의 전체 API 참조에요. duckdb 모듈의 모든 클래스·함수·상수를 자동 생성(pdoc)으로 문서화한 것으로, 각 항목의 시그니처와 설명이 담겨 있어요.

출처: 문서

본문

이 API 참조는 Python pdoc가 생성한 대용량 자동 생성 문서예요. 수천 개의 항목(클래스, 함수, 속성)을 포함하며, 원문 그대로의 기술 시그니처(클래스, 메서드, 파라미터, 타입)를 기준으로 사용해야 해요. 기술 값은 원문을 그대로 보존했어요.

Python 클라이언트에서 가장 자주 사용되는 항목들을 정리하면 다음과 같아요.

핵심 클래스 (Core Classes)

  • duckdb.Connection — 데이터베이스 커넥션. connect()로 생성하며 execute(), sql(), query() 메서드를 제공해요.
  • duckdb.DuckDBPyConnection — 커넥션의 Python 바인딩 타입.
  • duckdb.DuckDBPyRelation — relational API의 관계(relation) 객체. filter(), project(), order(), df() 등 메서드를 제공해요.
  • duckdb.Value — 스칼라 값의 추상 기본 클래스. 이를 상속받는 구체 타입(BooleanValue, IntegerValue, DecimalValue, StringValue, TimestampValue, BlobValue, StructValue, ListValue, MapValue 등)이 있어요.

커넥션 인스턴스화 (Instantiating a Connection)

import duckdb

# 인메모리 데이터베이스
con = duckdb.connect()

# 파일 기반 데이터베이스
con = duckdb.connect('my_database.duckdb')

핵심 메서드 (Core Methods)

Method Description
execute(query, params) 준비/매개변수화된 쿼리를 실행하고 결과 커서를 반환해요.
sql(query) SQL을 실행하고 relational API의 관계를 반환해요.
query(query) SQL을 실행하고 구체화된(materialized) 결과를 반환해요.
from_df(df) / from_arrow(arrow_table) DataFrame/Arrow 테이블에서 관계를 생성해요.
register(view_name, python_object) Python 객체를 뷰로 등록해요.
install_extension(name) / load_extension(name) 확장을 설치/로드해요.
close() 커넥션을 닫아요.

예외 (Exceptions)

duckdb 모듈은 DB-API를 따르는 예외 계층을 제공해요: Error → Warning, InterfaceError, DatabaseError → DataError, OperationalError, IntegrityError, InternalError, ProgrammingError, NotSupportedError. duckdb.Error는 모든 예외의 공통 기본 클래스예요.

전체 참조 (Full Reference)

전체 API 참조(모든 클래스·함수·메서드 시그니처와 설명)는 원본 README/문서의 자동 생성 내용으로, 그 양이 매우 방대해 이 페이지에는 핵심 항목만 요약해 실었어요. 정확한 시그니처와 전체 목록은 출처 문서(원본URL)를 직접 참고하세요.

더 알아보기 (Learn more)