Kinetica C# API  Version 7.1.10.0
 All Classes Namespaces Files Functions Variables Enumerations Enumerator Properties Pages
Classes | Public Member Functions | Properties | List of all members
kinetica.AppendRecordsRequest Class Reference

A set of parameters for Kinetica.appendRecords(string,string,IDictionary{string, string},IDictionary{string, string}). More...

+ Inheritance diagram for kinetica.AppendRecordsRequest:
+ Collaboration diagram for kinetica.AppendRecordsRequest:

Classes

struct  Options
 Optional parameters. More...
 

Public Member Functions

 AppendRecordsRequest ()
 Constructs an AppendRecordsRequest object with default parameters. More...
 
 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. More...
 
- Public Member Functions inherited from kinetica.KineticaData
 KineticaData (KineticaType type)
 Constructor from Kinetica Type More...
 
 KineticaData (System.Type type=null)
 Default constructor, with optional System.Type More...
 
object Get (int fieldPos)
 Retrieve a specific property from this object More...
 
void Put (int fieldPos, object fieldValue)
 Write a specific property to this object More...
 

Properties

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

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. More...
 

Detailed Description

A set of parameters for Kinetica.appendRecords(string,string,IDictionary{string, string},IDictionary{string, string}).


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

Definition at line 25 of file AppendRecords.cs.

Constructor & Destructor Documentation

kinetica.AppendRecordsRequest.AppendRecordsRequest ( )
inline

Constructs an AppendRecordsRequest object with default parameters.

Definition at line 476 of file AppendRecords.cs.

kinetica.AppendRecordsRequest.AppendRecordsRequest ( string  table_name,
string  source_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 ) as the keys, and corresponding column names or expressions (e.g., 'col_name+1') from the source table (specified by ). 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 . 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 . Or END_OF_SET (-9999) to indicate that the max number of results should be returned. The default value is '-9999'.
  • EXPRESSION: Optional filter expression to apply to the . The default value is ''.
  • ORDER_BY: Comma-separated list of the columns to be sorted by from source table (specified by ), e.g., 'timestamp asc, x desc'. The order_by columns do not have to be present in . The default value is ''.
  • UPDATE_ON_EXISTING_PK: Specifies the record collision policy for inserting source table records (specified by ) into a target table (specified by ) 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.
  • IGNORE_EXISTING_PK: Specifies the record collision error-suppression policy for inserting source table records (specified by ) into a target table (specified by ) 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.
  • 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 645 of file AppendRecords.cs.

Property Documentation

IDictionary<string, string> kinetica.AppendRecordsRequest.field_map
getset

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

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 326 of file AppendRecords.cs.

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 . 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 . Or END_OF_SET (-9999) to indicate that the max number of results should be returned. The default value is '-9999'.
  • EXPRESSION: Optional filter expression to apply to the . The default value is ''.
  • ORDER_BY: Comma-separated list of the columns to be sorted by from source table (specified by ), e.g., 'timestamp asc, x desc'. The order_by columns do not have to be present in . The default value is ''.
  • UPDATE_ON_EXISTING_PK: Specifies the record collision policy for inserting source table records (specified by ) into a target table (specified by ) 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.
  • IGNORE_EXISTING_PK: Specifies the record collision error-suppression policy for inserting source table records (specified by ) into a target table (specified by ) 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.
  • 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 471 of file AppendRecords.cs.

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 315 of file AppendRecords.cs.

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 308 of file AppendRecords.cs.

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