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

string	source_table_name `[get, set]`
	The source table name to get records from. 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 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 23 of file AppendRecords.cs.

Constructor & Destructor Documentation

◆ AppendRecordsRequest() [1/2]

kinetica.AppendRecordsRequest.AppendRecordsRequest ( )

inline

Constructs an AppendRecordsRequest object with default parameters.

Definition at line 254 of file AppendRecords.cs.

◆ AppendRecordsRequest() [2/2]

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_name	The table name for the records to be appended. Must be an existing table.
source_table_name	The source table name to get records from. Must be an existing table name.
field_map	Contains the mapping of column names from the target table (specified by ) as the keys, and corresponding column names from the source table (specified by ). Must be existing column names in source table and target table, and their types must be matched.
options	Optional parameters. OFFSET: A positive integer indicating the number of initial results to skip from source table (specified by ). Default is 0. The minimum allowed value is 0. The maximum allowed value is MAX_INT. LIMIT: A positive integer indicating the maximum number of results to be returned from source table (specified by ). Or END_OF_SET (-9999) to indicate that the max number of results should be returned. EXPRESSION: Optional filter expression to apply to the source table (specified by ). Empty by default. ORDER_BY: Comma-separated list of the columns to be sorted from source table (specified by ) by; e.g. 'timestamp asc, x desc'. The columns specified must be present in . If any alias is given for any column name, the alias must be used, rather than the original column name. UPDATE_ON_EXISTING_PK: Specifies the record collision policy for inserting the source table records (specified by ) into the target table (specified by ) table with a primary key. If set to true, any existing target table record with primary key values that match those of a source table record being inserted will be replaced by that new record. If set to false, any existing target table record with primary key values that match those of a source table record being inserted will remain unchanged and the new record discarded. If the specified table does not have a primary key, then this option is ignored. Supported values: TRUE FALSE The default value is FALSE.

Definition at line 343 of file AppendRecords.cs.

Property Documentation

◆ field_map

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 from the source table (specified by ).

Must be existing column names in source table and target table, and their types must be matched.

Definition at line 175 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 source table (specified by ). Default is 0. The minimum allowed value is 0. The maximum allowed value is MAX_INT.
LIMIT: A positive integer indicating the maximum number of results to be returned from source table (specified by ). Or END_OF_SET (-9999) to indicate that the max number of results should be returned.
EXPRESSION: Optional filter expression to apply to the source table (specified by ). Empty by default.
ORDER_BY: Comma-separated list of the columns to be sorted from source table (specified by ) by; e.g. 'timestamp asc, x desc'. The columns specified must be present in . If any alias is given for any column name, the alias must be used, rather than the original column name.
UPDATE_ON_EXISTING_PK: Specifies the record collision policy for inserting the source table records (specified by ) into the target table (specified by ) table with a primary key. If set to true, any existing target table record with primary key values that match those of a source table record being inserted will be replaced by that new record. If set to false, any existing target table record with primary key values that match those of a source table record being inserted will remain unchanged and the new record discarded. If the specified table does not have a primary key, then this option is ignored. Supported values:
- TRUE
- FALSE
The default value is FALSE.

Definition at line 249 of file AppendRecords.cs.

◆ source_table_name

string kinetica.AppendRecordsRequest.source_table_name

getset

The source table name to get records from.

Must be an existing table name.

Definition at line 166 of file AppendRecords.cs.

◆ table_name

string kinetica.AppendRecordsRequest.table_name

getset

The table name for the records to be appended.

Must be an existing table.

Definition at line 162 of file AppendRecords.cs.

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

Kinetica/Protocol/AppendRecords.cs

Classes

Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ AppendRecordsRequest() [1/2]

◆ AppendRecordsRequest() [2/2]

Property Documentation

◆ field_map

◆ options

◆ source_table_name

◆ table_name