Scanner related classes

Scanner related classes

Functions

GArrowTable * gadataset_scanner_to_table ()
GADatasetScannerBuilder * gadataset_scanner_builder_new ()
GADatasetScannerBuilder * gadataset_scanner_builder_new_record_batch_reader ()
gboolean gadataset_scanner_builder_set_filter ()
GADatasetScanner * gadataset_scanner_builder_finish ()

Properties

gpointer scanner Write / Construct Only
gpointer scanner-builder Write / Construct Only

Types and Values

#define GADATASET_TYPE_SCANNER
struct GADatasetScannerClass
#define GADATASET_TYPE_SCANNER_BUILDER
struct GADatasetScannerBuilderClass
  GADatasetScanner
  GADatasetScannerBuilder

Object Hierarchy

    GObject
    ├── GADatasetScanner
    ╰── GADatasetScannerBuilder

Includes

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

Description

GADatasetScanner is a class for scanning dataset.

GADatasetScannerBuilder is a class for building a scanner.

Functions

gadataset_scanner_to_table ()

GArrowTable *
gadataset_scanner_to_table (GADatasetScanner *scanner,
                            GError **error);

Parameters

scanner

A GADatasetScanner.

  

error

Return location for a GError or NULL.

[nullable]

Returns

A newly created GArrowTable on success, NULL on error.

[transfer full][nullable]

Since: 5.0.0

gadataset_scanner_builder_new ()

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

Parameters

dataset

A GADatasetDataset to be scanned.

  

error

Return location for a GError or NULL.

[nullable]

Returns

A newly created GADatasetScannerBuilder on success, NULL on error.

[nullable]

Since: 5.0.0

gadataset_scanner_builder_new_record_batch_reader ()

GADatasetScannerBuilder *
gadataset_scanner_builder_new_record_batch_reader
                               (GArrowRecordBatchReader *reader);

Parameters

reader

A GArrowRecordBatchReader that produces record batches.

  

Returns

A newly created GADatasetScannerBuilder.

[nullable]

Since: 6.0.0

gadataset_scanner_builder_set_filter ()

gboolean
gadataset_scanner_builder_set_filter (GADatasetScannerBuilder *builder,
                                      GArrowExpression *expression,
                                      GError **error);

Parameters

builder

A GADatasetScannerBuilder.

  

expression

A GArrowExpression to filter rows with.

  

error

Return location for a GError or NULL.

[nullable]

Returns

TRUE on success, FALSE on error.

Since: 6.0.0

gadataset_scanner_builder_finish ()

GADatasetScanner *
gadataset_scanner_builder_finish (GADatasetScannerBuilder *builder,
                                  GError **error);

Parameters

builder

A GADatasetScannerBuilder.

  

error

Return location for a GError or NULL.

[nullable]

Returns

A newly created GADatasetScanner on success, NULL on error.

[transfer full][nullable]

Since: 5.0.0

Types and Values

GADATASET_TYPE_SCANNER

#define GADATASET_TYPE_SCANNER (gadataset_scanner_get_type())

struct GADatasetScannerClass

struct GADatasetScannerClass {
  GObjectClass parent_class;
};

GADATASET_TYPE_SCANNER_BUILDER

#define GADATASET_TYPE_SCANNER_BUILDER (gadataset_scanner_builder_get_type())

struct GADatasetScannerBuilderClass

struct GADatasetScannerBuilderClass {
  GObjectClass parent_class;
};

GADatasetScanner

typedef struct _GADatasetScanner GADatasetScanner;

GADatasetScannerBuilder

typedef struct _GADatasetScannerBuilder GADatasetScannerBuilder;

Property Details

The “scanner” property

  “scanner”                  gpointer

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

Owner: GADatasetScanner

Flags: Write / Construct Only

The “scanner-builder” property

  “scanner-builder”          gpointer

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

Owner: GADatasetScannerBuilder

Flags: Write / Construct Only

Generated by GTK-Doc V1.33.1