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.MergeRecordsRequest Class Reference

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 name of the new result table for the records to be merged into, in [schema_name. More...
 
IList< string > source_table_names [get, set]
 The list of names of source tables to get the records from, each in [schema_name. 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 39 of file MergeRecords.cs.

Constructor & Destructor Documentation

kinetica.MergeRecordsRequest.MergeRecordsRequest ( )
inline

Constructs a MergeRecordsRequest object with default parameters.

Definition at line 383 of file MergeRecords.cs.

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_nameThe name of the new result table for the records to be merged into, in [schema_name.]table_name format, using standard name resolution rules and meeting table naming criteria. Must NOT be an existing table.
source_table_namesThe list of names of source tables to get the records from, each in [schema_name.]table_name format, using standard name resolution rules. Must be existing table names.
field_mapsContains 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.
optionsOptional parameters.
  • CREATE_TEMP_TABLE: If true, a unique temporary table name will be generated in the sys_temp schema and used in place of . If persist is false, then this is always allowed even if the caller does not have permission to create tables. The generated name is returned in qualified_table_name. Supported values: The default value is FALSE.
  • COLLECTION_NAME: [DEPRECATED–please specify the containing schema for the merged table as part of and use /create/schema to create the schema if non-existent] Name of a schema for the newly created merged table specified by .
  • 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: 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: The default value is TRUE.
  • CHUNK_SIZE: Indicates the number of records per chunk 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 519 of file MergeRecords.cs.

Property Documentation

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 271 of file MergeRecords.cs.

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

Optional parameters.

  • CREATE_TEMP_TABLE: If true, a unique temporary table name will be generated in the sys_temp schema and used in place of . If persist is false, then this is always allowed even if the caller does not have permission to create tables. The generated name is returned in qualified_table_name. Supported values: The default value is FALSE.
  • COLLECTION_NAME: [DEPRECATED–please specify the containing schema for the merged table as part of and use /create/schema to create the schema if non-existent] Name of a schema for the newly created merged table specified by .
  • 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: 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: The default value is TRUE.
  • CHUNK_SIZE: Indicates the number of records per chunk 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 378 of file MergeRecords.cs.

IList<string> kinetica.MergeRecordsRequest.source_table_names
getset

The list of names of source tables to get the records from, each in [schema_name.

]table_name format, using standard name resolution rules. Must be existing table names.

Definition at line 258 of file MergeRecords.cs.

string kinetica.MergeRecordsRequest.table_name
getset

The name of the new result table for the records to be merged into, in [schema_name.

]table_name format, using standard name resolution rules and meeting table naming criteria. Must NOT be an existing table.

Definition at line 251 of file MergeRecords.cs.

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