Client related classes

Client related classes

Functions

Properties

gpointer client Write / Construct Only
GAFlightClient * flight-client Read / Write / Construct Only

Types and Values

Object Hierarchy

    GObject
    ╰── GAFlightSQLClient

Includes

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

Description

GAFlightSQLClient is a class for Apache Arrow Flight SQL client.

Functions

gaflightsql_client_new ()

GAFlightSQLClient *
gaflightsql_client_new (GAFlightClient *client);

Parameters

client

A GAFlightClient to be used.

 

Returns

: The newly created Flight SQL client.

Since: 9.0.0

gaflightsql_client_execute ()

GAFlightInfo *
gaflightsql_client_execute (GAFlightSQLClient *client,
                            const gchar *query,
                            GAFlightCallOptions *options,
                            GError **error);

Parameters

client

A GAFlightSQLClient.

 

query

A query to be executed in the UTF-8 format.

 

options

A GAFlightCallOptions.

[nullable]

error

Return location for a GError or NULL.

[nullable]

Returns

The GAFlightInfo describing where to access the dataset on success, NULL on error.

[nullable][transfer full]

Since: 9.0.0

gaflightsql_client_do_get ()

GAFlightStreamReader *
gaflightsql_client_do_get (GAFlightSQLClient *client,
                           GAFlightTicket *ticket,
                           GAFlightCallOptions *options,
                           GError **error);

Parameters

client

A GAFlightClient.

 

ticket

A GAFlightTicket.

 

options

A GAFlightCallOptions.

[nullable]

error

Return location for a GError or NULL.

[nullable]

Returns

The GAFlightStreamReader to read record batched from the server on success, NULL on error.

[nullable][transfer full]

Since: 9.0.0

Types and Values

GAFLIGHTSQL_TYPE_CLIENT

#define GAFLIGHTSQL_TYPE_CLIENT (gaflightsql_client_get_type())

struct GAFlightSQLClientClass

struct GAFlightSQLClientClass {
  GObjectClass parent_class;
};

GAFlightSQLClient

typedef struct _GAFlightSQLClient GAFlightSQLClient;

Property Details

The “client” property

  “client”                   gpointer

The raw arrow::flight::sql::FlightSqlClient *.

Owner: GAFlightSQLClient

Flags: Write / Construct Only

The “flight-client” property

  “flight-client”            GAFlightClient *

The underlying Flight client.

Owner: GAFlightSQLClient

Flags: Read / Write / Construct Only

Since: 9.0.0