API Reference#
- Programming Support
- Memory (management)
- Thread (management)
- Data Types
typeNABOOLUINT8INT8UINT16INT16UINT32INT32UINT64INT64HALF_FLOATFLOATDOUBLESTRINGBINARYFIXED_SIZE_BINARYDATE32DATE64TIMESTAMPTIME32TIME64INTERVAL_MONTHSINTERVAL_DAY_TIMEDECIMAL128DECIMALDECIMAL256LISTSTRUCTSPARSE_UNIONDENSE_UNIONDICTIONARYMAPEXTENSIONFIXED_SIZE_LISTDURATIONLARGE_STRINGLARGE_BINARYLARGE_LISTINTERVAL_MONTH_DAY_NANORUN_END_ENCODEDSTRING_VIEWBINARY_VIEWLIST_VIEWLARGE_LIST_VIEWDECIMAL32DECIMAL64MAX_ID
arrow::DataType- Factory functions
null()boolean()int8()int16()int32()int64()uint8()uint16()uint32()uint64()float16()float32()float64()utf8()utf8_view()large_utf8()binary()binary_view()large_binary()date32()date64()fixed_size_binary()decimal()smallest_decimal()decimal32()decimal64()decimal128()decimal256()list()list()large_list()large_list()list_view()list_view()large_list_view()large_list_view()map()map()fixed_size_list()fixed_size_list()duration()day_time_interval()month_interval()month_day_nano_interval()timestamp()timestamp()time32()time64()struct_()struct_()run_end_encoded()sparse_union()sparse_union()dense_union()dense_union()dictionary()
- Concrete type subclasses
- Fields and Schemas
- Utilities
- Arrays
- Extension
- Scalars
arrow::Scalar- Factory functions
- Concrete scalar subclasses
arrow::NullScalararrow::BooleanScalararrow::NumericScalararrow::Int8Scalararrow::Int16Scalararrow::Int32Scalararrow::Int64Scalararrow::UInt8Scalararrow::UInt16Scalararrow::UInt32Scalararrow::UInt64Scalararrow::HalfFloatScalararrow::FloatScalararrow::DoubleScalararrow::BaseBinaryScalararrow::BinaryScalararrow::StringScalararrow::BinaryViewScalararrow::StringViewScalararrow::LargeBinaryScalararrow::LargeStringScalararrow::FixedSizeBinaryScalararrow::TemporalScalararrow::DateScalararrow::Date32Scalararrow::Date64Scalararrow::TimeScalararrow::Time32Scalararrow::Time64Scalararrow::TimestampScalararrow::IntervalScalararrow::MonthIntervalScalararrow::DayTimeIntervalScalararrow::MonthDayNanoIntervalScalararrow::DurationScalararrow::DecimalScalararrow::Decimal32Scalararrow::Decimal64Scalararrow::Decimal128Scalararrow::Decimal256Scalararrow::BaseListScalararrow::ListScalararrow::LargeListScalararrow::ListViewScalararrow::LargeListViewScalararrow::MapScalararrow::FixedSizeListScalararrow::StructScalararrow::UnionScalararrow::SparseUnionScalararrow::DenseUnionScalararrow::RunEndEncodedScalararrow::DictionaryScalararrow::ExtensionScalar
- Utilities
- Array Builders
- Two-dimensional Datasets
- C Interfaces
- Compute Functions
- Datum class
- Abstract Function classes
PrintTo()arrow::compute::Arityarrow::compute::FunctionDocarrow::compute::FunctionExecutorarrow::compute::Functionarrow::compute::ScalarFunctionarrow::compute::VectorFunctionarrow::compute::ScalarAggregateFunctionarrow::compute::HashAggregateFunctionarrow::compute::MetaFunctionarrow::compute::FunctionOptionsTypearrow::compute::FunctionOptions
- Function execution
- Function registry
- Convenience functions
- Concrete options classes
RoundModeCalendarUnitCompareOperatorCumulativeSumOptionsarrow::compute::ScalarAggregateOptionsarrow::compute::CountOptionsarrow::compute::ModeOptionsarrow::compute::VarianceOptionsarrow::compute::SkewOptionsarrow::compute::QuantileOptionsarrow::compute::TDigestOptionsarrow::compute::PivotWiderOptionsarrow::compute::IndexOptionsarrow::compute::Aggregatearrow::compute::ArithmeticOptionsarrow::compute::ElementWiseAggregateOptionsarrow::compute::RoundOptionsarrow::compute::RoundBinaryOptionsarrow::compute::RoundTemporalOptionsarrow::compute::RoundToMultipleOptionsarrow::compute::JoinOptionsarrow::compute::MatchSubstringOptionsarrow::compute::SplitOptionsarrow::compute::SplitPatternOptionsarrow::compute::ReplaceSliceOptionsarrow::compute::ReplaceSubstringOptionsarrow::compute::ExtractRegexOptionsarrow::compute::ExtractRegexSpanOptionsarrow::compute::SetLookupOptionsarrow::compute::StructFieldOptionsarrow::compute::StrptimeOptionsarrow::compute::StrftimeOptionsarrow::compute::PadOptionsarrow::compute::ZeroFillOptionsarrow::compute::TrimOptionsarrow::compute::SliceOptionsarrow::compute::ListSliceOptionsarrow::compute::NullOptionsarrow::compute::CompareOptionsarrow::compute::MakeStructOptionsarrow::compute::DayOfWeekOptionsarrow::compute::AssumeTimezoneOptionsarrow::compute::WeekOptionsarrow::compute::Utf8NormalizeOptionsarrow::compute::RandomOptionsarrow::compute::MapLookupOptionsarrow::compute::FilterOptionsarrow::compute::TakeOptionsarrow::compute::DictionaryEncodeOptionsarrow::compute::RunEndEncodeOptionsarrow::compute::ArraySortOptionsarrow::compute::SortOptionsarrow::compute::SelectKOptionsarrow::compute::RankOptionsarrow::compute::RankQuantileOptionsarrow::compute::PartitionNthOptionsarrow::compute::WinsorizeOptionsarrow::compute::CumulativeOptionsarrow::compute::PairwiseOptionsarrow::compute::ListFlattenOptionsarrow::compute::InversePermutationOptionsarrow::compute::ScatterOptionsarrow::compute::CastOptions
- Compute Expressions
operator==()operator!=()PrintTo()literal()literal()field_ref()call()call()FieldsInExpression()ExpressionHasFieldRefs()ExtractKnownFieldValues()arrow::compute::Expressionproject()equal()not_equal()less()less_equal()greater()greater_equal()is_null()is_valid()and_()and_()or_()or_()not_()Canonicalize()FoldConstants()ReplaceFieldsWithKnownValues()SimplifyWithGuarantee()RemoveNamedRefs()
- Streaming Execution (Acero)
- Creating and running execution plans
UnalignedBufferHandlingGetDefaultUnalignedBufferHandling()DeclarationToSchema()DeclarationToString()DeclarationToTable()DeclarationToTable()DeclarationToTableAsync()DeclarationToTableAsync()DeclarationToExecBatches()DeclarationToExecBatches()DeclarationToExecBatchesAsync()DeclarationToExecBatchesAsync()DeclarationToBatches()DeclarationToBatches()DeclarationToBatchesAsync()DeclarationToBatchesAsync()DeclarationToReader()DeclarationToReader()DeclarationToStatus()DeclarationToStatus()DeclarationToStatusAsync()DeclarationToStatusAsync()arrow::acero::Declarationarrow::acero::QueryOptionsarrow::acero::BatchesWithCommonSchema
- Configuration for execution nodes
JoinTypeJoinKeyCmpArrayVectorIteratorMakerExecBatchIteratorMakerRecordBatchIteratorMakerkDefaultBackpressureHighByteskDefaultBackpressureLowBytesToString()arrow::acero::ExecNodeOptionsarrow::acero::SourceNodeOptionsarrow::acero::TableSourceNodeOptionsarrow::acero::NamedTableNodeOptionsarrow::acero::SchemaSourceNodeOptionsarrow::acero::RecordBatchReaderSourceNodeOptionsarrow::acero::ArrayVectorSourceNodeOptionsarrow::acero::ExecBatchSourceNodeOptionsarrow::acero::RecordBatchSourceNodeOptionsarrow::acero::FilterNodeOptionsarrow::acero::FetchNodeOptionsarrow::acero::ProjectNodeOptionsarrow::acero::AggregateNodeOptionsarrow::acero::BackpressureMonitorarrow::acero::BackpressureOptionsarrow::acero::SinkNodeOptionsarrow::acero::BackpressureControlarrow::acero::SinkNodeConsumerarrow::acero::ConsumingSinkNodeOptionsarrow::acero::OrderBySinkNodeOptionsarrow::acero::OrderByNodeOptionsarrow::acero::HashJoinNodeOptionsarrow::acero::AsofJoinNodeOptionsarrow::acero::SelectKSinkNodeOptionsarrow::acero::TableSinkNodeOptionsarrow::acero::PivotLongerRowTemplatearrow::acero::PivotLongerNodeOptions
- Internals for creating custom nodes
- Creating and running execution plans
- Gandiva Expression Compiler
- Tensors
- Utilities
- Asynchronous programming
- Input / output
- Arrow IPC
- File Formats
- CUDA support
- Arrow Flight RPC
- Common Types
arrow::flight::Actionarrow::flight::ActionTypearrow::flight::AddCallHeadersarrow::flight::CallInfoarrow::flight::Criteriaarrow::flight::FlightDescriptorarrow::flight::FlightEndpointarrow::flight::FlightInfoarrow::flight::FlightPayloadarrow::flight::FlightListingFlightMethodarrow::flight::Locationarrow::flight::MetadataRecordBatchReaderarrow::flight::Resultarrow::flight::ResultStreamarrow::flight::Ticket
- Clients
- Servers
arrow::flight::FlightServerBasearrow::flight::FlightServerOptionsarrow::flight::CertKeyPairarrow::flight::FlightDataStreamarrow::flight::FlightMessageReaderarrow::flight::FlightMetadataWriterarrow::flight::RecordBatchStreamarrow::flight::ServerAuthHandlerarrow::flight::ServerCallContextarrow::flight::ServerMiddlewarearrow::flight::ServerMiddlewareFactoryarrow::flight::SimpleFlightListingarrow::flight::SimpleResultStream
- Error Handling
- Implementing Custom Transports
- Common Types
- Arrow Flight SQL
- Common Types
- Client
- Server
arrow::flight::sql::FlightSqlServerBaseCreateStatementQueryTicket()arrow::flight::sql::SqlSchemaarrow::flight::sql::StatementQueryarrow::flight::sql::StatementSubstraitPlanarrow::flight::sql::StatementUpdatearrow::flight::sql::StatementQueryTicketarrow::flight::sql::PreparedStatementQueryarrow::flight::sql::PreparedStatementUpdatearrow::flight::sql::StatementIngestarrow::flight::sql::GetSqlInfoarrow::flight::sql::GetDbSchemasarrow::flight::sql::GetTablesarrow::flight::sql::GetXdbcTypeInfoarrow::flight::sql::GetPrimaryKeysarrow::flight::sql::GetExportedKeysarrow::flight::sql::GetImportedKeysarrow::flight::sql::GetCrossReferencearrow::flight::sql::ActionBeginTransactionRequestarrow::flight::sql::ActionBeginSavepointRequestarrow::flight::sql::ActionBeginSavepointResultarrow::flight::sql::ActionBeginTransactionResultarrow::flight::sql::ActionEndSavepointRequestarrow::flight::sql::ActionEndTransactionRequestarrow::flight::sql::ActionCancelQueryRequestarrow::flight::sql::ActionCreatePreparedStatementRequestarrow::flight::sql::ActionCreatePreparedSubstraitPlanRequestarrow::flight::sql::ActionClosePreparedStatementRequestarrow::flight::sql::ActionCreatePreparedStatementResult
- Filesystems
- Dataset
- Interface
- Partitioning
SegmentEncodingkDefaultHiveNullFallbackoperator<<()StripPrefix()StripPrefixAndFilename()StripPrefixAndFilename()StripPrefixAndFilename()arrow::dataset::Partitioningarrow::dataset::KeyValuePartitioningOptionsarrow::dataset::PartitioningFactoryOptionsarrow::dataset::HivePartitioningFactoryOptionsarrow::dataset::PartitioningFactoryarrow::dataset::KeyValuePartitioningarrow::dataset::DirectoryPartitioningarrow::dataset::HivePartitioningOptionsarrow::dataset::HivePartitioningarrow::dataset::FunctionPartitioningarrow::dataset::FilenamePartitioningarrow::dataset::PartitioningOrFactory
- Dataset discovery/factories
- Scanning
TaggedRecordBatchGeneratorTaggedRecordBatchIteratorEnumeratedRecordBatchGeneratorEnumeratedRecordBatchIteratorkDefaultBatchSizekDefaultBatchReadaheadkDefaultFragmentReadaheadkDefaultBytesReadaheadSetProjection()arrow::dataset::FragmentScanOptionsarrow::dataset::ScanOptionsarrow::dataset::ScanV2Optionsarrow::dataset::ProjectionDescrarrow::dataset::TaggedRecordBatcharrow::dataset::EnumeratedRecordBatcharrow::dataset::Scannerarrow::dataset::ScannerBuilderarrow::dataset::ScanNodeOptions
- Concrete implementations