# SparkEx v0.1.0 - Table of Contents

Native Elixir client for Apache Spark via the Spark Connect protocol

## Pages

- [SparkEx](readme.md)
- [SparkEx Livebook Demo](spark_ex_demo.md)
- [LICENSE](license.md)

## Modules

- [SparkEx](SparkEx.md): Elixir client for Apache Spark via the Spark Connect protocol.
- [SparkEx.Artifacts](SparkEx.Artifacts.md): Convenience helpers for uploading local artifacts to a Spark Connect session.
- [SparkEx.Catalog](SparkEx.Catalog.md): Catalog API for Spark Connect sessions.
- [SparkEx.Catalog.CatalogMetadata](SparkEx.Catalog.CatalogMetadata.md): Metadata about a catalog.
- [SparkEx.Catalog.ColumnInfo](SparkEx.Catalog.ColumnInfo.md): Metadata about a column.
- [SparkEx.Catalog.Database](SparkEx.Catalog.Database.md): Metadata about a database.
- [SparkEx.Catalog.Function](SparkEx.Catalog.Function.md): Metadata about a function.
- [SparkEx.Catalog.Table](SparkEx.Catalog.Table.md): Metadata about a table.
- [SparkEx.Column](SparkEx.Column.md): Expression wrapper for Spark DataFrame columns.
- [SparkEx.Connect.Errors](SparkEx.Connect.Errors.md): Handles gRPC error enrichment via `FetchErrorDetails` RPC.
- [SparkEx.DataFrame](SparkEx.DataFrame.md): A lazy reference to a Spark DataFrame.
- [SparkEx.DataFrame.NA](SparkEx.DataFrame.NA.md): Null-value handling sub-API for DataFrames.
- [SparkEx.DataFrame.Stat](SparkEx.DataFrame.Stat.md): Statistical operations sub-API for DataFrames.
- [SparkEx.Error](SparkEx.Error.md): Structured error types for SparkEx.

- [SparkEx.Functions](SparkEx.Functions.md): Expression constructors for Spark DataFrame operations.
- [SparkEx.GroupedData](SparkEx.GroupedData.md): Represents a grouped DataFrame, created by `SparkEx.DataFrame.group_by/2`.
- [SparkEx.Livebook](SparkEx.Livebook.md): Livebook helpers for `SparkEx.DataFrame`.
- [SparkEx.ManagedStream](SparkEx.ManagedStream.md): Managed wrapper around response streams with explicit lifecycle controls.
- [SparkEx.MergeIntoWriter](SparkEx.MergeIntoWriter.md): Builder for MERGE INTO table commands.
- [SparkEx.Observation](SparkEx.Observation.md): Collects metrics observed during query execution.
- [SparkEx.ProgressHandlerRegistry](SparkEx.ProgressHandlerRegistry.md): Registry for session-scoped progress handlers driven by telemetry events.

- [SparkEx.Reader](SparkEx.Reader.md): Data source reader APIs for creating DataFrames from external sources.
- [SparkEx.RetryPolicyRegistry](SparkEx.RetryPolicyRegistry.md): Stores retry policies for Spark Connect client operations.

- [SparkEx.Session](SparkEx.Session.md): Manages a Spark Connect session as a GenServer process.
- [SparkEx.SqlFormatter](SparkEx.SqlFormatter.md): Formats SQL strings with auto-quoting of parameters.
- [SparkEx.StreamReader](SparkEx.StreamReader.md): Data source reader APIs for creating streaming DataFrames.
- [SparkEx.StreamWriter](SparkEx.StreamWriter.md): Builder API for starting structured streaming queries.
- [SparkEx.StreamingQuery](SparkEx.StreamingQuery.md): Controls a running structured streaming query.
- [SparkEx.StreamingQueryListener](SparkEx.StreamingQueryListener.md): Behaviour for streaming query event listeners.
- [SparkEx.StreamingQueryListenerBus](SparkEx.StreamingQueryListenerBus.md): Manages a persistent gRPC stream for receiving streaming query listener events.
- [SparkEx.StreamingQueryManager](SparkEx.StreamingQueryManager.md): Manages all active streaming queries for a Spark session.
- [SparkEx.TableArg](SparkEx.TableArg.md): Minimal table-argument wrapper for DataFrame subquery usage.

- [SparkEx.TableValuedFunction](SparkEx.TableValuedFunction.md): Table-valued function (TVF) accessor.
- [SparkEx.Types](SparkEx.Types.md): Elixir-friendly type construction for Spark schemas.
- [SparkEx.UDFRegistration](SparkEx.UDFRegistration.md): Registers user-defined functions (UDFs), table functions (UDTFs),
and data sources with a Spark session.
- [SparkEx.Window](SparkEx.Window.md): Convenience constructors for window specifications.
- [SparkEx.WindowSpec](SparkEx.WindowSpec.md): Represents a window specification for window functions.
- [SparkEx.Writer](SparkEx.Writer.md): Builder API for writing DataFrames to external storage.
- [SparkEx.WriterV2](SparkEx.WriterV2.md): Builder API for writing DataFrames using the V2 DataSource API.

- Exceptions
  - [SparkEx.Error.LimitExceeded](SparkEx.Error.LimitExceeded.md): Raised when a materialization operation exceeds configured bounds.
  - [SparkEx.Error.Remote](SparkEx.Error.Remote.md): A structured error from the Spark Connect server.