Python API

• Data Types
  • Factory Functions
    • null()
    • bool_()
    • float_()
    • int_()
    • uint()
    • utf8()
    • binary()
    • struct()
    • list_()
  • Base Class
    • DType
      • DType.from_arrow()
  • DType Classes
    • NullDType
    • BoolDType
    • PrimitiveDType
      • PrimitiveDType.ptype
    • Utf8DType
    • BinaryDType
    • StructDType
      • StructDType.fields()
      • StructDType.names()
    • ListDType
    • ExtensionDType
  • Primitive Types
    • PType
• Scalars
  • Factory Function
    • scalar()
  • Base Class
    • Scalar
      • Scalar.as_py()
      • Scalar.dtype
  • Scalar Classes
    • NullScalar
    • BoolScalar
    • PrimitiveScalar
    • Utf8Scalar
    • BinaryScalar
    • StructScalar
      • StructScalar.field()
    • ListScalar
      • ListScalar.element()
    • ExtensionScalar
      • ExtensionScalar.storage()
• Arrays
  • Factory Functions
    • array()
  • Base Class
    • Array
      • Array.__len__()
      • Array.display_tree()
      • Array.dtype
      • Array.filter()
      • Array.from_arrow()
      • Array.from_range()
      • Array.id
      • Array.nbytes
      • Array.scalar_at()
      • Array.take()
      • Array.to_arrow_array()
      • Array.to_arrow_table()
      • Array.to_numpy()
      • Array.to_pandas_df()
      • Array.to_polars_dataframe()
      • Array.to_polars_series()
      • Array.to_pylist()
  • Canonical Encodings
    • NullArray
    • BoolArray
    • PrimitiveArray
    • VarBinArray
    • VarBinViewArray
    • StructArray
      • StructArray.field()
      • StructArray.names()
    • ListArray
    • ExtensionArray
  • Utility Encodings
    • ConstantArray
      • ConstantArray.scalar()
    • ChunkedArray
    • ByteBoolArray
  • Compressed Encodings
    • AlpArray
    • AlpRdArray
    • DateTimePartsArray
    • DictArray
    • FsstArray
    • RunEndArray
    • SequenceArray
    • SparseArray
    • ZigZagArray
    • FastLanesBitPackedArray
      • FastLanesBitPackedArray.bit_width
    • FastLanesDeltaArray
    • FastLanesFoRArray
  • Pluggable Encodings
    • PyArray
      • PyArray.decode()
      • PyArray.dtype
      • PyArray.id
  • Registry and Serde
    • registry
    • register()
    • ArrayContext
    • ArrayParts
      • ArrayParts.buffers
      • ArrayParts.children
      • ArrayParts.decode()
      • ArrayParts.metadata
      • ArrayParts.nbuffers
      • ArrayParts.nchildren
      • ArrayParts.parse()
  • Streams and Iterators
    • ArrayIterator
      • ArrayIterator.dtype
      • ArrayIterator.from_iter()
      • ArrayIterator.read_all()
      • ArrayIterator.to_arrow()
• Expressions
  • column()
  • not_()
  • and_()
  • root()
  • literal()
  • Expr
• Compression
  • compress()
• Input and Output
  • open()
  • VortexFile
    • VortexFile.dtype
    • VortexFile.scan()
    • VortexFile.to_arrow()
    • VortexFile.to_dataset()
    • VortexFile.to_polars()
    • VortexFile.to_repeated_scan()
  • RepeatedScan
    • RepeatedScan.execute()
    • RepeatedScan.scalar_at()
  • VortexWriteOptions
    • VortexWriteOptions.compact()
    • VortexWriteOptions.default()
    • VortexWriteOptions.write_path()
  • read_url()
  • write()
• Dataset
  • VortexDataset
    • VortexDataset.count_rows()
    • VortexDataset.filter()
    • VortexDataset.get_fragments()
    • VortexDataset.head()
    • VortexDataset.join()
    • VortexDataset.join_asof()
    • VortexDataset.replace_schema()
    • VortexDataset.scanner()
    • VortexDataset.schema
    • VortexDataset.sort_by()
    • VortexDataset.take()
    • VortexDataset.to_batches()
    • VortexDataset.to_record_batch_reader()
    • VortexDataset.to_table()
  • VortexFragment
    • VortexFragment.count_rows()
    • VortexFragment.head()
    • VortexFragment.partition_expression
    • VortexFragment.physical_schema
    • VortexFragment.scanner()
    • VortexFragment.take()
    • VortexFragment.to_batches()
    • VortexFragment.to_table()
  • VortexScanner
    • VortexScanner.count_rows()
    • VortexScanner.head()
    • VortexScanner.scan_batches()
    • VortexScanner.to_batches()
    • VortexScanner.to_reader()
    • VortexScanner.to_table()
• Type Aliases
  • vortex.type_aliases.IntoArrayIterator
  • vortex.type_aliases.IntoProjection