Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
- API
  
  Reference documentation for the pkg.go.dev API
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

orc

package module

Go to main page

Versions in this module

v0

v0.2.0

Nov 6, 2026

Changes in this version

type Reader

+ func (r *Reader) ReadRowBatches(yield func(RowBatch) error) error

+ func (r *Reader) ReadRowBatchesWithColumns(names []string, yield func(RowBatch) error) error

+ func (r *Reader) ReadRowsRangeValuesWithColumns(start, end uint64, names []string, yield func(RowValues) error) error

+ func (r *Reader) ReadRowsValuesWithColumns(names []string, yield func(RowValues) error) error

+ type RowBatch struct

+ func (b RowBatch) Column(name string) ([]any, bool)

+ func (b RowBatch) Field(row, field int) (string, any, bool)

+ func (b RowBatch) FieldNames() []string

+ func (b RowBatch) Get(row int, name string) (any, bool)

+ func (b RowBatch) IsNull(row int) (bool, bool)

+ func (b RowBatch) Len() int

+ type RowValues struct

+ func (r RowValues) Field(index int) (string, any, bool)

+ func (r RowValues) Get(name string) (any, bool)

+ func (r RowValues) IsNull() bool

+ func (r RowValues) Len() int

type WriterOptions

+ MaxBufferedBytes uint64

v0.1.0

Nov 5, 2026

Changes in this version

+ var ErrColumnNotEncrypted = errors.New("ORC column is not encrypted")

+ var ErrEncryptedStatisticsUnavailable = errors.New("encrypted ORC statistics are unavailable")

+ var ErrInvalidFile = errors.New("invalid ORC file")

+ var ErrKeyUnavailable = errors.New("ORC encryption key is unavailable")

+ var ErrUnsupportedCalendar = errors.New("unsupported ORC calendar")

+ var ErrUnsupportedCompression = errors.New("unsupported ORC compression")

+ var ErrUnsupportedEncoding = errors.New("unsupported ORC column encoding")

+ var ErrUnsupportedEncryption = errors.New("unsupported ORC encryption")

+ var ErrUnsupportedType = errors.New("unsupported ORC type")

+ var ErrWriterClosed = errors.New("ORC writer is closed")

+ type BinaryStatistics struct

+ HasSum bool

+ Sum int64

+ type BloomFilter struct

+ Bitset []uint64

+ NumHashFunctions uint32

+ UTF8Bitset []byte

+ func (f BloomFilter) MightContainBytes(value []byte) bool

+ func (f BloomFilter) MightContainFloat64(value float64) bool

+ func (f BloomFilter) MightContainInt64(value int64) bool

+ func (f BloomFilter) MightContainString(value string) bool

+ type BucketStatistics struct

+ Counts []uint64

+ type CalendarKind uint32

+ const CalendarKindJulianGregorian

+ const CalendarKindProlepticGregorian

+ const CalendarKindUnknown

+ type CollectionStatistics struct

+ HasMaximumChildren bool

+ HasMinimumChildren bool

+ HasTotalChildren bool

+ MaximumChildren uint64

+ MinimumChildren uint64

+ TotalChildren uint64

+ type ColumnBloomFilterIndex struct

+ BloomEncoding uint32

+ ColumnID uint32

+ Filters []BloomFilter

+ type ColumnEncryptionStatistics struct

+ File []ColumnStatistics

+ Stripes [][]ColumnStatistics

+ type ColumnRowIndex struct

+ ColumnID uint32

+ Entries []RowIndexEntry

+ type ColumnStatistics struct

+ Binary *BinaryStatistics

+ Bucket *BucketStatistics

+ BytesOnDisk uint64

+ Collection *CollectionStatistics

+ Date *DateStatistics

+ Decimal *DecimalStatistics

+ Double *DoubleStatistics

+ Geospatial *GeospatialStatistics

+ HasBytesOnDisk bool

+ HasNull bool

+ HasNullSet bool

+ HasNumberOfValues bool

+ Integer *IntegerStatistics

+ NumberOfValues uint64

+ String *StringStatistics

+ Timestamp *TimestampStatistics

+ type CompressionKind uint32

+ const CompressionBrotli

+ const CompressionLZ4

+ const CompressionLZO

+ const CompressionNone

+ const CompressionSnappy

+ const CompressionZlib

+ const CompressionZstd

+ func (kind CompressionKind) String() string

+ type DateStatistics struct

+ HasMaximum bool

+ HasMinimum bool

+ Maximum int32

+ Minimum int32

+ type Decimal string

+ func ParseDecimal(value string) (Decimal, error)

+ func (value Decimal) String() string

+ type DecimalStatistics struct

+ HasMaximum bool

+ HasMinimum bool

+ HasSum bool

+ Maximum string

+ Minimum string

+ Sum string

+ type DoubleStatistics struct

+ HasMaximum bool

+ HasMinimum bool

+ HasSum bool

+ Maximum float64

+ Minimum float64

+ Sum float64

+ type EdgeInterpolationAlgorithm uint32

+ const EdgeInterpolationAndoyer

+ const EdgeInterpolationKarney

+ const EdgeInterpolationSpherical

+ const EdgeInterpolationThomas

+ const EdgeInterpolationVincenty

+ type EncryptionAlgorithm uint32

+ const EncryptionAESCTR128

+ const EncryptionAESCTR256

+ type EncryptionKeyProvider interface

+ DecryptLocalKey func(name string, version uint32, algorithm EncryptionAlgorithm, ...) ([]byte, error)

+ GenerateLocalKey func(name string, version uint32, algorithm EncryptionAlgorithm) (localKey, encryptedLocalKey []byte, err error)

+ Kind func() KeyProviderKind

+ type EncryptionMask struct

+ Columns []uint32

+ Name string

+ Parameters []string

+ type EncryptionRule struct

+ Algorithm EncryptionAlgorithm

+ Column string

+ KeyName string

+ KeyVersion uint32

+ type GeospatialBoundingBox struct

+ HasMMax bool

+ HasMMin bool

+ HasXMax bool

+ HasXMin bool

+ HasYMax bool

+ HasYMin bool

+ HasZMax bool

+ HasZMin bool

+ MMax float64

+ MMin float64

+ XMax float64

+ XMin float64

+ YMax float64

+ YMin float64

+ ZMax float64

+ ZMin float64

+ type GeospatialStatistics struct

+ BoundingBox *GeospatialBoundingBox

+ GeospatialTypes []int32

+ type IntegerStatistics struct

+ HasMaximum bool

+ HasMinimum bool

+ HasSum bool

+ Maximum int64

+ Minimum int64

+ Sum int64

+ type KeyProvider interface

+ GetKey func(name string, version uint32) ([]byte, error)

+ type KeyProviderFunc func(name string, version uint32) ([]byte, error)

+ func (f KeyProviderFunc) GetKey(name string, version uint32) ([]byte, error)

+ type KeyProviderKind uint32

+ const KeyProviderKindAWS

+ const KeyProviderKindAzure

+ const KeyProviderKindGCP

+ const KeyProviderKindHadoop

+ const KeyProviderKindUnknown

+ type MapEntry struct

+ Key any

+ Value any

+ type Reader struct

+ func NewReader(source io.ReaderAt, size int64) (*Reader, error)

+ func NewReaderWithOptions(source io.ReaderAt, size int64, options ReaderOptions) (*Reader, error)

+ func Open(path string) (*Reader, error)

+ func OpenWithOptions(path string, options ReaderOptions) (*Reader, error)

+ func (r *Reader) BloomFilterIndexes() ([]StripeBloomFilterIndexes, error)

+ func (r *Reader) CalendarKind() CalendarKind

+ func (r *Reader) Close() error

+ func (r *Reader) Compression() CompressionKind

+ func (r *Reader) EncryptionMasks() []EncryptionMask

+ func (r *Reader) EncryptionStatistics(column string) (ColumnEncryptionStatistics, error)

+ func (r *Reader) FileStatistics() []ColumnStatistics

+ func (r *Reader) FormatVersion() []uint32

+ func (r *Reader) NumRows() uint64

+ func (r *Reader) NumStripes() int

+ func (r *Reader) ReadAll() ([]Row, error)

+ func (r *Reader) ReadAllRange(start, end uint64) ([]Row, error)

+ func (r *Reader) ReadAllRangeWithColumns(start, end uint64, names []string) ([]Row, error)

+ func (r *Reader) ReadAllValues() ([]any, error)

+ func (r *Reader) ReadAllValuesRange(start, end uint64) ([]any, error)

+ func (r *Reader) ReadAllWithColumns(names []string) ([]Row, error)

+ func (r *Reader) ReadRows(yield func(Row) error) error

+ func (r *Reader) ReadRowsRange(start, end uint64, yield func(Row) error) error

+ func (r *Reader) ReadRowsRangeWithColumns(start, end uint64, names []string, yield func(Row) error) error

+ func (r *Reader) ReadRowsWithColumns(names []string, yield func(Row) error) error

+ func (r *Reader) ReadValues(yield func(any) error) error

+ func (r *Reader) ReadValuesRange(start, end uint64, yield func(any) error) error

+ func (r *Reader) RowIndexStride() uint64

+ func (r *Reader) RowIndexes() ([]StripeRowIndexes, error)

+ func (r *Reader) Schema() []Type

+ func (r *Reader) StripeStatistics() [][]ColumnStatistics

+ func (r *Reader) Stripes() []StripeInfo

+ func (r *Reader) UserMetadata() []UserMetadataItem

+ func (r *Reader) WriterMetadata() WriterMetadata

+ type ReaderOptions struct

+ DefaultCalendar CalendarKind

+ EncryptionKeyProvider EncryptionKeyProvider

+ KeyProvider KeyProvider

+ type Row map[string]any

+ type RowIndexEntry struct

+ HasStatistics bool

+ Positions []uint64

+ Statistics ColumnStatistics

+ type StringStatistics struct

+ HasLowerBound bool

+ HasMaximum bool

+ HasMinimum bool

+ HasSum bool

+ HasUpperBound bool

+ LowerBound string

+ Maximum string

+ Minimum string

+ Sum int64

+ UpperBound string

+ type StripeBloomFilterIndexes struct

+ Columns []ColumnBloomFilterIndex

+ type StripeInfo struct

+ DataLength uint64

+ FooterLength uint64

+ IndexLength uint64

+ NumberOfRows uint64

+ Offset uint64

+ type StripeRowIndexes struct

+ Columns []ColumnRowIndex

+ type TimestampStatistics struct

+ HasMaximum bool

+ HasMaximumNanos bool

+ HasMaximumUTC bool

+ HasMinimum bool

+ HasMinimumNanos bool

+ HasMinimumUTC bool

+ Maximum int64

+ MaximumNanos int32

+ MaximumUTC int64

+ Minimum int64

+ MinimumNanos int32

+ MinimumUTC int64

+ type Type struct

+ Attributes []TypeAttribute

+ CRS string

+ EdgeInterpolation EdgeInterpolationAlgorithm

+ FieldNames []string

+ Kind TypeKind

+ MaxLength uint32

+ Precision uint32

+ Scale uint32

+ Subtypes []uint32

+ type TypeAttribute struct

+ Key string

+ Value string

+ type TypeKind uint32

+ const TypeKindBinary

+ const TypeKindBoolean

+ const TypeKindByte

+ const TypeKindChar

+ const TypeKindDate

+ const TypeKindDecimal

+ const TypeKindDouble

+ const TypeKindFloat

+ const TypeKindGeography

+ const TypeKindGeometry

+ const TypeKindInt

+ const TypeKindList

+ const TypeKindLong

+ const TypeKindMap

+ const TypeKindShort

+ const TypeKindString

+ const TypeKindStruct

+ const TypeKindTimestamp

+ const TypeKindTimestampInstant

+ const TypeKindUnion

+ const TypeKindVarchar

+ func (kind TypeKind) String() string

+ type UnionValue struct

+ Tag uint8

+ Value any

+ type UserMetadataItem struct

+ Name string

+ Value []byte

+ type Writer struct

+ func NewWriter(destination io.Writer, schema []Type, options WriterOptions) (*Writer, error)

+ func (w *Writer) AddUserMetadata(name string, value []byte) error

+ func (w *Writer) Close() error

+ func (w *Writer) WriteRow(row Row) error

+ func (w *Writer) WriteValue(value any) error

+ type WriterMetadata struct

+ HasImplementationID bool

+ HasSoftwareVersion bool

+ HasWriterVersion bool

+ ImplementationID uint32

+ SoftwareVersion string

+ WriterVersion uint32

+ type WriterOptions struct

+ BloomFilterColumns []string

+ BloomFilterFPP float64

+ Compression CompressionKind

+ CompressionBlockSize uint64

+ DisableRowIndexes bool

+ EncryptColumns []EncryptionRule

+ EncryptionKeyProvider EncryptionKeyProvider

+ KeyProvider KeyProvider

+ LegacyBloomFilterEncoding bool

+ MaxRowsPerStripe uint64

+ RowIndexStride uint64

+ SoftwareVersion string

+ UseDictionary bool

+ UseRLEv2 bool