Skip to main content

A set of parameters for Kinetica.appendRecords. More…

Inheritance diagram for kinetica.AppendRecordsRequest:
[legend]
Collaboration diagram for kinetica.AppendRecordsRequest:
[legend]

​
Classes

struct  Options
 A set of string constants for the parameter AppendRecordsRequest.options. More…
 

​
Public Member Functions

 AppendRecordsRequest ()
 Constructs an AppendRecordsRequest object with default parameters.
 
 AppendRecordsRequest (string table_name, string source_table_name, IDictionary< string, string > field_map, IDictionary< string, string > options=null)
 Constructs an AppendRecordsRequest object with the specified parameters.
 
 AppendRecordsRequest ()
 Constructs an AppendRecordsRequest object with default parameters.
 
 AppendRecordsRequest (string table_name, string source_table_name, IDictionary< string, string > field_map, IDictionary< string, string > options=null)
 Constructs an AppendRecordsRequest object with the specified parameters.
 
 Public Member Functions inherited from kinetica.KineticaData
 KineticaData (KineticaType type)
 Constructor from Kinetica Type.
 
 KineticaData (System.Type type=null)
 Default constructor, with optional System.Type.
 
object Get (int fieldPos)
 Retrieve a specific property from this object.
 
void Put (int fieldPos, object fieldValue)
 Write a specific property to this object.
 
 KineticaData (KineticaType type)
 Constructor from Kinetica Type.
 
 KineticaData (System.Type type=null)
 Default constructor, with optional System.Type.
 
object Get (int fieldPos)
 Retrieve a specific property from this object.
 
void Put (int fieldPos, object fieldValue)
 Write a specific property to this object.
 

​
Properties

string table_name [get, set]
 The table name for the records to be appended, in [schema_name.
 
string source_table_name [get, set]
 The source table name to get records from, in [schema_name.
 
IDictionary< string, string > field_map = new Dictionary<string, string>() [get, set]
 Contains the mapping of column names from the target table (specified by AppendRecordsRequest.table_name) as the keys, and corresponding column names or expressions (e.g., ‘col_name+1’) from the source table (specified by AppendRecordsRequest.source_table_name).
 
IDictionary< string, string > options = new Dictionary<string, string>() [get, set]
 Optional parameters.
 
 Properties inherited from kinetica.KineticaData
Schema Schema [get]
 Avro Schema for this class.
 

​
Additional Inherited Members

 Static Public Member Functions inherited from kinetica.KineticaData
static ? RecordSchema SchemaFromType (System.Type t, KineticaType? ktype=null)
 Create an Avro Schema from a System.Type and a KineticaType.
 
static ? RecordSchema SchemaFromType (System.Type t, KineticaType? ktype=null)
 Create an Avro Schema from a System.Type and a KineticaType.
 

​
Detailed Description

A set of parameters for Kinetica.appendRecords.

Append (or insert) all records from a source table (specified by AppendRecordsRequest.source_table_name) to a particular target table (specified by AppendRecordsRequest.table_name). The field map (specified by AppendRecordsRequest.field_map) holds the user specified map of target table column names with their mapped source column names.

Definition at line 21 of file AppendRecords.cs.

​
Constructor & Destructor Documentation

​
◆ AppendRecordsRequest() [1/4]

kinetica.AppendRecordsRequest.AppendRecordsRequest ()
 inline

Constructs an AppendRecordsRequest object with default parameters.

Definition at line 451 of file AppendRecords.cs.

​
◆ AppendRecordsRequest() [2/4]

kinetica.AppendRecordsRequest.AppendRecordsRequest (stringtable_name,
stringsource_table_name,
IDictionary< string, string >field_map,
IDictionary< string, string >options = null )
 inline

Constructs an AppendRecordsRequest object with the specified parameters.

Parameters
table_nameThe table name for the records to be appended, in [schema_name.]table_name format, using standard name resolution rules. Must be an existing table.
source_table_nameThe source table name to get records from, in [schema_name.]table_name format, using standard name resolution rules. Must be an existing table name.
field_mapContains the mapping of column names from the target table (specified by table_name ) as the keys, and corresponding column names or expressions (e.g., ‘col_name+1’) from the source table (specified by source_table_name ). Must be existing column names in source table and target table, and their types must be matched. For details on using expressions, see Expressions.
optionsOptional parameters.
  • OFFSET: A positive integer indicating the number of initial results to skip from source_table_name . Default is 0. The minimum allowed value is 0. The maximum allowed value is MAX_INT. The default value is ‘0’.
  • LIMIT: A positive integer indicating the maximum number of results to be returned from source_table_name . Or END_OF_SET (-9999) to indicate that the max number of results should be returned. The default value is ‘-9999’.
  • EXPRESSION: Filter expression to apply to the source_table_name . The default value is ”.
  • ORDER_BY: Comma-separated list of the columns to be sorted by from source table (specified by source_table_name ), e.g., ‘timestamp asc, x desc’. The ORDER_BY columns do not have to be present in field_map . The default value is ”.
  • UPDATE_ON_EXISTING_PK: Specifies the record collision policy for inserting source table records (specified by source_table_name ) into a target table (specified by table_name ) with a primary key. If set to TRUE, any existing table record with primary key values that match those of a source table 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 source table record being inserted will remain unchanged, while the source record will be rejected and an error handled as determined by IGNORE_EXISTING_PK. 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.
  • ENABLE_INPLACE_UPDATES: Applies only when upserting (when UPDATE_ON_EXISTING_PK is TRUE). If set to TRUE, an existing record matched by primary key is modified in place. If set to FALSE, it is updated by deleting the existing record 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.
  • IGNORE_EXISTING_PK: Specifies the record collision error-suppression policy for inserting source table records (specified by source_table_name ) into a target table (specified by table_name ) 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 source table record being inserted that is rejected for having primary key values that match those of an existing target table record will be ignored with no error generated. If FALSE, the rejection of any source table record for having primary key values matching an existing target table record will result in an error being raised. 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 source table records whose primary key values collide with those of target table records.
    • FALSE: Raise an error for any source table record whose primary key values collide with those of a target table record.
    The default value is FALSE.
  • PK_CONFLICT_PREDICATE_HIGHER: The record with higher value for the column resolves the primary-key insert conflict. The default value is ”.
  • PK_CONFLICT_PREDICATE_LOWER: The record with lower value for the column resolves the primary-key insert conflict. The default value is ”.
  • TRUNCATE_STRINGS: If set to TRUE, it allows inserting longer strings into smaller charN string columns by truncating the longer strings to fit. Supported values:The default value is FALSE.
The default value is an empty Dictionary.

Definition at line 682 of file AppendRecords.cs.

​
◆ AppendRecordsRequest() [3/4]

kinetica.AppendRecordsRequest.AppendRecordsRequest ()
 inline

Constructs an AppendRecordsRequest object with default parameters.

Definition at line 451 of file AppendRecords.cs.

​
◆ AppendRecordsRequest() [4/4]

kinetica.AppendRecordsRequest.AppendRecordsRequest (stringtable_name,
stringsource_table_name,
IDictionary< string, string >field_map,
IDictionary< string, string >options = null )
 inline

Constructs an AppendRecordsRequest object with the specified parameters.

Parameters
table_nameThe table name for the records to be appended, in [schema_name.]table_name format, using standard name resolution rules. Must be an existing table.
source_table_nameThe source table name to get records from, in [schema_name.]table_name format, using standard name resolution rules. Must be an existing table name.
field_mapContains the mapping of column names from the target table (specified by table_name ) as the keys, and corresponding column names or expressions (e.g., ‘col_name+1’) from the source table (specified by source_table_name ). Must be existing column names in source table and target table, and their types must be matched. For details on using expressions, see Expressions.
optionsOptional parameters.
  • OFFSET: A positive integer indicating the number of initial results to skip from source_table_name . Default is 0. The minimum allowed value is 0. The maximum allowed value is MAX_INT. The default value is ‘0’.
  • LIMIT: A positive integer indicating the maximum number of results to be returned from source_table_name . Or END_OF_SET (-9999) to indicate that the max number of results should be returned. The default value is ‘-9999’.
  • EXPRESSION: Filter expression to apply to the source_table_name . The default value is ”.
  • ORDER_BY: Comma-separated list of the columns to be sorted by from source table (specified by source_table_name ), e.g., ‘timestamp asc, x desc’. The ORDER_BY columns do not have to be present in field_map . The default value is ”.
  • UPDATE_ON_EXISTING_PK: Specifies the record collision policy for inserting source table records (specified by source_table_name ) into a target table (specified by table_name ) with a primary key. If set to TRUE, any existing table record with primary key values that match those of a source table 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 source table record being inserted will remain unchanged, while the source record will be rejected and an error handled as determined by IGNORE_EXISTING_PK. 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.
  • ENABLE_INPLACE_UPDATES: Applies only when upserting (when UPDATE_ON_EXISTING_PK is TRUE). If set to TRUE, an existing record matched by primary key is modified in place. If set to FALSE, it is updated by deleting the existing record 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.
  • IGNORE_EXISTING_PK: Specifies the record collision error-suppression policy for inserting source table records (specified by source_table_name ) into a target table (specified by table_name ) 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 source table record being inserted that is rejected for having primary key values that match those of an existing target table record will be ignored with no error generated. If FALSE, the rejection of any source table record for having primary key values matching an existing target table record will result in an error being raised. 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 source table records whose primary key values collide with those of target table records.
    • FALSE: Raise an error for any source table record whose primary key values collide with those of a target table record.
    The default value is FALSE.
  • PK_CONFLICT_PREDICATE_HIGHER: The record with higher value for the column resolves the primary-key insert conflict. The default value is ”.
  • PK_CONFLICT_PREDICATE_LOWER: The record with lower value for the column resolves the primary-key insert conflict. The default value is ”.
  • TRUNCATE_STRINGS: If set to TRUE, it allows inserting longer strings into smaller charN string columns by truncating the longer strings to fit. Supported values:The default value is FALSE.
The default value is an empty Dictionary.

Definition at line 682 of file AppendRecords.cs.

​
Property Documentation

​
◆ field_map

IDictionary< string, string > kinetica.AppendRecordsRequest.field_map = new Dictionary<string, string>()
 getset

Contains the mapping of column names from the target table (specified by AppendRecordsRequest.table_name) as the keys, and corresponding column names or expressions (e.g., ‘col_name+1’) from the source table (specified by AppendRecordsRequest.source_table_name).

Must be existing column names in source table and target table, and their types must be matched. For details on using expressions, see Expressions.

Definition at line 236 of file AppendRecords.cs.

​
◆ options

IDictionary< string, string > kinetica.AppendRecordsRequest.options = new Dictionary<string, string>()
 getset

Optional parameters.

  • OFFSET: A positive integer indicating the number of initial results to skip from AppendRecordsRequest.source_table_name. Default is 0. The minimum allowed value is 0. The maximum allowed value is MAX_INT. The default value is ‘0’.
  • LIMIT: A positive integer indicating the maximum number of results to be returned from AppendRecordsRequest.source_table_name. Or END_OF_SET (-9999) to indicate that the max number of results should be returned. The default value is ‘-9999’.
  • EXPRESSION: Filter expression to apply to the AppendRecordsRequest.source_table_name. The default value is ”.
  • ORDER_BY: Comma-separated list of the columns to be sorted by from source table (specified by AppendRecordsRequest.source_table_name), e.g., ‘timestamp asc, x desc’. The ORDER_BY columns do not have to be present in AppendRecordsRequest.field_map. The default value is ”.
  • UPDATE_ON_EXISTING_PK: Specifies the record collision policy for inserting source table records (specified by AppendRecordsRequest.source_table_name) into a target table (specified by AppendRecordsRequest.table_name) with a primary key. If set to TRUE, any existing table record with primary key values that match those of a source table 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 source table record being inserted will remain unchanged, while the source record will be rejected and an error handled as determined by IGNORE_EXISTING_PK. 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.
  • ENABLE_INPLACE_UPDATES: Applies only when upserting (when UPDATE_ON_EXISTING_PK is TRUE). If set to TRUE, an existing record matched by primary key is modified in place. If set to FALSE, it is updated by deleting the existing record 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.
  • IGNORE_EXISTING_PK: Specifies the record collision error-suppression policy for inserting source table records (specified by AppendRecordsRequest.source_table_name) into a target table (specified by AppendRecordsRequest.table_name) 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 source table record being inserted that is rejected for having primary key values that match those of an existing target table record will be ignored with no error generated. If FALSE, the rejection of any source table record for having primary key values matching an existing target table record will result in an error being raised. 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 source table records whose primary key values collide with those of target table records.
    • FALSE: Raise an error for any source table record whose primary key values collide with those of a target table record.
    The default value is FALSE.
  • PK_CONFLICT_PREDICATE_HIGHER: The record with higher value for the column resolves the primary-key insert conflict. The default value is ”.
  • PK_CONFLICT_PREDICATE_LOWER: The record with lower value for the column resolves the primary-key insert conflict. The default value is ”.
  • TRUNCATE_STRINGS: If set to TRUE, it allows inserting longer strings into smaller charN string columns by truncating the longer strings to fit. Supported values:The default value is FALSE.

The default value is an empty Dictionary.

Definition at line 447 of file AppendRecords.cs.

​
◆ source_table_name

string kinetica.AppendRecordsRequest.source_table_name
 getset

The source table name to get records from, in [schema_name.

]table_name format, using standard name resolution rules.

Must be an existing table name.

Definition at line 225 of file AppendRecords.cs.

​
◆ table_name

string kinetica.AppendRecordsRequest.table_name
 getset

The table name for the records to be appended, in [schema_name.

]table_name format, using standard name resolution rules.

Must be an existing table.

Definition at line 218 of file AppendRecords.cs.

The documentation for this class was generated from the following files: