Kinetica C# API  Version 7.1.10.0
 All Classes Namespaces Files Functions Variables Enumerations Enumerator Properties Pages
Public Attributes | List of all members
kinetica.MergeRecordsRequest.Options Struct Reference

Optional parameters. More...

Public Attributes

const string CREATE_TEMP_TABLE = "create_temp_table"
 If true, a unique temporary table name will be generated in the sys_temp schema and used in place of table_name. More...
 
const string TRUE = "true"
 
const string FALSE = "false"
 
const string COLLECTION_NAME = "collection_name"
 [DEPRECATED–please specify the containing schema for the merged table as part of table_name and use Kinetica.createSchema(string,IDictionary{string, string}) to create the schema if non-existent] Name of a schema for the newly created merged table specified by table_name. More...
 
const string IS_REPLICATED = "is_replicated"
 Indicates the distribution scheme for the data of the merged table specified in table_name. More...
 
const string TTL = "ttl"
 Sets the TTL of the merged table specified in table_name. More...
 
const string PERSIST = "persist"
 If true, then the table specified in table_name will be persisted and will not expire unless a ttl is specified. More...
 
const string CHUNK_SIZE = "chunk_size"
 Indicates the number of records per chunk to be used for the merged table specified in table_name. More...
 
const string VIEW_ID = "view_id"
 view this result table is part of. More...
 

Detailed Description

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. A set of string constants for the parameter options.

Definition at line 149 of file MergeRecords.cs.

Member Data Documentation

const string kinetica.MergeRecordsRequest.Options.CHUNK_SIZE = "chunk_size"

Indicates the number of records per chunk to be used for the merged table specified in table_name.

Definition at line 236 of file MergeRecords.cs.

const string kinetica.MergeRecordsRequest.Options.COLLECTION_NAME = "collection_name"

[DEPRECATED–please specify the containing schema for the merged table as part of table_name and use Kinetica.createSchema(string,IDictionary{string, string}) to create the schema if non-existent] Name of a schema for the newly created merged table specified by table_name.

Definition at line 182 of file MergeRecords.cs.

const string kinetica.MergeRecordsRequest.Options.CREATE_TEMP_TABLE = "create_temp_table"

If true, a unique temporary table name will be generated in the sys_temp schema and used in place of table_name.

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.

Definition at line 171 of file MergeRecords.cs.

const string kinetica.MergeRecordsRequest.Options.FALSE = "false"

Definition at line 173 of file MergeRecords.cs.

const string kinetica.MergeRecordsRequest.Options.IS_REPLICATED = "is_replicated"

Indicates the distribution scheme for the data of the merged table specified in table_name.

If true, the table will be replicated. If false, the table will be randomly sharded. Supported values:

The default value is FALSE.

Definition at line 206 of file MergeRecords.cs.

const string kinetica.MergeRecordsRequest.Options.PERSIST = "persist"

If true, then the table specified in table_name 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.

Definition at line 231 of file MergeRecords.cs.

const string kinetica.MergeRecordsRequest.Options.TRUE = "true"

Definition at line 172 of file MergeRecords.cs.

const string kinetica.MergeRecordsRequest.Options.TTL = "ttl"

Sets the TTL of the merged table specified in table_name.

Definition at line 211 of file MergeRecords.cs.

const string kinetica.MergeRecordsRequest.Options.VIEW_ID = "view_id"

view this result table is part of.

The default value is ''.

Definition at line 240 of file MergeRecords.cs.

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