A set of string constants for the parameter InsertRecordsFromFilesRequest.options. More…
Static Public Attributes | |
| const string | BAD_RECORD_TABLE_NAME = “bad_record_table_name” |
| Name of a table to which records that were rejected are written. | |
| const string | BAD_RECORD_TABLE_LIMIT = “bad_record_table_limit” |
| A positive integer indicating the maximum number of records that can be written to the bad-record-table. | |
| const string | BAD_RECORD_TABLE_LIMIT_PER_INPUT = “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. | |
| const string | BATCH_SIZE = “batch_size” |
| Number of records to insert per batch when inserting data. | |
| const string | COLUMN_FORMATS = “column_formats” |
| For each target column specified, applies the column-property-bound format to the source data loaded into that column. | |
| const string | COLUMNS_TO_LOAD = “columns_to_load” |
| Specifies a comma-delimited list of columns from the source data to load. | |
| const string | COLUMNS_TO_SKIP = “columns_to_skip” |
| Specifies a comma-delimited list of columns from the source data to skip. | |
| const string | COMPRESSION_TYPE = “compression_type” |
| Source data compression type. | |
| const string | NONE = “none” |
| No compression. | |
| const string | AUTO = “auto” |
| Auto detect compression type. | |
| const string | GZIP = “gzip” |
| gzip file compression. | |
| const string | BZIP2 = “bzip2” |
| bzip2 file compression. | |
| const string | DATASOURCE_NAME = “datasource_name” |
| Name of an existing external data source from which data file(s) specified in InsertRecordsFromFilesRequest.filepaths will be loaded. | |
| const string | DEFAULT_COLUMN_FORMATS = “default_column_formats” |
| Specifies the default format to be applied to source data loaded into columns with the corresponding column property. | |
| const string | ERROR_HANDLING = “error_handling” |
| Specifies how errors should be handled upon insertion. | |
| const string | PERMISSIVE = “permissive” |
| Records with missing columns are populated with nulls if possible; otherwise, the malformed records are skipped. | |
| const string | IGNORE_BAD_RECORDS = “ignore_bad_records” |
| Malformed records are skipped. | |
| const string | ABORT = “abort” |
| Stops current insertion and aborts entire operation when an error is encountered. | |
| const string | FILE_TYPE = “file_type” |
| Specifies the type of the file(s) whose records will be inserted. | |
| const string | AVRO = “avro” |
| Avro file format. | |
| const string | DELIMITED_TEXT = “delimited_text” |
| Delimited text file format; e.g., CSV, TSV, PSV, etc. | |
| const string | GDB = “gdb” |
| Esri/GDB file format. | |
| const string | JSON = “json” |
| JSON file format. | |
| const string | PARQUET = “parquet” |
| Apache Parquet file format. | |
| const string | SHAPEFILE = “shapefile” |
| ShapeFile file format. | |
| const string | FLATTEN_COLUMNS = “flatten_columns” |
| Specifies how to handle nested columns. | |
| const string | TRUE = “true” |
| A boolean constant for the InsertRecordsFromFilesRequest.Options options. | |
| const string | FALSE = “false” |
| A boolean constant for the InsertRecordsFromFilesRequest.Options options. | |
| const string | GDAL_CONFIGURATION_OPTIONS = “gdal_configuration_options” |
| Comma separated list of gdal conf options, for the specific requests: key=value. | |
| const string | IGNORE_EXISTING_PK = “ignore_existing_pk” |
| Specifies the record collision error-suppression policy for inserting into a table with a primary key, only used when not in upsert mode (upsert mode is disabled when UPDATE_ON_EXISTING_PK is FALSE). | |
| const string | INGESTION_MODE = “ingestion_mode” |
| Whether to do a full load, dry run, or perform a type inference on the source data. | |
| const string | FULL = “full” |
| Run a type inference on the source data (if needed) and ingest. | |
| const string | DRY_RUN = “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. | |
| const string | TYPE_INFERENCE_ONLY = “type_inference_only” |
| Infer the type of the source data and return, without ingesting any data. | |
| const string | KAFKA_CONSUMERS_PER_RANK = “kafka_consumers_per_rank” |
| Number of Kafka consumer threads per rank (valid range 1-6). | |
| const string | KAFKA_GROUP_ID = “kafka_group_id” |
| The group id to be used when consuming data from a Kafka topic (valid only for Kafka datasource subscriptions). | |
| const string | KAFKA_OFFSET_RESET_POLICY = “kafka_offset_reset_policy” |
| Policy to determine whether the Kafka data consumption starts either at earliest offset or latest offset. | |
| const string | EARLIEST = “earliest” |
| A constant for the InsertRecordsFromFilesRequest.Options options. | |
| const string | LATEST = “latest” |
| A constant for the InsertRecordsFromFilesRequest.Options options. | |
| const string | KAFKA_OPTIMISTIC_INGEST = “kafka_optimistic_ingest” |
| Enable optimistic ingestion where Kafka topic offsets and table data are committed independently to achieve parallelism. | |
| const string | KAFKA_SUBSCRIPTION_CANCEL_AFTER = “kafka_subscription_cancel_after” |
| Sets the Kafka subscription lifespan (in minutes). | |
| const string | KAFKA_TYPE_INFERENCE_FETCH_TIMEOUT = “kafka_type_inference_fetch_timeout” |
| Maximum time to collect Kafka messages before type inferencing on the set of them. | |
| const string | LAYER = “layer” |
| Geo files layer(s) name(s): comma separated. | |
| const string | LOADING_MODE = “loading_mode” |
| Scheme for distributing the extraction and loading of data from the source data file(s). | |
| const string | HEAD = “head” |
| The head node loads all data. | |
| const string | DISTRIBUTED_SHARED = “distributed_shared” |
| The head node coordinates loading data by worker processes across all nodes from shared files available to all workers. | |
| const string | DISTRIBUTED_LOCAL = “distributed_local” |
| A single worker process on each node loads all files that are available to it. | |
| const string | LOCAL_TIME_OFFSET = “local_time_offset” |
| Apply an offset to Avro local timestamp columns. | |
| const string | MAX_RECORDS_TO_LOAD = “max_records_to_load” |
| Limit the number of records to load in this request: if this number is larger than BATCH_SIZE, then the number of records loaded will be limited to the next whole number of BATCH_SIZE (per working thread). | |
| const string | NAME_COLUMNS_FROM_FILE = “name_columns_from_file” |
| Specifies a comma-delimited list of column names to be used as the source-data column names. | |
| const string | NUM_TASKS_PER_RANK = “num_tasks_per_rank” |
| Number of tasks for reading file per rank. | |
| const string | POLL_INTERVAL = “poll_interval” |
| If TRUE, the number of seconds between attempts to load external files into the table. | |
| const string | PRIMARY_KEYS = “primary_keys” |
| Comma separated list of column names to set as primary keys, when not specified in the type. | |
| const string | SCHEMA_REGISTRY_CONNECTION_RETRIES = “schema_registry_connection_retries” |
| Confluent Schema registry connection timeout (in secs). | |
| const string | SCHEMA_REGISTRY_CONNECTION_TIMEOUT = “schema_registry_connection_timeout” |
| Confluent Schema registry connection timeout (in secs). | |
| const string | SCHEMA_REGISTRY_MAX_CONSECUTIVE_CONNECTION_FAILURES = “schema_registry_max_consecutive_connection_failures” |
| Max records to skip due to SR connection failures, before failing. | |
| const string | MAX_CONSECUTIVE_INVALID_SCHEMA_FAILURE = “max_consecutive_invalid_schema_failure” |
| Max records to skip due to schema related errors, before failing. | |
| const string | SCHEMA_REGISTRY_SCHEMA_NAME = “schema_registry_schema_name” |
| Name of the Avro schema in the schema registry to use when reading Avro records. | |
| const string | SHARD_KEYS = “shard_keys” |
| Comma separated list of column names to set as shard keys, when not specified in the type. | |
| const string | SKIP_LINES = “skip_lines” |
| Skip a number of lines from the beginning of the file. | |
| const string | START_OFFSETS = “start_offsets” |
| Starting offsets by partition to fetch from kafka. | |
| const string | SUBSCRIBE = “subscribe” |
| Continuously poll the data source to check for new data and load it into the table. | |
| const string | TABLE_INSERT_MODE = “table_insert_mode” |
| Insertion scheme to use when inserting records from multiple shapefiles. | |
| const string | SINGLE = “single” |
| Insert all records into a single table. | |
| const string | TABLE_PER_FILE = “table_per_file” |
| Insert records from each file into a new table corresponding to that file. | |
| const string | TEXT_COMMENT_STRING = “text_comment_string” |
| Specifies the character string that should be interpreted as a comment line prefix in the source data. | |
| const string | TEXT_DELIMITER = “text_delimiter” |
| Specifies the character delimiting field values in the source data and field names in the header (if present). | |
| const string | TEXT_ESCAPE_CHARACTER = “text_escape_character” |
| Specifies the character that is used to escape other characters in the source data. | |
| const string | TEXT_HAS_HEADER = “text_has_header” |
| Indicates whether the source data contains a header row. | |
| const string | TEXT_HEADER_PROPERTY_DELIMITER = “text_header_property_delimiter” |
| Specifies the delimiter for column properties in the header row (if present). | |
| const string | TEXT_NULL_STRING = “text_null_string” |
| Specifies the character string that should be interpreted as a null value in the source data. | |
| const string | TEXT_QUOTE_CHARACTER = “text_quote_character” |
| Specifies the character that should be interpreted as a field value quoting character in the source data. | |
| const string | TEXT_SEARCH_COLUMNS = “text_search_columns” |
| Add ‘text_search’ property to internally inferenced string columns. | |
| const string | TEXT_SEARCH_MIN_COLUMN_LENGTH = “text_search_min_column_length” |
| Set the minimum column size for strings to apply the ‘text_search’ property to. | |
| const string | TRIM_SPACE = “trim_space” |
| If set to TRUE, remove leading or trailing space from fields. | |
| const string | TRUNCATE_STRINGS = “truncate_strings” |
| If set to TRUE, truncate string values that are longer than the column’s type size. | |
| const string | TRUNCATE_TABLE = “truncate_table” |
| If set to TRUE, truncates the table specified by InsertRecordsFromFilesRequest.table_name prior to loading the file(s). | |
| const string | TYPE_INFERENCE_MAX_RECORDS_READ = “type_inference_max_records_read” |
| A constant for the InsertRecordsFromFilesRequest.Options options. | |
| const string | TYPE_INFERENCE_MODE = “type_inference_mode” |
| Optimize type inferencing for either speed or accuracy. | |
| const string | ACCURACY = “accuracy” |
| Scans data to get exactly-typed and sized columns for all data scanned. | |
| const string | SPEED = “speed” |
| Scans data and picks the widest possible column types so that ‘all’ values will fit with minimum data scanned. | |
| const string | ENABLE_INPLACE_UPDATES = “enable_inplace_updates” |
| Applies only when upserting (when update_on_existing_pk is true). | |
| const string | UPDATE_ON_EXISTING_PK = “update_on_existing_pk” |
| Specifies the record collision policy for inserting into a table with a primary key. | |
| const string | TRANSFORMATIONS = “transformations” |
| Comma-separated expressions, one per target table column. | |
Detailed Description
A set of string constants for the parameter InsertRecordsFromFilesRequest.options.
Optional parameters.
Definition at line 319 of file InsertRecordsFromFiles.cs.
Member Data Documentation
◆ ABORT
| static |
Stops current insertion and aborts entire operation when an error is encountered.
Primary key collisions are considered abortable errors in this mode.
Definition at line 527 of file InsertRecordsFromFiles.cs.
◆ ACCURACY
| static |
Scans data to get exactly-typed and sized columns for all data scanned.
Definition at line 1236 of file InsertRecordsFromFiles.cs.
◆ AUTO
| static |
Auto detect compression type.
Definition at line 439 of file InsertRecordsFromFiles.cs.
◆ AVRO
| static |
Avro file format.
Definition at line 577 of file InsertRecordsFromFiles.cs.
◆ BAD_RECORD_TABLE_LIMIT
| static |
A positive integer indicating the maximum number of records that can be written to the bad-record-table.
The default value is ‘10000’.
Definition at line 335 of file InsertRecordsFromFiles.cs.
◆ BAD_RECORD_TABLE_LIMIT_PER_INPUT
| static |
For subscriptions, a positive integer indicating the maximum number of records that can be written to the bad-record-table per file/payload.
Default value will be BAD_RECORD_TABLE_LIMIT and total size of the table per rank is limited to BAD_RECORD_TABLE_LIMIT.
Definition at line 345 of file InsertRecordsFromFiles.cs.
◆ BAD_RECORD_TABLE_NAME
| static |
Name of a table to which records that were rejected are written.
The bad-record-table has the following columns: line_number (long), line_rejected (string), error_message (string). When ERROR_HANDLING is ABORT, bad records table is not populated.
Definition at line 330 of file InsertRecordsFromFiles.cs.
◆ BATCH_SIZE
| static |
Number of records to insert per batch when inserting data.
The default value is ‘50000’.
Definition at line 350 of file InsertRecordsFromFiles.cs.
◆ BZIP2
| static |
bzip2 file compression.
Definition at line 445 of file InsertRecordsFromFiles.cs.
◆ COLUMN_FORMATS
| static |
For each target column specified, applies the column-property-bound format to the source data loaded into that column.
Each column format will contain a mapping of one or more of its column properties to an appropriate format for each property. Currently supported column properties include date, time, and datetime. The parameter value must be formatted as a JSON string of maps of column names to maps of column properties to their corresponding column formats, e.g., ’ “order_date” : “date” : “%Y.%m.%d” , “order_time” : “time” : “%H:%M:%S” ’.
See DEFAULT_COLUMN_FORMATS for valid format syntax.
Definition at line 366 of file InsertRecordsFromFiles.cs.
◆ COLUMNS_TO_LOAD
| static |
Specifies a comma-delimited list of columns from the source data to load.
If more than one file is being loaded, this list applies to all files.
Column numbers can be specified discretely or as a range. For example, a value of ‘5,7,1..3’ will insert values from the fifth column in the source data into the first column in the target table, from the seventh column in the source data into the second column in the target table, and from the first through third columns in the source data into the third through fifth columns in the target table.
If the source data contains a header, column names matching the file header names may be provided instead of column numbers. If the target table doesn’t exist, the table will be created with the columns in this order. If the target table does exist with columns in a different order than the source data, this list can be used to match the order of the target table. For example, a value of ‘C, B, A’ will create a three column table with column C, followed by column B, followed by column A; or will insert those fields in that order into a table created with columns in that order. If the target table exists, the column names must match the source data field names for a name-mapping to be successful.
Mutually exclusive with COLUMNS_TO_SKIP.
Definition at line 393 of file InsertRecordsFromFiles.cs.
◆ COLUMNS_TO_SKIP
| static |
Specifies a comma-delimited list of columns from the source data to skip.
Mutually exclusive with COLUMNS_TO_LOAD.
Definition at line 400 of file InsertRecordsFromFiles.cs.
◆ COMPRESSION_TYPE
| static |
◆ DATASOURCE_NAME
| static |
Name of an existing external data source from which data file(s) specified in InsertRecordsFromFilesRequest.filepaths will be loaded.
Definition at line 451 of file InsertRecordsFromFiles.cs.
◆ DEFAULT_COLUMN_FORMATS
| static |
Specifies the default format to be applied to source data loaded into columns with the corresponding column property.
Currently supported column properties include date, time, and datetime. This default column-property-bound format can be overridden by specifying a column property and format for a given target column in COLUMN_FORMATS. For each specified annotation, the format will apply to all columns with that annotation unless a custom COLUMN_FORMATS for that annotation is specified.
The parameter value must be formatted as a JSON string that is a map of column properties to their respective column formats, e.g., ’ “date” : “%Y.%m.%d”, “time” : “%H:%M:%S” ’. Column formats are specified as a string of control characters and plain text. The supported control characters are ‘Y’, ‘m’, ‘d’, ‘H’, ‘M’, ‘S’, and ‘s’, which follow the Linux ‘strptime()’ specification, as well as ‘s’, which specifies seconds and fractional seconds (though the fractional component will be truncated past milliseconds).
Formats for the ‘date’ annotation must include the ‘Y’, ‘m’, and ‘d’ control characters. Formats for the ‘time’ annotation must include the ‘H’, ‘M’, and either ‘S’ or ‘s’ (but not both) control characters. Formats for the ‘datetime’ annotation meet both the ‘date’ and ‘time’ control character requirements. For example, ‘“datetime” : “%m/%d/%Y %H:%M:%S” ’ would be used to interpret text as “05/04/2000 12:12:11”
Definition at line 481 of file InsertRecordsFromFiles.cs.
◆ DELIMITED_TEXT
| static |
Delimited text file format; e.g., CSV, TSV, PSV, etc.
Definition at line 581 of file InsertRecordsFromFiles.cs.
◆ DISTRIBUTED_LOCAL
| static |
A single worker process on each node loads all files that are available to it.
This option works best when each worker loads files from its own file system, to maximize performance. In order to avoid data duplication, either each worker performing the load needs to have visibility to a set of files unique to it (no file is visible to more than one node) or the target table needs to have a primary key (which will allow the worker to automatically deduplicate data).
NOTE:
If the target table doesn’t exist, the table structure will be determined by the head node. If the head node has no files local to it, it will be unable to determine the structure and the request will fail.
If the head node is configured to have no worker processes, no data strictly accessible to the head node will be loaded.
Definition at line 888 of file InsertRecordsFromFiles.cs.
◆ DISTRIBUTED_SHARED
| static |
The head node coordinates loading data by worker processes across all nodes from shared files available to all workers.
NOTE:
Instead of existing on a shared source, the files can be duplicated on a source local to each host to improve performance, though the files must appear as the same data set from the perspective of all hosts performing the load.
Definition at line 869 of file InsertRecordsFromFiles.cs.
◆ DRY_RUN
| static |
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.
Definition at line 722 of file InsertRecordsFromFiles.cs.
◆ EARLIEST
| static |
A constant for the InsertRecordsFromFilesRequest.Options options.
Definition at line 761 of file InsertRecordsFromFiles.cs.
◆ ENABLE_INPLACE_UPDATES
| static |
Applies only when upserting (when update_on_existing_pk is true).
If set to true (the default), an existing record matched by primary key is modified in place. If set to false, the matched record is updated by deleting it and inserting a replacement (delete and insert), which prevents the change from being reflected in dependent materialized views until they are refreshed. Supported values:
The default value is TRUE.
Definition at line 1266 of file InsertRecordsFromFiles.cs.
◆ ERROR_HANDLING
| static |
Specifies how errors should be handled upon insertion.
Supported values:
- PERMISSIVE: Records with missing columns are populated with nulls if possible; otherwise, the malformed records are skipped.
- IGNORE_BAD_RECORDS: Malformed records are skipped.
- ABORT: Stops current insertion and aborts entire operation when an error is encountered. Primary key collisions are considered abortable errors in this mode.
The default value is ABORT.
Definition at line 514 of file InsertRecordsFromFiles.cs.
◆ FALSE
| static |
A boolean constant for the InsertRecordsFromFilesRequest.Options options.
Definition at line 624 of file InsertRecordsFromFiles.cs.
◆ FILE_TYPE
| static |
Specifies the type of the file(s) whose records will be inserted.
Supported values:
- AVRO: Avro file format.
- DELIMITED_TEXT: Delimited text file format; e.g., CSV, TSV, PSV, etc.
- GDB: Esri/GDB file format.
- JSON: JSON file format.
- PARQUET: Apache Parquet file format.
- SHAPEFILE: ShapeFile file format.
The default value is DELIMITED_TEXT.
Definition at line 574 of file InsertRecordsFromFiles.cs.
◆ FLATTEN_COLUMNS
| static |
Specifies how to handle nested columns.
Supported values:
- TRUE: Break up nested columns to multiple columns.
- FALSE: Treat nested columns as JSON columns instead of flattening.
The default value is FALSE.
Definition at line 616 of file InsertRecordsFromFiles.cs.
◆ FULL
| static |
Run a type inference on the source data (if needed) and ingest.
Definition at line 715 of file InsertRecordsFromFiles.cs.
◆ GDAL_CONFIGURATION_OPTIONS
| static |
Comma separated list of gdal conf options, for the specific requests: key=value.
Definition at line 628 of file InsertRecordsFromFiles.cs.
◆ GDB
| static |
Esri/GDB file format.
Definition at line 584 of file InsertRecordsFromFiles.cs.
◆ GZIP
| static |
gzip file compression.
Definition at line 442 of file InsertRecordsFromFiles.cs.
◆ HEAD
| static |
The head node loads all data.
All files must be available to the head node.
Definition at line 859 of file InsertRecordsFromFiles.cs.
◆ IGNORE_BAD_RECORDS
| static |
Malformed records are skipped.
Definition at line 521 of file InsertRecordsFromFiles.cs.
◆ IGNORE_EXISTING_PK
| static |
Specifies the record collision error-suppression policy for inserting into a table with a primary key, only used when not in upsert mode (upsert mode is disabled when UPDATE_ON_EXISTING_PK is FALSE).
If set to TRUE, any record being inserted that is rejected for having primary key values that match those of an existing table record will be ignored with no error generated. If FALSE, the rejection of any record for having primary key values matching an existing record will result in an error being reported, as determined by ERROR_HANDLING. If the specified table does not have a primary key or if upsert mode is in effect (UPDATE_ON_EXISTING_PK is TRUE), then this option has no effect. Supported values:
- TRUE: Ignore new records whose primary key values collide with those of existing records.
- FALSE: Treat as errors any new records whose primary key values collide with those of existing records.
The default value is FALSE.
Definition at line 676 of file InsertRecordsFromFiles.cs.
◆ INGESTION_MODE
| static |
Whether to do a full load, dry run, or perform a type inference on the source data.
Supported values:
- FULL: Run a type inference on the source data (if needed) and ingest.
- 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.
- TYPE_INFERENCE_ONLY: Infer the type of the source data and return, without ingesting any data. The inferred type is returned in the response.
The default value is FULL.
Definition at line 711 of file InsertRecordsFromFiles.cs.
◆ JSON
| static |
JSON file format.
Definition at line 587 of file InsertRecordsFromFiles.cs.
◆ KAFKA_CONSUMERS_PER_RANK
| static |
Number of Kafka consumer threads per rank (valid range 1-6).
The default value is ‘1’.
Definition at line 733 of file InsertRecordsFromFiles.cs.
◆ KAFKA_GROUP_ID
| static |
The group id to be used when consuming data from a Kafka topic (valid only for Kafka datasource subscriptions).
Definition at line 737 of file InsertRecordsFromFiles.cs.
◆ KAFKA_OFFSET_RESET_POLICY
| static |
Policy to determine whether the Kafka data consumption starts either at earliest offset or latest offset.
Supported values:
The default value is EARLIEST.
Definition at line 757 of file InsertRecordsFromFiles.cs.
◆ KAFKA_OPTIMISTIC_INGEST
| static |
Enable optimistic ingestion where Kafka topic offsets and table data are committed independently to achieve parallelism.
Supported values:
The default value is FALSE.
Definition at line 786 of file InsertRecordsFromFiles.cs.
◆ KAFKA_SUBSCRIPTION_CANCEL_AFTER
| static |
Sets the Kafka subscription lifespan (in minutes).
Expired subscription will be cancelled automatically.
Definition at line 792 of file InsertRecordsFromFiles.cs.
◆ KAFKA_TYPE_INFERENCE_FETCH_TIMEOUT
| static |
Maximum time to collect Kafka messages before type inferencing on the set of them.
Definition at line 796 of file InsertRecordsFromFiles.cs.
◆ LATEST
| static |
A constant for the InsertRecordsFromFilesRequest.Options options.
Definition at line 765 of file InsertRecordsFromFiles.cs.
◆ LAYER
| static |
Geo files layer(s) name(s): comma separated.
Definition at line 799 of file InsertRecordsFromFiles.cs.
◆ LOADING_MODE
| static |
Scheme for distributing the extraction and loading of data from the source data file(s).
This option applies only when loading files that are local to the database. Supported values:
- HEAD: The head node loads all data. All files must be available to the head node.
- DISTRIBUTED_SHARED: The head node coordinates loading data by worker processes across all nodes from shared files available to all workers. NOTE: Instead of existing on a shared source, the files can be duplicated on a source local to each host to improve performance, though the files must appear as the same data set from the perspective of all hosts performing the load.
- DISTRIBUTED_LOCAL: A single worker process on each node loads all files that are available to it. This option works best when each worker loads files from its own file system, to maximize performance. In order to avoid data duplication, either each worker performing the load needs to have visibility to a set of files unique to it (no file is visible to more than one node) or the target table needs to have a primary key (which will allow the worker to automatically deduplicate data). NOTE: If the target table doesn’t exist, the table structure will be determined by the head node. If the head node has no files local to it, it will be unable to determine the structure and the request will fail. If the head node is configured to have no worker processes, no data strictly accessible to the head node will be loaded.
The default value is HEAD.
Definition at line 854 of file InsertRecordsFromFiles.cs.
◆ LOCAL_TIME_OFFSET
| static |
Apply an offset to Avro local timestamp columns.
Definition at line 891 of file InsertRecordsFromFiles.cs.
◆ MAX_CONSECUTIVE_INVALID_SCHEMA_FAILURE
| static |
Max records to skip due to schema related errors, before failing.
Definition at line 952 of file InsertRecordsFromFiles.cs.
◆ MAX_RECORDS_TO_LOAD
| static |
Limit the number of records to load in this request: if this number is larger than BATCH_SIZE, then the number of records loaded will be limited to the next whole number of BATCH_SIZE (per working thread).
Definition at line 900 of file InsertRecordsFromFiles.cs.
◆ NAME_COLUMNS_FROM_FILE
| static |
Specifies a comma-delimited list of column names to be used as the source-data column names.
If the file has a header row (i.e., TEXT_HAS_HEADER is TRUE), these names override the file’s header names. If the file has no header row, these names are used as the source-data column names. Either way, the i-th name in this list applies to the i-th column in the file, enabling name-based matching against the target table’s columns (and use with COLUMNS_TO_LOAD / COLUMNS_TO_SKIP).
Definition at line 917 of file InsertRecordsFromFiles.cs.
◆ NONE
| static |
No compression.
Definition at line 436 of file InsertRecordsFromFiles.cs.
◆ NUM_TASKS_PER_RANK
| static |
Number of tasks for reading file per rank.
Default will be system configuration parameter, external_file_reader_num_tasks.
Definition at line 922 of file InsertRecordsFromFiles.cs.
◆ PARQUET
| static |
Apache Parquet file format.
Definition at line 590 of file InsertRecordsFromFiles.cs.
◆ PERMISSIVE
| static |
Records with missing columns are populated with nulls if possible; otherwise, the malformed records are skipped.
Definition at line 518 of file InsertRecordsFromFiles.cs.
◆ POLL_INTERVAL
| static |
If TRUE, the number of seconds between attempts to load external files into the table.
If zero, polling will be continuous as long as data is found. If no data is found, the interval will steadily increase to a maximum of 60 seconds. The default value is ‘0’.
Definition at line 932 of file InsertRecordsFromFiles.cs.
◆ PRIMARY_KEYS
| static |
Comma separated list of column names to set as primary keys, when not specified in the type.
Definition at line 936 of file InsertRecordsFromFiles.cs.
◆ SCHEMA_REGISTRY_CONNECTION_RETRIES
| static |
Confluent Schema registry connection timeout (in secs).
Definition at line 940 of file InsertRecordsFromFiles.cs.
◆ SCHEMA_REGISTRY_CONNECTION_TIMEOUT
| static |
Confluent Schema registry connection timeout (in secs).
Definition at line 944 of file InsertRecordsFromFiles.cs.
◆ SCHEMA_REGISTRY_MAX_CONSECUTIVE_CONNECTION_FAILURES
| static |
Max records to skip due to SR connection failures, before failing.
Definition at line 948 of file InsertRecordsFromFiles.cs.
◆ SCHEMA_REGISTRY_SCHEMA_NAME
| static |
Name of the Avro schema in the schema registry to use when reading Avro records.
Definition at line 956 of file InsertRecordsFromFiles.cs.
◆ SHAPEFILE
| static |
ShapeFile file format.
Definition at line 593 of file InsertRecordsFromFiles.cs.
◆ SHARD_KEYS
| static |
Comma separated list of column names to set as shard keys, when not specified in the type.
Definition at line 960 of file InsertRecordsFromFiles.cs.
◆ SINGLE
| static |
Insert all records into a single table.
Definition at line 1017 of file InsertRecordsFromFiles.cs.
◆ SKIP_LINES
| static |
Skip a number of lines from the beginning of the file.
Definition at line 964 of file InsertRecordsFromFiles.cs.
◆ SPEED
| static |
Scans data and picks the widest possible column types so that ‘all’ values will fit with minimum data scanned.
Definition at line 1240 of file InsertRecordsFromFiles.cs.
◆ START_OFFSETS
| static |
Starting offsets by partition to fetch from kafka.
A comma separated list of partition:offset pairs.
Definition at line 970 of file InsertRecordsFromFiles.cs.
◆ SUBSCRIBE
| static |
Continuously poll the data source to check for new data and load it into the table.
Supported values:
The default value is FALSE.
Definition at line 990 of file InsertRecordsFromFiles.cs.
◆ TABLE_INSERT_MODE
| static |
Insertion scheme to use when inserting records from multiple shapefiles.
Supported values:
- SINGLE: Insert all records into a single table.
- TABLE_PER_FILE: Insert records from each file into a new table corresponding to that file.
The default value is SINGLE.
Definition at line 1014 of file InsertRecordsFromFiles.cs.
◆ TABLE_PER_FILE
| static |
Insert records from each file into a new table corresponding to that file.
Definition at line 1021 of file InsertRecordsFromFiles.cs.
◆ TEXT_COMMENT_STRING
| static |
Specifies the character string that should be interpreted as a comment line prefix in the source data.
All lines in the data starting with the provided string are ignored.
For DELIMITED_TEXT FILE_TYPE only. The default value is ’#’.
Definition at line 1032 of file InsertRecordsFromFiles.cs.
◆ TEXT_DELIMITER
| static |
Specifies the character delimiting field values in the source data and field names in the header (if present).
For DELIMITED_TEXT FILE_TYPE only. The default value is ’,’.
Definition at line 1041 of file InsertRecordsFromFiles.cs.
◆ TEXT_ESCAPE_CHARACTER
| static |
Specifies the character that is used to escape other characters in the source data.
An ‘a’, ‘b’, ‘f’, ‘n’, ‘r’, ‘t’, or ‘v’ preceded by an escape character will be interpreted as the ASCII bell, backspace, form feed, line feed, carriage return, horizontal tab, and vertical tab, respectively. For example, the escape character followed by an ‘n’ will be interpreted as a newline within a field value.
The escape character can also be used to escape the quoting character, and will be treated as an escape character whether it is within a quoted field value or not.
For DELIMITED_TEXT FILE_TYPE only.
Definition at line 1059 of file InsertRecordsFromFiles.cs.
◆ TEXT_HAS_HEADER
| static |
Indicates whether the source data contains a header row.
For DELIMITED_TEXT FILE_TYPE only. Supported values:
The default value is TRUE.
Definition at line 1084 of file InsertRecordsFromFiles.cs.
◆ TEXT_HEADER_PROPERTY_DELIMITER
| static |
Specifies the delimiter for column properties in the header row (if present).
Cannot be set to same value as TEXT_DELIMITER.
For DELIMITED_TEXT FILE_TYPE only. The default value is ’|’.
Definition at line 1097 of file InsertRecordsFromFiles.cs.
◆ TEXT_NULL_STRING
| static |
Specifies the character string that should be interpreted as a null value in the source data.
For DELIMITED_TEXT FILE_TYPE only. The default value is ‘\N’.
Definition at line 1106 of file InsertRecordsFromFiles.cs.
◆ TEXT_QUOTE_CHARACTER
| static |
Specifies the character that should be interpreted as a field value quoting character in the source data.
The character must appear at beginning and end of field value to take effect. Delimiters within quoted fields are treated as literals and not delimiters. Within a quoted field, two consecutive quote characters will be interpreted as a single literal quote character, effectively escaping it. To not have a quote character, specify an empty string.
For DELIMITED_TEXT FILE_TYPE only. The default value is ’”’.
Definition at line 1121 of file InsertRecordsFromFiles.cs.
◆ TEXT_SEARCH_COLUMNS
| static |
Add ‘text_search’ property to internally inferenced string columns.
Comma separated list of column names or ’*’ for all columns. To add ‘text_search’ property only to string columns greater than or equal to a minimum size, also set the TEXT_SEARCH_MIN_COLUMN_LENGTH
Definition at line 1130 of file InsertRecordsFromFiles.cs.
◆ TEXT_SEARCH_MIN_COLUMN_LENGTH
| static |
Set the minimum column size for strings to apply the ‘text_search’ property to.
Used only when TEXT_SEARCH_COLUMNS has a value.
Definition at line 1137 of file InsertRecordsFromFiles.cs.
◆ TRANSFORMATIONS
| static |
Comma-separated expressions, one per target table column.
Each expression is evaluated per record. Empty entries (two consecutive commas) mean no transformation for that column – the value is resolved from the input record, table default, NULL, or an error. Expressions may reference input columns by name or by position (2 for the second, etc.). The default value is ”.
Definition at line 1315 of file InsertRecordsFromFiles.cs.
◆ TRIM_SPACE
| static |
◆ TRUE
| static |
A boolean constant for the InsertRecordsFromFilesRequest.Options options.
Definition at line 620 of file InsertRecordsFromFiles.cs.
◆ TRUNCATE_STRINGS
| static |
◆ TRUNCATE_TABLE
| static |
If set to TRUE, truncates the table specified by InsertRecordsFromFilesRequest.table_name prior to loading the file(s).
Supported values:
The default value is FALSE.
Definition at line 1203 of file InsertRecordsFromFiles.cs.
◆ TYPE_INFERENCE_MAX_RECORDS_READ
| static |
A constant for the InsertRecordsFromFilesRequest.Options options.
Definition at line 1207 of file InsertRecordsFromFiles.cs.
◆ TYPE_INFERENCE_MODE
| static |
Optimize type inferencing for either speed or accuracy.
Supported values:
- ACCURACY: Scans data to get exactly-typed and sized columns for all data scanned.
- SPEED: Scans data and picks the widest possible column types so that ‘all’ values will fit with minimum data scanned.
The default value is ACCURACY.
Definition at line 1232 of file InsertRecordsFromFiles.cs.
◆ TYPE_INFERENCE_ONLY
| static |
Infer the type of the source data and return, without ingesting any data.
The inferred type is returned in the response.
Definition at line 728 of file InsertRecordsFromFiles.cs.
◆ UPDATE_ON_EXISTING_PK
| static |
Specifies the record collision policy for inserting into a table with a primary key.
If set to TRUE, any existing table record with primary key values that match those of a record being inserted will be replaced by that new record (the new data will be ‘upserted’). If set to FALSE, any existing table record with primary key values that match those of a record being inserted will remain unchanged, while the new record will be rejected and the error handled as determined by IGNORE_EXISTING_PK and ERROR_HANDLING. If the specified table does not have a primary key, then this option has no effect. Supported values:
- TRUE: Upsert new records when primary keys match existing records.
- FALSE: Reject new records when primary keys match existing records.
The default value is FALSE.
Definition at line 1305 of file InsertRecordsFromFiles.cs.
The documentation for this struct was generated from the following files:
- _build/public-os_ubuntu24.04-arch_amd64-cc_gcc_13.3.0/install/Kinetica/Protocol/InsertRecordsFromFiles.cs
- Kinetica/Protocol/InsertRecordsFromFiles.cs