API Reference#
- Programming Support
- Memory (management)
- Thread (management)
- Data Types
type
NA
BOOL
UINT8
INT8
UINT16
INT16
UINT32
INT32
UINT64
INT64
HALF_FLOAT
FLOAT
DOUBLE
STRING
BINARY
FIXED_SIZE_BINARY
DATE32
DATE64
TIMESTAMP
TIME32
TIME64
INTERVAL_MONTHS
INTERVAL_DAY_TIME
DECIMAL128
DECIMAL
DECIMAL256
LIST
STRUCT
SPARSE_UNION
DENSE_UNION
DICTIONARY
MAP
EXTENSION
FIXED_SIZE_LIST
DURATION
LARGE_STRING
LARGE_BINARY
LARGE_LIST
INTERVAL_MONTH_DAY_NANO
RUN_END_ENCODED
STRING_VIEW
BINARY_VIEW
LIST_VIEW
LARGE_LIST_VIEW
DECIMAL32
DECIMAL64
MAX_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::NullScalar
arrow::BooleanScalar
arrow::NumericScalar
arrow::Int8Scalar
arrow::Int16Scalar
arrow::Int32Scalar
arrow::Int64Scalar
arrow::UInt8Scalar
arrow::UInt16Scalar
arrow::UInt32Scalar
arrow::UInt64Scalar
arrow::HalfFloatScalar
arrow::FloatScalar
arrow::DoubleScalar
arrow::BaseBinaryScalar
arrow::BinaryScalar
arrow::StringScalar
arrow::BinaryViewScalar
arrow::StringViewScalar
arrow::LargeBinaryScalar
arrow::LargeStringScalar
arrow::FixedSizeBinaryScalar
arrow::TemporalScalar
arrow::DateScalar
arrow::Date32Scalar
arrow::Date64Scalar
arrow::TimeScalar
arrow::Time32Scalar
arrow::Time64Scalar
arrow::TimestampScalar
arrow::IntervalScalar
arrow::MonthIntervalScalar
arrow::DayTimeIntervalScalar
arrow::MonthDayNanoIntervalScalar
arrow::DurationScalar
arrow::DecimalScalar
arrow::Decimal32Scalar
arrow::Decimal64Scalar
arrow::Decimal128Scalar
arrow::Decimal256Scalar
arrow::BaseListScalar
arrow::ListScalar
arrow::LargeListScalar
arrow::ListViewScalar
arrow::LargeListViewScalar
arrow::MapScalar
arrow::FixedSizeListScalar
arrow::StructScalar
arrow::UnionScalar
arrow::SparseUnionScalar
arrow::DenseUnionScalar
arrow::RunEndEncodedScalar
arrow::DictionaryScalar
arrow::ExtensionScalar
- Utilities
- Array Builders
- Two-dimensional Datasets
- C Interfaces
- Compute Functions
- Datum class
- Abstract Function classes
PrintTo()
arrow::compute::Arity
arrow::compute::FunctionDoc
arrow::compute::FunctionExecutor
arrow::compute::Function
arrow::compute::ScalarFunction
arrow::compute::VectorFunction
arrow::compute::ScalarAggregateFunction
arrow::compute::HashAggregateFunction
arrow::compute::MetaFunction
arrow::compute::FunctionOptionsType
arrow::compute::FunctionOptions
- Function execution
- Function registry
- Convenience functions
- Concrete options classes
RoundMode
CalendarUnit
CompareOperator
CumulativeSumOptions
arrow::compute::ScalarAggregateOptions
arrow::compute::CountOptions
arrow::compute::ModeOptions
arrow::compute::VarianceOptions
arrow::compute::SkewOptions
arrow::compute::QuantileOptions
arrow::compute::TDigestOptions
arrow::compute::PivotWiderOptions
arrow::compute::IndexOptions
arrow::compute::Aggregate
arrow::compute::ArithmeticOptions
arrow::compute::ElementWiseAggregateOptions
arrow::compute::RoundOptions
arrow::compute::RoundBinaryOptions
arrow::compute::RoundTemporalOptions
arrow::compute::RoundToMultipleOptions
arrow::compute::JoinOptions
arrow::compute::MatchSubstringOptions
arrow::compute::SplitOptions
arrow::compute::SplitPatternOptions
arrow::compute::ReplaceSliceOptions
arrow::compute::ReplaceSubstringOptions
arrow::compute::ExtractRegexOptions
arrow::compute::ExtractRegexSpanOptions
arrow::compute::SetLookupOptions
arrow::compute::StructFieldOptions
arrow::compute::StrptimeOptions
arrow::compute::StrftimeOptions
arrow::compute::PadOptions
arrow::compute::ZeroFillOptions
arrow::compute::TrimOptions
arrow::compute::SliceOptions
arrow::compute::ListSliceOptions
arrow::compute::NullOptions
arrow::compute::CompareOptions
arrow::compute::MakeStructOptions
arrow::compute::DayOfWeekOptions
arrow::compute::AssumeTimezoneOptions
arrow::compute::WeekOptions
arrow::compute::Utf8NormalizeOptions
arrow::compute::RandomOptions
arrow::compute::MapLookupOptions
arrow::compute::FilterOptions
arrow::compute::TakeOptions
arrow::compute::DictionaryEncodeOptions
arrow::compute::RunEndEncodeOptions
arrow::compute::ArraySortOptions
arrow::compute::SortOptions
arrow::compute::SelectKOptions
arrow::compute::RankOptions
arrow::compute::RankQuantileOptions
arrow::compute::PartitionNthOptions
arrow::compute::WinsorizeOptions
arrow::compute::CumulativeOptions
arrow::compute::PairwiseOptions
arrow::compute::ListFlattenOptions
arrow::compute::InversePermutationOptions
arrow::compute::ScatterOptions
arrow::compute::CastOptions
- Compute Expressions
operator==()
operator!=()
PrintTo()
literal()
literal()
field_ref()
call()
call()
FieldsInExpression()
ExpressionHasFieldRefs()
ExtractKnownFieldValues()
arrow::compute::Expression
project()
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
UnalignedBufferHandling
GetDefaultUnalignedBufferHandling()
DeclarationToSchema()
DeclarationToString()
DeclarationToTable()
DeclarationToTable()
DeclarationToTableAsync()
DeclarationToTableAsync()
DeclarationToExecBatches()
DeclarationToExecBatches()
DeclarationToExecBatchesAsync()
DeclarationToExecBatchesAsync()
DeclarationToBatches()
DeclarationToBatches()
DeclarationToBatchesAsync()
DeclarationToBatchesAsync()
DeclarationToReader()
DeclarationToReader()
DeclarationToStatus()
DeclarationToStatus()
DeclarationToStatusAsync()
DeclarationToStatusAsync()
arrow::acero::Declaration
arrow::acero::QueryOptions
arrow::acero::BatchesWithCommonSchema
- Configuration for execution nodes
JoinType
JoinKeyCmp
ArrayVectorIteratorMaker
ExecBatchIteratorMaker
RecordBatchIteratorMaker
kDefaultBackpressureHighBytes
kDefaultBackpressureLowBytes
ToString()
arrow::acero::ExecNodeOptions
arrow::acero::SourceNodeOptions
arrow::acero::TableSourceNodeOptions
arrow::acero::NamedTableNodeOptions
arrow::acero::SchemaSourceNodeOptions
arrow::acero::RecordBatchReaderSourceNodeOptions
arrow::acero::ArrayVectorSourceNodeOptions
arrow::acero::ExecBatchSourceNodeOptions
arrow::acero::RecordBatchSourceNodeOptions
arrow::acero::FilterNodeOptions
arrow::acero::FetchNodeOptions
arrow::acero::ProjectNodeOptions
arrow::acero::AggregateNodeOptions
arrow::acero::BackpressureMonitor
arrow::acero::BackpressureOptions
arrow::acero::SinkNodeOptions
arrow::acero::BackpressureControl
arrow::acero::SinkNodeConsumer
arrow::acero::ConsumingSinkNodeOptions
arrow::acero::OrderBySinkNodeOptions
arrow::acero::OrderByNodeOptions
arrow::acero::HashJoinNodeOptions
arrow::acero::AsofJoinNodeOptions
arrow::acero::SelectKSinkNodeOptions
arrow::acero::TableSinkNodeOptions
arrow::acero::PivotLongerRowTemplate
arrow::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::Action
arrow::flight::ActionType
arrow::flight::AddCallHeaders
arrow::flight::CallInfo
arrow::flight::Criteria
arrow::flight::FlightDescriptor
arrow::flight::FlightEndpoint
arrow::flight::FlightInfo
arrow::flight::FlightPayload
arrow::flight::FlightListing
FlightMethod
arrow::flight::Location
arrow::flight::MetadataRecordBatchReader
arrow::flight::Result
arrow::flight::ResultStream
arrow::flight::Ticket
- Clients
- Servers
arrow::flight::FlightServerBase
arrow::flight::FlightServerOptions
arrow::flight::CertKeyPair
arrow::flight::FlightDataStream
arrow::flight::FlightMessageReader
arrow::flight::FlightMetadataWriter
arrow::flight::RecordBatchStream
arrow::flight::ServerAuthHandler
arrow::flight::ServerCallContext
arrow::flight::ServerMiddleware
arrow::flight::ServerMiddlewareFactory
arrow::flight::SimpleFlightListing
arrow::flight::SimpleResultStream
- Error Handling
- Implementing Custom Transports
- Common Types
- Arrow Flight SQL
- Common Types
- Client
- Server
arrow::flight::sql::FlightSqlServerBase
CreateStatementQueryTicket()
arrow::flight::sql::SqlSchema
arrow::flight::sql::StatementQuery
arrow::flight::sql::StatementSubstraitPlan
arrow::flight::sql::StatementUpdate
arrow::flight::sql::StatementQueryTicket
arrow::flight::sql::PreparedStatementQuery
arrow::flight::sql::PreparedStatementUpdate
arrow::flight::sql::StatementIngest
arrow::flight::sql::GetSqlInfo
arrow::flight::sql::GetDbSchemas
arrow::flight::sql::GetTables
arrow::flight::sql::GetXdbcTypeInfo
arrow::flight::sql::GetPrimaryKeys
arrow::flight::sql::GetExportedKeys
arrow::flight::sql::GetImportedKeys
arrow::flight::sql::GetCrossReference
arrow::flight::sql::ActionBeginTransactionRequest
arrow::flight::sql::ActionBeginSavepointRequest
arrow::flight::sql::ActionBeginSavepointResult
arrow::flight::sql::ActionBeginTransactionResult
arrow::flight::sql::ActionEndSavepointRequest
arrow::flight::sql::ActionEndTransactionRequest
arrow::flight::sql::ActionCancelQueryRequest
arrow::flight::sql::ActionCreatePreparedStatementRequest
arrow::flight::sql::ActionCreatePreparedSubstraitPlanRequest
arrow::flight::sql::ActionClosePreparedStatementRequest
arrow::flight::sql::ActionCreatePreparedStatementResult
- Filesystems
- Dataset
- Interface
- Partitioning
SegmentEncoding
kDefaultHiveNullFallback
operator<<()
StripPrefix()
StripPrefixAndFilename()
StripPrefixAndFilename()
StripPrefixAndFilename()
arrow::dataset::Partitioning
arrow::dataset::KeyValuePartitioningOptions
arrow::dataset::PartitioningFactoryOptions
arrow::dataset::HivePartitioningFactoryOptions
arrow::dataset::PartitioningFactory
arrow::dataset::KeyValuePartitioning
arrow::dataset::DirectoryPartitioning
arrow::dataset::HivePartitioningOptions
arrow::dataset::HivePartitioning
arrow::dataset::FunctionPartitioning
arrow::dataset::FilenamePartitioning
arrow::dataset::PartitioningOrFactory
- Dataset discovery/factories
- Scanning
TaggedRecordBatchGenerator
TaggedRecordBatchIterator
EnumeratedRecordBatchGenerator
EnumeratedRecordBatchIterator
kDefaultBatchSize
kDefaultBatchReadahead
kDefaultFragmentReadahead
kDefaultBytesReadahead
SetProjection()
arrow::dataset::FragmentScanOptions
arrow::dataset::ScanOptions
arrow::dataset::ScanV2Options
arrow::dataset::ProjectionDescr
arrow::dataset::TaggedRecordBatch
arrow::dataset::EnumeratedRecordBatch
arrow::dataset::Scanner
arrow::dataset::ScannerBuilder
arrow::dataset::ScanNodeOptions
- Concrete implementations