chDB

chDB is an in-process SQL OLAP Engine powered by ClickHouse.

For more information, see the GitHub repository.

Contents

• Installation
  • Requirements
  • Quick Installation
  • Optional Dependencies
  • Supported Platforms
  • System Requirements
  • Verification
  • Troubleshooting
  • Development Installation
• Quick Start
  • Your First Query
  • Connection-Based API (Recommended)
  • Output Formats
  • Working with Files
  • DataFrame Integration
  • Memory vs Persistent Storage
  • Performance Tips
  • Error Handling
  • Next Steps
• API Reference
  • Core Query Functions
  • Connection and Session
  • State Management
  • DataFrame Integration
  • Database API (DBAPI) Support
  • User-Defined Functions (UDF)
  • Exception Handling
  • Abstract Base Classes
  • Utilities
  • Version Information
• Examples
  • Basic Queries
  • File Processing Examples
  • Connection-Based API
  • DataFrame Integration
  • Text and String Processing
  • Advanced Analytics
  • Complex Data Transformations
  • Performance Optimization Examples
  • Error Handling and Debugging
  • Next Steps
• DB-API 2.0 Interface
  • Overview
  • API Reference
  • Basic Usage
  • Connection Management
  • Cursor Operations
  • Advanced Usage
  • Type System
  • Error Handling
  • Integration Examples
  • Best Practices
  • Module Constants
  • See Also
• Session Management
  • Overview
  • Session API
  • Basic Usage
  • Connection String Support
  • Streaming Queries
  • Context Manager Support
  • Advanced Usage
  • Error Handling
  • Best Practices
  • See Also
• Streaming Queries
  • Overview
  • Basic Streaming Examples
  • Advanced Streaming Operations
  • PyArrow Integration
  • File Processing with Streaming
  • Error Handling and Resource Management
  • Performance Optimization
  • Best Practices
  • See Also
• User Defined Functions (UDF)
  • Overview
  • API Reference
  • Creating UDFs
  • Text Processing UDFs
  • JSON and Data Processing UDFs
  • Mathematical and Statistical UDFs
  • Data Validation UDFs
  • UDF with External Libraries
  • UDF Best Practices and Guidelines
  • UDF Configuration and Advanced Usage
  • Performance Considerations
  • Debugging UDFs
  • Complete Example: Log Processing UDF
  • See Also
• Utilities
  • Overview
  • API Reference
  • Data Processing Utilities
  • Type Conversion
  • Tracing and Debugging
  • Performance Monitoring
  • Memory Usage Monitoring
  • Data Processing Helpers
  • Utility Functions
  • See Also
• Troubleshooting
  • Installation Issues
  • Query Execution Issues
  • UDF (User Defined Functions) Issues
  • Streaming Query Issues
  • Debug and Diagnostics
  • Getting Help
  • Error Reporting
  • Common Error Messages
  • Frequently Asked Questions

Indices and tables

• Index

• Module Index

• Search Page