A set of parameters for /insert/records. More...

Inheritance diagram for kinetica.RawInsertRecordsRequest:

Collaboration diagram for kinetica.RawInsertRecordsRequest:

Classes
struct	ListEncoding
	The encoding of the records to be inserted. More...

struct	Options
	Optional parameters. More...

Public Member Functions
	RawInsertRecordsRequest ()
	Constructs a RawInsertRecordsRequest object with default parameters. More...

	RawInsertRecordsRequest (string table_name, IList< byte[]> list, IDictionary< string, string > options=null)
	Constructs a RawInsertRecordsRequest object with the specified parameters. More...

	RawInsertRecordsRequest (string table_name, IList< byte[]> list, IList< string > list_str, string list_encoding=null, IDictionary< string, string > options=null)
	Constructs a RawInsertRecordsRequest 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]`
	Table to which the records are to be added. More...

IList< byte[]>	list `[get, set]`
	An array of binary-encoded data for the records to be added. More...

IList< string >	list_str = new List<byte[]>() `[get, set]`
	An array of JSON encoded data for the records to be added. More...

string	list_encoding = new List<string>() `[get, set]`
	The encoding of the records to be inserted. More...

IDictionary< string, string >	options = ListEncoding.BINARY `[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 /insert/records.

Adds multiple records to the specified table. The operation is synchronous, meaning that a response will not be returned until all the records are fully inserted and available. The response payload provides the counts of the number of records actually inserted and/or updated, and can provide the unique identifier of each added record.
The <member name="options"> parameter can be used to customize this function's behavior.
The update_on_existing_pk option specifies the record collision policy for inserting into a table with a primary key, but is ignored if no primary key exists.
The return_record_ids option indicates that the database should return the unique identifiers of inserted records.
The route_to_address option directs that inserted records should be targeted for a particular database node.

Definition at line 35 of file InsertRecords.cs.

Constructor & Destructor Documentation

kinetica.RawInsertRecordsRequest.RawInsertRecordsRequest ( )

inline

Constructs a RawInsertRecordsRequest object with default parameters.

Definition at line 167 of file InsertRecords.cs.

kinetica.RawInsertRecordsRequest.RawInsertRecordsRequest	(	string	table_name,
		IList< byte[]>	list,
		IDictionary< string, string >	options = `null`
	)

inline

Constructs a RawInsertRecordsRequest object with the specified parameters.

Parameters

table_name	Table to which the records are to be added. Must be an existing table.
list	An array of binary-encoded data for the records to be added. All records must be of the same type as that of the table. Empty array if is json.
options	Optional parameters. update_on_existing_pk 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. If set to false, any existing table record with primary key values that match those of a 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. Values: true, false. return_record_ids If true then return the internal record id along for each inserted record. Values: true, false. route_to_address Route to a specific rank/tom. Option not suitable for tables using primary/shard keys

Definition at line 209 of file InsertRecords.cs.

kinetica.RawInsertRecordsRequest.RawInsertRecordsRequest	(	string	table_name,
		IList< byte[]>	list,
		IList< string >	list_str,
		string	list_encoding = `null`,
		IDictionary< string, string >	options = `null`
	)

inline

Constructs a RawInsertRecordsRequest object with the specified parameters.

Parameters

table_name	Table to which the records are to be added. Must be an existing table.
list	An array of binary-encoded data for the records to be added. All records must be of the same type as that of the table. Empty array if is json.
list_str	An array of JSON encoded data for the records to be added. All records must be of the same type as that of the table. Empty array if is binary.
list_encoding	The encoding of the records to be inserted. Values: binary, json.
options	Optional parameters. update_on_existing_pk 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. If set to false, any existing table record with primary key values that match those of a 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. Values: true, false. return_record_ids If true then return the internal record id along for each inserted record. Values: true, false. route_to_address Route to a specific rank/tom. Option not suitable for tables using primary/shard keys

Definition at line 269 of file InsertRecords.cs.

Property Documentation

IList<byte[]> kinetica.RawInsertRecordsRequest.list

getset

An array of binary-encoded data for the records to be added.

All records must be of the same type as that of the table. Empty array if is json.

Definition at line 120 of file InsertRecords.cs.

string kinetica.RawInsertRecordsRequest.list_encoding = new List<string>()

getset

The encoding of the records to be inserted.

Values: binary, json.

Definition at line 131 of file InsertRecords.cs.

IList<string> kinetica.RawInsertRecordsRequest.list_str = new List<byte[]>()

getset

An array of JSON encoded data for the records to be added.

All records must be of the same type as that of the table. Empty array if is binary.

Definition at line 126 of file InsertRecords.cs.

IDictionary<string, string> kinetica.RawInsertRecordsRequest.options = ListEncoding.BINARY

getset

Optional parameters.

update_on_existing_pk 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. If set to false, any existing table record with primary key values that match those of a 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. Values: true, false.
return_record_ids If true then return the internal record id along for each inserted record. Values: true, false.
route_to_address Route to a specific rank/tom. Option not suitable for tables using primary/shard keys

Definition at line 162 of file InsertRecords.cs.

string kinetica.RawInsertRecordsRequest.table_name

getset

Table to which the records are to be added.

Must be an existing table.

Definition at line 113 of file InsertRecords.cs.

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

Kinetica/Protocol/InsertRecords.cs

Classes

Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Property Documentation