Dataset related classes: Apache Arrow Dataset GLib Reference Manual

Dataset related classes

Functions

GADatasetScannerBuilder *	gadataset_dataset_begin_scan ()
GArrowTable *	gadataset_dataset_to_table ()
gchar *	gadataset_dataset_get_type_name ()

Properties

gpointer	dataset	Write / Construct Only
GArrowFileSystem *	file-system	Read / Write / Construct Only
GADatasetFileFormat *	format	Read / Write / Construct Only
gpointer	scanner-builder	Write / Construct Only

Types and Values

#define	GADATASET_TYPE_DATASET
struct	GADatasetDatasetClass
#define	GADATASET_TYPE_FILE_SYSTEM_DATASET
struct	GADatasetFileSystemDatasetClass
	GADatasetDataset
	GADatasetFileSystemDataset
	GADatasetScannerBuilder

Object Hierarchy

    GObject
    ├── GADatasetDataset
    │   ╰── GADatasetFileSystemDataset
    ╰── GADatasetScannerBuilder

Includes

#include <arrow-dataset-glib/arrow-dataset-glib.h>

Description

GADatasetDataset is a base class for datasets.

GADatasetFileSystemDataset is a class for file system dataset.

GADatasetFileFormat is a base class for file formats.

GADatasetCSVFileFormat is a class for CSV file format.

GADatasetIPCFileFormat is a class for IPC file format.

GADatasetParquetFileFormat is a class for Apache Parquet file format.

Functions

gadataset_dataset_begin_scan ()

GADatasetScannerBuilder *
gadataset_dataset_begin_scan (GADatasetDataset *dataset,
                              GError **error);

Parameters

dataset	A GADatasetDataset.
error	Return location for a GError or `NULL`.	[nullable]

Returns

A newly created GADatasetScannerBuilder on success, NULL on error.

[transfer full][nullable]

Since: 5.0.0

gadataset_dataset_to_table ()

GArrowTable *
gadataset_dataset_to_table (GADatasetDataset *dataset,
                            GError **error);

Parameters

dataset	A GADatasetDataset.
error	Return location for a GError or `NULL`.	[nullable]

Returns

A loaded GArrowTable on success, NULL on error.

[transfer full][nullable]

Since: 5.0.0

gadataset_dataset_get_type_name ()

gchar *
gadataset_dataset_get_type_name (GADatasetDataset *dataset);

Parameters

dataset

A GADatasetDataset.

Returns

The type name of dataset .

It should be freed with g_free() when no longer needed.

Since: 5.0.0

Types and Values

GADATASET_TYPE_DATASET

#define GADATASET_TYPE_DATASET (gadataset_dataset_get_type())

struct GADatasetDatasetClass

struct GADatasetDatasetClass {
  GObjectClass parent_class;
};

GADATASET_TYPE_FILE_SYSTEM_DATASET

#define             GADATASET_TYPE_FILE_SYSTEM_DATASET

struct GADatasetFileSystemDatasetClass

struct GADatasetFileSystemDatasetClass {
  GADatasetDatasetClass parent_class;
};

GADatasetDataset

typedef struct _GADatasetDataset GADatasetDataset;

GADatasetFileSystemDataset

typedef struct _GADatasetFileSystemDataset GADatasetFileSystemDataset;

GADatasetScannerBuilder

typedef struct _GADatasetScannerBuilder GADatasetScannerBuilder;

Property Details

The `“dataset”` property

  “dataset”                  gpointer

The raw std::shared<arrow::dataset::Dataset> *.

Owner: GADatasetDataset

Flags: Write / Construct Only

The `“file-system”` property

  “file-system”              GArrowFileSystem *

File system of the dataset.

Owner: GADatasetFileSystemDataset

Flags: Read / Write / Construct Only

Since: 5.0.0

The `“format”` property

  “format”                   GADatasetFileFormat *

Format of the dataset.

Owner: GADatasetFileSystemDataset

Flags: Read / Write / Construct Only

Since: 5.0.0

The `“scanner-builder”` property

  “scanner-builder”          gpointer

The raw std::shared<arrow::dataset::ScannerBuilder> *.

Owner: GADatasetScannerBuilder

Flags: Write / Construct Only