Module org.apache.arrow.flight.sql

Package org.apache.arrow.flight.sql

Class FlightSqlClient.ExecuteIngestOptions

java.lang.Object

org.apache.arrow.flight.sql.FlightSqlClient.ExecuteIngestOptions

Enclosing class:

FlightSqlClient

public static class FlightSqlClient.ExecuteIngestOptions
extends Object

Class to encapsulate Flight SQL bulk ingest request options. *

Constructor Summary

Constructors

Constructor	Description
ExecuteIngestOptions(String table, FlightSql.CommandStatementIngest.TableDefinitionOptions tableDefinitionOptions, boolean useTemporaryTable, String catalog, String schema, Map<String,String> options)	Constructor.
ExecuteIngestOptions(String table, FlightSql.CommandStatementIngest.TableDefinitionOptions tableDefinitionOptions, String catalog, String schema, Map<String,String> options)	Constructor.

Method Summary

Modifier and Type	Method	Description
protected void	updateCommandBuilder(FlightSql.CommandStatementIngest.Builder builder)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

ExecuteIngestOptions

public ExecuteIngestOptions(String table,
 FlightSql.CommandStatementIngest.TableDefinitionOptions tableDefinitionOptions,
 String catalog,
 String schema,
 Map<String,String> options)

Constructor.

Parameters:

table - The table to load data into.

tableDefinitionOptions - The behavior for handling the table definition.

catalog - The catalog of the destination table to load data into. If null, a backend-specific default may be used.

schema - The schema of the destination table to load data into. If null, a backend-specific default may be used.

options - Backend-specific options. Can be null if there are no options to be set.

ExecuteIngestOptions

public ExecuteIngestOptions(String table,
 FlightSql.CommandStatementIngest.TableDefinitionOptions tableDefinitionOptions,
 boolean useTemporaryTable,
 String catalog,
 String schema,
 Map<String,String> options)

Constructor.

Parameters:

table - The table to load data into.

tableDefinitionOptions - The behavior for handling the table definition.

useTemporaryTable - Use a temporary table for bulk ingestion. Temporary table may get placed in a backend-specific schema and/or catalog and gets dropped at the end of the session. If backend does not support ingesting using a temporary table or an explicit choice of schema or catalog is incompatible with the server's namespacing decision, an error is returned as part of FlightSqlClient.executeIngest(org.apache.arrow.vector.VectorSchemaRoot, org.apache.arrow.flight.sql.FlightSqlClient.ExecuteIngestOptions, org.apache.arrow.flight.CallOption...) request.

catalog - The catalog of the destination table to load data into. If null, a backend-specific default may be used.

schema - The schema of the destination table to load data into. If null, a backend-specific default may be used.

options - Backend-specific options. Can be null if there are no options to be set.

Method Details

updateCommandBuilder

protected void updateCommandBuilder(FlightSql.CommandStatementIngest.Builder builder)