Package com.google.cloud.bigquery

Class InsertAllRequest

java.lang.Object

com.google.cloud.bigquery.InsertAllRequest

All Implemented Interfaces:

Serializable

public final class InsertAllRequest
extends Object
implements Serializable

Google Cloud BigQuery insert all request. This class can be used to stream data into BigQuery one record at a time without needing to run a load job. This approach enables querying data without the delay of running a load job. There are several important trade-offs to consider before choosing an approach.

See Also:

• Streaming Data into BigQuery
• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	InsertAllRequest.Builder
static class	InsertAllRequest.RowToInsert	A Google Big Query row to be inserted into a table.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
io.opentelemetry.api.common.Attributes	getOtelAttributes()
List<InsertAllRequest.RowToInsert>	getRows()	Returns the rows to be inserted.
TableId	getTable()	Returns the destination table for rows insert request.
String	getTemplateSuffix()	If specified, the destination table is treated as a base template.
int	hashCode()
Boolean	ignoreUnknownValues()	Returns whether to accept rows that contain values that do not match the schema.
static InsertAllRequest.Builder	newBuilder(TableId table)	Returns a builder for an InsertAllRequest object given the destination table.
static InsertAllRequest.Builder	newBuilder(TableId table, InsertAllRequest.RowToInsert... rows)	Returns a builder for an InsertAllRequest object given the destination table and the rows to insert.
static InsertAllRequest.Builder	newBuilder(TableId table, Iterable<InsertAllRequest.RowToInsert> rows)	Returns a builder for an InsertAllRequest object given the destination table and the rows to insert.
static InsertAllRequest.Builder	newBuilder(TableInfo tableInfo, InsertAllRequest.RowToInsert... rows)	Returns a builder for an InsertAllRequest object given the destination table and the rows to insert.
static InsertAllRequest.Builder	newBuilder(TableInfo tableInfo, Iterable<InsertAllRequest.RowToInsert> rows)	Returns a builder for an InsertAllRequest object given the destination table and the rows to insert.
static InsertAllRequest.Builder	newBuilder(String datasetId, String tableId)	Returns a builder for an InsertAllRequest object given the destination table.
static InsertAllRequest.Builder	newBuilder(String datasetId, String tableId, InsertAllRequest.RowToInsert... rows)	Returns a builder for an InsertAllRequest object given the destination table and the rows to insert.
static InsertAllRequest.Builder	newBuilder(String datasetId, String tableId, Iterable<InsertAllRequest.RowToInsert> rows)	Returns a builder for an InsertAllRequest object given the destination table and the rows to insert.
static InsertAllRequest	of(TableId tableId, InsertAllRequest.RowToInsert... rows)	Returns a InsertAllRequest object given the destination table and the rows to insert.
static InsertAllRequest	of(TableId tableId, Iterable<InsertAllRequest.RowToInsert> rows)	Returns a InsertAllRequest object given the destination table and the rows to insert.
static InsertAllRequest	of(TableInfo tableInfo, InsertAllRequest.RowToInsert... rows)	Returns a InsertAllRequest object given the destination table and the rows to insert.
static InsertAllRequest	of(TableInfo tableInfo, Iterable<InsertAllRequest.RowToInsert> rows)	Returns a InsertAllRequest object given the destination table and the rows to insert.
static InsertAllRequest	of(String datasetId, String tableId, InsertAllRequest.RowToInsert... rows)	Returns a InsertAllRequest object given the destination table and the rows to insert.
static InsertAllRequest	of(String datasetId, String tableId, Iterable<InsertAllRequest.RowToInsert> rows)	Returns a InsertAllRequest object given the destination table and the rows to insert.
Boolean	skipInvalidRows()	Returns whether to insert all valid rows of a request, even if invalid rows exist.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Details

getTable

public TableId getTable()

Returns the destination table for rows insert request.

getRows

public List<InsertAllRequest.RowToInsert> getRows()

Returns the rows to be inserted.

ignoreUnknownValues

public Boolean ignoreUnknownValues()

Returns whether to accept rows that contain values that do not match the schema. The unknown values are ignored. If not set, rows with unknown values are considered to be invalid.

skipInvalidRows

public Boolean skipInvalidRows()

Returns whether to insert all valid rows of a request, even if invalid rows exist. If not set the entire insert request will fail if it contains an invalid row.

getTemplateSuffix

public String getTemplateSuffix()

If specified, the destination table is treated as a base template. Rows are inserted into an instance table named "{destination}{templateSuffix}". BigQuery will manage the creation of the instance table, using the schema of the base template table. Table creation might take some time. To obtain table's information after BigQuery.insertAll(InsertAllRequest) is called use:

 String suffixTableId = ...;
 TableInfo suffixTable = bigquery.getTable(DATASET, suffixTableId);
 while (suffixTable == null) {
   Thread.sleep(1000L);
   suffixTable = bigquery.getTable(DATASET, suffixTableId);
 }
 

See Also:

• Template Tables

newBuilder

public static InsertAllRequest.Builder newBuilder(TableId table)

Returns a builder for an InsertAllRequest object given the destination table.

newBuilder

public static InsertAllRequest.Builder newBuilder(TableId table,
 Iterable<InsertAllRequest.RowToInsert> rows)

Returns a builder for an InsertAllRequest object given the destination table and the rows to insert.

newBuilder

public static InsertAllRequest.Builder newBuilder(TableId table,
 InsertAllRequest.RowToInsert... rows)

Returns a builder for an InsertAllRequest object given the destination table and the rows to insert.

newBuilder

public static InsertAllRequest.Builder newBuilder(String datasetId,
 String tableId)

Returns a builder for an InsertAllRequest object given the destination table.

newBuilder

public static InsertAllRequest.Builder newBuilder(String datasetId,
 String tableId,
 Iterable<InsertAllRequest.RowToInsert> rows)

Returns a builder for an InsertAllRequest object given the destination table and the rows to insert.

newBuilder

public static InsertAllRequest.Builder newBuilder(String datasetId,
 String tableId,
 InsertAllRequest.RowToInsert... rows)

Returns a builder for an InsertAllRequest object given the destination table and the rows to insert.

newBuilder

public static InsertAllRequest.Builder newBuilder(TableInfo tableInfo,
 Iterable<InsertAllRequest.RowToInsert> rows)

Returns a builder for an InsertAllRequest object given the destination table and the rows to insert.

newBuilder

public static InsertAllRequest.Builder newBuilder(TableInfo tableInfo,
 InsertAllRequest.RowToInsert... rows)

Returns a builder for an InsertAllRequest object given the destination table and the rows to insert.

of

public static InsertAllRequest of(TableId tableId,
 Iterable<InsertAllRequest.RowToInsert> rows)

Returns a InsertAllRequest object given the destination table and the rows to insert.

of

public static InsertAllRequest of(TableId tableId,
 InsertAllRequest.RowToInsert... rows)

Returns a InsertAllRequest object given the destination table and the rows to insert.

of

public static InsertAllRequest of(String datasetId,
 String tableId,
 Iterable<InsertAllRequest.RowToInsert> rows)

Returns a InsertAllRequest object given the destination table and the rows to insert.

of

public static InsertAllRequest of(String datasetId,
 String tableId,
 InsertAllRequest.RowToInsert... rows)

Returns a InsertAllRequest object given the destination table and the rows to insert.

of

public static InsertAllRequest of(TableInfo tableInfo,
 Iterable<InsertAllRequest.RowToInsert> rows)

Returns a InsertAllRequest object given the destination table and the rows to insert.

of

public static InsertAllRequest of(TableInfo tableInfo,
 InsertAllRequest.RowToInsert... rows)

Returns a InsertAllRequest object given the destination table and the rows to insert.

toString

public String toString()

Overrides:

toString in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

getOtelAttributes

public io.opentelemetry.api.common.Attributes getOtelAttributes()