Dataset factory related classes

Dataset factory related classes

Functions

Properties

gpointer dataset-factory Write / Construct Only
GArrowFileSystem * file-system Read
GADatasetFileFormat * format Read / Write / Construct Only
char * partition-base-dir Read / Write
GADatasetPartitioning * partitioning Read / Write
gpointer finish-options Write / Construct Only
int inspect-n-fragments Read / Write
GArrowSchema * schema Read / Write
gboolean validate-fragments Read / Write

Types and Values

Object Hierarchy

    GObject
    ├── GADatasetDatasetFactory
       ╰── GADatasetFileSystemDatasetFactory
    ╰── GADatasetFinishOptions

Includes

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

Description

GADatasetFinishOptions is a class for gadataset_factory_finish().

GADatasetDatasetFactory is a base class for dataset factories.

GADatasetFileSystemDatasetFactory is a class for GADatasetFileSystemDataset factory.

Functions

gadataset_finish_options_new ()

GADatasetFinishOptions *
gadataset_finish_options_new (void);

Returns

A newly created GADatasetDataset.

Since: 11.0.0

gadataset_dataset_factory_finish ()

GADatasetDataset *
gadataset_dataset_factory_finish (GADatasetDatasetFactory *factory,
                                  GADatasetFinishOptions *options,
                                  GError **error);

Parameters

factory

A GADatasetDatasetFactory.

 

options

A GADatasetFinishOptions.

[nullable]

error

Return location for a GError or NULL.

[nullable]

Returns

A newly created GADatasetDataset on success, NULL on error.

[transfer full][nullable]

Since: 5.0.0

gadataset_file_system_dataset_factory_new ()

GADatasetFileSystemDatasetFactory *
gadataset_file_system_dataset_factory_new
                               (GADatasetFileFormat *file_format);

gadataset_file_system_dataset_factory_set_file_system ()

gboolean
gadataset_file_system_dataset_factory_set_file_system
                               (GADatasetFileSystemDatasetFactory *factory,
                                GArrowFileSystem *file_system,
                                GError **error);

Parameters

factory

A GADatasetFileSystemDatasetFactory.

 

file_system

A GArrowFileSystem.

 

error

Return location for a GError or NULL.

[nullable]

Returns

TRUE on success, FALSE otherwise.

Since: 5.0.0

gadataset_file_system_dataset_factory_set_file_system_uri ()

gboolean
gadataset_file_system_dataset_factory_set_file_system_uri
                               (GADatasetFileSystemDatasetFactory *factory,
                                const gchar *uri,
                                GError **error);

Parameters

factory

A GADatasetFileSystemDatasetFactory.

 

uri

An URI for file system.

 

error

Return location for a GError or NULL.

[nullable]

Returns

TRUE on success, FALSE otherwise.

Since: 5.0.0

gadataset_file_system_dataset_factory_add_path ()

gboolean
gadataset_file_system_dataset_factory_add_path
                               (GADatasetFileSystemDatasetFactory *factory,
                                const gchar *path,
                                GError **error);

Parameters

factory

A GADatasetFileSystemDatasetFactory.

 

path

A path to be added.

 

error

Return location for a GError or NULL.

[nullable]

Returns

TRUE on success, FALSE otherwise.

Since: 5.0.0

gadataset_file_system_dataset_factory_finish ()

GADatasetFileSystemDataset *
gadataset_file_system_dataset_factory_finish
                               (GADatasetFileSystemDatasetFactory *factory,
                                GADatasetFinishOptions *options,
                                GError **error);

Parameters

factory

A GADatasetFileSystemDatasetFactory.

 

options

A GADatasetFinishOptions.

[nullable]

error

Return location for a GError or NULL.

[nullable]

Returns

A newly created GADatasetFileSystemDataset on success, NULL on error.

[transfer full][nullable]

Since: 5.0.0

Types and Values

GADATASET_TYPE_FINISH_OPTIONS

#define GADATASET_TYPE_FINISH_OPTIONS (gadataset_finish_options_get_type())

struct GADatasetFinishOptionsClass

struct GADatasetFinishOptionsClass {
  GObjectClass parent_class;
};

GADATASET_TYPE_DATASET_FACTORY

#define GADATASET_TYPE_DATASET_FACTORY (gadataset_dataset_factory_get_type())

struct GADatasetDatasetFactoryClass

struct GADatasetDatasetFactoryClass {
  GObjectClass parent_class;
};

GADATASET_TYPE_FILE_SYSTEM_DATASET_FACTORY

#define             GADATASET_TYPE_FILE_SYSTEM_DATASET_FACTORY

struct GADatasetFileSystemDatasetFactoryClass

struct GADatasetFileSystemDatasetFactoryClass {
  GADatasetDatasetFactoryClass parent_class;
};

GADatasetDatasetFactory

typedef struct _GADatasetDatasetFactory GADatasetDatasetFactory;

GADatasetFileSystemDatasetFactory

typedef struct _GADatasetFileSystemDatasetFactory GADatasetFileSystemDatasetFactory;

GADatasetFinishOptions

typedef struct _GADatasetFinishOptions GADatasetFinishOptions;

Property Details

The “dataset-factory” property

  “dataset-factory”          gpointer

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

Owner: GADatasetDatasetFactory

Flags: Write / Construct Only

The “file-system” property

  “file-system”              GArrowFileSystem *

File system passed to GADatasetFileSystemDataset.

Owner: GADatasetFileSystemDatasetFactory

Flags: Read

Since: 5.0.0

The “format” property

  “format”                   GADatasetFileFormat *

Format passed to GADatasetFileSystemDataset.

Owner: GADatasetFileSystemDatasetFactory

Flags: Read / Write / Construct Only

Since: 5.0.0

The “partition-base-dir” property

  “partition-base-dir”       char *

Partition base directory used by GADatasetFileSystemDataset.

Owner: GADatasetFileSystemDatasetFactory

Flags: Read / Write

Default value: NULL

Since: 6.0.0

The “partitioning” property

  “partitioning”             GADatasetPartitioning *

Partitioning used by GADatasetFileSystemDataset.

Owner: GADatasetFileSystemDatasetFactory

Flags: Read / Write

Since: 6.0.0

The “finish-options” property

  “finish-options”           gpointer

The raw arrow::dataset::FinishOptions *.

Owner: GADatasetFinishOptions

Flags: Write / Construct Only

The “inspect-n-fragments” property

  “inspect-n-fragments”      int

The number of fragments to be used to inspect schema.

Owner: GADatasetFinishOptions

Flags: Read / Write

Allowed values: >= -1

Default value: 1

Since: 11.0.0

The “schema” property

  “schema”                   GArrowSchema *

The schema to finalize the dataset's schema.

Owner: GADatasetFinishOptions

Flags: Read / Write

Since: 11.0.0

The “validate-fragments” property

  “validate-fragments”       gboolean

Whether validate fragments against the given schema or not.

Owner: GADatasetFinishOptions

Flags: Read / Write

Default value: FALSE

Since: 11.0.0