A set of parameters for Kinetica.mergeRecords(string,IList<string>,IList<IDictionary<string, string>>,IDictionary<string, string>). More...

Inheritance diagram for kinetica.MergeRecordsRequest:

Collaboration diagram for kinetica.MergeRecordsRequest:

Classes
struct	Options
	Optional parameters. More...

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

	MergeRecordsRequest (string table_name, IList< string > source_table_names, IList< IDictionary< string, string >> field_maps, IDictionary< string, string > options=null)
	Constructs a MergeRecordsRequest 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 new result table name for the records to be merged. More...

IList< string >	source_table_names `[get, set]`
	The list of source table names to get the records from. More...

IList< IDictionary< string, string > >	field_maps = new List<string>() `[get, set]`
	Contains a list of source/target column mappings, one mapping for each source table listed in being merged into the target table specified by . More...

IDictionary< string, string >	options = new List<IDictionary<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.mergeRecords(string,IList<string>,IList<IDictionary<string, string>>,IDictionary<string, string>).

Create a new empty result table (specified by table_name), and insert all records from source tables (specified by source_table_names) based on the field mapping information (specified by field_maps).
For merge records details and examples, see Merge Records. For limitations, see Merge Records Limitations and Cautions.
The field map (specified by field_maps) holds the user-specified maps of target table column names to source table columns. The array of field_maps must match one-to-one with the source_table_names, e.g., there's a map present in field_maps for each table listed in source_table_names.

Definition at line 35 of file MergeRecords.cs.

Constructor & Destructor Documentation

◆ MergeRecordsRequest() [1/2]

kinetica.MergeRecordsRequest.MergeRecordsRequest ( )

inline

Constructs a MergeRecordsRequest object with default parameters.

Definition at line 301 of file MergeRecords.cs.

◆ MergeRecordsRequest() [2/2]

kinetica.MergeRecordsRequest.MergeRecordsRequest	(	string	table_name,
		IList< string >	source_table_names,
		IList< IDictionary< string, string >>	field_maps,
		IDictionary< string, string >	options = `null`
	)

inline

Constructs a MergeRecordsRequest object with the specified parameters.

Parameters

table_name	The new result table name for the records to be merged. Must NOT be an existing table.
source_table_names	The list of source table names to get the records from. Must be existing table names.
field_maps	Contains a list of source/target column mappings, one mapping for each source table listed in being merged into the target table specified by . Each mapping contains the target column names (as keys) that the data in the mapped source columns or column expressions (as values) will be merged into. All of the source columns being merged into a given target column must match in type, as that type will determine the type of the new target column.
options	Optional parameters. COLLECTION_NAME: Name of a collection which is to contain the newly created merged table specified by . If the collection provided is non-existent, the collection will be automatically created. If empty, then the newly created merged table will be a top-level table. IS_REPLICATED: Indicates the distribution scheme for the data of the merged table specified in . If true, the table will be replicated. If false, the table will be randomly sharded. Supported values: TRUE FALSE The default value is FALSE. TTL: Sets the TTL of the merged table specified in . PERSIST: If true, then the table specified in will be persisted and will not expire unless a ttl is specified. If false, then the table will be an in-memory table and will expire unless a ttl is specified otherwise. Supported values: TRUE FALSE The default value is TRUE. CHUNK_SIZE: Indicates the chunk size to be used for the merged table specified in . VIEW_ID: view this result table is part of. The default value is ''. The default value is an empty Dictionary.

Definition at line 404 of file MergeRecords.cs.

Property Documentation

◆ field_maps

IList<IDictionary<string, string> > kinetica.MergeRecordsRequest.field_maps = new List<string>()

getset

Contains a list of source/target column mappings, one mapping for each source table listed in being merged into the target table specified by .

Each mapping contains the target column names (as keys) that the data in the mapped source columns or column expressions (as values) will be merged into. All of the source columns being merged into a given target column must match in type, as that type will determine the type of the new target column.

Definition at line 212 of file MergeRecords.cs.

◆ options

IDictionary<string, string> kinetica.MergeRecordsRequest.options = new List<IDictionary<string, string>>()

getset

Optional parameters.

COLLECTION_NAME: Name of a collection which is to contain the newly created merged table specified by . If the collection provided is non-existent, the collection will be automatically created. If empty, then the newly created merged table will be a top-level table.
IS_REPLICATED: Indicates the distribution scheme for the data of the merged table specified in . If true, the table will be replicated. If false, the table will be randomly sharded. Supported values:
- TRUE
- FALSE
The default value is FALSE.
TTL: Sets the TTL of the merged table specified in .
PERSIST: If true, then the table specified in will be persisted and will not expire unless a ttl is specified. If false, then the table will be an in-memory table and will expire unless a ttl is specified otherwise. Supported values:
- TRUE
- FALSE
The default value is TRUE.
CHUNK_SIZE: Indicates the chunk size to be used for the merged table specified in .
VIEW_ID: view this result table is part of. The default value is ''.

The default value is an empty Dictionary.

Definition at line 296 of file MergeRecords.cs.

◆ source_table_names

IList<string> kinetica.MergeRecordsRequest.source_table_names

getset

The list of source table names to get the records from.

Must be existing table names.

Definition at line 199 of file MergeRecords.cs.

◆ table_name

string kinetica.MergeRecordsRequest.table_name

getset

The new result table name for the records to be merged.

Must NOT be an existing table.

Definition at line 195 of file MergeRecords.cs.

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

Kinetica/Protocol/MergeRecords.cs

Classes

Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ MergeRecordsRequest() [1/2]

◆ MergeRecordsRequest() [2/2]

Property Documentation

◆ field_maps

◆ options

◆ source_table_names

◆ table_name