Scalar classes

Scalar classes

Functions

GArrowScalar * garrow_scalar_parse ()
GArrowDataType * garrow_scalar_get_data_type ()
gboolean garrow_scalar_is_valid ()
gboolean garrow_scalar_equal ()
gboolean garrow_scalar_equal_options ()
gchar * garrow_scalar_to_string ()
GArrowScalar * garrow_scalar_cast ()
GArrowNullScalar * garrow_null_scalar_new ()
GArrowBooleanScalar * garrow_boolean_scalar_new ()
gboolean garrow_boolean_scalar_get_value ()
GArrowInt8Scalar * garrow_int8_scalar_new ()
gint8 garrow_int8_scalar_get_value ()
GArrowInt16Scalar * garrow_int16_scalar_new ()
gint16 garrow_int16_scalar_get_value ()
GArrowInt32Scalar * garrow_int32_scalar_new ()
gint32 garrow_int32_scalar_get_value ()
GArrowInt64Scalar * garrow_int64_scalar_new ()
gint64 garrow_int64_scalar_get_value ()
GArrowUInt8Scalar * garrow_uint8_scalar_new ()
guint8 garrow_uint8_scalar_get_value ()
GArrowUInt16Scalar * garrow_uint16_scalar_new ()
guint16 garrow_uint16_scalar_get_value ()
GArrowUInt32Scalar * garrow_uint32_scalar_new ()
guint32 garrow_uint32_scalar_get_value ()
GArrowUInt64Scalar * garrow_uint64_scalar_new ()
guint64 garrow_uint64_scalar_get_value ()
GArrowFloatScalar * garrow_float_scalar_new ()
gfloat garrow_float_scalar_get_value ()
GArrowDoubleScalar * garrow_double_scalar_new ()
gdouble garrow_double_scalar_get_value ()
GArrowBuffer * garrow_base_binary_scalar_get_value ()
GArrowBinaryScalar * garrow_binary_scalar_new ()
GArrowStringScalar * garrow_string_scalar_new ()
GArrowLargeBinaryScalar * garrow_large_binary_scalar_new ()
GArrowLargeStringScalar * garrow_large_string_scalar_new ()
GArrowFixedSizeBinaryScalar * garrow_fixed_size_binary_scalar_new ()
GArrowDate32Scalar * garrow_date32_scalar_new ()
gint32 garrow_date32_scalar_get_value ()
GArrowDate64Scalar * garrow_date64_scalar_new ()
gint64 garrow_date64_scalar_get_value ()
GArrowTime32Scalar * garrow_time32_scalar_new ()
gint32 garrow_time32_scalar_get_value ()
GArrowTime64Scalar * garrow_time64_scalar_new ()
gint64 garrow_time64_scalar_get_value ()
GArrowTimestampScalar * garrow_timestamp_scalar_new ()
gint64 garrow_timestamp_scalar_get_value ()
GArrowDecimal128Scalar * garrow_decimal128_scalar_new ()
GArrowDecimal128 * garrow_decimal128_scalar_get_value ()
GArrowDecimal256Scalar * garrow_decimal256_scalar_new ()
GArrowDecimal256 * garrow_decimal256_scalar_get_value ()
GArrowArray * garrow_base_list_scalar_get_value ()
GArrowListScalar * garrow_list_scalar_new ()
GArrowLargeListScalar * garrow_large_list_scalar_new ()
GArrowMapScalar * garrow_map_scalar_new ()
GArrowStructScalar * garrow_struct_scalar_new ()
GList * garrow_struct_scalar_get_value ()
gint8 garrow_union_scalar_get_type_code ()
GArrowScalar * garrow_union_scalar_get_value ()
GArrowSparseUnionScalar * garrow_sparse_union_scalar_new ()
GArrowDenseUnionScalar * garrow_dense_union_scalar_new ()

Properties

GArrowBuffer * value Write / Construct Only
GArrowArray * value Write / Construct Only
gboolean allow-decimal-truncate Read / Write
gboolean allow-float-truncate Read / Write
gboolean allow-int-overflow Read / Write
gboolean allow-invalid-utf8 Read / Write
gboolean allow-time-overflow Read / Write
gboolean allow-time-truncate Read / Write
GArrowDataType * to-data-type Read / Write
GArrowDecimal128 * value Write / Construct Only
GArrowDecimal256 * value Write / Construct Only
GArrowDataType * data-type Write / Construct Only
gpointer scalar Write / Construct Only
GArrowScalar * value Write / Construct Only

Types and Values

#define GARROW_TYPE_SCALAR
struct GArrowScalarClass
#define GARROW_TYPE_NULL_SCALAR
struct GArrowNullScalarClass
#define GARROW_TYPE_BOOLEAN_SCALAR
struct GArrowBooleanScalarClass
#define GARROW_TYPE_INT8_SCALAR
struct GArrowInt8ScalarClass
#define GARROW_TYPE_INT16_SCALAR
struct GArrowInt16ScalarClass
#define GARROW_TYPE_INT32_SCALAR
struct GArrowInt32ScalarClass
#define GARROW_TYPE_INT64_SCALAR
struct GArrowInt64ScalarClass
#define GARROW_TYPE_UINT8_SCALAR
struct GArrowUInt8ScalarClass
#define GARROW_TYPE_UINT16_SCALAR
struct GArrowUInt16ScalarClass
#define GARROW_TYPE_UINT32_SCALAR
struct GArrowUInt32ScalarClass
#define GARROW_TYPE_UINT64_SCALAR
struct GArrowUInt64ScalarClass
#define GARROW_TYPE_FLOAT_SCALAR
struct GArrowFloatScalarClass
#define GARROW_TYPE_DOUBLE_SCALAR
struct GArrowDoubleScalarClass
#define GARROW_TYPE_BASE_BINARY_SCALAR
struct GArrowBaseBinaryScalarClass
#define GARROW_TYPE_BINARY_SCALAR
struct GArrowBinaryScalarClass
#define GARROW_TYPE_STRING_SCALAR
struct GArrowStringScalarClass
#define GARROW_TYPE_LARGE_BINARY_SCALAR
struct GArrowLargeBinaryScalarClass
#define GARROW_TYPE_LARGE_STRING_SCALAR
struct GArrowLargeStringScalarClass
#define GARROW_TYPE_FIXED_SIZE_BINARY_SCALAR
struct GArrowFixedSizeBinaryScalarClass
#define GARROW_TYPE_DATE32_SCALAR
struct GArrowDate32ScalarClass
#define GARROW_TYPE_DATE64_SCALAR
struct GArrowDate64ScalarClass
#define GARROW_TYPE_TIME32_SCALAR
struct GArrowTime32ScalarClass
#define GARROW_TYPE_TIME64_SCALAR
struct GArrowTime64ScalarClass
#define GARROW_TYPE_TIMESTAMP_SCALAR
struct GArrowTimestampScalarClass
#define GARROW_TYPE_DECIMAL128_SCALAR
struct GArrowDecimal128ScalarClass
#define GARROW_TYPE_DECIMAL256_SCALAR
struct GArrowDecimal256ScalarClass
#define GARROW_TYPE_BASE_LIST_SCALAR
struct GArrowBaseListScalarClass
#define GARROW_TYPE_LIST_SCALAR
struct GArrowListScalarClass
#define GARROW_TYPE_LARGE_LIST_SCALAR
struct GArrowLargeListScalarClass
#define GARROW_TYPE_MAP_SCALAR
struct GArrowMapScalarClass
#define GARROW_TYPE_STRUCT_SCALAR
struct GArrowStructScalarClass
#define GARROW_TYPE_UNION_SCALAR
struct GArrowUnionScalarClass
#define GARROW_TYPE_SPARSE_UNION_SCALAR
struct GArrowSparseUnionScalarClass
#define GARROW_TYPE_DENSE_UNION_SCALAR
struct GArrowDenseUnionScalarClass
#define GARROW_TYPE_EXTENSION_SCALAR
struct GArrowExtensionScalarClass
  GArrowBaseBinaryScalar
  GArrowBaseListScalar
  GArrowBinaryScalar
  GArrowBooleanScalar
  GArrowCastOptions
  GArrowDate32Scalar
  GArrowDate64Scalar
  GArrowDecimal128Scalar
  GArrowDecimal256Scalar
  GArrowDenseUnionScalar
  GArrowDoubleScalar
  GArrowExtensionScalar
  GArrowFixedSizeBinaryScalar
  GArrowFloatScalar
  GArrowInt16Scalar
  GArrowInt32Scalar
  GArrowInt64Scalar
  GArrowInt8Scalar
  GArrowLargeBinaryScalar
  GArrowLargeListScalar
  GArrowLargeStringScalar
  GArrowListScalar
  GArrowMapScalar
  GArrowNullScalar
  GArrowScalar
  GArrowSparseUnionScalar
  GArrowStringScalar
  GArrowStructScalar
  GArrowTime32Scalar
  GArrowTime64Scalar
  GArrowTimestampScalar
  GArrowUInt16Scalar
  GArrowUInt32Scalar
  GArrowUInt64Scalar
  GArrowUInt8Scalar
  GArrowUnionScalar

Object Hierarchy

    GObject
    ├── GArrowFunctionOptions
       ╰── GArrowCastOptions
    ╰── GArrowScalar
        ├── GArrowBaseBinaryScalar
        ├── GArrowBaseListScalar
        ├── GArrowBooleanScalar
        ├── GArrowDate32Scalar
        ├── GArrowDate64Scalar
        ├── GArrowDecimal128Scalar
        ├── GArrowDecimal256Scalar
        ├── GArrowUnionScalar
           ├── GArrowDenseUnionScalar
           ├── GArrowSparseUnionScalar
           ╰── GArrowSparseUnionScalar
        ├── GArrowDoubleScalar
        ├── GArrowExtensionScalar
        ├── GArrowFloatScalar
        ├── GArrowInt16Scalar
        ├── GArrowInt32Scalar
        ├── GArrowInt64Scalar
        ├── GArrowInt8Scalar
        ├── GArrowNullScalar
        ├── GArrowStructScalar
        ├── GArrowTime32Scalar
        ├── GArrowTime64Scalar
        ├── GArrowTimestampScalar
        ├── GArrowUInt16Scalar
        ├── GArrowUInt32Scalar
        ├── GArrowUInt64Scalar
        ├── GArrowUInt8Scalar
        ├── GArrowDoubleScalar
        ├── GArrowExtensionScalar
        ├── GArrowFloatScalar
        ├── GArrowInt16Scalar
        ├── GArrowInt32Scalar
        ├── GArrowInt64Scalar
        ├── GArrowInt8Scalar
        ├── GArrowNullScalar
        ├── GArrowUnionScalar
           ╰── GArrowDenseUnionScalar
        ├── GArrowBaseBinaryScalar
           ├── GArrowBinaryScalar
           ├── GArrowFixedSizeBinaryScalar
           ├── GArrowLargeBinaryScalar
           ├── GArrowLargeStringScalar
           ╰── GArrowStringScalar
        ├── GArrowBaseListScalar
           ├── GArrowLargeListScalar
           ├── GArrowListScalar
           ╰── GArrowMapScalar
        ├── GArrowBooleanScalar
        ├── GArrowDate32Scalar
        ├── GArrowDate64Scalar
        ├── GArrowDecimal128Scalar
        ╰── GArrowDecimal256Scalar

Includes

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

Description

GArrowScalar is a base class for all scalar classes such as GArrowBooleanScalar.

GArrowNullScalar is a class for a null scalar.

GArrowBooleanScalar is a class for a boolean scalar.

GArrowInt8Scalar is a class for a 8-bit integer scalar.

GArrowInt16Scalar is a class for a 16-bit integer scalar.

GArrowInt32Scalar is a class for a 32-bit integer scalar.

GArrowInt64Scalar is a class for a 64-bit integer scalar.

GArrowUInt8Scalar is a class for a 8-bit unsigned integer scalar.

GArrowUInt16Scalar is a class for a 16-bit unsigned integer scalar.

GArrowUInt32Scalar is a class for a 32-bit unsigned integer scalar.

GArrowUInt64Scalar is a class for a 64-bit unsigned integer scalar.

GArrowFloatScalar is a class for a 32-bit floating point scalar.

GArrowDoubleScalar is a class for a 64-bit floating point scalar.

GArrowBaseBinaryScalar is a base class for all binary and string scalar classes such as GArrowBinaryScalar.

GArrowBinaryScalar is a class for a binary scalar.

GArrowStringScalar is a class for an UTF-8 encoded string scalar.

GArrowLargeBinaryScalar is a class for a 64-bit offsets binary scalar.

GArrowLargeStringScalar is a class for a 64-bit offsets UTF-8 encoded string scalar.

GArrowFixedSizeBinaryScalar is a class for a fixed-size binary scalar.

GArrowDate32Scalar is a class for the number of days since UNIX epoch in a 32-bit signed integer scalar.

GArrowDate64Scalar is a class for the number of milliseconds since UNIX epoch in a 64-bit signed integer scalar.

GArrowTime32Scalar is a class for the number of seconds or milliseconds since midnight in a 32-bit signed integer scalar.

GArrowTime64Scalar is a class for the number of microseconds or nanoseconds since midnight in a 64-bit signed integer scalar.

GArrowTimestampScalar is a class for the number of seconds/milliseconds/microseconds/nanoseconds since UNIX epoch in a 64-bit signed integer scalar.

GArrowDecimal128Scalar is a class for a 128-bit decimal scalar.

GArrowDecimal256Scalar is a class for a 256-bit decimal scalar.

GArrowBaseListScalar is a base class for all list scalar classes such as GArrowListScalar.

GArrowListScalar is a class for a list scalar.

GArrowLargeListScalar is a class for a large list scalar.

GArrowMapScalar is a class for a map list scalar.

GArrowStructScalar is a class for a struct list scalar.

GArrowUnionScalar is a base class for all union scalar classes such as GArrowSparseUnionScalar.

GArrowSparseUnionScalar is a class for a sparse union scalar.

GArrowDenseUnionScalar is a class for a dense union scalar.

GArrowExtensionScalar is a base class for user-defined extension scalar.

Functions

garrow_scalar_parse ()

GArrowScalar *
garrow_scalar_parse (GArrowDataType *data_type,
                     const guint8 *data,
                     gsize size,
                     GError **error);

Parameters

data_type

A GArrowDataType for the parsed scalar.

 

data

Data to be parsed.

[array length=size]

size

The number of bytes of the data.

 

error

Return location for a GError or NULL.

[nullable]

Returns

A newly created GArrowScalar if the data is parsed successfully, NULL otherwise.

[nullable][transfer full]

Since: 5.0.0


garrow_scalar_get_data_type ()

GArrowDataType *
garrow_scalar_get_data_type (GArrowScalar *scalar);

Parameters

scalar

A GArrowScalar.

 

Returns

The GArrowDataType for the scalar.

[transfer none]

Since: 5.0.0


garrow_scalar_is_valid ()

gboolean
garrow_scalar_is_valid (GArrowScalar *scalar);

Parameters

scalar

A GArrowScalar.

 

Returns

TRUE if the scalar is valid, FALSE otherwise.

Since: 5.0.0


garrow_scalar_equal ()

gboolean
garrow_scalar_equal (GArrowScalar *scalar,
                     GArrowScalar *other_scalar);

Parameters

scalar

A GArrowScalar.

 

other_scalar

A GArrowScalar to be compared.

 

Returns

TRUE if both of them have the same data, FALSE otherwise.

Since: 5.0.0


garrow_scalar_equal_options ()

gboolean
garrow_scalar_equal_options (GArrowScalar *scalar,
                             GArrowScalar *other_scalar,
                             GArrowEqualOptions *options);

Parameters

scalar

A GArrowScalar.

 

other_scalar

A GArrowScalar to be compared.

 

options

A GArrowEqualOptions.

[nullable]

Returns

TRUE if both of them have the same data, FALSE otherwise.

Since: 5.0.0


garrow_scalar_to_string ()

gchar *
garrow_scalar_to_string (GArrowScalar *scalar);

Parameters

scalar

A GArrowScalar.

 

Returns

The string representation of the scalar.

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

Since: 5.0.0


garrow_scalar_cast ()

GArrowScalar *
garrow_scalar_cast (GArrowScalar *scalar,
                    GArrowDataType *data_type,
                    GArrowCastOptions *options,
                    GError **error);

Parameters

scalar

A GArrowScalar.

 

data_type

A GArrowDataType of the casted scalar.

 

options

A GArrowCastOptions.

[nullable]

error

Return location for a GError or NULL.

[nullable]

Returns

A newly created casted scalar on success, NULL on error.

[nullable][transfer full]

Since: 5.0.0


garrow_null_scalar_new ()

GArrowNullScalar *
garrow_null_scalar_new (void);

Returns

A newly created GArrowNullScalar.

Since: 5.0.0


garrow_boolean_scalar_new ()

GArrowBooleanScalar *
garrow_boolean_scalar_new (gboolean value);

Parameters

value

The value of this scalar.

 

Returns

A newly created GArrowBooleanScalar.

Since: 5.0.0


garrow_boolean_scalar_get_value ()

gboolean
garrow_boolean_scalar_get_value (GArrowBooleanScalar *scalar);

Parameters

scalar

A GArrowBooleanScalar.

 

Returns

The value of this scalar.

Since: 5.0.0


garrow_int8_scalar_new ()

GArrowInt8Scalar *
garrow_int8_scalar_new (gint8 value);

Parameters

value

The value of this scalar.

 

Returns

A newly created GArrowInt8Scalar.

Since: 5.0.0


garrow_int8_scalar_get_value ()

gint8
garrow_int8_scalar_get_value (GArrowInt8Scalar *scalar);

Parameters

scalar

A GArrowInt8Scalar.

 

Returns

The value of this scalar.

Since: 5.0.0


garrow_int16_scalar_new ()

GArrowInt16Scalar *
garrow_int16_scalar_new (gint16 value);

Parameters

value

The value of this scalar.

 

Returns

A newly created GArrowInt16Scalar.

Since: 5.0.0


garrow_int16_scalar_get_value ()

gint16
garrow_int16_scalar_get_value (GArrowInt16Scalar *scalar);

Parameters

scalar

A GArrowInt16Scalar.

 

Returns

The value of this scalar.

Since: 5.0.0


garrow_int32_scalar_new ()

GArrowInt32Scalar *
garrow_int32_scalar_new (gint32 value);

Parameters

value

The value of this scalar.

 

Returns

A newly created GArrowInt32Scalar.

Since: 5.0.0


garrow_int32_scalar_get_value ()

gint32
garrow_int32_scalar_get_value (GArrowInt32Scalar *scalar);

Parameters

scalar

A GArrowInt32Scalar.

 

Returns

The value of this scalar.

Since: 5.0.0


garrow_int64_scalar_new ()

GArrowInt64Scalar *
garrow_int64_scalar_new (gint64 value);

Parameters

value

The value of this scalar.

 

Returns

A newly created GArrowInt64Scalar.

Since: 5.0.0


garrow_int64_scalar_get_value ()

gint64
garrow_int64_scalar_get_value (GArrowInt64Scalar *scalar);

Parameters

scalar

A GArrowInt64Scalar.

 

Returns

The value of this scalar.

Since: 5.0.0


garrow_uint8_scalar_new ()

GArrowUInt8Scalar *
garrow_uint8_scalar_new (guint8 value);

Parameters

value

The value of this scalar.

 

Returns

A newly created GArrowUInt8Scalar.

Since: 5.0.0


garrow_uint8_scalar_get_value ()

guint8
garrow_uint8_scalar_get_value (GArrowUInt8Scalar *scalar);

Parameters

scalar

A GArrowUInt8Scalar.

 

Returns

The value of this scalar.

Since: 5.0.0


garrow_uint16_scalar_new ()

GArrowUInt16Scalar *
garrow_uint16_scalar_new (guint16 value);

Parameters

value

The value of this scalar.

 

Returns

A newly created GArrowUInt16Scalar.

Since: 5.0.0


garrow_uint16_scalar_get_value ()

guint16
garrow_uint16_scalar_get_value (GArrowUInt16Scalar *scalar);

Parameters

scalar

A GArrowUInt16Scalar.

 

Returns

The value of this scalar.

Since: 5.0.0


garrow_uint32_scalar_new ()

GArrowUInt32Scalar *
garrow_uint32_scalar_new (guint32 value);

Parameters

value

The value of this scalar.

 

Returns

A newly created GArrowUInt32Scalar.

Since: 5.0.0


garrow_uint32_scalar_get_value ()

guint32
garrow_uint32_scalar_get_value (GArrowUInt32Scalar *scalar);

Parameters

scalar

A GArrowUInt32Scalar.

 

Returns

The value of this scalar.

Since: 5.0.0


garrow_uint64_scalar_new ()

GArrowUInt64Scalar *
garrow_uint64_scalar_new (guint64 value);

Parameters

value

The value of this scalar.

 

Returns

A newly created GArrowUInt64Scalar.

Since: 5.0.0


garrow_uint64_scalar_get_value ()

guint64
garrow_uint64_scalar_get_value (GArrowUInt64Scalar *scalar);

Parameters

scalar

A GArrowUInt64Scalar.

 

Returns

The value of this scalar.

Since: 5.0.0


garrow_float_scalar_new ()

GArrowFloatScalar *
garrow_float_scalar_new (gfloat value);

Parameters

value

The value of this scalar.

 

Returns

A newly created GArrowFloatScalar.

Since: 5.0.0


garrow_float_scalar_get_value ()

gfloat
garrow_float_scalar_get_value (GArrowFloatScalar *scalar);

Parameters

scalar

A GArrowFloatScalar.

 

Returns

The value of this scalar.

Since: 5.0.0


garrow_double_scalar_new ()

GArrowDoubleScalar *
garrow_double_scalar_new (gdouble value);

Parameters

value

The value of this scalar.

 

Returns

A newly created GArrowDoubleScalar.

Since: 5.0.0


garrow_double_scalar_get_value ()

gdouble
garrow_double_scalar_get_value (GArrowDoubleScalar *scalar);

Parameters

scalar

A GArrowDoubleScalar.

 

Returns

The value of this scalar.

Since: 5.0.0


garrow_base_binary_scalar_get_value ()

GArrowBuffer *
garrow_base_binary_scalar_get_value (GArrowBaseBinaryScalar *scalar);

Parameters

scalar

A GArrowBaseBinaryScalar.

 

Returns

The value of this scalar.

[transfer none]

Since: 5.0.0


garrow_binary_scalar_new ()

GArrowBinaryScalar *
garrow_binary_scalar_new (GArrowBuffer *value);

Parameters

value

The value of this scalar.

 

Returns

A newly created GArrowBinaryScalar.

Since: 5.0.0


garrow_string_scalar_new ()

GArrowStringScalar *
garrow_string_scalar_new (GArrowBuffer *value);

Parameters

value

The value of this scalar.

 

Returns

A newly created GArrowStringScalar.

Since: 5.0.0


garrow_large_binary_scalar_new ()

GArrowLargeBinaryScalar *
garrow_large_binary_scalar_new (GArrowBuffer *value);

Parameters

value

The value of this scalar.

 

Returns

A newly created GArrowLargeBinaryScalar.

Since: 5.0.0


garrow_large_string_scalar_new ()

GArrowLargeStringScalar *
garrow_large_string_scalar_new (GArrowBuffer *value);

Parameters

value

The value of this scalar.

 

Returns

A newly created GArrowLargeStringScalar.

Since: 5.0.0


garrow_fixed_size_binary_scalar_new ()

GArrowFixedSizeBinaryScalar *
garrow_fixed_size_binary_scalar_new (GArrowFixedSizeBinaryDataType *data_type,
                                     GArrowBuffer *value);

Parameters

data_type

A GArrowFixedSizeBinaryDataType for this scalar.

 

value

The value of this scalar.

 

Returns

A newly created GArrowFixedSizeBinaryScalar.

Since: 5.0.0


garrow_date32_scalar_new ()

GArrowDate32Scalar *
garrow_date32_scalar_new (gint32 value);

Parameters

value

The value of this scalar.

 

Returns

A newly created GArrowDate32Scalar.

Since: 5.0.0


garrow_date32_scalar_get_value ()

gint32
garrow_date32_scalar_get_value (GArrowDate32Scalar *scalar);

Parameters

scalar

A GArrowDate32Scalar.

 

Returns

The value of this scalar.

Since: 5.0.0


garrow_date64_scalar_new ()

GArrowDate64Scalar *
garrow_date64_scalar_new (gint64 value);

Parameters

value

The value of this scalar.

 

Returns

A newly created GArrowDate64Scalar.

Since: 5.0.0


garrow_date64_scalar_get_value ()

gint64
garrow_date64_scalar_get_value (GArrowDate64Scalar *scalar);

Parameters

scalar

A GArrowDate64Scalar.

 

Returns

The value of this scalar.

Since: 5.0.0


garrow_time32_scalar_new ()

GArrowTime32Scalar *
garrow_time32_scalar_new (GArrowTime32DataType *data_type,
                          gint32 value);

Parameters

data_type

A GArrowTime32DataType for this scalar.

 

value

The value of this scalar.

 

Returns

A newly created GArrowTime32Scalar.

Since: 5.0.0


garrow_time32_scalar_get_value ()

gint32
garrow_time32_scalar_get_value (GArrowTime32Scalar *scalar);

Parameters

scalar

A GArrowTime32Scalar.

 

Returns

The value of this scalar.

Since: 5.0.0


garrow_time64_scalar_new ()

GArrowTime64Scalar *
garrow_time64_scalar_new (GArrowTime64DataType *data_type,
                          gint64 value);

Parameters

data_type

A GArrowTime64DataType for this scalar.

 

value

The value of this scalar.

 

Returns

A newly created GArrowTime64Scalar.

Since: 5.0.0


garrow_time64_scalar_get_value ()

gint64
garrow_time64_scalar_get_value (GArrowTime64Scalar *scalar);

Parameters

scalar

A GArrowTime64Scalar.

 

Returns

The value of this scalar.

Since: 5.0.0


garrow_timestamp_scalar_new ()

GArrowTimestampScalar *
garrow_timestamp_scalar_new (GArrowTimestampDataType *data_type,
                             gint64 value);

Parameters

data_type

A GArrowTimestampDataType for this scalar.

 

value

The value of this scalar.

 

Returns

A newly created GArrowTimestampScalar.

Since: 5.0.0


garrow_timestamp_scalar_get_value ()

gint64
garrow_timestamp_scalar_get_value (GArrowTimestampScalar *scalar);

Parameters

scalar

A GArrowTimestampScalar.

 

Returns

The value of this scalar.

Since: 5.0.0


garrow_decimal128_scalar_new ()

GArrowDecimal128Scalar *
garrow_decimal128_scalar_new (GArrowDecimal128DataType *data_type,
                              GArrowDecimal128 *value);

Parameters

data_type

A GArrowDecimal128DataType for this scalar.

 

value

The value of this scalar.

 

Returns

A newly created GArrowDecimal128Scalar.

Since: 5.0.0


garrow_decimal128_scalar_get_value ()

GArrowDecimal128 *
garrow_decimal128_scalar_get_value (GArrowDecimal128Scalar *scalar);

Parameters

scalar

A GArrowDecimal128Scalar.

 

Returns

The value of this scalar.

[transfer none]

Since: 5.0.0


garrow_decimal256_scalar_new ()

GArrowDecimal256Scalar *
garrow_decimal256_scalar_new (GArrowDecimal256DataType *data_type,
                              GArrowDecimal256 *value);

Parameters

data_type

A GArrowDecimal256DataType for this scalar.

 

value

The value of this scalar.

 

Returns

A newly created GArrowDecimal256Scalar.

Since: 5.0.0


garrow_decimal256_scalar_get_value ()

GArrowDecimal256 *
garrow_decimal256_scalar_get_value (GArrowDecimal256Scalar *scalar);

Parameters

scalar

A GArrowDecimal256Scalar.

 

Returns

The value of this scalar.

[transfer none]

Since: 5.0.0


garrow_base_list_scalar_get_value ()

GArrowArray *
garrow_base_list_scalar_get_value (GArrowBaseListScalar *scalar);

Parameters

scalar

A GArrowBaseListScalar.

 

Returns

The value of this scalar.

[transfer none]

Since: 5.0.0


garrow_list_scalar_new ()

GArrowListScalar *
garrow_list_scalar_new (GArrowListArray *value);

Parameters

value

The value of this scalar.

 

Returns

A newly created GArrowListScalar.

Since: 5.0.0


garrow_large_list_scalar_new ()

GArrowLargeListScalar *
garrow_large_list_scalar_new (GArrowLargeListArray *value);

Parameters

value

The value of this scalar.

 

Returns

A newly created GArrowLargeListScalar.

Since: 5.0.0


garrow_map_scalar_new ()

GArrowMapScalar *
garrow_map_scalar_new (GArrowStructArray *value);

Parameters

value

The value of this scalar.

 

Returns

A newly created GArrowMapScalar.

Since: 5.0.0


garrow_struct_scalar_new ()

GArrowStructScalar *
garrow_struct_scalar_new (GArrowStructDataType *data_type,
                          GList *value);

Parameters

data_type

A GArrowStructDataType for this scalar.

 

value

The value of this scalar.

[element-type GArrowScalar]

Returns

A newly created GArrowDecimal256Scalar.

Since: 5.0.0


garrow_struct_scalar_get_value ()

GList *
garrow_struct_scalar_get_value (GArrowStructScalar *scalar);

Parameters

scalar

A GArrowStructScalar.

 

Returns

The value of this scalar.

[element-type GArrowScalar][transfer none]

Since: 5.0.0


garrow_union_scalar_get_type_code ()

gint8
garrow_union_scalar_get_type_code (GArrowUnionScalar *scalar);

Parameters

scalar

A GArrowUnionScalar.

 

Returns

The type code of this scalar.

Since: 6.0.0


garrow_union_scalar_get_value ()

GArrowScalar *
garrow_union_scalar_get_value (GArrowUnionScalar *scalar);

Parameters

scalar

A GArrowUnionScalar.

 

Returns

The value of this scalar.

[transfer none]

Since: 5.0.0


garrow_sparse_union_scalar_new ()

GArrowSparseUnionScalar *
garrow_sparse_union_scalar_new (GArrowSparseUnionDataType *data_type,
                                gint8 type_code,
                                GArrowScalar *value);

Parameters

data_type

A GArrowSparseUnionDataType for this scalar.

 

type_code

The type code of this scalar.

 

value

The value of this scalar.

 

Returns

A newly created GArrowSparseUnionScalar.

Since: 5.0.0


garrow_dense_union_scalar_new ()

GArrowDenseUnionScalar *
garrow_dense_union_scalar_new (GArrowDenseUnionDataType *data_type,
                               gint8 type_code,
                               GArrowScalar *value);

Parameters

data_type

A GArrowDenseUnionDataType for this scalar.

 

type_code

The type code of this scalar.

 

value

The value of this scalar.

 

Returns

A newly created GArrowDenseUnionScalar.

Since: 5.0.0

Types and Values

GARROW_TYPE_SCALAR

#define GARROW_TYPE_SCALAR (garrow_scalar_get_type())

struct GArrowScalarClass

struct GArrowScalarClass {
  GObjectClass parent_class;
};

GARROW_TYPE_NULL_SCALAR

#define GARROW_TYPE_NULL_SCALAR (garrow_null_scalar_get_type())

struct GArrowNullScalarClass

struct GArrowNullScalarClass {
  GArrowScalarClass parent_class;
};

GARROW_TYPE_BOOLEAN_SCALAR

#define GARROW_TYPE_BOOLEAN_SCALAR (garrow_boolean_scalar_get_type())

struct GArrowBooleanScalarClass

struct GArrowBooleanScalarClass {
  GArrowScalarClass parent_class;
};

GARROW_TYPE_INT8_SCALAR

#define GARROW_TYPE_INT8_SCALAR (garrow_int8_scalar_get_type())

struct GArrowInt8ScalarClass

struct GArrowInt8ScalarClass {
  GArrowScalarClass parent_class;
};

GARROW_TYPE_INT16_SCALAR

#define GARROW_TYPE_INT16_SCALAR (garrow_int16_scalar_get_type())

struct GArrowInt16ScalarClass

struct GArrowInt16ScalarClass {
  GArrowScalarClass parent_class;
};

GARROW_TYPE_INT32_SCALAR

#define GARROW_TYPE_INT32_SCALAR (garrow_int32_scalar_get_type())

struct GArrowInt32ScalarClass

struct GArrowInt32ScalarClass {
  GArrowScalarClass parent_class;
};

GARROW_TYPE_INT64_SCALAR

#define GARROW_TYPE_INT64_SCALAR (garrow_int64_scalar_get_type())

struct GArrowInt64ScalarClass

struct GArrowInt64ScalarClass {
  GArrowScalarClass parent_class;
};

GARROW_TYPE_UINT8_SCALAR

#define GARROW_TYPE_UINT8_SCALAR (garrow_uint8_scalar_get_type())

struct GArrowUInt8ScalarClass

struct GArrowUInt8ScalarClass {
  GArrowScalarClass parent_class;
};

GARROW_TYPE_UINT16_SCALAR

#define GARROW_TYPE_UINT16_SCALAR (garrow_uint16_scalar_get_type())

struct GArrowUInt16ScalarClass

struct GArrowUInt16ScalarClass {
  GArrowScalarClass parent_class;
};

GARROW_TYPE_UINT32_SCALAR

#define GARROW_TYPE_UINT32_SCALAR (garrow_uint32_scalar_get_type())

struct GArrowUInt32ScalarClass

struct GArrowUInt32ScalarClass {
  GArrowScalarClass parent_class;
};

GARROW_TYPE_UINT64_SCALAR

#define GARROW_TYPE_UINT64_SCALAR (garrow_uint64_scalar_get_type())

struct GArrowUInt64ScalarClass

struct GArrowUInt64ScalarClass {
  GArrowScalarClass parent_class;
};

GARROW_TYPE_FLOAT_SCALAR

#define GARROW_TYPE_FLOAT_SCALAR (garrow_float_scalar_get_type())

struct GArrowFloatScalarClass

struct GArrowFloatScalarClass {
  GArrowScalarClass parent_class;
};

GARROW_TYPE_DOUBLE_SCALAR

#define GARROW_TYPE_DOUBLE_SCALAR (garrow_double_scalar_get_type())

struct GArrowDoubleScalarClass

struct GArrowDoubleScalarClass {
  GArrowScalarClass parent_class;
};

GARROW_TYPE_BASE_BINARY_SCALAR

#define GARROW_TYPE_BASE_BINARY_SCALAR (garrow_base_binary_scalar_get_type())

struct GArrowBaseBinaryScalarClass

struct GArrowBaseBinaryScalarClass {
  GArrowScalarClass parent_class;
};

GARROW_TYPE_BINARY_SCALAR

#define GARROW_TYPE_BINARY_SCALAR (garrow_binary_scalar_get_type())

struct GArrowBinaryScalarClass

struct GArrowBinaryScalarClass {
  GArrowBaseBinaryScalarClass parent_class;
};

GARROW_TYPE_STRING_SCALAR

#define GARROW_TYPE_STRING_SCALAR (garrow_string_scalar_get_type())

struct GArrowStringScalarClass

struct GArrowStringScalarClass {
  GArrowBaseBinaryScalarClass parent_class;
};

GARROW_TYPE_LARGE_BINARY_SCALAR

#define GARROW_TYPE_LARGE_BINARY_SCALAR (garrow_large_binary_scalar_get_type())

struct GArrowLargeBinaryScalarClass

struct GArrowLargeBinaryScalarClass {
  GArrowBaseBinaryScalarClass parent_class;
};

GARROW_TYPE_LARGE_STRING_SCALAR

#define GARROW_TYPE_LARGE_STRING_SCALAR (garrow_large_string_scalar_get_type())

struct GArrowLargeStringScalarClass

struct GArrowLargeStringScalarClass {
  GArrowBaseBinaryScalarClass parent_class;
};

GARROW_TYPE_FIXED_SIZE_BINARY_SCALAR

#define             GARROW_TYPE_FIXED_SIZE_BINARY_SCALAR

struct GArrowFixedSizeBinaryScalarClass

struct GArrowFixedSizeBinaryScalarClass {
  GArrowBaseBinaryScalarClass parent_class;
};

GARROW_TYPE_DATE32_SCALAR

#define GARROW_TYPE_DATE32_SCALAR (garrow_date32_scalar_get_type())

struct GArrowDate32ScalarClass

struct GArrowDate32ScalarClass {
  GArrowScalarClass parent_class;
};

GARROW_TYPE_DATE64_SCALAR

#define GARROW_TYPE_DATE64_SCALAR (garrow_date64_scalar_get_type())

struct GArrowDate64ScalarClass

struct GArrowDate64ScalarClass {
  GArrowScalarClass parent_class;
};

GARROW_TYPE_TIME32_SCALAR

#define GARROW_TYPE_TIME32_SCALAR (garrow_time32_scalar_get_type())

struct GArrowTime32ScalarClass

struct GArrowTime32ScalarClass {
  GArrowScalarClass parent_class;
};

GARROW_TYPE_TIME64_SCALAR

#define GARROW_TYPE_TIME64_SCALAR (garrow_time64_scalar_get_type())

struct GArrowTime64ScalarClass

struct GArrowTime64ScalarClass {
  GArrowScalarClass parent_class;
};

GARROW_TYPE_TIMESTAMP_SCALAR

#define GARROW_TYPE_TIMESTAMP_SCALAR (garrow_timestamp_scalar_get_type())

struct GArrowTimestampScalarClass

struct GArrowTimestampScalarClass {
  GArrowScalarClass parent_class;
};

GARROW_TYPE_DECIMAL128_SCALAR

#define GARROW_TYPE_DECIMAL128_SCALAR (garrow_decimal128_scalar_get_type())

struct GArrowDecimal128ScalarClass

struct GArrowDecimal128ScalarClass {
  GArrowScalarClass parent_class;
};

GARROW_TYPE_DECIMAL256_SCALAR

#define GARROW_TYPE_DECIMAL256_SCALAR (garrow_decimal256_scalar_get_type())

struct GArrowDecimal256ScalarClass

struct GArrowDecimal256ScalarClass {
  GArrowScalarClass parent_class;
};

GARROW_TYPE_BASE_LIST_SCALAR

#define GARROW_TYPE_BASE_LIST_SCALAR (garrow_base_list_scalar_get_type())

struct GArrowBaseListScalarClass

struct GArrowBaseListScalarClass {
  GArrowScalarClass parent_class;
};

GARROW_TYPE_LIST_SCALAR

#define GARROW_TYPE_LIST_SCALAR (garrow_list_scalar_get_type())

struct GArrowListScalarClass

struct GArrowListScalarClass {
  GArrowBaseListScalarClass parent_class;
};

GARROW_TYPE_LARGE_LIST_SCALAR

#define GARROW_TYPE_LARGE_LIST_SCALAR (garrow_large_list_scalar_get_type())

struct GArrowLargeListScalarClass

struct GArrowLargeListScalarClass {
  GArrowBaseListScalarClass parent_class;
};

GARROW_TYPE_MAP_SCALAR

#define GARROW_TYPE_MAP_SCALAR (garrow_map_scalar_get_type())

struct GArrowMapScalarClass

struct GArrowMapScalarClass {
  GArrowBaseListScalarClass parent_class;
};

GARROW_TYPE_STRUCT_SCALAR

#define GARROW_TYPE_STRUCT_SCALAR (garrow_struct_scalar_get_type())

struct GArrowStructScalarClass

struct GArrowStructScalarClass {
  GArrowScalarClass parent_class;
};

GARROW_TYPE_UNION_SCALAR

#define GARROW_TYPE_UNION_SCALAR (garrow_union_scalar_get_type())

struct GArrowUnionScalarClass

struct GArrowUnionScalarClass {
  GArrowScalarClass parent_class;
};

GARROW_TYPE_SPARSE_UNION_SCALAR

#define GARROW_TYPE_SPARSE_UNION_SCALAR (garrow_sparse_union_scalar_get_type())

struct GArrowSparseUnionScalarClass

struct GArrowSparseUnionScalarClass {
  GArrowUnionScalarClass parent_class;
};

GARROW_TYPE_DENSE_UNION_SCALAR

#define GARROW_TYPE_DENSE_UNION_SCALAR (garrow_dense_union_scalar_get_type())

struct GArrowDenseUnionScalarClass

struct GArrowDenseUnionScalarClass {
  GArrowUnionScalarClass parent_class;
};

GARROW_TYPE_EXTENSION_SCALAR

#define GARROW_TYPE_EXTENSION_SCALAR (garrow_extension_scalar_get_type())

struct GArrowExtensionScalarClass

struct GArrowExtensionScalarClass {
  GArrowScalarClass parent_class;
};

GArrowBaseBinaryScalar

typedef struct _GArrowBaseBinaryScalar GArrowBaseBinaryScalar;

GArrowBaseListScalar

typedef struct _GArrowBaseListScalar GArrowBaseListScalar;

GArrowBinaryScalar

typedef struct _GArrowBinaryScalar GArrowBinaryScalar;

GArrowBooleanScalar

typedef struct _GArrowBooleanScalar GArrowBooleanScalar;

GArrowCastOptions

typedef struct _GArrowCastOptions GArrowCastOptions;

GArrowDate32Scalar

typedef struct _GArrowDate32Scalar GArrowDate32Scalar;

GArrowDate64Scalar

typedef struct _GArrowDate64Scalar GArrowDate64Scalar;

GArrowDecimal128Scalar

typedef struct _GArrowDecimal128Scalar GArrowDecimal128Scalar;

GArrowDecimal256Scalar

typedef struct _GArrowDecimal256Scalar GArrowDecimal256Scalar;

GArrowDenseUnionScalar

typedef struct _GArrowDenseUnionScalar GArrowDenseUnionScalar;

GArrowDoubleScalar

typedef struct _GArrowDoubleScalar GArrowDoubleScalar;

GArrowExtensionScalar

typedef struct _GArrowExtensionScalar GArrowExtensionScalar;

GArrowFixedSizeBinaryScalar

typedef struct _GArrowFixedSizeBinaryScalar GArrowFixedSizeBinaryScalar;

GArrowFloatScalar

typedef struct _GArrowFloatScalar GArrowFloatScalar;

GArrowInt16Scalar

typedef struct _GArrowInt16Scalar GArrowInt16Scalar;

GArrowInt32Scalar

typedef struct _GArrowInt32Scalar GArrowInt32Scalar;

GArrowInt64Scalar

typedef struct _GArrowInt64Scalar GArrowInt64Scalar;

GArrowInt8Scalar

typedef struct _GArrowInt8Scalar GArrowInt8Scalar;

GArrowLargeBinaryScalar

typedef struct _GArrowLargeBinaryScalar GArrowLargeBinaryScalar;

GArrowLargeListScalar

typedef struct _GArrowLargeListScalar GArrowLargeListScalar;

GArrowLargeStringScalar

typedef struct _GArrowLargeStringScalar GArrowLargeStringScalar;

GArrowListScalar

typedef struct _GArrowListScalar GArrowListScalar;

GArrowMapScalar

typedef struct _GArrowMapScalar GArrowMapScalar;

GArrowNullScalar

typedef struct _GArrowNullScalar GArrowNullScalar;

GArrowScalar

typedef struct _GArrowScalar GArrowScalar;

GArrowSparseUnionScalar

typedef struct _GArrowSparseUnionScalar GArrowSparseUnionScalar;

GArrowStringScalar

typedef struct _GArrowStringScalar GArrowStringScalar;

GArrowStructScalar

typedef struct _GArrowStructScalar GArrowStructScalar;

GArrowTime32Scalar

typedef struct _GArrowTime32Scalar GArrowTime32Scalar;

GArrowTime64Scalar

typedef struct _GArrowTime64Scalar GArrowTime64Scalar;

GArrowTimestampScalar

typedef struct _GArrowTimestampScalar GArrowTimestampScalar;

GArrowUInt16Scalar

typedef struct _GArrowUInt16Scalar GArrowUInt16Scalar;

GArrowUInt32Scalar

typedef struct _GArrowUInt32Scalar GArrowUInt32Scalar;

GArrowUInt64Scalar

typedef struct _GArrowUInt64Scalar GArrowUInt64Scalar;

GArrowUInt8Scalar

typedef struct _GArrowUInt8Scalar GArrowUInt8Scalar;

GArrowUnionScalar

typedef struct _GArrowUnionScalar GArrowUnionScalar;

Property Details

The “value” property

  “value”                    GArrowBuffer *

The value of the scalar.

Owner: GArrowBaseBinaryScalar

Flags: Write / Construct Only

Since: 5.0.0


The “value” property

  “value”                    GArrowArray *

The value of the scalar.

Owner: GArrowBaseListScalar

Flags: Write / Construct Only

Since: 5.0.0


The “allow-decimal-truncate” property

  “allow-decimal-truncate”   gboolean

Whether truncating decimal value is allowed or not.

Owner: GArrowCastOptions

Flags: Read / Write

Default value: FALSE

Since: 1.0.0


The “allow-float-truncate” property

  “allow-float-truncate”     gboolean

Whether truncating float value is allowed or not.

Owner: GArrowCastOptions

Flags: Read / Write

Default value: FALSE

Since: 0.12.0


The “allow-int-overflow” property

  “allow-int-overflow”       gboolean

Whether integer overflow is allowed or not.

Owner: GArrowCastOptions

Flags: Read / Write

Default value: FALSE

Since: 0.7.0


The “allow-invalid-utf8” property

  “allow-invalid-utf8”       gboolean

Whether invalid UTF-8 string value is allowed or not.

Owner: GArrowCastOptions

Flags: Read / Write

Default value: FALSE

Since: 0.13.0


The “allow-time-overflow” property

  “allow-time-overflow”      gboolean

Whether time overflow is allowed or not.

Owner: GArrowCastOptions

Flags: Read / Write

Default value: FALSE

Since: 1.0.0


The “allow-time-truncate” property

  “allow-time-truncate”      gboolean

Whether truncating time value is allowed or not.

Owner: GArrowCastOptions

Flags: Read / Write

Default value: FALSE

Since: 0.8.0


The “to-data-type” property

  “to-data-type”             GArrowDataType *

The GArrowDataType being casted to.

Owner: GArrowCastOptions

Flags: Read / Write

Since: 1.0.0


The “value” property

  “value”                    GArrowDecimal128 *

The value of the scalar.

Owner: GArrowDecimal128Scalar

Flags: Write / Construct Only

Since: 5.0.0


The “value” property

  “value”                    GArrowDecimal256 *

The value of the scalar.

Owner: GArrowDecimal256Scalar

Flags: Write / Construct Only

Since: 5.0.0


The “data-type” property

  “data-type”                GArrowDataType *

The data type of the scalar.

Owner: GArrowScalar

Flags: Write / Construct Only

Since: 5.0.0


The “scalar” property

  “scalar”                   gpointer

The raw std::shared<arrow::Scalar> *.

Owner: GArrowScalar

Flags: Write / Construct Only


The “value” property

  “value”                    GArrowScalar *

The value of the scalar.

Owner: GArrowUnionScalar

Flags: Write / Construct Only

Since: 5.0.0