API Reference - PIPolars 0.1.0 documentation

Skip to content
Back to top
View this page
Edit this page

# API Reference

This section provides complete API documentation for all public classes, functions, and modules in PIPolars.

## Overview

PIPolars is organized into several modules:

Module | Description
--- | ---
`pipolars.api` | User-facing API (PIClient, PIQuery)
`pipolars.core` | Core types, configuration, and exceptions
`pipolars.cache` | Caching backends and strategies
`pipolars.connection` | PI Server connectivity
`pipolars.extraction` | Data extraction from PI
`pipolars.transform` | Data conversion to Polars

## Quick Reference

### Main Classes

`pipolars.PIClient` | Main client for extracting PI System data as Polars DataFrames.
`pipolars.PIQuery` | Fluent query builder for PI data.
`pipolars.PIConfig` | Main configuration class for PIPolars library.

### Types

`pipolars.AFTime` | Represents a PI AF Time specification.
`pipolars.PIValue` | Represents a single PI value with timestamp and quality.
`pipolars.RetrievalMode` | Data retrieval modes for PI Point queries.
`pipolars.SummaryType` | Summary calculation types for PI data.
`pipolars.TimestampMode` | Timestamp handling modes for summary calculations.
`pipolars.DataQuality` | PI data quality flags.

### Exceptions

`pipolars.PIPolarsError` | Base exception for all PIPolars errors.
`pipolars.PIConnectionError` | Raised when connection to PI System fails.
`pipolars.PIDataError` | Raised when data retrieval or conversion fails.
`pipolars.PIQueryError` | Raised when a PI query is invalid or fails.

## Detailed API

- PIClient
  - PIClient Class
  - Usage Examples
  - See Also
- PIQuery
  - PIQuery Class
  - QueryOptions Class
  - QueryType Enum
  - Usage Examples
  - See Also
- Types
  - Type Aliases
  - AFTime Class
  - PIValue Class
  - TimeRange Class
  - PointConfig Class
  - SummaryResult Class
  - Enumerations
  - Schema Definitions
  - See Also
- Configuration
  - PIConfig
  - PIServerConfig
  - AFServerConfig
  - CacheConfig
  - QueryConfig
  - PolarsConfig
  - Enumerations
  - Configuration File Format
  - See Also
- Exceptions
  - Exception Hierarchy
  - Base Exception
  - Connection Exceptions
  - Data Exceptions
  - Query Exceptions
  - Other Exceptions
  - Error Handling Patterns
  - See Also
- Cache
  - Storage Module
  - Strategies Module
  - Cache Key Generation
  - Cache Statistics
  - Integration with PIClient
  - Custom Cache Backend
  - See Also