Scanner classes

Scanner classes

Functions

GADScanOptions * gad_scan_options_new ()
GArrowSchema * gad_scan_options_get_schema ()
GADScanOptions * gad_scan_task_get_options ()
GADFragment * gad_scan_task_get_fragment ()
GArrowRecordBatchIterator * gad_scan_task_execute ()
GADInMemoryScanTask * gad_in_memory_scan_task_new ()

Properties

gint64 batch-size Read / Write
gpointer scan-options Write / Construct Only
gboolean use-threads Read / Write
GADFragment * fragment Read / Write / Construct Only
GADScanOptions * options Read / Write / Construct Only
gpointer scan-task Write / Construct Only

Types and Values

#define GAD_TYPE_SCAN_OPTIONS
struct GADScanOptionsClass
#define GAD_TYPE_SCAN_TASK
struct GADScanTaskClass
#define GAD_TYPE_IN_MEMORY_SCAN_TASK
struct GADInMemoryScanTaskClass
  GADInMemoryScanTask
  GADScanOptions
  GADScanTask

Object Hierarchy

    GObject
    ├── GADScanOptions
    ╰── GADScanTask
        ├── GADInMemoryScanTask
        ╰── GADInMemoryScanTask

Includes

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

Description

GADScanOptions is a class for a set of scan options.

GADScanTask is an abstract class for a scan task.

GADInMemoryScanTask is a class for a scan task of record batches.

Functions

gad_scan_options_new ()

GADScanOptions *
gad_scan_options_new (GArrowSchema *schema);

Parameters

schema

A GArrowSchema.

  

Returns

A newly created GADScanOptions.

Since: 1.0.0

gad_scan_options_get_schema ()

GArrowSchema *
gad_scan_options_get_schema (GADScanOptions *scan_options);

Parameters

scan_options

A GADScanOptions.

  

Returns

A GArrowSchema.

[transfer full]

Since: 1.0.0

gad_scan_task_get_options ()

GADScanOptions *
gad_scan_task_get_options (GADScanTask *scan_task);

Parameters

scan_task

A GADScanTask.

  

Returns

A GADScanOptions.

[transfer full]

Since: 1.0.0

gad_scan_task_get_fragment ()

GADFragment *
gad_scan_task_get_fragment (GADScanTask *scan_task);

Parameters

scan_task

A GADFragment.

  

Returns

A GADFragment.

[transfer full]

Since: 4.0.0

gad_scan_task_execute ()

GArrowRecordBatchIterator *
gad_scan_task_execute (GADScanTask *scan_task,
                       GError **error);

Parameters

scan_task

A GADScanTask.

  

error

Return location for a GError or NULL.

[nullable]

Returns

A newly created GArrowRecordBatchIterator, or NULL on error.

[nullable][transfer full]

Since: 1.0.0

gad_in_memory_scan_task_new ()

GADInMemoryScanTask *
gad_in_memory_scan_task_new (GArrowRecordBatch **record_batches,
                             gsize n_record_batches,
                             GADScanOptions *options,
                             GADInMemoryFragment *fragment);

Parameters

record_batches

(element-type GArrowRecordBatch): The record batches of the table.

[array length=n_record_batches]

n_record_batches

The number of record batches.

  

options

A GADScanOptions.

  

fragment

A GADInMemoryFragment.

  

Returns

A newly created GADInMemoryScanTask.

Since: 1.0.0

Types and Values

GAD_TYPE_SCAN_OPTIONS

#define GAD_TYPE_SCAN_OPTIONS (gad_scan_options_get_type())

struct GADScanOptionsClass

struct GADScanOptionsClass {
  GObjectClass parent_class;
};

GAD_TYPE_SCAN_TASK

#define GAD_TYPE_SCAN_TASK (gad_scan_task_get_type())

struct GADScanTaskClass

struct GADScanTaskClass {
  GObjectClass parent_class;
};

GAD_TYPE_IN_MEMORY_SCAN_TASK

#define GAD_TYPE_IN_MEMORY_SCAN_TASK (gad_in_memory_scan_task_get_type())

struct GADInMemoryScanTaskClass

struct GADInMemoryScanTaskClass {
  GADScanTaskClass parent_class;
};

GADInMemoryScanTask

typedef struct _GADInMemoryScanTask GADInMemoryScanTask;

GADScanOptions

typedef struct _GADScanOptions GADScanOptions;

GADScanTask

typedef struct _GADScanTask GADScanTask;

Property Details

The “batch-size” property

  “batch-size”               gint64

Maximum row count for scanned batches.

Flags: Read / Write

Allowed values: >= 0

Default value: 1048576

Since: 1.0.0

The “scan-options” property

  “scan-options”             gpointer

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

Flags: Write / Construct Only

The “use-threads” property

  “use-threads”              gboolean

Indicate if the Scanner should make use of a ThreadPool.

Flags: Read / Write

Default value: FALSE

Since: 4.0.0

The “fragment” property

  “fragment”                 GADFragment *

The fragment of the scan task.

Flags: Read / Write / Construct Only

Since: 4.0.0

The “options” property

  “options”                  GADScanOptions *

The options of the scan task.

Flags: Read / Write / Construct Only

Since: 1.0.0

The “scan-task” property

  “scan-task”                gpointer

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

Flags: Write / Construct Only

Generated by GTK-Doc V1.28