Package org.apache.arrow.adbc.core

Interface BulkIngestBuilder

All Superinterfaces:

AutoCloseable

public interface BulkIngestBuilder
extends AutoCloseable

A fluent builder-style interface for configuring and executing a bulk ingest.

Method Summary

Modifier and Type	Method	Description
BulkIngestBuilder	appendMode()	Append to the target table; fail if not found.
BulkIngestBuilder	bind(ArrowReader stream)	Ingest data from the given reader.
BulkIngestBuilder	bind(VectorSchemaRoot root)	Ingest data from the given root.
void	close()	Clean up any state in this bulk ingest.
BulkIngestBuilder	createAppendMode()	Create the target table if necessary, append if already exists.
BulkIngestBuilder	createMode()	Create the target table; fail if already exists.
default AdbcStatement.UpdateResult	ingest()	Execute the bulk ingest.
BulkIngestBuilder	mode(BulkIngestMode mode)	How to handle an already-existing/non-existent target table.
BulkIngestBuilder	option(IngestOption option)	Set an arbitrary ingest option.
<T> BulkIngestBuilder	option(TypedKey<T> key, T value)	Set a statement option before ingest.
BulkIngestBuilder	replaceMode()	Drop (if exists) and create the target table.
BulkIngestBuilder	targetCatalog(String catalog)	Ingest into a table in the given catalog.
BulkIngestBuilder	targetSchema(String schema)	Ingest into a table in the given schema.
BulkIngestBuilder	targetTable(String table)	Ingest into a table with the given name (required).
default BulkIngestBuilder	temporary()	Ingest into a temporary table.
BulkIngestBuilder	temporary(boolean isTemporary)	Whether to ingest into a temporary table or not.
AdbcStatement	toStatement()	Convert this builder to an AdbcStatement (low-level API for further control) without executing.

Method Details

createMode

BulkIngestBuilder createMode()
                      throws AdbcException

Create the target table; fail if already exists.

Throws:

AdbcException

appendMode

BulkIngestBuilder appendMode()
                      throws AdbcException

Append to the target table; fail if not found.

Throws:

AdbcException

replaceMode

BulkIngestBuilder replaceMode()
                       throws AdbcException

Drop (if exists) and create the target table.

Throws:

AdbcException

createAppendMode

BulkIngestBuilder createAppendMode()
                            throws AdbcException

Create the target table if necessary, append if already exists.

Throws:

AdbcException

mode

BulkIngestBuilder mode(BulkIngestMode mode)
                throws AdbcException

How to handle an already-existing/non-existent target table. Default is BulkIngestMode.CREATE.

Also see the convenience methods createMode(), appendMode(), replaceMode(), and createAppendMode().

Throws:

AdbcException

bind

BulkIngestBuilder bind(VectorSchemaRoot root)
                throws AdbcException

Ingest data from the given root.

Like AdbcStatement.bind(VectorSchemaRoot), this ingest will NOT close the given root. If a different root or stream is bound, this root will simply be forgotten.

Throws:

AdbcException

bind

BulkIngestBuilder bind(ArrowReader stream)
                throws AdbcException

Ingest data from the given reader.

Like AdbcStatement.bind(ArrowReader), this ingest WILL close the given stream. If a different root or stream is bound, this stream will be closed.

Throws:

AdbcException

targetTable

BulkIngestBuilder targetTable(String table)
                       throws AdbcException

Ingest into a table with the given name (required).

Throws:

AdbcException

targetSchema

BulkIngestBuilder targetSchema(String schema)
                        throws AdbcException

Ingest into a table in the given schema.

Throws:

AdbcException

targetCatalog

BulkIngestBuilder targetCatalog(String catalog)
                         throws AdbcException

Ingest into a table in the given catalog.

Throws:

AdbcException

temporary

default BulkIngestBuilder temporary()
                             throws AdbcException

Ingest into a temporary table.

Throws:

AdbcException

temporary

BulkIngestBuilder temporary(boolean isTemporary)
                     throws AdbcException

Whether to ingest into a temporary table or not.

Throws:

AdbcException

option

BulkIngestBuilder option(IngestOption option)
                  throws AdbcException

Set an arbitrary ingest option.

Throws:

AdbcException

option

<T> BulkIngestBuilder option(TypedKey<T> key,
 T value)
                      throws AdbcException

Set a statement option before ingest.

Throws:

AdbcException

toStatement

AdbcStatement toStatement()
                   throws AdbcException

Convert this builder to an AdbcStatement (low-level API for further control) without executing.

The caller is responsible for closing the returned statement.

Throws:

AdbcException

ingest

default AdbcStatement.UpdateResult ingest()
                                   throws AdbcException

Execute the bulk ingest.

This will consume the bound stream, if any. To ingest again, bind a new stream or root or update data in the already-bound root.

Throws:

AdbcException

close

void close()
    throws AdbcException

Clean up any state in this bulk ingest.

Specified by:

close in interface AutoCloseable

Throws:

AdbcException