public static final class InsertRecordsFromPayloadRequest.Options extends Object
InsertRecordsFromPayloadRequest
parameter options
.
Optional parameters.
Modifier and Type | Field and Description | ||
---|---|---|---|
static String |
ABORT
Stops current insertion and aborts entire operation when an error is
encountered.
|
||
static String |
ACCURACY
Scans data to get exactly-typed & sized columns for all data
scanned.
|
||
static String |
AUTO
Default.
|
||
static String |
AVRO
Avro file format
|
||
static String |
AVRO_HEADER_BYTES
Optional number of bytes to skip when reading an avro record.
|
||
static String |
AVRO_NUM_RECORDS
Optional number of avro records, if data includes only records.
|
||
static String |
AVRO_SCHEMA
Optional string representing avro schema, for insert records in avro
format, that does not include is schema.
|
||
static String |
AVRO_SCHEMALESS
When user provides 'avro_schema', avro data is assumed to be
schemaless, unless specified.
|
||
static String |
BAD_RECORD_TABLE_LIMIT
A positive integer indicating the maximum number of records that can
be written to the bad-record-table.
|
||
static String |
BAD_RECORD_TABLE_LIMIT_PER_INPUT
For subscriptions: A positive integer indicating the maximum number
of records that can be written to the bad-record-table per
file/payload.
|
||
static String |
BAD_RECORD_TABLE_NAME
Optional name of a table to which records that were rejected are
written.
|
||
static String |
BATCH_SIZE
Internal tuning parameter--number of records per batch when
inserting data.
|
||
static String |
BZIP2
bzip2 file compression.
|
||
static String |
COLUMN_FORMATS
For each target column specified, applies the column-property-bound
format to the source data loaded into that column.
|
||
static String |
COLUMNS_TO_LOAD
Specifies a comma-delimited list of columns from the source data to
load.
|
||
static String |
COLUMNS_TO_SKIP
Specifies a comma-delimited list of columns from the source data to
skip.
|
||
static String |
COMPRESSION_TYPE
Optional: payload compression type.
|
||
static String |
DEFAULT_COLUMN_FORMATS
Specifies the default format to be applied to source data loaded
into columns with the corresponding column property.
|
||
static String |
DELIMITED_TEXT
Delimited text file format; e.g., CSV, TSV, PSV, etc.
|
||
static String |
DISTRIBUTED_LOCAL
A single worker process on each node loads all files that are
available to it.
|
||
static String |
DISTRIBUTED_SHARED
The head node coordinates loading data by worker processes across
all nodes from shared files available to all workers.
|
||
static String |
DRY_RUN
Does not load data, but walks through the source data and determines
the number of valid records, taking into account the current mode of
ERROR_HANDLING . |
||
static String |
ERROR_HANDLING
Specifies how errors should be handled upon insertion.
|
||
static String |
FALSE
Reject new records when primary keys match existing records
|
||
static String |
FILE_TYPE
Specifies the type of the file(s) whose records will be inserted.
|
||
static String |
FLATTEN_COLUMNS
Specifies how to handle nested columns.
|
||
static String |
FULL
Run a type inference on the source data (if needed) and ingest
|
||
static String |
GDAL_CONFIGURATION_OPTIONS
Comma separated list of gdal conf options, for the specific requets:
key=value.
|
||
static String |
GDB
Esri/GDB file format
|
||
static String |
GZIP
gzip file compression.
|
||
static String |
HEAD
The head node loads all data.
|
||
static String |
IGNORE_BAD_RECORDS
Malformed records are skipped.
|
||
static String |
IGNORE_EXISTING_PK
Specifies the record collision error-suppression policy for
inserting into a table with a
static String INGESTION_MODE
Whether to do a full load, dry run, or perform a type inference on
the source data.
| ||
static String |
JSON
Json file format
|
||
static String |
LAYER
Optional: geo files layer(s) name(s): comma separated.
|
||
static String |
LOADING_MODE
Scheme for distributing the extraction and loading of data from the
source data file(s).
|
||
static String |
LOCAL_TIME_OFFSET
For Avro local timestamp columns
|
||
static String |
MAX_RECORDS_TO_LOAD
Limit the number of records to load in this request: If this number
is larger than a batch_size, then the number of records loaded will
be limited to the next whole number of batch_size (per working
thread).
|
||
static String |
NONE
Uncompressed
|
||
static String |
NUM_TASKS_PER_RANK
Optional: number of tasks for reading file per rank.
|
||
static String |
PARQUET
Apache Parquet file format
|
||
static String |
PERMISSIVE
Records with missing columns are populated with nulls if possible;
otherwise, the malformed records are skipped.
|
||
static String |
POLL_INTERVAL
If
TRUE , the number of seconds between attempts
to load external files into the table. |
||
static String |
PRIMARY_KEYS
Optional: comma separated list of column names, to set as primary
keys, when not specified in the type.
|
||
static String |
SCHEMA_REGISTRY_SCHEMA_ID |
||
static String |
SCHEMA_REGISTRY_SCHEMA_NAME |
||
static String |
SCHEMA_REGISTRY_SCHEMA_VERSION |
||
static String |
SHAPEFILE
ShapeFile file format
|
||
static String |
SHARD_KEYS
Optional: comma separated list of column names, to set as primary
keys, when not specified in the type.
|
||
static String |
SINGLE |
||
static String |
SKIP_LINES
Skip number of lines from begining of file.
|
||
static String |
SPEED
Scans data and picks the widest possible column types so that 'all'
values will fit with minimum data scanned
|
||
static String |
SUBSCRIBE
Continuously poll the data source to check for new data and load it
into the table.
|
||
static String |
TABLE_INSERT_MODE
Optional: table_insert_mode.
|
||
static String |
TABLE_PER_FILE |
||
static String |
TEXT_COMMENT_STRING
Specifies the character string that should be interpreted as a
comment line prefix in the source data.
|
||
static String |
TEXT_DELIMITER
Specifies the character delimiting field values in the source data
and field names in the header (if present).
|
||
static String |
TEXT_ESCAPE_CHARACTER
Specifies the character that is used to escape other characters in
the source data.
|
||
static String |
TEXT_HAS_HEADER
Indicates whether the source data contains a header row.
|
||
static String |
TEXT_HEADER_PROPERTY_DELIMITER
Specifies the delimiter for
static String TEXT_NULL_STRING
Specifies the character string that should be interpreted as a null
value in the source data.
| ||
static String |
TEXT_QUOTE_CHARACTER
Specifies the character that should be interpreted as a field value
quoting character in the source data.
|
||
static String |
TEXT_SEARCH_COLUMNS
Add 'text_search' property to internally inferenced string columns.
|
||
static String |
TEXT_SEARCH_MIN_COLUMN_LENGTH
Set minimum column size.
|
||
static String |
TRUE
Upsert new records when primary keys match existing records
|
||
static String |
TRUNCATE_STRINGS
If set to
TRUE , truncate string values that are
longer than the column's type size. |
||
static String |
TRUNCATE_TABLE
|
||
static String |
TYPE_INFERENCE_MODE
optimize type inference for:
Supported values:
ACCURACY : Scans data to get
exactly-typed & sized columns for all data scanned. |
||
static String |
TYPE_INFERENCE_ONLY
Infer the type of the source data and return, without ingesting any
data.
|
||
static String |
UPDATE_ON_EXISTING_PK
Specifies the record collision policy for inserting into a table
with a
Method Summary
Copyright © 2025. All rights reserved. |