Skip to main content
Ctrl+K
Polars Cloud  documentation - Home Polars Cloud  documentation - Home
  • Python API reference
  • User guide
  • Discord
  • X/Twitter
  • Bluesky
  • Python API reference
  • User guide
  • Discord
  • X/Twitter
  • Bluesky

Section Navigation

  • Organization
    • Organization
  • Workspace
    • Workspace
    • WorkspaceStatus
    • WorkspaceDefaultComputeSpecs
    • WorkspaceProviderAWS
    • Provider type
  • Compute
    • ComputeContext
    • ClusterContext
    • ComputeContextStatus
    • set_compute_context
  • Query
    • LazyFrameRemote
      • polars_cloud.LazyFrameRemote
      • polars_cloud.LazyFrameRemote.await_and_scan
      • polars_cloud.LazyFrameRemote.distributed
      • polars_cloud.LazyFrameRemote.execute
      • polars_cloud.LazyFrameRemote.labels
      • polars_cloud.LazyFrameRemote.sink_batches
      • polars_cloud.LazyFrameRemote.sink_parquet
      • polars_cloud.LazyFrameRemote.sink_csv
      • polars_cloud.LazyFrameRemote.sink_ipc
      • polars_cloud.LazyFrameRemote.show
      • polars_cloud.LazyFrameRemote.with_lineage
    • Spawn compute
      • polars_cloud.spawn
      • polars_cloud.spawn_blocking
      • polars_cloud.spawn_many
      • polars_cloud.spawn_many_blocking
    • Result Types
      • ProxyQuery
      • DirectQuery
      • QueryResult
      • QueryStatus
      • StageStatistics
    • Destination
      • CsvDst
      • IpcDst
      • ParquetDst
  • Config
    • polars_cloud.Config.set_single_node
    • polars_cloud.Config.load
    • polars_cloud.Config.load_from_file
    • polars_cloud.Config.save
    • polars_cloud.Config.save_to_file
    • polars_cloud.Config.state
    • polars_cloud.Config.restore_defaults
  • Authentication
    • polars_cloud.login
    • polars_cloud.authenticate
  • Exceptions
    • polars_cloud.exceptions.WorkspaceDeploymentError
    • polars_cloud.exceptions.VerificationTimeoutError
    • polars_cloud.exceptions.WorkspaceResolveError
    • polars_cloud.exceptions.OrganizationResolveError
  • Python API reference

Python API reference#

This page gives a high-level overview of all public Polars Cloud objects, functions and methods. All classes and functions exposed in the polars_cloud.* namespace are public.

  • Organization
    • Organization
  • Workspace
    • Workspace
    • WorkspaceStatus
    • WorkspaceDefaultComputeSpecs
    • WorkspaceProviderAWS
    • Provider type
  • Compute
    • ComputeContext
    • ClusterContext
    • ComputeContextStatus
    • set_compute_context
  • Query
    • LazyFrameRemote
    • Spawn compute
    • Result Types
    • Destination
  • Config
    • Config options
    • Config load, save, state
    • Use as a context manager
    • Use as a decorator

previous

Index

next

Organization

© Copyright 2025, Polars.

Created using Sphinx 7.4.7.

Built with the PyData Sphinx Theme 0.16.0.