Partitioned Results

Collaboration diagram for Partitioned Results:

Classes
struct	AdbcPartitions
	The partitions of a distributed/partitioned result set. More...

Functions
ADBC_EXPORT AdbcStatusCode	AdbcStatementExecutePartitions (struct AdbcStatement *statement, struct ArrowSchema *schema, struct AdbcPartitions *partitions, int64_t *rows_affected, struct AdbcError *error)
	Execute a statement and get the results as a partitioned result set.

Detailed Description

Some backends may internally partition the results. These partitions are exposed to clients who may wish to integrate them with a threaded or distributed execution model, where partitions can be divided among threads or machines and fetched in parallel.

To use partitioning, execute the statement with AdbcStatementExecutePartitions to get the partition descriptors. Call AdbcConnectionReadPartition to turn the individual descriptors into ArrowArrayStream instances. This may be done on a different connection than the one the partition was created with, or even in a different process on another machine.

Drivers are not required to support partitioning.

Function Documentation

AdbcStatementExecutePartitions()

ADBC_EXPORT AdbcStatusCode AdbcStatementExecutePartitions	(	struct AdbcStatement *	statement,
		struct ArrowSchema *	schema,
		struct AdbcPartitions *	partitions,
		int64_t *	rows_affected,
		struct AdbcError *	error
	)

Execute a statement and get the results as a partitioned result set.

Parameters

[in]	statement	The statement to execute.
[out]	schema	The schema of the result set.
[out]	partitions	The result partitions.
[out]	rows_affected	The number of rows affected if known, else -1. Pass NULL if the client does not want this information.
[out]	error	An optional location to return an error message if necessary.

Returns

ADBC_STATUS_NOT_IMPLEMENTED if the driver does not support partitioned results