arrow API reference
131 public APIs from arrow (apache/arrow) — 95 classes, 24 functions, 12 methods. Signatures extracted by static analysis of the actual source.
Repository: apache/arrow
| Kind | Count |
|---|---|
| Classes | 95 |
| Functions | 24 |
| Methods | 12 |
API list
class
cpp.gdb_arrow.ArrayDataPrinterPretty-printer for arrow::ArrayData.
method
cpp.gdb_arrow.ArrayDataPrinter.type()The concrete DataTypeClass instance.
class
cpp.gdb_arrow.ArrayPrinterPretty-printer for arrow::Array and subclasses.
class
cpp.gdb_arrow.BaseBinaryScalarPrinterPretty-printer for arrow::BaseBinaryScalar and subclasses.
class
cpp.gdb_arrow.BaseDecimalBase class for arrow::BasicDecimal{32,64,128,256...} values.
class
cpp.gdb_arrow.BaseListScalarPrinterPretty-printer for arrow::BaseListScalar and subclasses.
class
cpp.gdb_arrow.BinaryArrayDataPrinterArrayDataPrinter specialization for variable-sized binary.
class
cpp.gdb_arrow.BitmapView a bytes-compatible object as a sequence of bools.
class
cpp.gdb_arrow.BooleanArrayDataPrinterArrayDataPrinter specialization for boolean.
class
cpp.gdb_arrow.BufferA arrow::Buffer value.
class
cpp.gdb_arrow.BufferPrinterPretty-printer for arrow::Buffer and subclasses.
class
cpp.gdb_arrow.BufferPtrA arrow::Buffer* value (possibly null).
class
cpp.gdb_arrow.CStringA `const char*` or similar value.
class
cpp.gdb_arrow.ChunkedArrayPrinterPretty-printer for arrow::ChunkedArray.
class
cpp.gdb_arrow.Date32ArrayDataPrinterArrayDataPrinter specialization for date32.
class
cpp.gdb_arrow.Date32ScalarPrinterPretty-printer for arrow::Date32Scalar.
class
cpp.gdb_arrow.Date64ArrayDataPrinterArrayDataPrinter specialization for date64.
class
cpp.gdb_arrow.Date64ScalarPrinterPretty-printer for arrow::Date64Scalar.
class
cpp.gdb_arrow.DatumPrinterPretty-printer for arrow::Datum.
class
cpp.gdb_arrow.DayTimeIntervalArrayDataPrinterArrayDataPrinter specialization for day_time_interval.
class
cpp.gdb_arrow.DecimalArrayDataPrinterArrayDataPrinter specialization for decimals.
class
cpp.gdb_arrow.DecimalPrinterPretty-printer for Arrow decimal values.
class
cpp.gdb_arrow.DecimalScalarPrinterPretty-printer for arrow::DecimalScalar and subclasses.
class
cpp.gdb_arrow.DecimalTypePrinterPretty-printer for decimal types.
class
cpp.gdb_arrow.DenseUnionScalarPrinterPretty-printer for arrow::UnionScalar and subclasses.
class
cpp.gdb_arrow.DictionaryScalarPrinterPretty-printer for arrow::DictionaryScalar.
class
cpp.gdb_arrow.DictionaryTypePrinterPretty-printer for dictionary types.
class
cpp.gdb_arrow.ExtensionScalarPrinterPretty-printer for arrow::ExtensionScalar.
class
cpp.gdb_arrow.ExtensionTypeA arrow::ExtensionType.
class
cpp.gdb_arrow.ExtensionTypePrinterPretty-printer for extension types.
class
cpp.gdb_arrow.FieldA arrow::Field value.
class
cpp.gdb_arrow.FieldPrinterPretty-printer for arrow::Field.
class
cpp.gdb_arrow.FieldPtrA std::shared_ptr<arrow::Field> value.
class
cpp.gdb_arrow.FixedSizeBinaryArrayDataPrinterArrayDataPrinter specialization for fixed_size_binary.
class
cpp.gdb_arrow.FixedSizeBinaryScalarPrinterPretty-printer for arrow::FixedSizeBinaryScalar.
class
cpp.gdb_arrow.FixedSizeBinaryTypePrinterPretty-printer for fixed-size binary types.
class
cpp.gdb_arrow.FixedSizeListTypePrinterPretty-printer for fixed-size list type.
class
cpp.gdb_arrow.ListTypePrinterPretty-printer for list types.
class
cpp.gdb_arrow.MapScalarPrinterPretty-printer for arrow::MapScalar.
class
cpp.gdb_arrow.MapTypePrinterPretty-printer for map types.
class
cpp.gdb_arrow.MetadataA arrow::KeyValueMetadata value.
class
cpp.gdb_arrow.MetadataPrinterPretty-printer for arrow::KeyValueMetadata.
class
cpp.gdb_arrow.MetadataPtrA shared_ptr<arrow::KeyValueMetadata> value, possibly null.
class
cpp.gdb_arrow.MonthDayNanoIntervalArrayDataPrinterArrayDataPrinter specialization for day_time_interval.
class
cpp.gdb_arrow.MonthIntervalArrayDataPrinterArrayDataPrinter specialization for month_interval.
class
cpp.gdb_arrow.MonthIntervalScalarPrinterPretty-printer for arrow::MonthIntervalScalarPrinter.
class
cpp.gdb_arrow.NullScalarPrinterPretty-printer for arrow::NullScalar.
class
cpp.gdb_arrow.NumericArrayDataPrinterArrayDataPrinter specialization for numeric data types.
class
cpp.gdb_arrow.NumericScalarPrinterPretty-printer for numeric Arrow scalars.
class
cpp.gdb_arrow.PrimitiveTypePrinterPretty-printer for non-parametric types.
class
cpp.gdb_arrow.RecordBatchA arrow::RecordBatch.
class
cpp.gdb_arrow.RecordBatchPrinterPretty-printer for arrow::RecordBatch.
class
cpp.gdb_arrow.ResultPrinterPretty-printer for arrow::Result<T>.
class
cpp.gdb_arrow.ScalarPrinterPretty-printer for arrow::Scalar and subclasses.
method
cpp.gdb_arrow.ScalarPrinter.type()The concrete DataTypeClass instance.
class
cpp.gdb_arrow.SchemaA arrow::Schema.
class
cpp.gdb_arrow.SchemaPrinterPretty-printer for arrow::Schema.
class
cpp.gdb_arrow.SharedPtrA `std::shared_ptr<T>` value.
method
cpp.gdb_arrow.SharedPtr.get()Return the underlying pointer (a T*).
method
cpp.gdb_arrow.SharedPtr.value()The underlying value (a T).
class
cpp.gdb_arrow.SparseUnionScalarPrinterPretty-printer for arrow::UnionScalar and subclasses.
class
cpp.gdb_arrow.StatusPrinterPretty-printer for arrow::Status.
class
cpp.gdb_arrow.StdStringA `std::string` (or possibly `std::string_view`) value.
class
cpp.gdb_arrow.StdVectorA `std::vector<T>` value.
class
cpp.gdb_arrow.StructScalarPrinterPretty-printer for arrow::StructScalar.
class
cpp.gdb_arrow.StructTypePrinterPretty-printer for struct types.
class
cpp.gdb_arrow.TableA arrow::Table.
class
cpp.gdb_arrow.TablePrinterPretty-printer for arrow::Table.
class
cpp.gdb_arrow.TimeArrayDataPrinterArrayDataPrinter specialization for time32 and time64.
class
cpp.gdb_arrow.TimeScalarPrinterPretty-printer for Arrow time-like scalars.
class
cpp.gdb_arrow.TimeTypePrinterPretty-printer for time and duration types.
class
cpp.gdb_arrow.TimestampArrayDataPrinterArrayDataPrinter specialization for timestamp.
class
cpp.gdb_arrow.TimestampScalarPrinterPretty-printer for arrow::TimestampScalar.
class
cpp.gdb_arrow.TimestampTypePrinterPretty-printer for timestamp types.
class
cpp.gdb_arrow.TypePrinterPretty-printer for arrow::DataTypeClass and subclasses.
class
cpp.gdb_arrow.TypedBufferA buffer containing values of a given a struct format code.
class
cpp.gdb_arrow.UnionTypePrinterPretty-printer for union types.
class
cpp.gdb_arrow.UniquePtrA `std::unique_ptr<T>` value.
method
cpp.gdb_arrow.UniquePtr.get()Return the underlying pointer (a T*).
method
cpp.gdb_arrow.UniquePtr.value()The underlying value (a T).
class
cpp.gdb_arrow.VariantA `std::variant<...>`.
func
cpp.gdb_arrow.deref(val)Dereference a raw or smart pointer.
func
cpp.gdb_arrow.format_date32(val)Format a date32 value.
func
cpp.gdb_arrow.format_date64(val)Format a date64 value.
func
cpp.gdb_arrow.format_month_interval(val)Format a MonthInterval value.
func
cpp.gdb_arrow.format_null_count(val)Format a null count value.
func
cpp.gdb_arrow.format_timestamp(val, unit)Format a timestamp value.
func
cpp.gdb_arrow.load_atomic(val)Load a std::atomic<T>'s value.
class
dev.archery.archery.bot.PullRequestStateState of a pull request.
func
dev.archery.archery.bot.actions(ctx)Ursabot
func
dev.archery.archery.bot.submit(obj, tasks, groups, params, arrow_version, wait, prefix)Submit crossbow testing tasks.
func
dev.archery.archery.cli.archery(ctx, debug, pdb, quiet)Apache Arrow developer utilities.
func
dev.archery.archery.cli.benchmark(ctx)Arrow benchmarking.
func
dev.archery.archery.cli.build(ctx, src, build_dir, force, targets, **kwargs)Initialize a C++ build directory.
class
dev.archery.archery.crossbow.core.JobDescribes multiple tasks against a single target repository
method
dev.archery.archery.crossbow.core.Repo.branch()Currently checked out branch
method
dev.archery.archery.crossbow.core.Repo.head()Currently checked out commit's sha
class
dev.archery.archery.crossbow.reports.ConsoleReportReport the status of a Job to the console using click
func
dev.archery.archery.docker.cli.docker_pull(obj, image, *pull_leaf, *ignore_pull_failures)Execute docker compose pull.
func
dev.archery.archery.integration.cdata.ffi() -> cffi.FFIReturn a FFI object supporting C Data Interface types.
class
dev.archery.archery.integration.scenario.ScenarioAn integration test scenario for Arrow Flight.
func
dev.archery.archery.integration.util.random_bytes(nbytes)Generate one random binary string.
func
dev.archery.archery.integration.util.random_utf8(nchars)Generate one random UTF8 string.
func
dev.archery.archery.release.cli.release(obj, src, github_token)Release related commands.
func
dev.archery.archery.release.cli.release_changelog()Release changelog.
func
dev.archery.archery.release.cli.release_cherry_pick(obj, version, dry_run, recreate)Cherry pick commits.
func
dev.archery.archery.release.cli.release_curate(obj, version, minimal)Release curation.
class
dev.archery.archery.utils.cache.CacheCache stores downloaded objects, notably apache-rat.jar.
method
dev.archery.archery.utils.cache.Cache.key_path(key)Return the full path of a key.
class
dev.archery.archery.utils.cmake.CMakeDefinitionCMakeDefinition captures the cmake invocation arguments.
class
dev.archery.archery.utils.command.CommandA runnable command.
method
dev.archery.archery.utils.git.Git.head(**kwargs)Return commit pointed by HEAD.
class
dev.archery.archery.utils.maven.MavenBuildMavenBuild represents a build directory initialized by maven.
method
dev.archery.archery.utils.maven.MavenBuild.from_path(path)Instantiate a Maven from a path.
class
dev.archery.archery.utils.maven.MavenDefinitionMavenDefinition captures the maven invocation arguments.
class
dev.merge_arrow_pr.CommandInputInterface to input(...) to enable unit test mocks to be created
func
python.pyarrow.compute.field(*name_or_index)Reference a column of the dataset.
func
python.pyarrow.compute.scalar(value)Expression representing a scalar value.
class
python.pyarrow.feather.FeatherDatasetEncapsulates details of reading a list of Feather files.
class
python.pyarrow.fs.FSSpecHandlerHandler for fsspec-based Python filesystems.
class
python.pyarrow.interchange.buffer.DlpackDeviceTypeInteger enum for device type codes matching DLPack.
class
python.pyarrow.interchange.column.ColumnNullTypeInteger enum for null type representation.
class
python.pyarrow.interchange.column.DtypeKindInteger enum for data types.
class
python.pyarrow.interchange.column.EndiannessEnum indicating the byte-order of a data-type.
class
python.pyarrow.interchange.column.NoBufferPresentException to signal that there is no requested buffer.
class
python.pyarrow.ipc.RecordBatchStreamReaderReader for the Arrow streaming binary format.
class
python.pyarrow.parquet.core.ParquetFileReader interface for a single Parquet file.
method
python.pyarrow.parquet.core.ParquetFile.metadata()Return the Parquet metadata.
class
python.pyarrow.types.TypesEnumAn Enum that maps constant values to data types.
func
python.pyarrow.types.is_unicode(t)Alias for {method}.
func
python.pyarrow.util.product(seq)Return a product of sequence items.
About this data
These signatures were extracted from the public source of apache/arrow
using Python's ast module. Argument names, default values,
type annotations and return types are taken verbatim from the code.
Implementation bodies are never stored. See
how it works for details.