Kinetica C# API  Version 6.2.0.1
Public Attributes | List of all members
kinetica.CreateMaterializedViewRequest.Options Struct Reference

Optional parameters. More...

Public Attributes

const string COLLECTION_NAME = "collection_name"
 Name of a collection which is to contain the newly created view. More...
 
const string TTL = "ttl"
 Sets the TTL of the table specified in table_name. More...
 
const string PERSIST = "persist"
 If true, then the materialized view specified in table_name will be persisted and will not expire unless a ttl is specified. More...
 
const string TRUE = "true"
 
const string FALSE = "false"
 
const string REFRESH_METHOD = "refresh_method"
 Method by which the join can be refreshed when the data in underlying member tables have changed. More...
 
const string MANUAL = "manual"
 Refresh only occurs when manually requested by calling Kinetica.alterTable(string,string,string,IDictionary<string, string>) with an 'action' of 'refresh' More...
 
const string ON_QUERY = "on_query"
 For future use. More...
 
const string ON_CHANGE = "on_change"
 If possible, incrementally refresh (refresh just those records added) whenever an insert, update, delete or refresh of input table is done. More...
 
const string PERIODIC = "periodic"
 Refresh table periodically at rate specified by refresh_period More...
 
const string REFRESH_PERIOD = "refresh_period"
 When refresh_method is periodic, specifies the period in seconds at which refresh occurs More...
 
const string REFRESH_START_TIME = "refresh_start_time"
 When refresh_method is periodic, specifies the first time at which a refresh is to be done. More...
 

Detailed Description

Optional parameters.

  • COLLECTION_NAME: Name of a collection which is to contain the newly created view. If the collection provided is non-existent, the collection will be automatically created. If empty, then the newly created table will be a top-level table.
  • TTL: Sets the TTL of the table specified in .
  • PERSIST: If true, then the materialized view specified in will be persisted and will not expire unless a ttl is specified. If false, then the materialized view will be an in-memory table and will expire unless a ttl is specified otherwise. Supported values: The default value is FALSE.
  • REFRESH_METHOD: Method by which the join can be refreshed when the data in underlying member tables have changed. Supported values:
    • MANUAL: Refresh only occurs when manually requested by calling /alter/table with an 'action' of 'refresh'
    • ON_QUERY: For future use.
    • ON_CHANGE: If possible, incrementally refresh (refresh just those records added) whenever an insert, update, delete or refresh of input table is done. A full refresh is done if an incremental refresh is not possible.
    • PERIODIC: Refresh table periodically at rate specified by refresh_period
    The default value is MANUAL.
  • REFRESH_PERIOD: When refresh_method is periodic, specifies the period in seconds at which refresh occurs
  • REFRESH_START_TIME: When refresh_method is periodic, specifies the first time at which a refresh is to be done. Value is a datetime string with format 'YYYY-MM-DD HH:MM:SS'.

The default value is an empty Dictionary. A set of string constants for the parameter options.

Definition at line 127 of file CreateMaterializedView.cs.

Member Data Documentation

◆ COLLECTION_NAME

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

Name of a collection which is to contain the newly created view.

If the collection provided is non-existent, the collection will be automatically created. If empty, then the newly created table will be a top-level table.

Definition at line 134 of file CreateMaterializedView.cs.

◆ FALSE

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

Definition at line 161 of file CreateMaterializedView.cs.

◆ MANUAL

const string kinetica.CreateMaterializedViewRequest.Options.MANUAL = "manual"

Refresh only occurs when manually requested by calling Kinetica.alterTable(string,string,string,IDictionary<string, string>) with an 'action' of 'refresh'

Definition at line 203 of file CreateMaterializedView.cs.

◆ ON_CHANGE

const string kinetica.CreateMaterializedViewRequest.Options.ON_CHANGE = "on_change"

If possible, incrementally refresh (refresh just those records added) whenever an insert, update, delete or refresh of input table is done.

A full refresh is done if an incremental refresh is not possible.

Definition at line 212 of file CreateMaterializedView.cs.

◆ ON_QUERY

const string kinetica.CreateMaterializedViewRequest.Options.ON_QUERY = "on_query"

For future use.

Definition at line 206 of file CreateMaterializedView.cs.

◆ PERIODIC

const string kinetica.CreateMaterializedViewRequest.Options.PERIODIC = "periodic"

Refresh table periodically at rate specified by refresh_period

Definition at line 216 of file CreateMaterializedView.cs.

◆ PERSIST

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

If true, then the materialized view specified in table_name will be persisted and will not expire unless a ttl is specified.

If false, then the materialized view will be an in-memory table and will expire unless a ttl is specified otherwise. Supported values:

The default value is FALSE.

Definition at line 159 of file CreateMaterializedView.cs.

◆ REFRESH_METHOD

const string kinetica.CreateMaterializedViewRequest.Options.REFRESH_METHOD = "refresh_method"

Method by which the join can be refreshed when the data in underlying member tables have changed.

Supported values:

The default value is MANUAL.

Definition at line 197 of file CreateMaterializedView.cs.

◆ REFRESH_PERIOD

const string kinetica.CreateMaterializedViewRequest.Options.REFRESH_PERIOD = "refresh_period"

When refresh_method is periodic, specifies the period in seconds at which refresh occurs

Definition at line 221 of file CreateMaterializedView.cs.

◆ REFRESH_START_TIME

const string kinetica.CreateMaterializedViewRequest.Options.REFRESH_START_TIME = "refresh_start_time"

When refresh_method is periodic, specifies the first time at which a refresh is to be done.

Value is a datetime string with format 'YYYY-MM-DD HH:MM:SS'.

Definition at line 227 of file CreateMaterializedView.cs.

◆ TRUE

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

Definition at line 160 of file CreateMaterializedView.cs.

◆ TTL

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

Sets the TTL of the table specified in table_name.

Definition at line 139 of file CreateMaterializedView.cs.

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